> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-dependabot-npm-and-yarn-scripts-css-minify-npm.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# WeaveClient
> Référence du SDK TypeScript
export const GitHubLink = ({url, compact = false}) =>
{compact ? "voir la source" : <>
Source GitHub
}
;
Propriétés
projectId
> **projectId** : `string`
***
settings
> **settings** : `object`
attributes
> `readonly` **attributes**: `Record`\<`string`, `any`>
Un ensemble d'attributs appliqués à chaque trace produite par ce client.
genai
> `readonly` **genai** : `objet`
genai.batchOptions
> `optional` **batchOptions** : `BufferConfig`
Configuration de `BatchSpanProcessor`. Ignorée sauf si `spanProcessor === 'batch'`.
genai.spanProcessor
> `optional` **spanProcessor**: `"batch"` | `"simple"` | `SpanProcessor`
Mode d'export des spans GenAI.
* `'batch'` (par défaut) : `BatchSpanProcessor`, adapté aux agents en
production et aux processus de longue durée.
* `'simple'` : `SimpleSpanProcessor`, une requête HTTP POST par span. Utile pour
les tests et les CLI de courte durée, lorsqu'un vidage déterministe importe plus
que le débit.
* Instance de `SpanProcessor` : un processor fourni par l'utilisateur. L'appelant
gère son cycle de vie ; l'exporter OTLP de Weave ciblant `/agents/otel/v1/traces`
n'est pas utilisé.
printCallLink
> `readonly` **printCallLink**: `boolean`
Affiche dans le terminal les liens vers l'interface Weave pour les ops.
Par défaut
`true`
useCallsComplete
> **useCallsComplete** : `boolean`
Envoie les appels terminés au point de terminaison `calls/complete` (début et fin
appariés côté client) au lieu de l'ancien chemin `call/upsert_batch`.
Par défaut
`true`
useOTelV2
> **useOTelV2** : `boolean`
Achemine les intégrations compatibles OTel via leur variante OTel.
Par défaut
`true`
***
traceServerApi
> **traceServerApi**: `Api`\<`any`>
Méthodes
addScore()
> **addScore**(`predictCallId`, `scorerCallId`, `runnableRefUri`, `scorerOutput`) : `Promise`\<`string`>
Ajoute le résultat d’un scorer (par exemple, sa sortie) à un appel.
Utilisé dans une évaluation impérative pour joindre les résultats du scorer aux appels de prédiction.
Paramètres
ID de l'appel predict auquel joindre le feedback
ID de l'appel du scorer ayant généré le feedback
URI du scorer (réf. d'op ou d'objet)
Sortie du scorer
Type complet : `{ callId: string; childSummary: Record; displayName?: string; opName?: string; traceId: string; } | undefined`
Renvoie
`Promise`\<`void`>
***
flush()
> **flush**(): `Promise`\<`void`>
Transmet au serveur tous les appels mis en mémoire tampon. À attendre avant `process.exit()`.
Renvoie
`Promise`\<`void`>
***
get()
> **get**(`ref`) : `Promise`\<`any`>
Paramètres
Voir [`ObjectRef`](../classes/objectref).
Renvoie
`Promise`\<`any`>
***
getAgentCustomAttributes()
> **getAgentCustomAttributes**(`options`): `Promise`\<[`Réponse`](../type-aliases/response)\<\{ `attributes?`: `object`\[]; `has_more?`: `boolean`; `limit?`: `number`; `offset?`: `number`; }>>
Découvrez les clés d’attributs personnalisés typés observées dans les spans d’agent du
projet. Chaque ligne de résultat correspond à un triplet `(source, key, value_type)`, accompagné du
nombre de spans qui le portent. Les API de requête, de regroupement et de statistiques des
spans l’utilisent pour référencer les attributs personnalisés.
Filtrez les spans pris en compte en transmettant `query` (un filtre de span
structuré), `startedAfter` / `startedBefore` (ISO-8601), ou les deux. Utilisez
`limit` / `offset` pour parcourir les clés découvertes par pages.
> **getAgents**(`options?`): `Promise`\<[`Réponse`](../type-aliases/response)\<[`GetAgentsResult`](../type-aliases/getagentsresult)>>
Répertorie les agents avec des statistiques agrégées.
> **getAgentSpans**(`options`) : `Promise`\<[`Réponse`](../type-aliases/response)\<[`GetAgentSpansResult`](../type-aliases/getagentspansresult)>>
Interroge les spans d’agent, éventuellement filtrés par nom d’agent et/ou par une expression de requête de type Mongo.
> **getAgentSpanStats**(`options`) : `Promise`\<[`Réponse`](../type-aliases/response)\<\{ `bucket_type?`: `"number"` | `"time"`; `columns?`: `object`\[]; `end`: `string`; `granularity?`: `number` | `null`; `rows?`: `Record`\<`string`, `string` | `number` | `boolean` | `null`>\[]; `start`: `string`; `timezone`: `string`; }>>
Agrégations sur les spans d’agent du projet, renvoyées sous forme de lignes et de métadonnées de colonnes
adaptées aux visualisations de séries temporelles ou par compartiments.
`start` (requis) et `end` définissent la fenêtre temporelle. Chaque entrée de
`metrics` indique un champ à extraire et la façon de l’agréger (`sum`,
`avg`, `count`, percentiles, etc.). Transmettez `granularity` (en secondes) pour
regrouper les lignes par intervalle temporel, ou `groupBy` pour ventiler les résultats par agent /
provider / model / etc. `query` filtre les spans sous-jacents avant
l’agrégation.
> **getAgentTurns**(`options`): `Promise`\<[`Réponse`](../type-aliases/response)\<[`GetAgentTurnsResult`](../type-aliases/getagentturnsresult)>>
Obtenir les données (y compris les messages) de nombreux tours de conversation (par conversationId).
```ts twoslash theme={null}
// @noErrors
const client = await weave.init('entity/project');
const resp = await client.getAgentTurns({
conversationId: 'trace_c50312356de3487fa90e381c9399b5b4',
limit: 20,
includeFeedback: true,
});
for (const turn of resp.data.turns ?? []) {
console.log(turn.trace_id, turn.root_span_name);
for (const message of turn.messages ?? []) {
if (message.user_message) console.log('user:', message.user_message);
if (message.assistant_message) console.log('assistant:', message.assistant_message);
}
}
console.log(`total turns: ${resp.data.total_turns}, has more: ${resp.data.has_more}`);
```
***
getAgentVersions()
> **getAgentVersions**(`options`) : `Promise`\<[`Réponse`](../type-aliases/response)\<[`GetAgentVersionsResult`](../type-aliases/getagentversionsresult)>>
Liste les versions d’un agent donné.
> **linkPromptToRegistry**(`prompt`, `options`): `Promise`\<\{ `version_index`: `number` | `null`; }>
Associe une version publiée d’un prompt à un portefeuille de registre.
Attributs
Nom d'affichage
ID
Entrées
Nom de l'op
Dump Otel
ID parent
ID du project
Date de démarrage
**Format**
date-time
ID du thread
ID de la trace
ID du tour de conversation
ID du run W\&B
Étape du run W\&B
ID de l'utilisateur W\&B
Ne définissez pas cette valeur directement. Le serveur renseigne automatiquement ce champ.
Renvoie
`void`
***
saveOp()
> **saveOp**(`op`, `objId?`): `Promise`\<`OpRef`>
Paramètres
Voir [`Op`](../type-aliases/op).
Renvoie
`Promise`\<`OpRef`>
***
searchAgents()
> **searchAgents**(`options`) : `Promise`\<[`Réponse`](../type-aliases/response)\<\{ `results`: `objet`\[]; `total_conversations?`: `number`; }>>
Recherche en texte intégral parmi les messages d’agent du projet. Renvoie les résultats
regroupés par conversation, avec un aperçu de chaque message correspondant.
`query` correspond au terme de recherche en texte intégral. Transmettez une chaîne vide pour récupérer
tous les messages correspondant aux filtres structurés (`agentName`,
`conversationId`, `traceId`) sans effectuer de recherche textuelle. Utilisez `limit` /
`offset` pour parcourir les résultats page par page.
```ts twoslash theme={null}
// @noErrors
const client = await weave.init('entity/project');
const resp = await client.searchAgents({
query: 'Liverpool',
agentName: 'Assistant',
limit: 20,
});
for (const conversation of resp.data.results ?? []) {
console.log(`${conversation.conversation_id} (${conversation.agent_name})`);
for (const match of conversation.matched_messages) {
console.log(` [${match.role}] ${match.content_preview}`);
}
}
console.log(`total conversations: ${resp.data.total_conversations}`);
```
***
serializeAudio()
> **serializeAudio**(`data`, `audioType?`): `Promise`\<\{ `_type`: `"CustomWeaveType"`; `files`: `Record`\<`string`, `string`>; `load_op`: `string`; `weave_type`: \{ `type`: `string`; }; }>
Téléverse des octets audio bruts vers le magasin de contenu Weave et renvoie l’espace réservé
`CustomWeaveType` pouvant être intégré à une sortie d’appel.
Utilisez cette méthode lorsque vous créez manuellement des sorties d’appel (par ex. via `saveCallEnd`)
et que le pipeline de sérialisation automatique de `finishCall` n’est pas utilisé.
Paramètres
Données audio brutes (WAV pour une compatibilité optimale avec les navigateurs)
Format de fichier — seul 'wav' est actuellement pris en charge