> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# weave_client
> weave.trace.weave_client용 Python SDK 레퍼런스
export const SourceLink = ({url}) =>
출처
;
# API Overview
***
## class `CrossProjectRefError`
클라이언트 측 다이제스트 계산 중 내부 ID로 확인할 수 없는 다른 프로젝트에 대한 ref를 만나면 발생합니다.
***
## class `FlushStatus`
현재 플러시 오퍼레이션에 대한 상태 정보입니다.
***
## class `NoInternalProjectIDError`
아직 내부 프로젝트 ID가 확인되지 않아 클라이언트 측 다이제스트 계산을 진행할 수 없을 때 발생합니다.
***
## class `PendingJobCounts`
각 유형의 대기 중인 작업 수입니다.
***
## class `WeaveClient`
### 방법 `__init__`
```python theme={null}
__init__(
entity: 'str',
project: 'str',
server: 'TraceServerClientInterface',
ensure_project_exists: 'bool' = True,
postprocess_inputs: 'PostprocessInputsFunc | None' = None,
postprocess_output: 'PostprocessOutputFunc | None' = None,
attributes: 'dict[str, Any] | None' = None,
api_key: 'str | None' = None
)
```
***
#### 속성 num\_outstanding\_jobs
모든 executor와 서버에 걸쳐 대기 중인 작업의 총 개수를 반환합니다.
이 속성은 메인 스레드를 차단하지 않고도 백그라운드 작업의 진행 상황을 확인하는 데 사용할 수 있습니다.
**반환값:**
* `int`: 대기 중인 작업의 총 개수
***
#### 속성 project\_id
***
### 방법 `add_calls_to_annotation_queue`
```python theme={null}
add_calls_to_annotation_queue(
queue_id: 'str',
call_ids: 'list[str]',
display_fields: 'list[str]'
) → AnnotationQueueAddCallsRes
```
annotation 큐에 Call을 추가합니다.
**인수:**
***
### 방법 `add_cost`
```python theme={null}
add_cost(
llm_id: 'str',
prompt_token_cost: 'float',
completion_token_cost: 'float',
effective_date: 'datetime | None' = None,
prompt_token_cost_unit: 'str | None' = 'USD',
completion_token_cost_unit: 'str | None' = 'USD',
provider_id: 'str | None' = 'default'
) → CostCreateRes
```
현재 프로젝트에 비용을 추가합니다.
* `queue_id`: annotation 큐의 ID입니다.
* `call_ids`: 큐에 추가할 Call ID입니다.
* `display_fields`: 검토자에게 보여줄 JSON 경로입니다. 예: `inputs.prompt` 또는 `output.text`.
**예시:**
```python theme={null}
client.add_cost(llm_id="my_expensive_custom_model", prompt_token_cost=1, completion_token_cost=2)
client.add_cost(llm_id="my_expensive_custom_model", prompt_token_cost=500, completion_token_cost=1000, effective_date=datetime(1998, 10, 3))
```
**인수:**
* `llm_id`: LLM의 ID입니다. 예: "gpt-4o-mini-2024-07-18"
* `prompt_token_cost`: 프롬프트 토큰당 비용입니다. 예: .0005
* `completion_token_cost`: completion 토큰당 비용입니다. 예: .0015
* `effective_date`: 기본값은 현재 날짜입니다. `datetime.datetime` 객체입니다.
* `provider_id`: LLM 제공자입니다. 기본값은 "default"입니다. 예: "openai"
* `prompt_token_cost_unit`: 프롬프트 토큰 비용의 단위입니다. 기본값은 "USD"입니다. (현재는 사용되지 않지만, 향후 비용의 통화 유형(예: "tokens" 또는 "time")을 지정하는 데 사용될 예정입니다.)
* `completion_token_cost_unit`: completion 토큰 비용의 단위입니다. 기본값은 "USD"입니다. (현재는 사용되지 않지만, 향후 비용의 통화 유형(예: "tokens" 또는 "time")을 지정하는 데 사용될 예정입니다.)
**반환값:**
CostCreateRes 객체입니다. `ids`라는 튜플 목록 필드가 하나 있으며, 각 튜플에는 `llm_id`와 생성된 비용 객체의 ID가 포함됩니다.
***
### 방법 `add_tags`
```python theme={null}
add_tags(obj_ref: 'ObjectRef | str', tags: 'list[str]') → None
```
객체 버전에 태그를 추가합니다.
**인수:**
***
### 방법 `clear_wandb_run_context`
```python theme={null}
clear_wandb_run_context() → None
```
wandb run 컨텍스트 재정의를 초기화합니다.
이 작업을 호출한 후에는 Call이 run\_id 및 step 정보에 대해 전역 wandb.run(사용 가능한 경우)으로 대체됩니다.
* `obj_ref`: 객체 버전에 대한 레퍼런스이며, ObjectRef 또는 weave /// URI 문자열입니다.
* `tags`: 추가할 태그 문자열 목록입니다.
**예시:**
```python theme={null}
client = weave.init("my-project")
client.set_wandb_run_context(run_id="my-run-id", step=5)
# ... 일부 Call 수행 ...
client.clear_wandb_run_context()
# 이제 Call이 전역 wandb.run을 다시 사용합니다
```
***
### 방법 `create_annotation_queue`
```python theme={null}
create_annotation_queue(
name: 'str',
scorer_refs: 'list[str]',
description: 'str' = ''
) → str
```
이 프로젝트의 annotation 큐를 생성합니다.
**인수:**
* `name`: 큐의 표시 이름입니다.
* `scorer_refs`: 검토자가 작성하는 Scorer/annotation 필드의 Weave ref입니다.
* `description`: 선택 사항인 검토자 가이드라인 또는 큐 설명입니다.
**반환값:**
생성된 annotation 큐의 ID입니다.
***
### 방법 `create_call`
```python theme={null}
create_call(
op: 'str | Op',
inputs: 'dict[str, Any]',
parent: 'Call | None' = None,
attributes: 'dict[str, Any] | None' = None,
display_name: 'str | Callable[[Call], str] | None' = None,
use_stack: 'bool' = True,
_call_id_override: 'str | None' = None,
started_at: 'datetime | None' = None
) → Call
```
Call을 생성하고 기록한 뒤 런타임 스택에 푸시합니다.
**인수:**
* `op`: Call을 생성하는 오퍼레이션 또는 익명 오퍼레이션의 이름입니다.
* `inputs`: 오퍼레이션의 입력값입니다.
* `parent`: 부모 Call입니다. `parent`가 제공되지 않으면 현재 run이 부모로 사용됩니다.
* `display_name`: Call의 표시 이름입니다. 기본값은 None입니다.
* `attributes`: Call의 속성입니다. 기본값은 None입니다.
* `use_stack`: Call을 런타임 스택에 푸시할지 여부입니다. 기본값은 True입니다.
* `started_at`: Call 시작 시간을 재정의합니다. None이면 현재 시간을 사용합니다.
**반환값:**
생성된 Call 객체입니다.
***
### 방법 `delete_all_object_versions`
```python theme={null}
delete_all_object_versions(object_name: 'str') → int
```
객체의 모든 버전을 삭제합니다.
**인수:**
* `object_name`: 삭제할 버전이 속한 객체의 이름입니다.
**반환값:**
삭제된 버전의 수입니다.
***
### 방법 `delete_all_op_versions`
```python theme={null}
delete_all_op_versions(op_name: 'str') → int
```
op의 모든 버전을 삭제합니다.
**인수:**
* `op_name`: 버전을 삭제할 op의 이름입니다.
**반환값:**
삭제된 버전의 개수입니다.
***
### 방법 `delete_annotation_queue`
```python theme={null}
delete_annotation_queue(queue_id: 'str') → AnnotationQueueSchema
```
annotation 큐를 소프트 삭제합니다.
***
### 방법 `delete_call`
```python theme={null}
delete_call(call: 'Call') → None
```
***
### 방법 `delete_calls`
```python theme={null}
delete_calls(call_ids: 'list[str]') → None
```
ID에 해당하는 Calls를 삭제합니다.
Call을 삭제하면 해당 Call의 모든 하위 Call도 함께 삭제됩니다.
**인수:**
***
### 방법 `delete_object_version`
```python theme={null}
delete_object_version(object: 'ObjectRef') → None
```
***
### 방법 `delete_object_versions`
```python theme={null}
delete_object_versions(object_name: 'str', digests: 'list[str]') → int
```
객체의 특정 버전을 삭제합니다.
* `call_ids`: 삭제할 call ID 목록입니다. 예: \["2F0193e107-8fcf-7630-b576-977cc3062e2e"]
**인수:**
* `object_name`: 버전을 삭제할 객체 이름입니다.
* `digests`: 삭제할 다이제스트 목록입니다. "latest" 또는 "v0" 같은 별칭을 포함할 수 있습니다.
**반환값:**
삭제된 버전의 수입니다.
***
### 방법 `delete_op_version`
```python theme={null}
delete_op_version(op: 'OpRef') → None
```
***
### 방법 `fail_call`
```python theme={null}
fail_call(call: 'Call', exception: 'BaseException') → None
```
예외를 사용해 Call을 실패 처리합니다. 이는 finish\_call을 간편하게 사용하기 위한 편의 방법입니다.
***
### 방법 `finish`
```python theme={null}
finish(
use_progress_bar: 'bool' = True,
callback: 'Callable[[FlushStatus], None] | None' = None
) → None
```
모든 백그라운드 작업을 플러시해 처리되도록 합니다.
이 메서드는 현재 큐에 들어 있는 모든 작업이 처리될 때까지 대기하며, 대기 중인 작업의 상태를 보여 주는 진행률 표시줄을 표시합니다. 또한 메인 스레드가 실행되는 동안에도 병렬 처리가 이루어지도록 하며, 데이터가 서버에 업로드되기 전에 사용자 코드가 완료되는 경우 성능이 향상될 수 있습니다.
**인수:**
***
### 방법 `finish_call`
```python theme={null}
finish_call(
call: 'Call',
output: 'Any' = None,
exception: 'BaseException | None' = None,
op: 'Op | None' = None,
ended_at: 'datetime | None' = None
) → None
```
Call을 완료하고 결과를 저장합니다.
`Call.summary`에 있는 값은 데이터베이스에 기록되기 전에 계산된 summary 통계(예: 사용량 및 상태 개수)와 깊게 병합됩니다.
***
### 방법 `flush`
```python theme={null}
flush() → None
```
백그라운드 비동기 작업을 플러시합니다. 여러 번 호출해도 안전합니다.
***
### 방법 `get`
```python theme={null}
get(ref: 'ObjectRef', objectify: 'bool' = True) → Any
```
***
### 방법 `get_agent_custom_attributes`
```python theme={null}
get_agent_custom_attributes(
query: 'Query | None' = None,
started_after: 'datetime | None' = None,
started_before: 'datetime | None' = None,
limit: 'int' = 200,
offset: 'int' = 0
) → AgentCustomAttrsSchemaRes
```
일치하는 에이전트 span에서 유형 지정된 맞춤형 속성 키를 찾습니다.
필터/열 선택기를 채우는 데 유용합니다. 선택한 span에서 확인된 맞춤형 속성 키(및 해당 값 유형)를 반환합니다.
* `use_progress_bar`: flush 중 진행률 표시줄을 표시할지 여부입니다. 진행률 표시줄이 제대로 렌더링되지 않는 환경(예: CI 환경)에서는 False로 설정하세요.
* `callback`: 상태 업데이트를 받는 선택적 콜백 함수입니다. `use_progress_bar` 설정보다 우선합니다.
**인수:**
* `query`: span을 제한하기 위한 Mongo 스타일 필터 표현식입니다.
* `started_after`: 이 시각 이후 또는 이 시각에 시작된 span만 고려합니다.
* `started_before`: 이 시각 이전에 시작된 span만 고려합니다.
* `limit`: 반환할 속성 키의 최대 개수입니다.
* `offset`: 건너뛸 키 수입니다(페이지 매김용).
**반환값:**
`attributes` 및 `has_more`를 포함하는 `AgentCustomAttrsSchemaRes`입니다.
**예시:**
```python theme={null}
client = weave.init("entity/project")
resp = client.get_agent_custom_attributes()
for attr in resp.attributes:
print(attr.key, attr.value_type, attr.span_count)
```
***
### 방법 `get_agent_span_stats`
```python theme={null}
get_agent_span_stats(
start: 'datetime',
metrics: 'list[AgentSpanStatsMetricSpec]',
end: 'datetime | None' = None,
query: 'Query | None' = None,
group_by: 'list[AgentGroupByRef] | None' = None,
granularity: 'int | None' = None,
timezone: 'str' = 'UTC'
) → AgentSpanStatsRes
```
에이전트 span에 대해 차트에 바로 사용할 수 있는 집계를 계산합니다.
일반적인 시계열 / 그룹화된 메트릭 사용 사례를 다룹니다. 숫자 버킷 통계나 기타 고급 옵션이 필요한 경우 `server.agent_spans_stats`를 직접 호출하세요.
**인수:**
* `start`: 시간 범위의 시작(포함)입니다.
* `metrics`: 집계할 하나 이상의 메트릭입니다(예: token 합계).
* `end`: 시간 범위의 끝입니다. 생략하면 현재 시각이 기본값으로 사용됩니다.
* `query`: span을 제한하는 Mongo 스타일 필터 표현식입니다.
* `group_by`: 집계를 그룹화할 span 필드입니다.
* `granularity`: 시계열 통계를 위한 초 단위 시간 버킷 폭입니다.
* `timezone`: 시간 버킷을 정렬하는 데 사용하는 IANA 표준 시간대입니다.
**반환값:**
`columns`와 `rows`를 포함하는 `AgentSpanStatsRes`입니다.
**예시:**
```python theme={null}
client = weave.init("entity/project")
resp = client.get_agent_span_stats(start=start, metrics=metrics)
for row in resp.rows:
print(row)
```
***
### 방법 `get_agent_spans`
```python theme={null}
get_agent_spans(
agent_name: 'str | None' = None,
query: 'Query | None' = None,
sort_by: 'list[AgentSortBy] | None' = None,
limit: 'int | None' = None,
offset: 'int | None' = None,
page_size: 'int' = 100
) → AgentSpansIter
```
이 프로젝트의 에이전트 span을 조회하며, 필요에 따라 필터링할 수 있습니다.
소비하는 동안 페이지를 가져오는(`get_calls`와 같은) `PaginatedIterator`를 반환하며, `len(...)`은 전체 span 개수를 나타냅니다.
**인수:**
* `agent_name`: 설정하면 결과를 해당 에이전트로 제한합니다(`agent_name` 필드에 대한 `query`의 편의 단축 구문).
* `query`: Mongo 스타일 필터 표현식입니다. 둘 다 제공되면 `agent_name`과 `$and`로 결합됩니다.
* `sort_by`: 결과를 정렬할 필드입니다.
* `limit`: 반환할 span의 최대 개수입니다. `None`이면 모두 반환합니다.
* `offset`: span을 반환하기 전에 건너뛸 span 수입니다(페이지 매김용).
* `page_size`: 요청당 가져오는 span 수입니다.
**반환값:**
`AgentSpanSchema`에 대한 `PaginatedIterator`입니다.
**예시:**
```python theme={null}
client = weave.init("entity/project")
for span in client.get_agent_spans(agent_name="my-agent"):
print(span.span_id, span.span_name, span.input_tokens)
```
***
### 방법 `get_agent_turn`
```python theme={null}
get_agent_turn(
trace_id: 'str',
include_feedback: 'bool' = False
) → AgentTraceChatRes
```
단일 턴에 대한 구조화된 chat 뷰(메시지)를 조회합니다.
하나의 턴은 하나의 트레이스에 해당합니다.
**인수:**
* `trace_id`: chat 뷰를 가져올 트레이스입니다.
* `include_feedback`: true이면 메시지에 대한 feedback을 포함합니다.
**반환값:**
턴의 `messages`가 순서대로 포함된 `AgentTraceChatRes`를 반환합니다.
**예시:**
```python theme={null}
client = weave.init("entity/project")
resp = client.get_agent_turn(trace_id="...", include_feedback=True)
for message in resp.messages:
print(message.type)
```
***
### 방법 `get_agent_turns`
```python theme={null}
get_agent_turns(
conversation_id: 'str',
limit: 'int' = 50,
offset: 'int' = 0,
include_feedback: 'bool' = False
) → AgentConversationChatRes
```
대화의 multi-turn chat 뷰를 조회합니다.
각 턴은 하나의 트레이스에 해당합니다.
**인수:**
* `conversation_id`: 턴을 가져올 대화입니다.
* `limit`: 반환할 최대 턴 수입니다.
* `offset`: 건너뛸 최신 턴 수입니다(페이지 매김용).
* `include_feedback`: true이면 메시지의 피드백을 포함합니다.
**반환값:**
순서대로 정렬된 `turns`를 포함하는 `AgentConversationChatRes`입니다.
**예시:**
```python theme={null}
client = weave.init("entity/project")
resp = client.get_agent_turns(conversation_id="...", limit=20)
for turn in resp.turns:
for message in turn.messages:
print(message.type)
```
***
### 방법 `get_agent_versions`
```python theme={null}
get_agent_versions(
agent_name: 'str',
sort_by: 'list[AgentSortBy] | None' = None,
limit: 'int | None' = None,
offset: 'int | None' = None,
page_size: 'int' = 100
) → AgentVersionsIter
```
단일 에이전트의 버전을 집계 통계와 함께 나열합니다.
소비하는 동안 페이지를 가져오는(`get_calls`와 같은) `PaginatedIterator`를 반환하며, `len(...)`은 전체 버전 수를 나타냅니다.
**인수:**
* `agent_name`: 버전을 나열할 에이전트입니다.
* `sort_by`: 결과를 정렬할 필드입니다.
* `limit`: 반환할 최대 버전 수입니다. `None`이면 모두 반환합니다.
* `offset`: 반환하기 전에 건너뛸 버전 수입니다(페이지 매김용).
* `page_size`: 요청당 가져오는 버전 수입니다.
**반환값:**
`AgentVersionSchema`에 대한 `PaginatedIterator`입니다.
**예시:**
```python theme={null}
client = weave.init("entity/project")
for version in client.get_agent_versions(agent_name="my-agent"):
print(version.agent_version, version.total_input_tokens)
```
***
### 방법 `get_agents`
```python theme={null}
get_agents(
agent_name: 'str | None' = None,
sort_by: 'list[AgentSortBy] | None' = None,
limit: 'int | None' = None,
offset: 'int | None' = None,
page_size: 'int' = 100
) → AgentsIter
```
이 프로젝트의 에이전트 목록과 집계 통계를 조회합니다.
순회하는 동안 페이지를 자동으로 가져오는 `PaginatedIterator`(`get_calls`와 유사)를 반환합니다. `len(...)`은 전체 에이전트 수를 나타내며, 인덱싱/슬라이싱도 지원합니다.
**인수:**
* `agent_name`: 설정하면 결과를 해당 에이전트로 제한합니다.
* `sort_by`: 결과를 정렬할 필드입니다.
* `limit`: 반환할 최대 에이전트 수입니다. `None`이면 전체를 반환합니다.
* `offset`: 반환 전에 건너뛸 에이전트 수입니다(페이지 매김용).
* `page_size`: 요청당 가져오는 에이전트 수입니다.
**반환값:**
`AgentSchema`에 대한 `PaginatedIterator`입니다.
**예시:**
```python theme={null}
client = weave.init("entity/project")
for agent in client.get_agents(limit=20):
print(agent.agent_name, agent.total_input_tokens)
```
***
### 방법 `get_aliases`
```python theme={null}
get_aliases(obj_ref: 'ObjectRef | str') → list[str]
```
객체 버전의 별칭을 조회합니다.
**인수:**
* `obj_ref`: 객체 버전에 대한 레퍼런스이며, `ObjectRef` 또는 weave /// URI 문자열입니다.
**반환값:**
별칭 문자열 목록입니다. 객체 버전이 최신 버전이면 가상 "latest" 별칭이 포함됩니다.
***
### 방법 `get_annotation_queue`
```python theme={null}
get_annotation_queue(queue_id: 'str') → AnnotationQueueSchema
```
ID로 어노테이션 큐 하나를 조회합니다.
***
### 방법 `get_annotation_queue_stats`
```python theme={null}
get_annotation_queue_stats(
queue_ids: 'list[str]'
) → list[AnnotationQueueStatsSchema]
```
어노테이션 큐 항목의 완료 통계를 조회합니다.
***
### 방법 `get_call`
```python theme={null}
get_call(
call_id: 'str',
include_costs: 'bool' = False,
include_feedback: 'bool' = False,
columns: 'list[str] | None' = None
) → WeaveObject
```
ID로 단일 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`
```python theme={null}
get_calls(
filter: 'CallsFilterLike | None' = None,
limit: 'int | None' = None,
offset: 'int | None' = None,
sort_by: 'list[SortByLike] | None' = None,
query: 'QueryLike | None' = None,
include_costs: 'bool' = False,
include_feedback: 'bool' = False,
include_storage_size: 'bool' = False,
include_total_storage_size: 'bool' = False,
include_usernames: 'bool' = False,
columns: 'list[str] | None' = None,
expand_columns: 'list[str] | None' = None,
return_expanded_column_values: 'bool' = True,
scored_by: 'str | list[str] | None' = None,
page_size: 'int' = 1000
) → CallsIter
```
이 프로젝트의 트레이스된 Call(오퍼레이션) 목록을 조회합니다.
이 메서드는 트레이스 데이터 쿼리를 위한 강력하고 유연한 인터페이스를 제공합니다. 페이지 매김, 필터링, 정렬, 필드 프로젝션, 스코어링 메타데이터를 지원하며, 맞춤형 트레이스 UI나 분석 도구를 구현하는 데 사용할 수 있습니다.
성능 팁: 결과 크기를 줄이려면 `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`에 token/비용 정보를 포함합니다.
* `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()`를 지원합니다.
**예시:**
```python theme={null}
calls = client.get_calls(
filter=CallsFilter(op_names=["my_op"]),
columns=["inputs", "output", "summary"],
limit=100,
)
for call in calls:
print(call.inputs, call.output)
```
***
### 방법 `get_evaluation`
```python theme={null}
get_evaluation(uri: 'str') → Evaluation
```
URI로 특정 Evaluation 객체를 조회합니다.
Evaluation URI는 일반적으로 다음 형식을 따릅니다: `weave:///entity/project/object/Evaluation:version`
"알기 쉬운" 이름으로도 evaluation을 조회할 수 있습니다: get\_evaluation("Evaluation:v1")
**인수:**
* `uri` (str): 조회할 evaluation의 고유 리소스 식별자입니다.
**반환값:**
* `Evaluation`: 지정한 URI에 해당하는 Evaluation 객체입니다.
**예외:**
* `TypeError`: 해당 URI의 객체가 Evaluation 인스턴스가 아닌 경우입니다.
* `ValueError`: URI가 올바르지 않거나 객체를 찾을 수 없는 경우입니다.
**예시:**
```python theme={null}
client = weave.init("my-project")
evaluation = client.get_evaluation("weave:///entity/project/object/my-eval:v1")
print(evaluation.name)
```
***
### 방법 `get_evaluations`
```python theme={null}
get_evaluations() → list[Evaluation]
```
현재 프로젝트의 모든 Evaluation 객체를 조회합니다.
**반환값:**
* `list[Evaluation]`: 현재 프로젝트에 있는 모든 Evaluation 객체의 목록입니다. evaluations를 찾지 못했거나 모든 변환이 실패한 경우에는 빈 목록이 반환됩니다.
**예시:**
```python theme={null}
client = weave.init("my-project")
evaluations = client.get_evaluations()
print(f"Found {len(evaluations)} evaluations")
for eval in evaluations:
print(f"Evaluation: {eval.name}")
```
***
### 방법 `get_feedback`
```python theme={null}
get_feedback(
query: 'Query | str | None' = None,
reaction: 'str | None' = None,
offset: 'int' = 0,
limit: 'int' = 100
) → FeedbackQuery
```
프로젝트의 피드백을 쿼리합니다.
**예시:**
```python theme={null}
# 특정 피드백 객체를 가져옵니다.
# 이 경우에도 컬렉션이 반환되며, 항목이 0개 또는 1개 포함될 것으로 예상됩니다.
client.get_feedback("1B4082A3-4EDA-4BEB-BFEB-2D16ED59AA07")
# 특정 반응이 있는 모든 피드백 객체를 찾습니다.
client.get_feedback(reaction="👍", limit=10)
# Mongo 스타일 쿼리를 사용하여 특정 피드백 유형의
# 모든 피드백 객체를 찾습니다.
from weave.trace_server.interface.query import Query
query = Query(
**{
"$expr": {
"$eq": [
{"$getField": "feedback_type"},
{"$literal": "wandb.reaction.1"},
],
}
}
)
client.get_feedback(query=query)
```
**인수:**
* `query`: Mongo 스타일의 쿼리 표현식입니다. 편의를 위해 피드백 UUID 문자열도 사용할 수 있습니다.
* `reaction`: 편의를 위해 특정 반응 이모지로 필터링합니다.
* `offset`: 피드백 객체를 가져오기 시작할 오프셋입니다.
* `limit`: 가져올 피드백 객체의 최대 개수입니다.
**반환값:**
FeedbackQuery 객체입니다.
***
### 방법 `get_tags`
```python theme={null}
get_tags(obj_ref: 'ObjectRef | str') → list[str]
```
객체 버전의 태그를 조회합니다.
**인수:**
* `obj_ref`: 객체 버전을 가리키는 레퍼런스로, ObjectRef 또는 weave /// URI 문자열입니다.
**반환값:**
태그 문자열 목록입니다. 객체 버전에 태그가 없으면 빈 목록을 반환합니다.
***
### 방법 `get_tags_and_aliases`
```python theme={null}
get_tags_and_aliases(obj_ref: 'ObjectRef | str') → tuple[list[str], list[str]]
```
단일 Call로 객체 버전의 태그와 별칭를 모두 조회합니다.
**인수:**
* `obj_ref`: `ObjectRef` 또는 `weave /// URI` 문자열로 지정한 객체 버전의 레퍼런스입니다.
**반환값:**
`(태그, 별칭)` 튜플입니다. 각 항목은 문자열 목록입니다. 객체 버전에 태그 또는 별칭가 없으면 빈 목록을 반환합니다.
***
### 방법 `link_prompt_to_registry`
```python theme={null}
link_prompt_to_registry(
prompt: 'LinkablePrompt',
target_path: 'str',
aliases: 'Sequence[str] | None' = None
) → LinkAssetToRegistryRes
```
게시된 프롬프트 버전을 레지스트리에 연결합니다.
**인수:**
* `prompt`: 게시된 프롬프트, `ObjectRef`, 또는 전체 경로가 지정된 Weave `///...` URI string입니다.
* `target_path`: `/` 형식의 레지스트리 대상 경로입니다. 예: `wandb-registry-prompts/my-prompt-collection`.
* `aliases`: 생성된 레지스트리 버전에 추가할 선택 사항인 별칭입니다.
**반환값:**
* `LinkAssetToRegistryRes`: registry-link 엔드포인트에서 파싱된 응답입니다.
***
### 방법 `list_aliases`
```python theme={null}
list_aliases() → list[str]
```
프로젝트의 모든 고유한 별칭를 나열합니다.
**반환값:**
프로젝트의 모든 별칭 문자열 목록입니다.
***
### 방법 `list_annotation_queue_items`
```python theme={null}
list_annotation_queue_items(
queue_id: 'str',
filter: 'AnnotationQueueItemsFilter | None' = None,
sort_by: 'list[SortBy] | None' = None,
limit: 'int | None' = None,
offset: 'int | None' = None,
include_position: 'bool' = False
) → list[AnnotationQueueItemSchema]
```
어노테이션 큐에 부여된 Call을 목록으로 반환합니다.
***
### 방법 `list_annotation_queues`
```python theme={null}
list_annotation_queues(
name: 'str | None' = None,
sort_by: 'list[SortBy] | None' = None,
limit: 'int | None' = None,
offset: 'int | None' = None
) → list[AnnotationQueueSchema]
```
이 프로젝트의 어노테이션 큐 목록을 나열합니다.
***
### 방법 `list_tags`
```python theme={null}
list_tags() → list[str]
```
프로젝트의 모든 고유한 태그를 모두 나열합니다.
**반환값:**
프로젝트의 모든 태그 문자열 목록입니다.
***
### 방법 `purge_costs`
```python theme={null}
purge_costs(ids: 'list[str] | str') → None
```
현재 프로젝트의 비용을 삭제합니다.
**예시:**
```python theme={null}
client.purge_costs([ids])
client.purge_costs(ids)
```
**인수:**
***
### 방법 `query_costs`
```python theme={null}
query_costs(
query: 'Query | str | None' = None,
llm_ids: 'list[str] | None' = None,
offset: 'int' = 0,
limit: 'int' = 100
) → list[CostQueryOutput]
```
프로젝트의 비용을 쿼리합니다.
* `ids`: 제거할 비용 ID입니다. 단일 ID 또는 ID 목록일 수 있습니다.
**예시:**
```python theme={null}
# 특정 cost 객체를 가져옵니다.
# 이 경우에도 컬렉션이 반환되며, 항목이 0개 또는 1개 포함될 것으로 예상됩니다.
client.query_costs("1B4082A3-4EDA-4BEB-BFEB-2D16ED59AA07")
# 특정 반응을 가진 모든 cost 객체를 찾습니다.
client.query_costs(llm_ids=["gpt-4o-mini-2024-07-18"], limit=10)
```
**인수:**
* `query`: Mongo 스타일 쿼리 표현식입니다. 편의를 위해 cost UUID 문자열도 받을 수 있습니다.
* `llm_ids`: 편의를 위해 llm\_ids 집합을 기준으로 필터링합니다.
* `offset`: cost 객체를 가져오기 시작할 오프셋입니다.
* `limit`: 가져올 cost 객체의 최대 개수입니다.
**반환값:**
CostQuery 객체입니다.
***
### 방법 `remove_aliases`
```python theme={null}
remove_aliases(obj_ref: 'ObjectRef | str', alias: 'str | list[str]') → None
```
객체에서 하나 이상의 별칭를 제거합니다.
**인수:**
***
### 방법 `remove_tags`
```python theme={null}
remove_tags(obj_ref: 'ObjectRef | str', tags: 'list[str]') → None
```
객체 버전에서 태그를 제거합니다.
* `obj_ref`: 객체를 가리키는 레퍼런스입니다. ObjectRef 또는 weave /// URI 문자열일 수 있습니다(별칭은 객체 범위에 한정되므로 digest는 사용하지 않음).
* `alias`: 제거할 별칭 이름 또는 별칭 이름 목록입니다.
**인수:**
***
### 방법 `save`
```python theme={null}
save(val: 'Any', name: 'str', branch: 'str' = 'latest') → Any
```
직접 호출하지 말고 `weave.publish()`를 대신 사용하세요.
* `obj_ref`: 객체 버전에 대한 레퍼런스입니다. ObjectRef 또는 weave /// URI 문자열일 수 있습니다.
* `tags`: 제거할 태그 문자열 목록입니다.
**인수:**
* `val`: 저장할 객체입니다.
* `name`: 객체를 저장할 때 사용할 이름입니다.
* `branch`: 객체를 저장할 브랜치입니다. 기본값은 "latest"입니다.
**반환값:**
저장된 객체를 역직렬화한 결과입니다.
***
### 방법 `search_agents`
```python theme={null}
search_agents(
query: 'str' = '',
agent_name: 'str | None' = None,
conversation_id: 'str | None' = None,
trace_id: 'str | None' = None,
limit: 'int' = 20,
offset: 'int' = 0
) → AgentSearchRes
```
대화별로 묶어 내용 기준으로 에이전트 메시지를 검색합니다.
메시지 내용(및/또는 아래의 구조화된 필터)을 검색하여, 일치하는 메시지가 포함된 대화를 반환합니다. `query`가 비어 있으면 필터에 대한 구조화된 검색으로 처리됩니다.
**인수:**
* `query`: 메시지 내용에서 일치할 부분 문자열입니다. 비어 있으면 모두 일치합니다.
* `agent_name`: 이 에이전트의 메시지로 제한합니다.
* `conversation_id`: 특정 대화 하나로 제한합니다.
* `trace_id`: 특정 트레이스 하나로 제한합니다.
* `limit`: 고려할 일치 메시지의 최대 개수입니다.
* `offset`: 건너뛸 일치 항목 수입니다(페이지 매김용).
**반환값:**
`results`(일치하는 대화)를 포함하는 `AgentSearchRes`입니다.
**예시:**
```python theme={null}
client = weave.init("entity/project")
resp = client.search_agents(query="timeout", agent_name="my-agent")
for conversation in resp.results:
print(conversation.conversation_id, conversation.matched_messages)
```
***
### 방법 `set_aliases`
```python theme={null}
set_aliases(obj_ref: 'ObjectRef | str', alias: 'str | list[str]') → None
```
객체 버전에 하나 이상의 별칭를 설정합니다.
**인수:**
***
### 방법 `set_wandb_run_context`
```python theme={null}
set_wandb_run_context(run_id: 'str', step: 'int | None' = None) → None
```
이 클라이언트가 생성한 Call에 대해 wandb run\_id와 step을 재정의합니다.
이렇게 하면 전역 wandb.run 심볼에 바인딩되지 않은 특정 WandB run에 Weave Call을 연결할 수 있습니다.
* `obj_ref`: 객체 버전에 대한 레퍼런스이며, ObjectRef 또는 weave /// URI 문자열입니다.
* `alias`: 설정할 별칭 이름 또는 별칭 이름 목록입니다(예: "프로덕션").
**인수:**
* `run_id`: run ID입니다(entity/프로젝트 접두사 제외). 클라이언트가 entity/프로젝트 접두사를 자동으로 추가합니다.
* `step`: Call에 사용할 step 번호입니다. None이면 step은 설정되지 않습니다.
**예시:**
```python theme={null}
client = weave.init("my-project")
client.set_wandb_run_context(run_id="my-run-id", step=5)
# 이제 모든 Call이 step 5에서 entity/project/my-run-id와 연결됩니다
# 또는 step 없이
client.set_wandb_run_context(run_id="my-run-id")
# Call이 step 없이 entity/project/my-run-id와 연결됩니다
```
***
### 방법 `update_annotation_queue`
```python theme={null}
update_annotation_queue(
queue_id: 'str',
name: 'str | None' = None,
description: 'str | None' = None,
scorer_refs: 'list[str] | None' = None
) → AnnotationQueueSchema
```
어노테이션 큐 메타데이터를 업데이트합니다.
***
### 함수 `get_obj_name`
```python theme={null}
get_obj_name(val: 'Any') → str
```
***
### 함수 `get_parallelism_settings`
```python theme={null}
get_parallelism_settings() → tuple[int | None, int | None]
```
***
### 함수 `map_to_refs`
```python theme={null}
map_to_refs(obj: 'Any') → Any
```
***
### 함수 `print_call_link`
```python theme={null}
print_call_link(call: 'Call') → None
```
***
### 함수 `redact_sensitive_keys`
```python theme={null}
redact_sensitive_keys(obj: 'Any') → Any
```
***
### 함수 `sanitize_object_name`
```python theme={null}
sanitize_object_name(name: 'str') → str
```