API 개요
클래스 CrossProjectRefError
클라이언트 측 digest 계산 중 다른 프로젝트를 가리키는 ref를 만나 내부 ID로 해결할 수 없을 때 발생합니다.
클래스 FlushStatus
현재 플러시 오퍼레이션에 대한 상태 정보입니다.
클래스 NoInternalProjectIDError
내부 프로젝트 ID가 아직 확인되지 않아 클라이언트 측 digest 계산을 진행할 수 없을 때 발생합니다.
클래스 PendingJobCounts
유형별 대기 중인 작업 수입니다.
클래스 WeaveClient
방법 __init__
속성 num_outstanding_jobs
모든 실행기와 서버에서 대기 중인 작업의 총개수를 반환합니다. 이 속성을 사용하면 메인 스레드를 블로킹하지 않고도 백그라운드 작업의 진행 상황을 확인할 수 있습니다. 반환값:int: 대기 중인 작업의 총개수
속성 project_id
방법 add_calls_to_annotation_queue
방법 add_cost
queue_id: annotation 큐 ID입니다.call_ids: 큐에 추가할 call ID입니다.display_fields: 검토자에게 표시할 JSON 경로입니다(예:inputs.prompt또는output.text). 예시:
llm_id: LLM의 ID입니다. 예: “gpt-4o-mini-2024-07-18”prompt_token_cost: 프롬프트 토큰당 비용입니다. 예: .0005completion_token_cost: 완료 토큰당 비용입니다. 예: .0015effective_date: 기본값은 현재 날짜입니다. datetime.datetime 객체입니다.provider_id: LLM의 공급자입니다. 기본값은 “default”입니다. 예: “openai”prompt_token_cost_unit: 프롬프트 토큰 비용의 단위입니다. 기본값은 “USD”입니다. (현재 사용되지 않으며, 향후 비용의 통화 유형을 지정하는 데 사용될 예정입니다. 예: “tokens” 또는 “time”)completion_token_cost_unit: 완료 토큰 비용의 단위입니다. 기본값은 “USD”입니다. (현재 사용되지 않으며, 향후 비용의 통화 유형을 지정하는 데 사용될 예정입니다. 예: “tokens” 또는 “time”) 반환값: CostCreateRes 객체입니다. ids라는 이름의 튜플 목록이라는 하나의 필드를 가지고 있습니다. 각 튜플은 llm_id와 생성된 비용 객체의 id를 포함합니다.
방법 add_tags
방법 clear_wandb_run_context
obj_ref: 객체 버전에 대한 레퍼런스로, ObjectRef 또는 weave /// URI string입니다.tags: 추가할 태그 string의 목록입니다. 예시:
방법 create_annotation_queue
name: 큐의 표시 이름입니다.scorer_refs: 리뷰어가 작성할 Scorer/어노테이션 필드의 Weave Ref입니다.description: 리뷰어 가이드라인 또는 큐 설명입니다(선택). 반환값: 생성된 annotation 큐의 ID입니다.
방법 create_call
op: call을 생성하는 오퍼레이션 또는 익명 오퍼레이션의 이름입니다.inputs: 오퍼레이션에 대한 입력입니다.parent: 부모 call입니다. parent가 제공되지 않으면 current run이 부모로 사용됩니다.display_name: call의 표시 이름입니다. 기본값은 None입니다.attributes: call의 속성입니다. 기본값은 None입니다.use_stack: call을 런타임 스택에 push할지 여부입니다. 기본값은 True입니다.started_at: call 시작 시간을 재정의합니다. None이면 현재 시간을 사용합니다. 반환값: 생성된 Call 객체입니다.
방법 delete_all_object_versions
object_name: 버전을 삭제할 객체의 이름입니다. 반환값: 삭제된 버전의 수입니다.
방법 delete_all_op_versions
op_name: 버전을 삭제할 op의 이름입니다. 반환값: 삭제된 버전의 수입니다.
방법 delete_annotation_queue
방법 delete_call
방법 delete_calls
방법 delete_object_version
방법 delete_object_versions
-
call_ids: 삭제할 call ID의 목록입니다. 예: [“2F0193e107-8fcf-7630-b576-977cc3062e2e”] 인수: -
object_name: 삭제할 버전이 있는 객체의 이름입니다. -
digests: 삭제할 digest 목록입니다. “latest” 또는 “v0”과 같은 별칭을 포함할 수 있습니다. 반환값: 삭제된 버전의 수입니다.
방법 delete_op_version
방법 fail_call
방법 finish
방법 finish_call
call.summary에 있는 모든 값은 데이터베이스에 기록되기 전에 계산된 요약 통계(예: 사용 및 상태 수)와 깊이 병합됩니다.
방법 flush
방법 get
방법 get_agent_custom_attributes
-
use_progress_bar: 플러시 중에 진행률 표시줄을 표시할지 여부입니다. 진행률 표시줄이 제대로 렌더링되지 않는 환경(예: CI 환경)에서는 False로 설정하세요. -
callback: 상태 업데이트를 받는 선택적 callback 함수입니다. use_progress_bar를 재정의합니다. 인수: -
query: span을 제한하는 Mongo 스타일 필터 표현식입니다. -
started_after: 이 시간 이후(해당 시간 포함)에 시작된 span만 고려합니다. -
started_before: 이 시간 전에 시작된 span만 고려합니다. -
limit: 반환할 속성 키의 최대 개수입니다. -
offset: 건너뛸 키의 개수입니다(페이지 매김용). 반환값:attributes와has_more가 포함된AgentCustomAttrsSchemaRes입니다.
방법 get_agent_span_stats
server.agent_spans_stats를 직접 호출하세요.
인수:
start: 시간 범위의 시작(포함).metrics: 집계할 하나 이상의 메트릭(예: 토큰 합계).end: 시간 범위의 끝. 생략 시 현재 시간으로 기본 설정됩니다.query: span을 제한하는 Mongo 스타일 필터 표현식입니다.group_by: 집계를 그룹화할 span 필드입니다.granularity: 시계열 통계를 위한 시간 버킷 너비(초).timezone: 시간 버킷을 정렬하는 데 사용되는 IANA 시간대. 반환값:columns와rows가 포함된AgentSpanStatsRes.
방법 get_agent_spans
PaginatedIterator를 반환합니다(get_calls와 동일). len(...)은 전체 span 수를 알려줍니다.
인수:
agent_name: 설정하면 결과를 이 에이전트로 제한합니다(agent_name필드에 대한query를 간편하게 지정하는 방법).query: Mongo 스타일 필터 표현식입니다.agent_name과 함께 제공하면$and로 결합됩니다.sort_by: 결과를 정렬할 기준 필드입니다.limit: 생성할 span의 최대 개수입니다.None이면 모두 생성합니다.offset: 생성 전에 건너뛸 span의 개수입니다(페이지 매김용).page_size: 요청당 가져올 span의 개수입니다. 반환값:AgentSpanSchema를 순회하는PaginatedIterator입니다.
방법 get_agent_turn
trace_id: 채팅 뷰를 가져올 트레이스입니다.include_feedback: true이면 메시지에 대한 피드백을 포함합니다. 반환값: 해당 턴의 순서대로 정렬된messages를 포함하는AgentTraceChatRes입니다.
방법 get_agent_turns
conversation_id: 턴을 가져올 대화입니다.limit: 반환할 턴의 최대 개수입니다.offset: 건너뛸 가장 최근 턴의 개수입니다(페이지 매김용).include_feedback: true인 경우 메시지에 대한 피드백을 포함합니다. 반환값: 정렬된turns가 포함된AgentConversationChatRes입니다.
방법 get_agent_versions
PaginatedIterator를 반환합니다(get_calls와 동일). len(...)은 전체 버전 수를 반환합니다.
인수:
agent_name: 버전 목록을 조회할 에이전트입니다.sort_by: 결과를 정렬할 기준 필드입니다.limit: 반환할 최대 버전 수입니다.None이면 모두 반환합니다.offset: 반환하기 전에 건너뛸 버전 수입니다(페이지 매김용).page_size: 요청당 가져올 버전 수입니다. 반환값:AgentVersionSchema를 순회하는PaginatedIterator입니다.
방법 get_agents
PaginatedIterator(get_calls와 유사)를 반환합니다. len(...)은 전체 에이전트 수를 알려주며, 인덱싱과 슬라이싱을 지원합니다.
인수:
agent_name: 설정하면 결과를 이 에이전트로 제한합니다.sort_by: 결과를 정렬할 기준 필드입니다.limit: 반환할 에이전트의 최대 수입니다.None이면 모두 반환합니다.offset: 반환하기 전에 건너뛸 에이전트 수입니다(페이지 매김용).page_size: 요청당 가져올 에이전트 수입니다. 반환값:AgentSchema를 순회하는PaginatedIterator입니다.
방법 get_aliases
obj_ref: 객체 버전에 대한 레퍼런스이며, ObjectRef 또는 weave /// URI string입니다. 반환값: 별칭 string의 목록. 객체 버전이 최신인 경우 가상 “latest” 별칭을 포함합니다.
방법 get_annotation_queue
방법 get_annotation_queue_stats
방법 get_call
call_id: 조회할 Call의 ID입니다.include_costs: true이면 summary.weave에 비용 정보가 포함됩니다.include_feedback: true이면 summary.weave.feedback에 피드백 정보가 포함됩니다.columns: 응답에 포함할 열의 목록입니다. None이면 모든 열이 포함됩니다. 더 적은 열을 지정하면 성능이 향상될 수 있습니다. 일부 열은 항상 포함됩니다. id, project_id, trace_id, op_name, started_at 반환값: Call 객체입니다.
방법 get_calls
columns를 지정하고 filter 또는 query를 사용하여 결과 크기를 줄이세요.
인수:
filter:op_name,parent_ids등의 필드로 결과를 좁히는 상위 수준 필터입니다.limit: 반환할 Call의 최대 개수입니다.offset: 결과를 반환하기 전에 건너뛸 Call의 개수입니다(페이지 매김에 사용).sort_by: 결과 정렬에 사용할 필드 목록입니다(예:started_at desc).query: 고급 필터링을 위한 Mongo와 유사한 표현식입니다. 모든 Mongo Operator가 지원되는 것은 아닙니다.include_costs: True이면summary.weave에 토큰/비용 정보를 포함합니다.include_feedback: True이면summary.weave.feedback에 피드백을 포함합니다.include_storage_size: True이면 Call의 저장소 크기를 포함합니다.include_total_storage_size: True이면 트레이스의 총 저장소 크기를 포함합니다.include_usernames: True이면 각 Call의wb_user_id를wb_username으로 변환하려고 시도합니다.columns: Call마다 반환할 필드 목록입니다. 이를 줄이면 성능이 크게 향상될 수 있습니다. (id,trace_id,op_name,started_at등의 일부 필드는 항상 포함됩니다.)scored_by: 하나 이상의 Scorer(이름 또는 ref URI)로 필터링합니다. 여러 Scorer는 AND로 결합됩니다.page_size: 페이지당 가져올 Call의 개수입니다. 대규모 쿼리의 성능을 위해 이 값을 조정하세요.
CallsIter:Call객체를 순회하는 반복자입니다. 슬라이싱, 반복,.to_pandas()를 지원합니다.
방법 get_evaluation
weave:///entity/project/object/Evaluation:version
평가의 “알기 쉬운” 이름으로도 조회할 수 있습니다: get_evaluation(“Evaluation:v1”)
인수:
uri(str): 조회할 평가의 고유 리소스 식별자입니다.
Evaluation: 제공된 URI에 해당하는 Evaluation 객체입니다.
TypeError: URI의 객체가 Evaluation 인스턴스가 아닌 경우 발생합니다.ValueError: URI가 유효하지 않거나 객체를 찾을 수 없는 경우 발생합니다.
방법 get_evaluations
list[Evaluation]: 현재 프로젝트의 모든 Evaluation 객체 목록입니다. 평가를 찾을 수 없거나 모든 변환이 실패하면 빈 목록입니다.
방법 get_feedback
query: Mongo 스타일의 쿼리 표현식입니다. 편의를 위해 피드백 UUID string도 허용합니다.reaction: 편의를 위해 특정 반응 이모지로 필터링합니다.offset: 피드백 객체를 가져오기 시작할 오프셋입니다.limit: 가져올 피드백 객체의 최대 개수입니다. 반환값: FeedbackQuery 객체입니다.
방법 get_tags
obj_ref: 객체 버전에 대한 레퍼런스입니다. ObjectRef 또는 weave /// URI string입니다. 반환값: 태그 string 목록입니다. 객체 버전에 태그가 없으면 빈 목록을 반환합니다.
방법 get_tags_and_aliases
obj_ref: 객체 버전에 대한 레퍼런스로, ObjectRef 또는 weave /// URI string입니다. 반환값: (tags, aliases) 튜플입니다. 각각은 string 목록입니다. 객체 버전에 태그나 별칭이 없으면 빈 목록을 반환합니다.
방법 link_prompt_to_registry
-
prompt: 게시된 프롬프트,ObjectRef또는 완전 수식된 weave ///… URI string입니다. -
target_path:<registry_project>/<portfolio_name>형식의 레지스트리 대상 경로입니다. 예를 들어wandb-registry-prompts/my-prompt-collection입니다. -
aliases: 생성된 레지스트리 버전에 추가할 선택 별칭입니다. 반환값: -
LinkAssetToRegistryRes: 레지스트리 연결 엔드포인트의 파싱된 응답입니다.
방법 list_aliases
방법 list_annotation_queue_items
방법 list_annotation_queues
방법 list_tags
방법 purge_costs
방법 query_costs
ids: 영구 삭제할 비용 ID입니다. 단일 ID 또는 ID 목록을 지정할 수 있습니다. 예시:
query: Mongo 스타일의 쿼리 표현식입니다. 편의를 위해 비용 UUID string도 허용합니다.llm_ids: 편의를 위해 llm_ids 집합으로 필터링합니다.offset: 비용 객체를 가져오기 시작할 오프셋입니다.limit: 가져올 비용 객체의 최대 개수입니다. 반환값: CostQuery 객체입니다.
방법 remove_aliases
방법 remove_tags
obj_ref: 객체에 대한 레퍼런스로, ObjectRef 또는 weave /// URI string입니다(별칭은 객체 범위에 속하므로 digest는 사용되지 않습니다).alias: 제거할 별칭 이름 또는 별칭 이름 목록입니다. 인수:
방법 save
-
obj_ref: 객체 버전에 대한 레퍼런스로, ObjectRef 또는 weave /// URI string입니다. -
tags: 제거할 태그 string의 목록입니다. 인수: -
val: 저장할 객체입니다. -
name: 객체를 저장할 이름입니다. -
branch: 객체를 저장할 브랜치입니다. 기본값은 “latest”입니다. 반환값: 저장된 객체의 역직렬화된 버전입니다.
방법 search_agents
query가 비어 있으면 필터를 기반으로 구조화된 검색을 수행합니다.
인수:
query: 메시지 내용에서 일치 여부를 확인할 부분 문자열입니다. 비어 있으면 모두 일치합니다.agent_name: 이 에이전트의 메시지로 제한합니다.conversation_id: 단일 대화로 제한합니다.trace_id: 단일 트레이스로 제한합니다.limit: 검색 시 고려할 일치하는 메시지의 최대 개수입니다.offset: 건너뛸 일치 항목의 개수입니다(페이지 매김용). 반환값:results(일치하는 대화)가 포함된AgentSearchRes입니다.
방법 set_aliases
방법 set_wandb_run_context
-
obj_ref: 객체 버전에 대한 레퍼런스로, ObjectRef 또는 weave /// URI string입니다. -
alias: 설정할 별칭 이름 또는 별칭 이름 목록입니다(예: “production”). 인수: -
run_id: run ID입니다(entity/project 접두사 제외). 클라이언트가 entity/project 접두사를 자동으로 추가합니다. -
step: Call에 사용할 step 숫자입니다. None이면 step이 설정되지 않습니다. 예시: