> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-sa-self-managed-config-change-restart.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Tool

> Référence du SDK TypeScript

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "voir la source" : <>
    <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>
    Source GitHub
      </>}
  </a>;

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

Une invocation d'outil. Émet un span `execute_tool` contenant le nom de l'outil,
les arguments, l'ID de l'appel d'outil et le résultat. Les arguments et les
résultats de type chaîne sont enregistrés tels quels ; les autres valeurs JSON sont sérialisées.

Créée par `weave.startTool()` (ou `turn.startTool()`, ou
`llm.startTool()`) et terminée par `end()`, qui accepte le résultat et
des métadonnées d'erreur facultatives.

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

```ts twoslash theme={null}
// @noErrors
const tool = weave.startTool({name: 'get_weather', args: {city: 'Tokyo'}});
try {
  const result = await getWeather('Tokyo');
  tool.end({result});
} catch (error) {
  tool.end({error: error as Error, errorType: 'weather_error'});
  throw error;
}
```

<div id="extends">
  ## Hérite de
</div>

* `SpanBase`

<div id="properties">
  ## Propriétés
</div>

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

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

***

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

> `readonly` **nom**: `string`

***

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

<Warning>
  **Obsolète.** Passez plutôt `result` à `end()`.
</Warning>

> `facultatif` **result**: `string`

Sortie de l’outil sous forme de chaîne. Préférez passer `result` à `end()`.

***

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

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

<div id="methods">
  ## Méthodes
</div>

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

<Warning>
  **Obsolète.** Enregistrez plutôt ces données avec [setAttributes](#setattributes).
  OpenTelemetry abandonne progressivement l’API d’événements de span (`Span.addEvent`). Cette
  méthode fonctionne toujours et les données d’événements de span existantes restent valides.
  Voir [https://opentelemetry.io/blog/2026/deprecating-span-events/](https://opentelemetry.io/blog/2026/deprecating-span-events/)
</Warning>

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

Ajoute un événement nommé au span. Utile pour marquer des moments non associés à un span, tels que
la compaction du contexte, la détection de boucles d’outils ou le déclenchement de guardrails. Émet un avertissement et
ne fait rien après `end()`. Reproduit `Span.addEvent` d’OTel.

<div id="parameters">
  #### Paramètres
</div>

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

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

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

<div id="returns">
  #### Renvoie
</div>

`this`

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

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

<div id="inherited-from">
  #### Hérité de
</div>

`SpanBase.addEvent`

***

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

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

Enregistrez un résultat et un type d'erreur facultatifs, puis fermez le span. Idempotent.
Transmettez `error` pour marquer le span comme ayant échoué et `endTime` pour antidater la fermeture.

<div id="parameters-2">
  #### Paramètres
</div>

<ParamField path="opts" type="ToolEndOptions">
  Voir [`ToolEndOptions`](./toolendoptions).
</ParamField>

<div id="returns-2">
  #### Renvoie
</div>

`void`

***

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

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

Définit simultanément plusieurs attributs sur le span. Émet un avertissement et ne fait rien après
`end()`. Correspond à `Span.setAttributes` d’OTel (ainsi qu’à
`set_attributes` du SDK Python).

<div id="parameters-3">
  #### Paramètres
</div>

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

<div id="returns-3">
  #### Renvoie
</div>

`this`

<div id="example-3">
  #### Exemple
</div>

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

<div id="inherited-from-2">
  #### Hérité de
</div>

`SpanBase.setAttributes`