API 概要
class CrossProjectRefError
クライアント側でダイジェストを計算する際に、内部 ID に解決できない別のprojectへの ref に遭遇した場合に発生します。
class FlushStatus
現在のフラッシュ処理のステータス情報。
class NoInternalProjectIDError
内部project ID がまだ解決されていないため、クライアント側でダイジェストを計算できない場合に発生します。
class PendingJobCounts
各タイプの保留中ジョブ数。
class WeaveClient
method __init__
プロパティ num_outstanding_jobs
すべてのエグゼキュータとサーバーにわたる、保留中のジョブの総数を返します。 このプロパティを使用すると、メインスレッドをブロックすることなく、バックグラウンドタスクの進行状況を確認できます。 戻り値:int: 保留中のジョブの総数
プロパティ project_id
method add_calls_to_annotation_queue
method add_cost
queue_id: アノテーションキューの ID。call_ids: キューに追加する Call ID。display_fields:inputs.promptやoutput.textなど、レビュアーに表示する JSON パス。 例:
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という名前のタプルのリストを 1 つのフィールドとして持ちます。各タプルにはllm_idと、作成されたコストオブジェクトの ID が含まれます。
method add_tags
method clear_wandb_run_context
obj_ref: オブジェクトのバージョンへの参照です。ObjectRef または weave /// URI 文字列のいずれかです。tags: 追加するタグ文字列のリスト。 例:
method create_annotation_queue
name: キューの表示名。scorer_refs: レビュー担当者が入力する scorer / アノテーションフィールドの Weave ref。description: 任意のレビュー担当者向けガイドライン、またはキューの説明。 戻り値: 作成したアノテーションキューの ID。
method create_call
op: Call を生成する op、または無名の op の名前。inputs: 操作への入力。parent: 親 Call。parent が指定されていない場合は、現在の run が親として使用されます。display_name: Call の表示名。デフォルトは None です。attributes: Call の属性。デフォルトは None です。use_stack: Call をランタイムスタックにプッシュするかどうか。デフォルトは True です。started_at: Call の開始時刻を上書きします。None の場合は、現在時刻を使用します。 戻り値: 作成された Call オブジェクト。
method delete_all_object_versions
object_name: バージョンを削除する対象のオブジェクト名。 戻り値: 削除されたバージョンの数。
method delete_all_op_versions
op_name: バージョンを削除する対象の op の名前。 戻り値: 削除されたバージョンの数。
method delete_annotation_queue
method delete_call
method delete_calls
method delete_object_version
method delete_object_versions
-
call_ids: 削除する Call ID のリスト。例: [“2F0193e107-8fcf-7630-b576-977cc3062e2e”] 引数: -
object_name: バージョンを削除する対象のオブジェクトの名。 -
digests: 削除する digest のリスト。“latest” や “v0” などのエイリアスを含めることができます。 戻り値: 削除されたバージョンの数。
method delete_op_version
method fail_call
method finish
method finish_call
call.summary に含まれる値は、データベースに書き込まれる前に、計算された summary 統計 (使用量やステータスのカウントなど) とディープマージされます。
method flush
method get
メソッド get_aliases
-
use_progress_bar: flush 時にプログレスバーを表示するかどうか。プログレスバーが適切に表示されない環境 (例: CI 環境) では、False に設定します。 -
callback: ステータス更新を受け取るオプションのコールバック関数。use_progress_bar より優先されます。 引数: -
obj_ref: オブジェクトのバージョンへの参照。ObjectRef または weave /// URI 文字列を指定します。 戻り値: エイリアス文字列のリスト。オブジェクトのバージョンが最新の場合は、仮想的な “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 演算子がサポートされるわけではありません。include_costs: True の場合、summary.weaveに token/コスト情報を含めます。include_feedback: True の場合、summary.weave.feedbackにフィードバックを含めます。include_storage_size: True の場合、Call のストレージサイズを含めます。include_total_storage_size: True の場合、trace の合計ストレージサイズを含めます。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: 1 ページあたりに取得する Call の数。大規模なクエリでのパフォーマンス向上のために調整してください。
CallsIter:Callオブジェクトを反復するイテレーター。スライス、反復、.to_pandas()をサポートします。
メソッド get_evaluation
weave:///entity/project/object/Evaluation:version
「フレンドリ名」を使って 評価 を取得することもできます: get_evaluation(“Evaluation:v1”)
引数:
uri(str): 取得する 評価 の一意のリソース識別子。
Evaluation: 指定した URI に対応する 評価 オブジェクト。
TypeError: URI のオブジェクトが 評価 インスタンスではない場合。ValueError: URI が無効な場合、またはオブジェクトが見つからない場合。
メソッド get_evaluations
list[Evaluation]: 現在のproject内にあるすべての評価オブジェクトのリスト。評価が見つからない場合、またはすべての変換に失敗した場合は、空のリストを返します。
メソッド get_feedback
query: Mongoスタイルのクエリ式です。利便性のため、フィードバック UUID 文字列も指定できます。reaction: 利便性のため、特定のリアクション絵文字でフィルタリングできます。offset: フィードバックオブジェクトの取得を開始する位置のオフセットです。limit: 取得するフィードバックオブジェクトの最大数です。 戻り値: FeedbackQuery オブジェクトです。
メソッド get_tags
obj_ref: オブジェクトのバージョンを参照する値です。ObjectRefまたはweave:///URI 文字列を指定します。 戻り値: タグ文字列のリストです。オブジェクトのバージョンにタグがない場合は、空のリストを返します。
メソッド get_tags_and_aliases
obj_ref: オブジェクトのバージョンへの参照です。ObjectRef または weave /// URI 文字列のいずれかを指定します。 戻り値:(タグ, エイリアス)のタプルを返します。どちらも文字列のリストです。オブジェクトのバージョンに タグ またはエイリアスがない場合は、空のリストを返します。
メソッド link_prompt_to_registry
-
prompt: 公開済みの prompt、ObjectRef、または完全修飾されたweave:///...URI string。 -
target_path:<registry_project>/<portfolio_name>形式の Registry の宛先パス。例:wandb-registry-prompts/my-prompt-collection。 -
aliases: 作成される Registry バージョンに付与するオプションのエイリアス。 戻り値: -
LinkAssetToRegistryRes: registry-link エンドポイントからのパース済みレスポンス。
メソッド list_aliases
メソッド list_annotation_queue_items
メソッド list_annotation_queues
メソッド list_tags
メソッド purge_costs
メソッド query_costs
ids: 削除するコスト ID。単一の ID または複数の ID を指定できます。 例:
query: Mongo スタイルのクエリ式です。便宜上、cost UUID 文字列も受け付けます。llm_ids: 便宜上、llm_ids の集合でフィルターします。offset: cost オブジェクトの取得を開始する位置を指定するオフセットです。limit: 取得する cost オブジェクトの最大数です。 戻り値: CostQuery オブジェクト。
メソッド remove_aliases
メソッド remove_tags
obj_ref: オブジェクトへの参照です。ObjectRef または weave:/// URI 文字列のいずれかです (エイリアス はオブジェクト スコープであるため、digest は使用されません) 。alias: 削除する エイリアス 名、または エイリアス 名のリストです。 引数:
メソッド save
weave.publish() を使用してください。
-
obj_ref: オブジェクトのバージョンへの参照です。ObjectRef または weave /// URI 文字列のいずれかです。 -
tags: 削除するタグ文字列のリストです。 引数: -
val: 保存するオブジェクト。 -
name: オブジェクトを保存するときの名前。 -
branch: オブジェクトを保存するときのブランチ。デフォルトは “latest” です。 戻り値: 保存したオブジェクトをデシリアライズしたもの。
メソッド set_aliases
メソッド set_wandb_run_context
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 は設定されません。 例: