> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# ツール

> TypeScript SDK リファレンス

ツールの invocation です。ツール名、JSON エンコードされた引数、ツール呼び出し ID、結果を含む `execute_tool` span を出力します。

`weave.startTool()` (または `turn.startTool()`、`llm.startTool()`) で作成し、`end()` で終了します。ツールの出力を span に記録するには、`end()` を呼び出す前に `result` を割り当てます。

定義元: [src/genai/tool.ts:43](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/tool.ts#L43)

## 例

```ts twoslash theme={null}
// @noErrors
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();
}
```

<div id="extends">
  ## 継承
</div>

* `SpanBase`

<div id="properties">
  ## プロパティ
</div>

<div id="args">
  ### args
</div>

> `readonly` **args**: `string`

定義元: [src/genai/tool.ts:52](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/tool.ts#L52)

***

### 名

> `readonly` **名**: `string`

定義元: [src/genai/tool.ts:51](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/tool.ts#L51)

***

<div id="result">
  ### result
</div>

> `optional` **result**: `string`

ツールの出力を文字列として表します。`end()` 時に `gen_ai.tool.call.result` に記録されます。

定義元: [src/genai/tool.ts:47](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/tool.ts#L47)

***

<div id="toolcallid">
  ### toolCallId
</div>

> `readonly` **toolCallId**: `string`

定義元: [src/genai/tool.ts:53](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/tool.ts#L53)

<div id="methods">
  ## メソッド
</div>

<div id="addevent">
  ### ~~addEvent()~~
</div>

<Warning>
  **非推奨。** このデータは代わりに [setAttributes](#setattributes) で記録してください。
  OpenTelemetry では Span Event API (`Span.addEvent`) の段階的な廃止が進められています。この
  メソッドは引き続き動作し、既存の span イベントデータも引き続き有効です。
  [https://opentelemetry.io/blog/2026/deprecating-span-events/](https://opentelemetry.io/blog/2026/deprecating-span-events/) を参照してください。
</Warning>

> **addEvent**(`name`, `attributes?`, `startTime?`): `this`

名前付きイベントを span に追加します。コンテキストの圧縮、ツールループの検出、guardrail のトリガーなど、
span 以外のタイミングを記録する場合に便利です。`end()` の後に呼び出すと警告が出力され、
何も実行されません。OTel の `Span.addEvent` と同様の動作です。

定義元: [src/genai/spanBase.ts:82](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/spanBase.ts#L82)

<div id="parameters">
  #### パラメーター
</div>

<div id="name">
  ##### 名
</div>

`string`

<div id="attributes">
  ##### 属性?
</div>

`Attributes`

<div id="starttime">
  ##### startTime?
</div>

`TimeInput`

<div id="returns">
  #### 戻り値
</div>

`this`

<div id="example">
  #### 例
</div>

```ts twoslash theme={null}
// @noErrors
span.addEvent('context_compacted', {removedMessages: 12});
```

<div id="inherited-from">
  #### 継承元
</div>

`SpanBase.addEvent`

***

<div id="end">
  ### end()
</div>

> **end**(`opts?`): `void`

`result` を span にフラッシュして閉じます。冪等です。span を失敗としてマークするには `error` を渡し、終了時刻を過去に設定するには `endTime` を渡します。

定義元: [src/genai/tool.ts:87](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/tool.ts#L87)

<div id="parameters">
  #### パラメーター
</div>

<div id="opts">
  ##### opts?
</div>

`SpanEndOptions`

<div id="returns">
  #### 戻り値
</div>

`void`

***

<div id="setattributes">
  ### setAttributes()
</div>

> **setAttributes**(`attributes`): `this`

span に複数の属性をまとめて設定します。`end()` の呼び出し後は警告を出力し、
何も実行しません。OTel の `Span.setAttributes` (および Python SDK の
`set_attributes`) と同様です。

定義元: [src/genai/spanBase.ts:63](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/spanBase.ts#L63)

<div id="parameters">
  #### パラメーター
</div>

##### 属性

`Attributes`

<div id="returns">
  #### 戻り値
</div>

`this`

<div id="example">
  #### 例
</div>

```ts twoslash theme={null}
// @noErrors
span.setAttributes({'weave.tag': 'prod', 'gen_ai.response.id': id});
```

<div id="inherited-from">
  #### 継承元
</div>

`SpanBase.setAttributes`