> ## 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.

# 클래스: Tool

> TypeScript SDK 레퍼런스

[weave](../) / Tool

도구 호출입니다. 도구 이름, JSON으로 인코딩된 인수, 도구 호출 ID, 결과를
포함하는 `execute_tool` span을 생성합니다.

`weave.startTool()`(또는 `turn.startTool()`, 또는
`llm.startTool()`)로 생성되며 `end()`로 종료됩니다. span에 도구의 출력을 기록하려면
`end()`를 호출하기 전에 `result`에 값을 부여하세요.

`예시`

```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="hierarchy">
  ## 계층 구조
</div>

* `SpanBase`

  ↳ `Tool`

<div id="table-of-contents">
  ## 목차
</div>

<div id="properties">
  ### 속성
</div>

* [args](./tool#args)
* [name](./tool#name)
* [result](./tool#result)
* [toolCallId](./tool#toolcallid)

<div id="methods">
  ### 방법
</div>

* [addEvent](./tool#addevent)
* [end](./tool#end)
* [setAttributes](./tool#setattributes)
* [create](./tool#create)

## 속성

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

• `Readonly` **args**: `string`

<div id="defined-in">
  #### 정의 위치
</div>

[src/genai/tool.ts:52](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/genai/tool.ts#L52)

***

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

• `Readonly` **name**: `string`

<div id="defined-in">
  #### 정의 위치
</div>

[src/genai/tool.ts:51](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/genai/tool.ts#L51)

***

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

• `선택` **result**: `string`

도구의 출력을 string으로 나타낸 값입니다. `end()`에서 `gen_ai.tool.call.result`에 기록됩니다.

<div id="defined-in">
  #### 정의 위치
</div>

[src/genai/tool.ts:47](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/genai/tool.ts#L47)

***

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

• `Readonly` **toolCallId**: `string`

<div id="defined-in">
  #### 정의 위치
</div>

[src/genai/tool.ts:53](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/genai/tool.ts#L53)

## 방법

<div id="addevent">
  ### addEvent
</div>

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

span에 이름이 지정된 event를 추가합니다. 컨텍스트 압축, 도구 루프 감지,
또는 가드레일 트리거처럼 span이 아닌 시점을 표시할 때 유용합니다. `end()` 이후에는 경고를
표시하고 no-op으로 처리됩니다. OTel `Span.addEvent`와 동일하게 동작합니다.

<div id="parameters">
  #### 매개변수
</div>

| 이름            | 유형           |
| :------------ | :----------- |
| `name`        | `string`     |
| `attributes?` | `Attributes` |
| `startTime?`  | `TimeInput`  |

<div id="returns">
  #### 반환값
</div>

`this`

`예시`

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

<div id="inherited-from">
  #### 상속됨
</div>

SpanBase.addEvent

<div id="defined-in">
  #### 정의 위치
</div>

[src/genai/spanBase.ts:77](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/genai/spanBase.ts#L77)

***

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

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

`result`를 span에 플러시한 후 닫습니다. 멱등성을 가집니다. span을 실패로 표시하려면
`error`를 전달하세요. 닫는 시점을 과거로 소급하려면 `endTime`을 전달하세요.

<div id="parameters">
  #### 매개변수
</div>

| 이름      | 유형               |
| :------ | :--------------- |
| `opts?` | `SpanEndOptions` |

<div id="returns">
  #### 반환값
</div>

`void`

<div id="defined-in">
  #### 정의 위치
</div>

[src/genai/tool.ts:87](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/genai/tool.ts#L87)

***

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

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

`span`에 여러 속성을 한 번에 설정합니다. `end()` 호출 후에는 경고를 표시하고 아무 작업도 수행하지 않습니다.
OTel `Span.setAttributes`(및 Python SDK의
`set_attributes`)와 동일하게 동작합니다.

<div id="parameters">
  #### 매개변수
</div>

| 이름           | 유형           |
| :----------- | :----------- |
| `attributes` | `Attributes` |

<div id="returns">
  #### 반환값
</div>

`this`

`예시`

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

<div id="inherited-from">
  #### 상속됨
</div>

SpanBase.setAttributes

<div id="defined-in">
  #### 정의 위치
</div>

[src/genai/spanBase.ts:63](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/genai/spanBase.ts#L63)

***

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

▸ **create**(`opts`): [`Tool`](./tool)

<div id="parameters">
  #### 매개변수
</div>

| 이름     | 유형                                                        |
| :----- | :-------------------------------------------------------- |
| `opts` | [`ToolInit`](../interfaces/toolinit) & `ChildSpanContext` |

<div id="returns">
  #### 반환값
</div>

[`Tool`](./tool)

<div id="defined-in">
  #### 정의 위치
</div>

[src/genai/tool.ts:58](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/genai/tool.ts#L58)