クラス: Tool - Weights & Biases Documentation

weave / Tool ツール呼び出しを表します。ツール名、 JSON エンコードされた引数、ツール呼び出し ID、および結果を含む execute_tool span を生成します。 weave.startTool() (または turn.startTool()、あるいは llm.startTool()) によって作成され、end() で終了します。span にツールの出力を記録するには、 end() を呼び出す前に result を設定してください。 例

const tool = weave.startTool({
  name: tc.function.name,
  args: tc.function.arguments,
  toolCallId: tc.id,
});
try {
  tool.result = await wikipediaSearch(JSON.parse(tc.function.arguments));
} finally {
  tool.end();
}

階層

SpanBase ↳ Tool

プロパティ

args

• Readonly args: string

定義元

src/genai/tool.ts:52

名

• Readonly name: string

定義元

src/genai/tool.ts:51

result

• Optional result: string 文字列形式のツール出力です。end() で gen_ai.tool.call.result に記録されます。

定義元

src/genai/tool.ts:47

toolCallId

• Readonly toolCallId: string

定義元

src/genai/tool.ts:53

メソッド

addEvent

▸ addEvent(name, attributes?, startTime?): this span に名前付きのイベントを追加します。コンテキストの圧縮、tool ループの検出、guardrail のトリガーなど、span では表されない時点を記録するのに便利です。end() の後に呼び出すと、警告を出して何も行いません。OTel の Span.addEvent に対応しています。

パラメーター

名	タイプ
`name`	`string`
`attributes?`	`Attributes`
`startTime?`	`TimeInput`

戻り値

this 例

span.addEvent('context_compacted', {removedMessages: 12});

継承元

SpanBase.addEvent

定義元

src/genai/spanBase.ts:77

end

▸ end(opts?): void result を span にフラッシュしてから閉じます。冪等です。error を渡すと、 span は失敗としてマークされます。endTime を渡すと、終了時刻を過去の時刻として設定します。

パラメーター

名	タイプ
`opts?`	`SpanEndOptions`

戻り値

void

定義元

src/genai/tool.ts:87

setAttributes

▸ setAttributes(attributes): this span に複数の属性をまとめて設定します。end() の後に呼び出すと警告が表示され、何も実行されません。OTel の Span.setAttributes (および Python SDK の set_attributes) に対応しています。

パラメーター

名	タイプ
`attributes`	`Attributes`

戻り値

this 例

span.setAttributes({'weave.tag': 'prod', 'gen_ai.response.id': id});

継承元

SpanBase.setAttributes

定義元

src/genai/spanBase.ts:63

create

▸ create(opts): Tool

パラメーター

名	タイプ
`opts`	`ToolInit` & `ChildSpanContext`

戻り値

Tool

定義元

src/genai/tool.ts:58

​階層

​目次

​プロパティ

​メソッド

​プロパティ

​args

​定義元

​名

​定義元

​result

​定義元

​toolCallId

​定義元

​メソッド

​addEvent

​パラメーター

​戻り値

​継承元

​定義元

​end

​パラメーター

​戻り値

​定義元

​setAttributes

​パラメーター

​戻り値

​継承元

​定義元

​create

​パラメーター

​戻り値

​定義元

階層

目次

プロパティ

メソッド

プロパティ

args

定義元

名

定義元

result

定義元

toolCallId

定義元

メソッド

addEvent

パラメーター

戻り値

継承元

定義元

end

パラメーター

戻り値

定義元

setAttributes

パラメーター

戻り値

継承元

定義元

create

パラメーター

戻り値

定義元