> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-serverless-sft-revamp.mintlify.site/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 概要
***
## class `FlushStatus`
現在の flush 操作に関するステータス情報。
***
## class `PendingJobCounts`
各タイプごとの保留中のジョブ数。
***
## class `WeaveClient`
### method `__init__`
```python theme={null}
__init__(
entity: 'str',
project: 'str',
server: 'TraceServerInterface',
ensure_project_exists: 'bool' = True
)
```
***
#### property num\_outstanding\_jobs
すべてのエグゼキューターとサーバーにわたる保留中のジョブの総数を返します。
このプロパティを使用すると、メインスレッドをブロックすることなくバックグラウンドタスクの進行状況を確認できます。
**Returns:**
* `int`: 保留中のジョブの総数
***
### method `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
```
現在の Projects にコストを追加します。
**Examples:**
```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))
```
**Args:**
* `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" などの通貨タイプを指定するために使用予定）
**Returns:**
CostCreateRes オブジェクト。ids と呼ばれるタプルのリストを持つ1つのフィールドが含まれます。各タプルには llm\_id と作成されたコストオブジェクトの ID が含まれます。
***
### method `clear_wandb_run_context`
```python theme={null}
clear_wandb_run_context() → None
```
wandb run コンテキストのオーバーライドをクリアします。
これを呼び出した後、呼び出しは run\_id と step 情報について（利用可能な場合は）グローバルな wandb.run を使用するように戻ります。
**Examples:**
```python theme={null}
client = weave.init("my-project")
client.set_wandb_run_context(run_id="my-run-id", step=5)
# ... いくつかの呼び出しを行う ...
client.clear_wandb_run_context()
# これで呼び出しは再びグローバルな wandb.run を使用するようになります
```
***
### method `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
) → Call
```
call を作成、ログ記録し、ランタイムスタックにプッシュします。
**Args:**
* `op`: call を生成する操作、または匿名操作の名前。
* `inputs`: 操作への入力。
* `parent`: 親の call。parent が指定されない場合、現在の run が親として使用されます。
* `display_name`: call の表示名。デフォルトは None。
* `attributes`: call の属性。デフォルトは None。
* `use_stack`: call をランタイムスタックにプッシュするかどうか。デフォルトは True。
**Returns:**
作成された Call オブジェクト。
***
### method `delete_all_object_versions`
```python theme={null}
delete_all_object_versions(object_name: 'str') → int
```
オブジェクトのすべてのバージョンを削除します。
**Args:**
* `object_name`: バージョンを削除するオブジェクトの名前。
**Returns:**
削除されたバージョンの数。
***
### method `delete_all_op_versions`
```python theme={null}
delete_all_op_versions(op_name: 'str') → int
```
op のすべてのバージョンを削除します。
**Args:**
* `op_name`: バージョンを削除する op の名前。
**Returns:**
削除されたバージョンの数。
***
### method `delete_call`
```python theme={null}
delete_call(call: 'Call') → None
```
***
### method `delete_calls`
```python theme={null}
delete_calls(call_ids: 'list[str]') → None
```
ID を指定して call を削除します。
call を削除すると、そのすべての子も削除されます。
**Args:**
***
### method `delete_object_version`
```python theme={null}
delete_object_version(object: 'ObjectRef') → None
```
***
### method `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"]
**Args:**
* `object_name`: バージョンを削除するオブジェクトの名前。
* `digests`: 削除するダイジェストのリスト。"latest" や "v0" などの エイリアス を含めることができます。
**Returns:**
削除されたバージョンの数。
***
### method `delete_op_version`
```python theme={null}
delete_op_version(op: 'OpRef') → None
```
***
### method `fail_call`
```python theme={null}
fail_call(call: 'Call', exception: 'BaseException') → None
```
例外を伴って call を失敗させます。これは finish\_call の便利なメソッドです。
***
### method `finish`
```python theme={null}
finish(
use_progress_bar: 'bool' = True,
callback: 'Callable[[FlushStatus], None] | None' = None
) → None
```
すべてのバックグラウンドタスクを flush して、それらが処理されるようにします。
このメソッドは、現在エンキューされているすべてのジョブが処理されるまでブロックされ、保留中のタスクのステータスを示すプログレスバーを表示します。メインスレッドの実行中に並列処理を保証し、データがサーバーにアップロードされる前にユーザーコードが完了した場合のパフォーマンスを向上させることができます。
**Args:**
***
### method `finish_call`
```python theme={null}
finish_call(
call: 'Call',
output: 'Any' = None,
exception: 'BaseException | None' = None,
op: 'Op | None' = None
) → None
```
call を完了させ、その結果を永続化します。
`call.summary` に存在するすべての値は、データベースに書き込まれる前に計算されたサマリー統計（例：使用状況やステータス数）とディープマージされます。
***
### method `flush`
```python theme={null}
flush() → None
```
バックグラウンドの非同期タスクを flush します。複数回呼び出しても安全です。
***
### method `get`
```python theme={null}
get(ref: 'ObjectRef', objectify: 'bool' = True) → Any
```
***
### method `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 を取得します。
* `use_progress_bar`: flush 中にプログレスバーを表示するかどうか。プログレスバーがうまくレンダリングされない環境（例：CI環境）では False に設定してください。
* `callback`: ステータスの更新を受け取るオプションの コールバック 関数。use\_progress\_bar をオーバーライドします。
**Args:**
* `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）は常に含まれます。
**Returns:**
call オブジェクト。
***
### method `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,
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
```
この Projects のトレースされた call（操作）のリストを取得します。
このメソッドは、トレースデータのクエリのための強力で柔軟なインターフェースを提供します。ページネーション、フィルタリング、ソート、フィールドプロジェクション、スコアリングメタデータをサポートしており、カスタムのトレース UI や分析ツールを動かすために使用できます。
パフォーマンスのヒント: `columns` を指定し、`filter` または `query` を使用して結果サイズを縮小してください。
**Args:**
* `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 の場合、トレースの合計ストレージサイズを含めます。
* `columns`: call ごとに返すフィールドのリスト。これを減らすことでパフォーマンスが大幅に向上します。（`id`、`trace_id`、`op_name`、`started_at` などの一部のフィールドは常に含まれます。）
* `scored_by`: 1つ以上のスコアラー（名前または ref URI）でフィルタリングします。複数のスコアラーは AND で結合されます。
* `page_size`: 1ページあたりにフェッチされる call の数。大規模なクエリの場合はパフォーマンスのためにこれを調整してください。
**Returns:**
* `CallsIter`: `Call` オブジェクトに対するイテレータ。スライス、イテレーション、および `.to_pandas()` をサポートします。
**Example:**
```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)
```
***
### method `get_evaluation`
```python theme={null}
get_evaluation(uri: 'str') → Evaluation
```
URI を指定して特定の Evaluation オブジェクトを取得します。
Evaluation の URI は通常、`weave:///entity/project/object/Evaluation:version` という形式に従います。
また、「フレンドリーな」名前で評価を取得することもできます: get\_evaluation("Evaluation:v1")
**Args:**
* `uri` (str): 取得する Evaluation の一意のリソース識別子。
**Returns:**
* `Evaluation`: 指定された URI に対応する Evaluation オブジェクト。
**Raises:**
* `TypeError`: URI のオブジェクトが Evaluation インスタンスではない場合。
* `ValueError`: URI が無効であるか、オブジェクトが見つからない場合。
**Examples:**
```python theme={null}
client = weave.init("my-project")
evaluation = client.get_evaluation("weave:///entity/project/object/my-eval:v1")
print(evaluation.name)
```
***
### method `get_evaluations`
```python theme={null}
get_evaluations() → list[Evaluation]
```
現在の Projects からすべての Evaluation オブジェクトを取得します。
**Returns:**
* `list[Evaluation]`: 現在の Projects 内のすべての Evaluation オブジェクトのリスト。評価が見つからない場合、またはすべての変換が失敗した場合は空のリストを返します。
**Examples:**
```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}")
```
***
### method `get_feedback`
```python theme={null}
get_feedback(
query: 'Query | str | None' = None,
reaction: 'str | None' = None,
offset: 'int' = 0,
limit: 'int' = 100
) → FeedbackQuery
```
Projects 内のフィードバックをクエリします。
**Examples:**
```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)
```
**Args:**
* `query`: Mongo スタイルのクエリ式。便宜上、フィードバックの UUID 文字列も受け入れます。
* `reaction`: 便宜上、特定のリアクション絵文字でフィルタリングします。
* `offset`: フィードバックオブジェクトの取得を開始するオフセット。
* `limit`: 取得するフィードバックオブジェクトの最大数。
**Returns:**
FeedbackQuery オブジェクト。
***
### method `purge_costs`
```python theme={null}
purge_costs(ids: 'list[str] | str') → None
```
現在の Projects からコストを消去します。
**Examples:**
```python theme={null}
client.purge_costs([ids])
client.purge_costs(ids)
```
**Args:**
***
### method `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]
```
Projects 内のコストをクエリします。
* `ids`: 消去するコスト ID。単一の ID または ID のリストを指定できます。
**Examples:**
```python theme={null}
# 特定のコストオブジェクトを取得します。
# これにより、0個または1個のアイテムが含まれることが期待される
# コレクションが返されます。
client.query_costs("1B4082A3-4EDA-4BEB-BFEB-2D16ED59AA07")
# 特定のリアクションを持つすべてのコストオブジェクトを検索します。
client.query_costs(llm_ids=["gpt-4o-mini-2024-07-18"], limit=10)
```
**Args:**
* `query`: Mongo スタイルのクエリ式。便宜上、コストの UUID 文字列も受け入れます。
* `llm_ids`: 便宜上、特定の llm\_ids セットでフィルタリングします。
* `offset`: コストオブジェクトの取得を開始するオフセット。
* `limit`: 取得するコストオブジェクトの最大数。
**Returns:**
CostQuery オブジェクト。
***
### method `save`
```python theme={null}
save(val: 'Any', name: 'str', branch: 'str' = 'latest') → Any
```
直接呼び出さないでください。代わりに weave.publish() を使用してください。
**Args:**
* `val`: 保存するオブジェクト。
* `name`: オブジェクトを保存する際の名前。
* `branch`: オブジェクトを保存するブランチ。デフォルトは "latest"。
**Returns:**
保存されたオブジェクトのデシリアライズされたバージョン。
***
### method `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 を関連付けることができます。
**Args:**
* `run_id`: run ID（entity/project プレフィックスは含まない）。クライアントは自動的に entity/project プレフィックスを追加します。
* `step`: call に使用するステップ番号。None の場合、ステップは設定されません。
**Examples:**
```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 に関連付けられます
# ステップなしの場合
client.set_wandb_run_context(run_id="my-run-id")
# call はステップなしで entity/project/my-run-id に関連付けられます
```
***
### function `get_obj_name`
```python theme={null}
get_obj_name(val: 'Any') → str
```
***
### function `get_parallelism_settings`
```python theme={null}
get_parallelism_settings() → tuple[int | None, int | None]
```
***
### function `map_to_refs`
```python theme={null}
map_to_refs(obj: 'Any') → Any
```
***
### function `print_call_link`
```python theme={null}
print_call_link(call: 'Call') → None
```
***
### function `redact_sensitive_keys`
```python theme={null}
redact_sensitive_keys(obj: 'Any') → Any
```
***
### function `sanitize_object_name`
```python theme={null}
sanitize_object_name(name: 'str') → str
```