> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coreweave.com/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}) =>
Source
;
API の概要
***
クラス `CrossProjectRefError`
クライアント側のダイジェスト計算が、内部 ID に解決できない異なる project への ref に遭遇したときに発生します。
***
クラス `FlushStatus`
現在のフラッシュ操作に関するステータス情報です。
***
クラス `NoInternalProjectIDError`
内部 project ID がまだ取得できておらず、クライアント側でダイジェストの計算を続行できない場合に発生します。
***
クラス `PendingJobCounts`
タイプごとの保留中のジョブ数です。
***
クラス `WeaveClient`
メソッド `__init__`
```python theme={"system"}
__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
すべてのエグゼキューターとサーバーにおける保留中のジョブの総数を返します。
このプロパティを使用すると、メインスレッドをブロックすることなくバックグラウンドタスクの進行状況を確認できます。
**戻り値:**
* `int`: 保留中のジョブの総数
***
プロパティ project\_id
***
メソッド `add_calls_to_annotation_queue`
```python theme={"system"}
add_calls_to_annotation_queue(
queue_id: 'str',
call_ids: 'list[str]',
display_fields: 'list[str]'
) → AnnotationQueueAddCallsRes
```
アノテーションキューに Call を追加します。
**引数:**
***
メソッド `add_cost`
```python theme={"system"}
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
```
現在の project にコストを追加します。
* `queue_id`: アノテーションキュー ID。
* `call_ids`: キューに追加する Call ID。
* `display_fields`: レビュー担当者に表示する JSON パス (例: `inputs.prompt`、`output.text`) 。
**サンプル:**
```python theme={"system"}
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`: 補完トークンあたりのコスト。例: .0015
* `effective_date`: デフォルトは現在の日付です。datetime.datetime オブジェクトです。
* `provider_id`: LLM のプロバイダー。デフォルトは "default" です。例: "openai"
* `prompt_token_cost_unit`: プロンプトトークンのコストの単位。デフォルトは "USD" です。(現在は未使用ですが、将来的にはコストの通貨タイプを指定するために使用される予定です。例: "tokens" または "time")
* `completion_token_cost_unit`: 補完トークンのコストの単位。デフォルトは "USD" です。(現在は未使用ですが、将来的にはコストの通貨タイプを指定するために使用される予定です。例: "tokens" または "time")
**戻り値:**
CostCreateRes オブジェクト。ids というタプルのリストを格納するフィールドを 1 つ持ちます。各タプルには llm\_id と、作成されたコストオブジェクトの ID が含まれます。
***
```python theme={"system"}
add_tags(obj_ref: 'ObjectRef | str', tags: 'list[str]') → None
```
オブジェクトのバージョンにタグを追加します。
**引数:**
***
メソッド `clear_wandb_run_context`
```python theme={"system"}
clear_wandb_run_context() → None
```
wandb run コンテキストの上書きを解除します。
これを呼び出すと、Call は run\_id と step の情報にグローバルな wandb.run (利用可能な場合) を使用するようになります。
* `obj_ref`: オブジェクトのバージョンへの参照。ObjectRef または weave /// URI 文字列です。
* `tags`: 追加するタグの strings のリスト。
**サンプル:**
```python theme={"system"}
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={"system"}
create_annotation_queue(
name: 'str',
scorer_refs: 'list[str]',
description: 'str' = ''
) → str
```
この project にアノテーションキューを作成します。
**引数:**
* `name`: キューの表示名。
* `scorer_refs`: レビュー担当者が入力する Scorer/アノテーション フィールドの Weave ref。
* `description`: レビュー担当者向けのガイドラインまたはキューの説明 (オプション)。
**戻り値:**
作成されたアノテーションキューの ID。
***
メソッド `create_call`
```python theme={"system"}
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={"system"}
delete_all_object_versions(object_name: 'str') → int
```
オブジェクトのすべてのバージョンを削除します。
**引数:**
* `object_name`: バージョンを削除するオブジェクト名。
**戻り値:**
削除されたバージョンの数。
***
メソッド `delete_all_op_versions`
```python theme={"system"}
delete_all_op_versions(op_name: 'str') → int
```
op のすべてのバージョンを削除します。
**引数:**
* `op_name`: バージョンを削除する op 名。
**戻り値:**
削除されたバージョンの数。
***
メソッド `delete_annotation_queue`
```python theme={"system"}
delete_annotation_queue(queue_id: 'str') → AnnotationQueueSchema
```
アノテーションキューを論理削除します。
***
メソッド `delete_call`
```python theme={"system"}
delete_call(call: 'Call') → None
```
***
メソッド `delete_calls`
```python theme={"system"}
delete_calls(call_ids: 'list[str]') → None
```
ID を指定して Call を削除します。
Call を削除すると、そのすべての子 Call も削除されます。
**引数:**
***
メソッド `delete_object_version`
```python theme={"system"}
delete_object_version(object: 'ObjectRef') → None
```
***
メソッド `delete_object_versions`
```python theme={"system"}
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={"system"}
delete_op_version(op: 'OpRef') → None
```
***
メソッド `fail_call`
```python theme={"system"}
fail_call(call: 'Call', exception: 'BaseException') → None
```
例外で Call を失敗させます。これは finish\_call のための便利なメソッドです。
***
メソッド `finish`
```python theme={"system"}
finish(
use_progress_bar: 'bool' = True,
callback: 'Callable[[FlushStatus], None] | None' = None
) → None
```
すべてのバックグラウンドタスクをフラッシュし、確実に処理されるようにします。
このメソッドは、現在キューに追加されているすべてのジョブの処理が完了するまでブロックし、その間、保留中のタスクのステータスをプログレスバーで表示します。メインスレッドの実行中も並列処理が行われるため、データがサーバーにアップロードされる前にユーザーのコードが終了する場合に、パフォーマンスを向上させることができます。
**引数:**
***
メソッド `finish_call`
```python theme={"system"}
finish_call(
call: 'Call',
output: 'Any' = None,
exception: 'BaseException | None' = None,
op: 'Op | None' = None,
ended_at: 'datetime | None' = None
) → None
```
Call を終了し、その結果を永続化します。
`call.summary` に存在する値はすべて、データベースに書き込まれる前に、計算されたサマリー統計 (例: 使用量とステータスの件数) とディープマージされます。
***
メソッド `flush`
```python theme={"system"}
flush() → None
```
バックグラウンドの非同期タスクをフラッシュします。複数回呼び出しても安全です。
***
メソッド `get`
```python theme={"system"}
get(ref: 'ObjectRef', objectify: 'bool' = True) → Any
```
***
メソッド `get_agent_custom_attributes`
```python theme={"system"}
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
```
条件に一致するエージェント スパンから、タイプ付きのカスタム属性キーを検出します。
フィルターや列の選択肢を作成する際に便利です。選択したスパンで検出されたカスタム属性キー (およびその値のタイプ) を返します。
* `use_progress_bar`: フラッシュ中にプログレス バーを表示するかどうか。プログレス バーが適切にレンダリングされない環境 (CI 環境など) では False に設定します。
* `callback`: ステータスの更新を受け取るコールバック関数 (オプション)。use\_progress\_bar よりも優先されます。
**引数:**
* `query`: スパンを絞り込むための Mongo スタイルのフィルター式。
* `started_after`: この時刻以降に開始されたスパンのみを対象にします。
* `started_before`: この時刻より前に開始されたスパンのみを対象にします。
* `limit`: 返す属性キーの最大数。
* `offset`: スキップするキーの数 (ページネーション用)。
**戻り値:**
`attributes` と `has_more` を含む `AgentCustomAttrsSchemaRes`。
**例:**
```python theme={"system"}
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={"system"}
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
```
エージェント スパンに対して、チャートでそのまま使用できる集約を計算します。
一般的な時系列 / グループ化されたメトリクスのケースに対応します。数値バケットの統計やその他の詳細オプションが必要な場合は、`server.agent_spans_stats` を直接呼び出してください。
**引数:**
* `start`: 時間範囲の開始 (この値を含みます)。
* `metrics`: 集約する 1 つ以上のメトリクス (例: トークンの合計)。
* `end`: 時間範囲の終了。省略した場合は、デフォルトで現在時刻になります。
* `query`: スパンを絞り込むための Mongo スタイルのフィルター式。
* `group_by`: 集約のグループ化に使用するスパンのフィールド。
* `granularity`: 時系列の統計に使用する時間バケットの幅 (秒単位)。
* `timezone`: 時間バケットの境界を揃えるために使用する IANA タイムゾーン。
**戻り値:**
`columns` と `rows` を含む `AgentSpanStatsRes`。
**例:**
```python theme={"system"}
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={"system"}
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
```
この project のエージェント スパンをクエリします。必要に応じてフィルターを適用できます。
`PaginatedIterator` を返します (`get_calls` と同様) 。このイテレーターは、消費に応じてページを順次取得します。`len(...)` はスパンの総数を返します。
**引数:**
* `agent_name`: 設定すると、結果をこのエージェントに限定します (`agent_name` フィールドに対する `query` の便利なショートカットです) 。
* `query`: Mongo スタイルのフィルター式。両方が指定された場合は、`$and` によって `agent_name` と結合されます。
* `sort_by`: 結果の並べ替えに使用するフィールド。
* `limit`: 返すスパンの最大数。`None` の場合はすべて返します。
* `offset`: 返す前にスキップするスパンの数 (ページネーション用) 。
* `page_size`: 1 回のリクエストで取得するスパンの数。
**戻り値:**
`AgentSpanSchema` を要素とする `PaginatedIterator`。
**例:**
```python theme={"system"}
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={"system"}
get_agent_turn(
trace_id: 'str',
include_feedback: 'bool' = False
) → AgentTraceChatRes
```
単一のターンについて、構造化されたチャットビュー (メッセージ) を取得します。
1 つのターンは 1 つのトレースに対応します。
**引数:**
* `trace_id`: チャットビューを取得するトレース。
* `include_feedback`: true の場合、メッセージに対するフィードバックを含めます。
**戻り値:**
ターンの `messages` を順序どおりに含む `AgentTraceChatRes`。
**例:**
```python theme={"system"}
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={"system"}
get_agent_turns(
conversation_id: 'str',
limit: 'int' = 50,
offset: 'int' = 0,
include_feedback: 'bool' = False
) → AgentConversationChatRes
```
会話のマルチターン チャットビューを取得します。
各ターンは1つのトレースに対応します。
**引数:**
* `conversation_id`: ターンを取得する対象の会話。
* `limit`: 返すターンの最大数。
* `offset`: スキップする最新ターンの数 (ページネーション用) 。
* `include_feedback`: true の場合、メッセージに対するフィードバックを含めます。
**戻り値:**
順序付けられた `turns` を含む `AgentConversationChatRes`。
**例:**
```python theme={"system"}
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={"system"}
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
```
単一のエージェントのバージョンを、集計統計とともに一覧表示します。
`PaginatedIterator` (`get_calls` と同様) を返します。これは、消費するにつれてページを取得します。`len(...)` は総バージョン数を報告します。
**引数:**
* `agent_name`: バージョンを一覧表示するエージェント。
* `sort_by`: 結果をソートするフィールド。
* `limit`: 取得するバージョンの最大数。`None` はすべてを取得します。
* `offset`: 取得する前にスキップするバージョン数 (ページネーション用)。
* `page_size`: リクエストごとに取得するバージョン数。
**戻り値:**
`AgentVersionSchema` を反復する `PaginatedIterator`。
**Example:**
```python theme={"system"}
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={"system"}
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
```
この project のエージェントを、集計された統計情報とともに一覧表示します。
`PaginatedIterator` を返します (`get_calls` と同様)。消費に応じてページを透過的に取得します。`len(...)` はエージェントの総数を返し、インデックス指定やスライスがサポートされます。
**引数:**
* `agent_name`: 設定した場合、結果をこのエージェントに制限します。
* `sort_by`: 結果のソート対象フィールド。
* `limit`: 取得するエージェントの最大数。`None` ですべて取得します。
* `offset`: 取得前にスキップするエージェント数 (ページネーション用)。
* `page_size`: 1 リクエストあたりに取得するエージェント数。
**戻り値:**
`AgentSchema` を反復する `PaginatedIterator`。
**Example:**
```python theme={"system"}
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={"system"}
get_aliases(obj_ref: 'ObjectRef | str') → list[str]
```
オブジェクトのバージョンのエイリアスを取得します。
**引数:**
* `obj_ref`: オブジェクトのバージョンの参照。ObjectRef または weave /// URI 文字列のいずれか。
**戻り値:**
エイリアスの strings のリスト。オブジェクトのバージョンが最新の場合、仮想の "latest" エイリアスを含みます。
***
メソッド `get_annotation_queue`
```python theme={"system"}
get_annotation_queue(queue_id: 'str') → AnnotationQueueSchema
```
ID で単一のアノテーションキューを取得します。
***
メソッド `get_annotation_queue_stats`
```python theme={"system"}
get_annotation_queue_stats(
queue_ids: 'list[str]'
) → list[AnnotationQueueStatsSchema]
```
アノテーションキューのアイテム完了統計を取得します。
***
メソッド `get_call`
```python theme={"system"}
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={"system"}
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
```
この project でトレースされた Call (操作) のリストを取得します。
このメソッドは、トレースデータをクエリするための強力かつ柔軟なインターフェースを提供します。ページネーション、フィルタリング、ソート、フィールド射影、スコアリングメタデータをサポートしており、カスタムのトレース UI や分析ツールの構築に使用できます。
パフォーマンスのヒント: 結果のサイズを削減するには、`columns` を指定し、`filter` または `query` を使用してください。
**引数:**
* `filter`: `op_name`、`parent_ids` などのフィールドで結果を絞り込むための高レベルのフィルター。
* `limit`: 返す Call の最大数。
* `offset`: 結果を返す前にスキップする Call の数 (ページネーションに使用)。
* `sort_by`: 結果のソートに使用するフィールドのリスト (例: `started_at desc`)。
* `query`: 高度なフィルタリングのための Mongo 風の式。すべての Mongo オペレーターがサポートされているわけではありません。
* `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`: 1 つ以上の Scorer (名前または ref URI) でフィルターします。複数の Scorer を指定した場合は AND 条件で結合されます。
* `page_size`: ページごとに取得する Call の数。大規模なクエリでは、パフォーマンスに応じてこの値を調整してください。
**戻り値:**
* `CallsIter`: `Call` オブジェクトのイテレーター。スライス、反復処理、`.to_pandas()` をサポートします。
**Example:**
```python theme={"system"}
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={"system"}
get_evaluation(uri: 'str') → Evaluation
```
URI を指定して特定の評価オブジェクトを取得します。
評価の URI は通常、次の形式に従います: `weave:///entity/project/object/Evaluation:version`
評価は "わかりやすい" 名前でも取得できます: get\_evaluation("Evaluation:v1")
**引数:**
* `uri` (str): 取得する評価の一意のリソース識別子。
**戻り値:**
* `Evaluation`: 指定された URI に対応する評価オブジェクト。
**送出される例外:**
* `TypeError`: URI のオブジェクトが Evaluation インスタンスではない場合。
* `ValueError`: URI が無効な場合、またはオブジェクトが見つからない場合。
**サンプル:**
```python theme={"system"}
client = weave.init("my-project")
evaluation = client.get_evaluation("weave:///entity/project/object/my-eval:v1")
print(evaluation.name)
```
***
メソッド `get_evaluations`
```python theme={"system"}
get_evaluations() → list[Evaluation]
```
現在の project からすべての評価オブジェクトを取得します。
**戻り値:**
* `list[Evaluation]`: 現在の project 内のすべての評価オブジェクトのリストです。 評価が見つからない場合、またはすべての変換が失敗した場合は、空のリストを返します。
**サンプル:**
```python theme={"system"}
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={"system"}
get_feedback(
query: 'Query | str | None' = None,
reaction: 'str | None' = None,
offset: 'int' = 0,
limit: 'int' = 100
) → FeedbackQuery
```
project のフィードバックをクエリする。
**サンプル:**
```python theme={"system"}
# 特定のフィードバックオブジェクトを取得します。
# この場合もコレクションが返されますが、
# 含まれるアイテムは 0 個または 1 個です。
client.get_feedback("1B4082A3-4EDA-4BEB-BFEB-2D16ED59AA07")
# 特定のリアクションを持つフィードバックオブジェクトをすべて検索します。
client.get_feedback(reaction="👍", limit=10)
# mongo-style のクエリを使用して、特定のフィードバックタイプを持つ
# フィードバックオブジェクトをすべて検索します。
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 string も受け入れます。
* `reaction`: 便宜上、特定のリアクション絵文字でフィルターします。
* `offset`: フィードバックオブジェクトの取得を開始するオフセット。
* `limit`: 取得するフィードバックオブジェクトの最大数。
**戻り値:**
FeedbackQuery オブジェクト。
***
```python theme={"system"}
get_tags(obj_ref: 'ObjectRef | str') → list[str]
```
オブジェクトのバージョンのタグを取得します。
**引数:**
* `obj_ref`: オブジェクトのバージョンの参照。ObjectRef または weave /// URI 文字列のいずれか。
**戻り値:**
タグ string のリスト。オブジェクトのバージョンにタグがない場合は空のリストを返します。
***
```python theme={"system"}
get_tags_and_aliases(obj_ref: 'ObjectRef | str') → tuple[list[str], list[str]]
```
オブジェクトのバージョンのタグとエイリアスを1回の呼び出しで取得します。
**引数:**
* `obj_ref`: オブジェクトのバージョンの参照。ObjectRef または weave /// URI 文字列のいずれか。
**戻り値:**
(tags, aliases) のタプル。それぞれ list of strings です。オブジェクトのバージョンにタグやエイリアスがない場合は空のリストを返します。
***
メソッド `link_prompt_to_registry`
```python theme={"system"}
link_prompt_to_registry(
prompt: 'LinkablePrompt',
target_path: 'str',
aliases: 'Sequence[str] | None' = None
) → LinkAssetToRegistryRes
```
パブリッシュ済みのプロンプトのバージョンを Registry にリンクします。
**引数:**
* `prompt`: パブリッシュ済みのプロンプト、`ObjectRef`、または完全修飾された weave ///... URI 文字列。
* `target_path`: Registry 内のリンク先パス。形式は `/` です (例: `wandb-registry-prompts/my-prompt-collection`)。
* `aliases`: 作成される Registry のバージョンに付与するエイリアス (オプション)。
**戻り値:**
* `LinkAssetToRegistryRes`: registry-link エンドポイントからの応答を解析した結果。
***
メソッド `list_aliases`
```python theme={"system"}
list_aliases() → list[str]
```
project 内の一意なエイリアスをすべて一覧表示します。
**戻り値:**
project 内のすべてのエイリアスを表す strings のリスト。
***
メソッド `list_annotation_queue_items`
```python theme={"system"}
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={"system"}
list_annotation_queues(
name: 'str | None' = None,
sort_by: 'list[SortBy] | None' = None,
limit: 'int | None' = None,
offset: 'int | None' = None
) → list[AnnotationQueueSchema]
```
この project のアノテーションキューを一覧表示します。
***
```python theme={"system"}
list_tags() → list[str]
```
project 内の一意なタグをすべて一覧表示します。
**戻り値:**
project 内のすべてのタグ strings のリスト。
***
メソッド `purge_costs`
```python theme={"system"}
purge_costs(ids: 'list[str] | str') → None
```
現在の project からコストを削除します。
**サンプル:**
```python theme={"system"}
client.purge_costs([ids])
client.purge_costs(ids)
```
**引数:**
***
メソッド `query_costs`
```python theme={"system"}
query_costs(
query: 'Query | str | None' = None,
llm_ids: 'list[str] | None' = None,
offset: 'int' = 0,
limit: 'int' = 100
) → list[CostQueryOutput]
```
project のコストをクエリします。
* `ids`: 削除するコストの ID。単一の ID または ID のリストを指定できます。
**サンプル:**
```python theme={"system"}
# 特定のコストオブジェクトを取得します。
# この場合もコレクションが返されることに注意してください。
# 含まれる項目数は 0 または 1 であると想定されます。
client.query_costs("1B4082A3-4EDA-4BEB-BFEB-2D16ED59AA07")
# 特定のリアクションを持つすべてのコストオブジェクトを検索します。
client.query_costs(llm_ids=["gpt-4o-mini-2024-07-18"], limit=10)
```
**引数:**
* `query`: mongo スタイルのクエリ式。便宜上、コスト UUID の string も受け入れます。
* `llm_ids`: 便宜上、llm\_ids のセットでフィルターします。
* `offset`: コストオブジェクトの取得を開始するオフセット。
* `limit`: 取得するコストオブジェクトの最大数。
**戻り値:**
CostQuery オブジェクト。
***
メソッド `remove_aliases`
```python theme={"system"}
remove_aliases(obj_ref: 'ObjectRef | str', alias: 'str | list[str]') → None
```
オブジェクトから 1 つ以上のエイリアスを削除します。
**引数:**
***
```python theme={"system"}
remove_tags(obj_ref: 'ObjectRef | str', tags: 'list[str]') → None
```
オブジェクトのバージョンからタグを削除します。
* `obj_ref`: オブジェクトへの参照。ObjectRef または weave /// URI 文字列のいずれかを指定します (エイリアスはオブジェクト単位でスコープされるため、ダイジェストは使用されません) 。
* `alias`: 削除するエイリアス名、またはエイリアス名のリスト。
**引数:**
***
メソッド `save`
```python theme={"system"}
save(val: 'Any', name: 'str', branch: 'str' = 'latest') → Any
```
直接呼び出さず、代わりに weave.publish() を使用してください。
* `obj_ref`: オブジェクトのバージョンへの参照。ObjectRef または weave /// URI 文字列のいずれかです。
* `tags`: 削除するタグの strings のリスト。
**引数:**
* `val`: 保存するオブジェクト。
* `name`: オブジェクトの保存に使用する名前。
* `branch`: オブジェクトの保存先ブランチ。デフォルトは "latest" です。
**戻り値:**
保存されたオブジェクトをデシリアライズしたバージョン。
***
メソッド `search_agents`
```python theme={"system"}
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
```
エージェントのメッセージを content で検索し、会話ごとにグループ化して返します。
メッセージの content(および/または以下の構造化フィルター)を検索し、一致した会話とその一致メッセージを返します。`query` を空にすると、フィルターのみに基づく構造化検索になります。
**引数:**
* `query`: メッセージの content 内で照合する部分文字列。空の場合はすべてに一致します。
* `agent_name`: このエージェントからのメッセージに限定します。
* `conversation_id`: 単一の会話に限定します。
* `trace_id`: 単一のトレースに限定します。
* `limit`: 対象とする一致メッセージの最大数。
* `offset`: スキップする一致の数(ページネーション用)。
**戻り値:**
`results`(一致した会話)を含む `AgentSearchRes`。
**例:**
```python theme={"system"}
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={"system"}
set_aliases(obj_ref: 'ObjectRef | str', alias: 'str | list[str]') → None
```
オブジェクトのバージョンに 1 つ以上のエイリアスを設定します。
**引数:**
***
メソッド `set_wandb_run_context`
```python theme={"system"}
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`: 設定するエイリアス名、またはエイリアス名のリスト (例: "production") 。
**引数:**
* `run_id`: run ID (entity/project の接頭辞は含みません) 。entity/project の接頭辞はクライアントが自動的に付加します。
* `step`: Call に使用する step 番号。None の場合、step は設定されません。
**サンプル:**
```python theme={"system"}
client = weave.init("my-project")
client.set_wandb_run_context(run_id="my-run-id", step=5)
# これ以降、すべての Call は entity/project/my-run-id の step 5 に関連付けられます
# step を指定しない場合
client.set_wandb_run_context(run_id="my-run-id")
# Call は step なしで entity/project/my-run-id に関連付けられます
```
***
メソッド `update_annotation_queue`
```python theme={"system"}
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={"system"}
get_obj_name(val: 'Any') → str
```
***
関数 `get_parallelism_settings`
```python theme={"system"}
get_parallelism_settings() → tuple[int | None, int | None]
```
***
関数 `map_to_refs`
```python theme={"system"}
map_to_refs(obj: 'Any') → Any
```
***
関数 `print_call_link`
```python theme={"system"}
print_call_link(call: 'Call') → None
```
***
関数 `redact_sensitive_keys`
```python theme={"system"}
redact_sensitive_keys(obj: 'Any') → Any
```
***
関数 `sanitize_object_name`
```python theme={"system"}
sanitize_object_name(name: 'str') → str
```
## Related topics
- [WeaveClient](/ja/products/wandb/weave/reference/typescript-sdk/interfaces/weaveclient.md)