Classe : WeaveClient - Weights & Biases Documentation

weave / WeaveClient

Table des matières

Constructeurs

constructeur

Propriétés

Méthodes

Constructeurs

constructeur

• new WeaveClient(«destructured»): WeaveClient

Paramètres

Nom	Type
`«destructured»`	`objet`
› `projectId`	`string`
› `settings?`	`Partial`<`Settings`>
› `traceServerApi`	`Api`<`any`>

Renvoie

WeaveClient

Défini dans

src/weaveClient.ts:459

Propriétés

projectId

• projectId: string

Défini dans

src/weaveClient.ts:456

settings

• settings: Settings

Défini dans

src/weaveClient.ts:457

traceServerApi

• traceServerApi: Api<any>

Défini dans

src/weaveClient.ts:455

Méthodes

addScore

▸ addScore(predictCallId, scorerCallId, runnableRefUri, scorerOutput): Promise<string> Ajoute un résultat de scorer (par ex. la sortie du scorer) à un appel. Utilisé dans l’évaluation impérative pour associer les résultats du scorer aux appels de prédiction.

Paramètres

Nom	Type	Description
`predictCallId`	`string`	ID de l’appel `predict` auquel associer le retour
`scorerCallId`	`string`	ID de l’appel du scorer ayant généré le retour
`runnableRefUri`	`string`	URI du scorer (op ou réf. d’objet)
`scorerOutput`	`any`	Résultat du scorer

Renvoie

Promise<string>

Défini dans

src/weaveClient.ts:1727

createCall

▸ createCall(internalCall, opRef, params, parameterNames, thisArg, currentCall, parentCall, startTime, displayName?, attributes?): Promise<void>

Paramètres

Nom	Type
`internalCall`	`InternalCall`
`opRef`	`any`
`params`	`any`[]
`parameterNames`	`ParameterNamesOption`
`thisArg`	`any`
`currentCall`	`CallStackEntry`
`parentCall`	`undefined`	`CallStackEntry`
`startTime`	`Date`
`displayName?`	`string`
`attributes?`	`Record`<`string`, `any`>

Renvoie

Promise<void>

Défini dans

src/weaveClient.ts:1570

finishCall

▸ finishCall(call, result, currentCall, parentCall, summarize, endTime, startCallPromise): Promise<void>

Paramètres

Nom	Type
`call`	`InternalCall`
`result`	`any`
`currentCall`	`CallStackEntry`
`parentCall`	`undefined`	`CallStackEntry`
`summarize`	`undefined`	(`result`: `any`) => `Record`<`string`, `any`>
`endTime`	`Date`
`startCallPromise`	`Promise`<`void`>

Renvoie

Promise<void>

Défini dans

src/weaveClient.ts:1630

finishCallWithException

▸ finishCallWithException(call, error, currentCall, parentCall, endTime, startCallPromise): Promise<void>

Paramètres

Nom	Type
`call`	`InternalCall`
`error`	`any`
`currentCall`	`CallStackEntry`
`parentCall`	`undefined`	`CallStackEntry`
`endTime`	`Date`
`startCallPromise`	`Promise`<`void`>

Renvoie

Promise<void>

Défini dans

src/weaveClient.ts:1672

get

▸ get(ref): Promise<any>

Paramètres

Nom	Type
`ref`	`ObjectRef`

Renvoie

Promise<any>

Défini dans

src/weaveClient.ts:1025

getAgentCustomAttributes

▸ getAgentCustomAttributes(options): Promise<Réponse<GetAgentCustomAttributesResult>> Découvrez les clés d’attributs personnalisés typés observées sur les spans d’agent dans le projet. Chaque ligne de résultat correspond à un triplet (source, key, value_type), ainsi qu’au nombre de spans qui le portent ; c’est ce qu’utilisent les API de requête/groupe/stats des spans 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.

Paramètres

Nom	Type
`options`	`GetAgentCustomAttributesOptions`

Renvoie

Promise<Réponse<GetAgentCustomAttributesResult>> Exemple

const client = await weave.init('entity/project');
const resp = await client.getAgentCustomAttributes({
  query: {
    $expr: {
      $eq: [{$getField: 'agent_name'}, {$literal: 'my-agent'}],
    },
  },
  startedAfter: '2026-06-15T00:00:00Z',
  limit: 200,
});

for (const attr of resp.data.attributes ?? []) {
  console.log(`${attr.source}.${attr.key} (${attr.value_type}): ${attr.span_count}`);
}

Défini dans

src/weaveClient.ts:772

getAgentSpanStats

▸ getAgentSpanStats(options): Promise<Réponse<GetAgentSpanStatsResult>> Agrégations sur les spans d’agent dans le projet, renvoyées sous forme de lignes + métadonnées de colonne adaptées aux visualisations de séries chronologiques / en buckets. start (requis) et end définissent la fenêtre temporelle. Chaque entrée de metrics déclare un champ à extraire et la façon de l’agréger (sum, avg, count, percentiles, etc.). Transmettez granularity (secondes) pour regrouper les lignes par bucket temporel, ou groupBy pour ventiler les résultats par agent / provider / model / etc. query filtre les spans correspondants avant l’agrégation.

Paramètres

Nom	Type
`options`	`GetAgentSpanStatsOptions`

Renvoie

Promise<Réponse<GetAgentSpanStatsResult>> Exemple

const client = await weave.init('entity/project');
const resp = await client.getAgentSpanStats({
  start: '2026-06-10T00:00:00Z',
  end: '2026-06-23T00:00:00Z',
  granularity: 86400, // une ligne par jour
  metrics: [
    {
      alias: 'total_input_tokens',
      value_type: 'number',
      aggregations: ['sum'],
      value: {source: 'field', key: 'input_tokens'},
    },
  ],
  groupBy: [{key: 'agent_name'}],
});

for (const row of resp.data.rows ?? []) {
  console.log(row.started_at_bucket, row.agent_name, row.total_input_tokens);
}

Défini dans

src/weaveClient.ts:621

getAgentSpans

▸ getAgentSpans(options): Promise<Réponse<GetAgentSpansResult>> Interroge les spans des agents, avec un filtrage facultatif par nom d’agent et/ou via une expression de requête de type Mongo.

Paramètres

Nom	Type
`options`	`GetAgentSpansOptions`

Renvoie

Promise<Réponse<GetAgentSpansResult>> Exemple

const client = await weave.init('entity/project');
const resp = await client.getAgentSpans({agentName: 'my-agent', limit: 20});

for (const span of resp.data.spans) {
  console.log(span.span_id, span.span_name, span.input_tokens);
}

Exemple

const client = await weave.init('entity/project');

const resp = await client.getAgentSpans({
  agentName: 'my-agent',
  query: {
    $expr: {$gt: [{$getField: 'input_tokens'}, {$literal: 1000}]},
  },
});

for (const span of resp.data.spans) {
  console.log(span.span_id, span.span_name, span.input_tokens);
}

Défini dans

src/weaveClient.ts:566

getAgentTurn

▸ getAgentTurn(options): Promise<Réponse<AgentTraceChatRes>> Obtenez les données (y compris les messages) d’un seul tour de conversation (par traceId).

Paramètres

Nom	Type
`options`	`GetAgentTurnOptions`

Renvoie

Promise<Réponse<AgentTraceChatRes>> Exemple

const client = await weave.init('entity/project');
const resp = await client.getAgentTurn({
  traceId: '01997b8a-2c89-7c4d-9d0e-2f7e5b9a1b2c',
  includeFeedback: true,
});

console.log(resp.data.root_span_name, resp.data.total_duration_ms);

for (const message of resp.data.messages ?? []) {
  if (message.user_message) console.log('user:', message.user_message);
  if (message.assistant_message) console.log('assistant:', message.assistant_message);
}

Défini dans

src/weaveClient.ts:655

getAgentTurns

▸ getAgentTurns(options): Promise<Réponse<GetAgentTurnsResult>> Obtenir les données (y compris les messages) de plusieurs tours de conversation (par conversationId).

Paramètres

Nom	Type
`options`	`GetAgentTurnsOptions`

Renvoie

Promise<Réponse<GetAgentTurnsResult>> Exemple

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}`);

Défini dans

src/weaveClient.ts:688

getAgentVersions

▸ getAgentVersions(options): Promise<Réponse<GetAgentVersionsResult>> Répertorie les versions d’un agent donné.

Paramètres

Nom	Type
`options`	`GetAgentVersionsOptions`

Renvoie

Promise<Réponse<GetAgentVersionsResult>> Exemple

const client = await weave.init('entity/project');
const resp = await client.getAgentVersions({agentName: 'my-agent', limit: 20});

for (const version of resp.data.versions) {
  console.log(version.agent_version, version.total_input_tokens);
}

console.log(`total count: ${resp.data.total_count}`)

Défini dans

src/weaveClient.ts:522

getAgents

▸ getAgents(options?): Promise<Réponse<GetAgentsResult>> Renvoie la liste des agents avec des statistiques agrégées.

Paramètres

Nom	Type
`options`	`GetAgentsOptions`

Renvoie

Promise<Réponse<GetAgentsResult>> Exemple

const client = await weave.init('entity/project');
const resp = await client.getAgents({limit: 20});

for (const agent of resp.data.agents) {
  console.log(agent.agent_name, agent.total_input_tokens);
}

console.log(`total count: ${resp.data.total_count}`)

Défini dans

src/weaveClient.ts:488

getCall

▸ getCall(callId, includeCosts?): Promise<Appel>

Paramètres

Nom	Type	Valeur par défaut
`callId`	`string`	`undefined`
`includeCosts`	`boolean`	`false`

Renvoie

Promise<Appel>

Défini dans

src/weaveClient.ts:902

getCallStack

▸ getCallStack(): CallStack

Renvoie

CallStack

Défini dans

src/weaveClient.ts:1482

getCalls

▸ getCalls(options?): Promise<Appel[]>

Paramètres

Nom	Type
`options?`	`GetCallsOptions`

Renvoie

Promise<Appel[]>

Défini dans

src/weaveClient.ts:935 ▸ getCalls(options?, includeCosts?, limit?): Promise<Appel[]>

Paramètres

Nom	Type
`options?`	`CallsFilter`
`includeCosts?`	`boolean`
`limit?`	`number`

Renvoie

Promise<Appel[]>

Défini dans

src/weaveClient.ts:936

getCallsIterator

▸ getCallsIterator(options?, includeCosts?, limit?): AsyncIterableIterator<CallSchema, any, any>

Paramètres

Nom	Type
`options?`	`CallsFilter`
`includeCosts?`	`boolean`
`limit?`	`number`

Renvoie

AsyncIterableIterator<CallSchema, any, any>

Défini dans

src/weaveClient.ts:957 ▸ getCallsIterator(options?): AsyncIterableIterator<CallSchema, any, any>

Paramètres

Nom	Type
`options?`	`GetCallsOptions`

Renvoie

AsyncIterableIterator<CallSchema, any, any>

Défini dans

src/weaveClient.ts:962

getCurrentAttributes

▸ getCurrentAttributes(): Record<string, any>

Renvoie

Record<string, any>

Défini dans

src/weaveClient.ts:1486

linkPromptToRegistry

▸ linkPromptToRegistry(prompt, options): Promise<LinkAssetToRegistryRes> Lie une version publiée du prompt à un portefeuille du registre.

Paramètres

Nom	Type
`prompt`	`RegistryLinkable`
`options`	`LinkPromptToRegistryOptions`

Renvoie

Promise<LinkAssetToRegistryRes>

Défini dans

src/weaveClient.ts:1181

publish

▸ publish(obj, objId?): Promise<ObjectRef>

Paramètres

Nom	Type
`obj`	`any`
`objId?`	`string`

Renvoie

Promise<ObjectRef>

Défini dans

src/weaveClient.ts:890

pushNewCall

▸ pushNewCall(): objet

Renvoie

objet

Nom	Type
`currentCall`	`CallStackEntry`
`newStack`	`CallStack`
`parentCall?`	`CallStackEntry`

Défini dans

src/weaveClient.ts:1490

runWithAttributes

▸ runWithAttributes<T>(attributes, fn): T

Paramètres de type

Nom
`T`

Paramètres

Nom	Type
`attributes`	`Record`<`string`, `any`>
`fn`	() => `T`

Renvoie

T

Défini dans

src/weaveClient.ts:1498

runWithCallStack

▸ runWithCallStack<T>(callStack, fn): T

Paramètres de type

Nom
`T`

Paramètres

Nom	Type
`callStack`	`CallStack`
`fn`	() => `T`

Renvoie

T

Défini dans

src/weaveClient.ts:1494

saveCallEnd

▸ saveCallEnd(callEnd): void

Paramètres

Nom	Type
`callEnd`	`EndedCallSchemaForInsert`

Renvoie

void

Défini dans

src/weaveClient.ts:1477

saveCallStart

▸ saveCallStart(callStart): void

Paramètres

Nom	Type
`callStart`	`StartedCallSchemaForInsert`

Renvoie

void

Défini dans

src/weaveClient.ts:1472

saveOp

▸ saveOp(op, objId?): Promise<OpRef>

Paramètres

Nom	Type
`op`	`Op`<(…`args`: `any`[]) => `any`>
`objId?`	`string`

Renvoie

Promise<OpRef>

Défini dans

src/weaveClient.ts:1537

searchAgents

▸ searchAgents(options): Promise<Réponse<SearchAgentsResult>> Recherche en texte intégral dans les messages des agents du projet. Renvoie les correspondances regroupées par conversation, avec un aperçu de chaque message correspondant. query est le terme de recherche en texte intégral. Passez une chaîne vide pour récupérer tous les messages correspondant aux filtres structurés (agentName, conversationId, traceId) sans tenir compte d’une correspondance textuelle. Utilisez limit / offset pour paginer les résultats.

Paramètres

Nom	Type
`options`	`SearchAgentsOptions`

Renvoie

Promise<Réponse<SearchAgentsResult>> Exemple

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}`);

Défini dans

src/weaveClient.ts:730

serializeAudio

▸ serializeAudio(data, audioType?): Promise<SerializedFileBlob> Téléversez des octets audio bruts dans le stockage de contenu Weave, puis renvoyez l’espace réservé CustomWeaveType qui peut être intégré dans la sortie d’un 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

Nom	Type	Valeur par défaut	Description
`data`	`Buffer`<`ArrayBufferLike`>	`undefined`	Octets audio bruts (WAV pour une compatibilité optimale avec les navigateurs)
`audioType`	`"wav"`	`DEFAULT_AUDIO_TYPE`	Format de fichier — actuellement, seul « wav » est pris en charge

Renvoie

Promise<SerializedFileBlob>

Défini dans

src/weaveClient.ts:1424

updateCall

▸ updateCall(callId, displayName): Promise<void>

Paramètres

Nom	Type
`callId`	`string`
`displayName`	`string`

Renvoie

Promise<void>

Défini dans

src/weaveClient.ts:1710

waitForBatchProcessing

▸ waitForBatchProcessing(): Promise<void>

Renvoie

Promise<void>

Défini dans

src/weaveClient.ts:801

Classe : WeaveAdkPlugin

Classe : WeaveObject

⌘I

​Table des matières

​Constructeurs

​Propriétés

​Méthodes

​Constructeurs

​constructeur

​Paramètres

​Renvoie

​Défini dans

​Propriétés

​projectId

​Défini dans

​settings

​Défini dans

​traceServerApi

​Défini dans

​Méthodes

​addScore

​Paramètres

​Renvoie

​Défini dans

​createCall

​Paramètres

​Renvoie

​Défini dans

​finishCall

​Paramètres

​Renvoie

​Défini dans

​finishCallWithException

​Paramètres

​Renvoie

​Défini dans

​get

​Paramètres

​Renvoie

​Défini dans

​getAgentCustomAttributes

​Paramètres

​Renvoie

​Défini dans

​getAgentSpanStats

​Paramètres

​Renvoie

​Défini dans

​getAgentSpans

​Paramètres

​Renvoie

​Défini dans

​getAgentTurn

​Paramètres

​Renvoie

​Défini dans

​getAgentTurns

​Paramètres

​Renvoie

​Défini dans

​getAgentVersions

​Paramètres

​Renvoie

​Défini dans

​getAgents

​Paramètres

​Renvoie

​Défini dans

​getCall

​Paramètres

​Renvoie

​Défini dans

​getCallStack

​Renvoie

​Défini dans

​getCalls

​Paramètres

​Renvoie

​Défini dans

​Paramètres

​Renvoie

​Défini dans

​getCallsIterator

Table des matières

Constructeurs

Propriétés

Méthodes

Constructeurs

constructeur

Paramètres

Renvoie

Défini dans

Propriétés

projectId

Défini dans

settings

Défini dans

traceServerApi

Défini dans

Méthodes

addScore

Paramètres

Renvoie

Défini dans

createCall

Paramètres

Renvoie

Défini dans

finishCall

Paramètres

Renvoie

Défini dans

finishCallWithException

Paramètres

Renvoie

Défini dans

get

Paramètres

Renvoie

Défini dans

getAgentCustomAttributes

Paramètres

Renvoie

Défini dans

getAgentSpanStats

Paramètres

Renvoie

Défini dans

getAgentSpans

Paramètres

Renvoie

Défini dans

getAgentTurn

Paramètres

Renvoie

Défini dans

getAgentTurns

Paramètres

Renvoie

Défini dans

getAgentVersions

Paramètres

Renvoie

Défini dans

getAgents

Paramètres

Renvoie

Défini dans

getCall

Paramètres

Renvoie

Défini dans

getCallStack

Renvoie

Défini dans

getCalls

Paramètres

Renvoie

Défini dans

Paramètres

Renvoie

Défini dans

getCallsIterator