> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-07-07-docs-update-ts-examples-to-prefer-calling.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# SubAgent

> TypeScript SDK リファレンス

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "ソースを表示" : <>
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub のソース
      </>}
  </a>;

<GitHubLink url="https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/subagent.ts#L84" />

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

* `SpanBase`

<div id="accessors">
  ## アクセサー
</div>

<div id="model">
  ### モデル
</div>

<div id="get-signature">
  #### 取得シグネチャ
</div>

> **get** **model**(): `string`

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

`string`

***

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

<div id="get-signature-2">
  #### 取得シグネチャ
</div>

> **get** **name**(): `string`

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

`string`

<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に追加します。コンテキストの圧縮、ツールループの検出、ガードレールのトリガーなど、span以外のタイミングを示す際に役立ちます。
`end()` の呼び出し後は警告を出力し、何も実行しません。OTel の `Span.addEvent` と同様の動作をします。

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

<ParamField path="name" type="string" required />

<ParamField path="attributes" type="Attributes" />

<ParamField path="startTime" type="TimeInput" />

<div id="returns-3">
  #### 戻り値
</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`

現在のフィールド値を読み取り (`start` 以降に `record()` で行われた変更を反映) 、span を閉じます。冪等です。`error` を渡すと失敗としてマークされ、`endTime` を渡すと終了時刻を過去に設定できます。

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

<ParamField path="opts" type="object">
  <Expandable title="プロパティ" defaultOpen>
    <ParamField path="endTime" type="TimeInput" />

    <ParamField path="error" type="Error" />
  </Expandable>
</ParamField>

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

`void`

***

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

> **record**(`opts`): `this`

可変フィールドの任意のサブセットを一括設定します。既存の値はマージではなく置換されます。
入力メッセージと出力メッセージは、span の終了時にシリアライズされます。

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

<ParamField path="opts" type="object" required>
  <Expandable title="プロパティ" defaultOpen>
    <ParamField path="agentDescription" type="string" />

    <ParamField path="agentId" type="string" />

    <ParamField path="agentVersion" type="string" />

    <ParamField path="messages" type="Message[]">
      [`Message`](./message) を参照してください。
    </ParamField>

    <ParamField path="model" type="string" />

    <ParamField path="name" type="string" />

    <ParamField path="outputMessages" type="Message[]">
      [`Message`](./message) を参照してください。
    </ParamField>

    <ParamField path="systemInstructions" type="string[]" />
  </Expandable>
</ParamField>

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

`this`

***

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

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

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

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

<ParamField path="attributes" type="Attributes" required />

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

`this`

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

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

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

`SpanBase.setAttributes`

***

<div id="startllm">
  ### startLLM()
</div>

> **startLLM**(`opts`): [`LLM`](./llm)

この SubAgent の配下にネストされた子 LLM span を開始します。

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

<ParamField path="opts" type="LLMInit" required>
  [`LLMInit`](./llminit) を参照してください。
</ParamField>

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

[`LLM`](./llm)

***

<div id="startsubagent">
  ### startSubagent()
</div>

> **startSubagent**(`opts`): `SubAgent`

この SubAgent の配下に、ネストされた SubAgent span を開始します。

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

<ParamField path="opts" type="SubAgentInit" required>
  [`SubAgentInit`](./subagentinit) を参照してください。
</ParamField>

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

`SubAgent`

***

<div id="starttool">
  ### startTool()
</div>

> **startTool**(`opts`): [`Tool`](./tool)

この SubAgent の配下にネストされた子 Tool span を開始します。

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

<ParamField path="opts" type="ToolInit" required>
  [`ToolInit`](./toolinit) を参照してください。
</ParamField>

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

[`Tool`](./tool)