> ## 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 레퍼런스

도구 호출입니다. 도구 이름, 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)

***

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

> `readonly` **name**: `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>

> `선택` **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-event 데이터도 유효합니다.
  [https://opentelemetry.io/blog/2026/deprecating-span-events/](https://opentelemetry.io/blog/2026/deprecating-span-events/)를 참조하세요.
</Warning>

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

span에 이름이 지정된 이벤트를 추가합니다. 컨텍스트 압축, 도구 루프 감지 또는
가드레일 위반과 같이 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>

##### 이름

`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`