クラス: WeaveClient - Weights & Biases Documentation

weave / WeaveClient

コンストラクタ

• new WeaveClient(«destructured»): WeaveClient

パラメーター

名	タイプ
`«destructured»`	`Object`
› `projectId`	`string`
› `settings?`	`Partial`<`Settings`>
› `traceServerApi`	`Api`<`any`>

戻り値

WeaveClient

定義箇所

src/weaveClient.ts:459

プロパティ

projectId

• projectId: string

定義箇所

src/weaveClient.ts:456

settings

• settings: Settings

定義箇所

src/weaveClient.ts:457

traceServerApi

• traceServerApi: Api<any>

定義箇所

src/weaveClient.ts:455

メソッド

addScore

▸ addScore(predictCallId, scorerCallId, runnableRefUri, scorerOutput): Promise<string> call に scorer の結果 (例: scorer output) を追加します。命令型評価で、predict call に scorer の結果を関連付けるために使用します。

パラメーター

名	タイプ	説明
`predictCallId`	`string`	フィードバックの関連付け先となる predict call のID
`scorerCallId`	`string`	フィードバックを生成した scorer call のID
`runnableRefUri`	`string`	scorer (Op または Object ref) のURI
`scorerOutput`	`any`	scorerの出力

戻り値

Promise<string>

定義箇所

src/weaveClient.ts:1727

createCall

▸ createCall(internalCall, opRef, params, parameterNames, thisArg, currentCall, parentCall, startTime, displayName?, attributes?): Promise<void>

パラメーター

名	タイプ
`internalCall`	`InternalCall`
`opRef`	`any`
`params`	`any`[]
`parameterNames`	`ParameterNamesOption`
`thisArg`	`any`
`currentCall`	`CallStackEntry`
`parentCall`	`undefined`	`CallStackEntry`
`startTime`	`Date`
`displayName?`	`string`
`attributes?`	`Record`<`string`, `any`>

戻り値

Promise<void>

定義箇所

src/weaveClient.ts:1570

finishCall

▸ finishCall(call, result, currentCall, parentCall, summarize, endTime, startCallPromise): Promise<void>

パラメーター

名	タイプ
`call`	`InternalCall`
`result`	`any`
`currentCall`	`CallStackEntry`
`parentCall`	`undefined`	`CallStackEntry`
`summarize`	`undefined`	(`result`: `any`) => `Record`<`string`, `any`>
`endTime`	`Date`
`startCallPromise`	`Promise`<`void`>

戻り値

Promise<void>

定義箇所

src/weaveClient.ts:1630

finishCallWithException

▸ finishCallWithException(call, error, currentCall, parentCall, endTime, startCallPromise): Promise<void>

パラメーター

名	タイプ
`call`	`InternalCall`
`error`	`any`
`currentCall`	`CallStackEntry`
`parentCall`	`undefined`	`CallStackEntry`
`endTime`	`Date`
`startCallPromise`	`Promise`<`void`>

戻り値

Promise<void>

定義箇所

src/weaveClient.ts:1672

get

▸ get(ref): Promise<any>

パラメーター

名	タイプ
`ref`	`ObjectRef`

戻り値

Promise<any>

定義箇所

src/weaveClient.ts:1025

getAgentCustomAttributes

▸ getAgentCustomAttributes(options): Promise<Response<GetAgentCustomAttributesResult>> project 内のエージェントのスパンで観測された型付きカスタム属性キーを検出します。各結果行は 1 つの (source, key, value_type) トリプルに、その値を持つスパン数を加えたもので、spans の query/group/stats API がカスタム属性を参照する際に使用する形式です。対象とするスパンは、query (構造化された span フィルター) 、startedAfter / startedBefore (ISO-8601) 、またはその両方を指定して絞り込めます。検出されたキーをページングするには、 limit / offset を使用します。

パラメーター

名	タイプ
`options`	`GetAgentCustomAttributesOptions`

戻り値

Promise<Response<GetAgentCustomAttributesResult>> 例

const client = await weave.init('entity/project');
const resp = await client.getAgentCustomAttributes({
  query: {
    $expr: {
      $eq: [{$getField: 'agent_name'}, {$literal: 'my-agent'}],
    },
  },
  startedAfter: '2026-06-15T00:00:00Z',
  limit: 200,
});

for (const attr of resp.data.attributes ?? []) {
  console.log(`${attr.source}.${attr.key} (${attr.value_type}): ${attr.span_count}`);
}

定義箇所

src/weaveClient.ts:772

getAgentSpanStats

▸ getAgentSpanStats(options): Promise<Response<GetAgentSpanStatsResult>> project 内のエージェントスパンに対する集約を、時系列 / バケット化された可視化に適した行 + 列のメタデータとして返します。 start (必須) と end は時間ウィンドウを定義します。metrics の各エントリでは、抽出するフィールドとその集約方法 (sum、 avg、count、パーセンタイルなど) を指定します。granularity (秒) を渡すと行を時間単位でバケット化でき、groupBy を渡すと結果をエージェント / provider / モデル / などごとに分けられます。query は、集約前に対象のスパンをフィルターします。

パラメーター

名	タイプ
`options`	`GetAgentSpanStatsOptions`

戻り値

Promise<Response<GetAgentSpanStatsResult>> 例

const client = await weave.init('entity/project');
const resp = await client.getAgentSpanStats({
  start: '2026-06-10T00:00:00Z',
  end: '2026-06-23T00:00:00Z',
  granularity: 86400, // 1日1行
  metrics: [
    {
      alias: 'total_input_tokens',
      value_type: 'number',
      aggregations: ['sum'],
      value: {source: 'field', key: 'input_tokens'},
    },
  ],
  groupBy: [{key: 'agent_name'}],
});

for (const row of resp.data.rows ?? []) {
  console.log(row.started_at_bucket, row.agent_name, row.total_input_tokens);
}

定義箇所

src/weaveClient.ts:621

getAgentSpans

▸ getAgentSpans(options): Promise<Response<GetAgentSpansResult>> エージェントのスパンをクエリします。必要に応じて、エージェント名や Mongo スタイルのクエリ式でフィルターできます。

パラメーター

名	タイプ
`options`	`GetAgentSpansOptions`

戻り値

Promise<Response<GetAgentSpansResult>> 例

const client = await weave.init('entity/project');
const resp = await client.getAgentSpans({agentName: 'my-agent', limit: 20});

for (const span of resp.data.spans) {
  console.log(span.span_id, span.span_name, span.input_tokens);
}

例

const client = await weave.init('entity/project');

const resp = await client.getAgentSpans({
  agentName: 'my-agent',
  query: {
    $expr: {$gt: [{$getField: 'input_tokens'}, {$literal: 1000}]},
  },
});

for (const span of resp.data.spans) {
  console.log(span.span_id, span.span_name, span.input_tokens);
}

定義箇所

src/weaveClient.ts:566

getAgentTurn

▸ getAgentTurn(options): Promise<Response<AgentTraceChatRes>> traceId で指定した単一のターンのデータ (メッセージを含む) を取得します。

パラメーター

名	タイプ
`options`	`GetAgentTurnOptions`

戻り値

Promise<Response<AgentTraceChatRes>> 例

const client = await weave.init('entity/project');
const resp = await client.getAgentTurn({
  traceId: '01997b8a-2c89-7c4d-9d0e-2f7e5b9a1b2c',
  includeFeedback: true,
});

console.log(resp.data.root_span_name, resp.data.total_duration_ms);

for (const message of resp.data.messages ?? []) {
  if (message.user_message) console.log('user:', message.user_message);
  if (message.assistant_message) console.log('assistant:', message.assistant_message);
}

定義箇所

src/weaveClient.ts:655

getAgentTurns

▸ getAgentTurns(options): Promise<Response<GetAgentTurnsResult>> 複数のターンのデータ (メッセージを含む) を conversationId ごとに取得します。

パラメーター

名	タイプ
`options`	`GetAgentTurnsOptions`

戻り値

Promise<Response<GetAgentTurnsResult>> 例

const client = await weave.init('entity/project');
const resp = await client.getAgentTurns({
  conversationId: 'trace_c50312356de3487fa90e381c9399b5b4',
  limit: 20,
  includeFeedback: true,
});

for (const turn of resp.data.turns ?? []) {
  console.log(turn.trace_id, turn.root_span_name);
  for (const message of turn.messages ?? []) {
    if (message.user_message) console.log('user:', message.user_message);
    if (message.assistant_message) console.log('assistant:', message.assistant_message);
  }
}

console.log(`total turns: ${resp.data.total_turns}, has more: ${resp.data.has_more}`);

定義箇所

src/weaveClient.ts:688

getAgentVersions

▸ getAgentVersions(options): Promise<Response<GetAgentVersionsResult>> 指定したエージェントのバージョンを一覧で取得します。

パラメーター

名	タイプ
`options`	`GetAgentVersionsOptions`

戻り値

Promise<Response<GetAgentVersionsResult>> 例

const client = await weave.init('entity/project');
const resp = await client.getAgentVersions({agentName: 'my-agent', limit: 20});

for (const version of resp.data.versions) {
  console.log(version.agent_version, version.total_input_tokens);
}

console.log(`total count: ${resp.data.total_count}`)

定義箇所

src/weaveClient.ts:522

getAgents

▸ getAgents(options?): Promise<Response<GetAgentsResult>> 集計済みの統計情報とともに、エージェントの一覧を返します。

パラメーター

名	タイプ
`options`	`GetAgentsOptions`

戻り値

Promise<Response<GetAgentsResult>> 例

const client = await weave.init('entity/project');
const resp = await client.getAgents({limit: 20});

for (const agent of resp.data.agents) {
  console.log(agent.agent_name, agent.total_input_tokens);
}

console.log(`total count: ${resp.data.total_count}`)

定義箇所

src/weaveClient.ts:488

getCall

▸ getCall(callId, includeCosts?): Promise<Call>

パラメーター

名	タイプ	デフォルト値
`callId`	`string`	`undefined`
`includeCosts`	`boolean`	`false`

戻り値

Promise<Call>

定義箇所

src/weaveClient.ts:902

getCallStack

▸ getCallStack(): CallStack

戻り値

CallStack

定義箇所

src/weaveClient.ts:1482

getCalls

▸ getCalls(options?): Promise<Call[]>

パラメーター

名	タイプ
`options?`	`GetCallsOptions`

戻り値

Promise<Call[]>

定義箇所

src/weaveClient.ts:935 ▸ getCalls(options?, includeCosts?, limit?): Promise<Call[]>

パラメーター

名	タイプ
`options?`	`CallsFilter`
`includeCosts?`	`boolean`
`limit?`	`number`

戻り値

Promise<Call[]>

定義箇所

src/weaveClient.ts:936

getCallsIterator

▸ getCallsIterator(options?, includeCosts?, limit?): AsyncIterableIterator<CallSchema, any, any>

パラメーター

名	タイプ
`options?`	`CallsFilter`
`includeCosts?`	`boolean`
`limit?`	`number`

戻り値

AsyncIterableIterator<CallSchema, any, any>

定義箇所

src/weaveClient.ts:957 ▸ getCallsIterator(options?): AsyncIterableIterator<CallSchema, any, any>

パラメーター

名	タイプ
`options?`	`GetCallsOptions`

戻り値

AsyncIterableIterator<CallSchema, any, any>

定義箇所

src/weaveClient.ts:962

getCurrentAttributes

▸ getCurrentAttributes(): Record<string, any>

戻り値

Record<string, any>

定義箇所

src/weaveClient.ts:1486

linkPromptToRegistry

▸ linkPromptToRegistry(prompt, options): Promise<LinkAssetToRegistryRes> 公開済みのプロンプトバージョンを Registry ポートフォリオにリンクします。

パラメーター

名	タイプ
`prompt`	`RegistryLinkable`
`options`	`LinkPromptToRegistryOptions`

戻り値

Promise<LinkAssetToRegistryRes>

定義箇所

src/weaveClient.ts:1181

publish

▸ publish(obj, objId?): Promise<ObjectRef>

パラメーター

名	タイプ
`obj`	`any`
`objId?`	`string`

戻り値

Promise<ObjectRef>

定義箇所

src/weaveClient.ts:890

pushNewCall

▸ pushNewCall(): Object

戻り値

Object

名	タイプ
`currentCall`	`CallStackEntry`
`newStack`	`CallStack`
`parentCall?`	`CallStackEntry`

定義箇所

src/weaveClient.ts:1490

runWithAttributes

▸ runWithAttributes<T>(attributes, fn): T

型パラメーター

名
`T`

パラメーター

名	タイプ
`attributes`	`Record`<`string`, `any`>
`fn`	() => `T`

戻り値

T

定義箇所

src/weaveClient.ts:1498

runWithCallStack

▸ runWithCallStack<T>(callStack, fn): T

型パラメーター

名
`T`

パラメーター

名	タイプ
`callStack`	`CallStack`
`fn`	() => `T`

戻り値

T

定義箇所

src/weaveClient.ts:1494

saveCallEnd

▸ saveCallEnd(callEnd): void

パラメーター

名	タイプ
`callEnd`	`EndedCallSchemaForInsert`

戻り値

void

定義箇所

src/weaveClient.ts:1477

saveCallStart

▸ saveCallStart(callStart): void

パラメーター

名	タイプ
`callStart`	`StartedCallSchemaForInsert`

戻り値

void

定義箇所

src/weaveClient.ts:1472

saveOp

▸ saveOp(op, objId?): Promise<OpRef>

パラメーター

名	タイプ
`op`	`Op`<(…`args`: `any`[]) => `any`>
`objId?`	`string`

戻り値

Promise<OpRef>

定義箇所

src/weaveClient.ts:1537

searchAgents

▸ searchAgents(options): Promise<Response<SearchAgentsResult>> project 内のエージェントメッセージ全体を対象に全文検索を実行します。結果は会話ごとにグループ化され、一致した各メッセージのプレビューが表示されます。 query は全文検索の検索語です。空の文字列を渡すと、テキスト一致は行わず、構造化フィルター (agentName, conversationId, traceId) に一致するすべてのメッセージを取得できます。limit / offset を使用して結果をページ単位で取得します。

パラメーター

名	タイプ
`options`	`SearchAgentsOptions`

戻り値

Promise<Response<SearchAgentsResult>> 例

const client = await weave.init('entity/project');
const resp = await client.searchAgents({
  query: 'Liverpool',
  agentName: 'Assistant',
  limit: 20,
});

for (const conversation of resp.data.results ?? []) {
  console.log(`${conversation.conversation_id} (${conversation.agent_name})`);
  for (const match of conversation.matched_messages) {
    console.log(`  [${match.role}] ${match.content_preview}`);
  }
}

console.log(`total conversations: ${resp.data.total_conversations}`);

定義箇所

src/weaveClient.ts:730

serializeAudio

▸ serializeAudio(data, audioType?): Promise<SerializedFileBlob> 生のオーディオバイトを Weave のコンテンツストアにアップロードし、 Call の出力に埋め込める CustomWeaveType プレースホルダーを返します。これは、finishCall の自動シリアライズパイプラインを使用せずに、 Call の出力を手動で構築する場合 (たとえば saveCallEnd 経由) に使用します。

パラメーター

名	タイプ	既定値	説明
`data`	`Buffer`<`ArrayBufferLike`>	`undefined`	生のオーディオバイト (ブラウザーとの互換性を最大限にするには WAV)
`audioType`	`"wav"`	`DEFAULT_AUDIO_TYPE`	ファイル形式 — 現在サポートされているのは ‘wav’ のみです

戻り値

Promise<SerializedFileBlob>

定義箇所

src/weaveClient.ts:1424

updateCall

▸ updateCall(callId, displayName): Promise<void>

パラメーター

名	タイプ
`callId`	`string`
`displayName`	`string`

戻り値

Promise<void>

定義箇所

src/weaveClient.ts:1710

waitForBatchProcessing

▸ waitForBatchProcessing(): Promise<void>

戻り値

Promise<void>

定義箇所

src/weaveClient.ts:801

クラス: WeaveAdkPlugin

クラス: WeaveObject

⌘I

​目次

​コンストラクタ

​プロパティ

​メソッド

​コンストラクタ

​コンストラクタ

​パラメーター

​戻り値

​定義箇所

​プロパティ

​projectId

​定義箇所

​settings

​定義箇所

​traceServerApi

​定義箇所

​メソッド

​addScore

​パラメーター

​戻り値

​定義箇所

​createCall

​パラメーター

​戻り値

​定義箇所

​finishCall

​パラメーター

​戻り値

​定義箇所

​finishCallWithException

​パラメーター

​戻り値

​定義箇所

​get

​パラメーター

​戻り値

​定義箇所

​getAgentCustomAttributes

​パラメーター

​戻り値

​定義箇所

​getAgentSpanStats

​パラメーター

​戻り値

​定義箇所

​getAgentSpans

​パラメーター

​戻り値

​定義箇所

​getAgentTurn

​パラメーター

​戻り値

​定義箇所

​getAgentTurns

​パラメーター

​戻り値

​定義箇所

​getAgentVersions

​パラメーター

​戻り値

​定義箇所

​getAgents

​パラメーター

​戻り値

​定義箇所

​getCall

​パラメーター

​戻り値

​定義箇所

​getCallStack

​戻り値

​定義箇所

​getCalls

​パラメーター

​戻り値

​定義箇所

​パラメーター

​戻り値

​定義箇所

​getCallsIterator

目次

コンストラクタ

プロパティ

メソッド

コンストラクタ

コンストラクタ

パラメーター

戻り値

定義箇所

プロパティ

projectId

定義箇所

settings

定義箇所

traceServerApi

定義箇所

メソッド

addScore

パラメーター

戻り値

定義箇所

createCall

パラメーター

戻り値

定義箇所

finishCall

パラメーター

戻り値

定義箇所

finishCallWithException

パラメーター

戻り値

定義箇所

get

パラメーター

戻り値

定義箇所

getAgentCustomAttributes

パラメーター

戻り値

定義箇所

getAgentSpanStats

パラメーター

戻り値

定義箇所

getAgentSpans

パラメーター

戻り値

定義箇所

getAgentTurn

パラメーター

戻り値

定義箇所

getAgentTurns

パラメーター

戻り値

定義箇所

getAgentVersions

パラメーター

戻り値

定義箇所

getAgents

パラメーター

戻り値

定義箇所

getCall

パラメーター

戻り値

定義箇所

getCallStack

戻り値

定義箇所

getCalls

パラメーター

戻り値

定義箇所

パラメーター

戻り値

定義箇所

getCallsIterator