Passer au contenu principal
weave / Tool Un appel d’outil. Émet un span execute_tool contenant le nom de l’outil, les arguments encodés en JSON, l’identifiant de l’appel d’outil et le résultat. Créé par weave.startTool() (ou turn.startTool(), ou llm.startTool()) et terminé avec end(). Attribuez result avant d’appeler end() pour enregistrer le résultat de l’outil dans le span. Exemple 
const  = weave.startTool({
  : tc.function.name,
  : tc.function.arguments,
  : tc.id,
});
try {
  .result = await wikipediaSearch(.(tc.function.arguments));
} finally {
  .end();
}

​
Hiérarchie

  • SpanBase ↳ Tool

​
Table des matières

​
Propriétés

​
Méthodes

​
Propriétés

​
args

• Readonly args: string

​
Défini dans

src/genai/tool.ts:52

​
nom

• Readonly nom: string

​
Défini dans

src/genai/tool.ts:51

​
result

• Facultatif result: string Sortie de l’outil sous forme de chaîne de caractères. Enregistrée dans gen_ai.tool.call.result à end().

​
Défini dans

src/genai/tool.ts:47

​
toolCallId

• Readonly toolCallId: string

​
Défini dans

src/genai/tool.ts:53

​
Méthodes

​
addEvent

▸ addEvent(name, attributes?, startTime?): this Ajoute un événement nommé au span. Utile pour marquer des événements ponctuels qui ne constituent pas un span, comme 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(). Correspond à OTel Span.addEvent.

​
Paramètres

NomType
namestring
attributes?Attributes
startTime?TimeInput

​
Renvoie

this Exemple 
span.addEvent('context_compacted', {: 12});

​
Hérité de

SpanBase.addEvent

​
Défini dans

src/genai/spanBase.ts:77

​
end

▸ end(opts?): void Vide result dans le span et le ferme. Idempotent. Passez error pour marquer le span comme ayant échoué ; passez endTime pour antidater la fermeture.

​
Paramètres

NomType
opts?SpanEndOptions

​
Renvoie

void

​
Défini dans

src/genai/tool.ts:87

​
setAttributes

▸ setAttributes(attributes): this Définit plusieurs attributs sur le span en une seule opération. Émet un avertissement et ne fait rien après end(). Reprend le comportement de Span.setAttributes d’OTel (ainsi que celui de set_attributes dans le SDK Python).

​
Paramètres

NomType
attributesAttributes

​
Renvoie

this Exemple 
span.setAttributes({'weave.tag': 'prod', 'gen_ai.response.id': id});

​
Hérité de

SpanBase.setAttributes

​
Défini dans

src/genai/spanBase.ts:63

​
create

▸ create(opts): Tool

​
Paramètres

NomType
optsToolInit & ChildSpanContext

​
Renvoie

Tool

​
Défini dans

src/genai/tool.ts:58