Skip to main content
Défini dans : src/weaveClient.ts:445

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 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. Défini dans : src/weaveClient.ts:1727

Paramètres

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

Renvoie

Promise<string>

createCall()

createCall(internalCall, opRef, params, parameterNames, thisArg, currentCall, parentCall, startTime, displayName?, attributes?) : Promise<void>
Défini dans : src/weaveClient.ts:1570

Paramètres

internalCall
InternalCall
opRef
any
params
any[]
nomsDesParamètres
ParameterNamesOption
thisArg
any
currentCall
CallStackEntry
parentCall
CallStackEntry | undefined
startTime
Date
nomAffiché ?
string
attributs ?
Record<string, any>

Renvoie

Promise<void>

finishCall()

finishCall(call, result, currentCall, parentCall, summarize, endTime, startCallPromise): Promise<void>
Défini dans : src/weaveClient.ts:1630

Paramètres

appel
InternalCall
résultat
any
currentCall
CallStackEntry
parentCall
CallStackEntry | undefined
summarize
((result) => Record<string, any>) | undefined
endTime
Date
startCallPromise
Promise<void>

Renvoie

Promise<void>

finishCallWithException()

finishCallWithException(call, error, currentCall, parentCall, endTime, startCallPromise): Promise<void>
Défini dans : src/weaveClient.ts:1672

Paramètres

appel
InternalCall
erreur
any
currentCall
CallStackEntry
parentCall
CallStackEntry | undefined
endTime
Date
startCallPromise
Promise<void>

Renvoie

Promise<void>

get()

get(ref) : Promise<any>
Défini dans : src/weaveClient.ts:1025

Paramètres

réf.
ObjectRef

Renvoie

Promise<any>

getAgentCustomAttributes()

getAgentCustomAttributes(options): Promise<Réponse<GetAgentCustomAttributesResult>>
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. Défini dans : src/weaveClient.ts:772

Paramètres

options
GetAgentCustomAttributesOptions

Renvoie

Promise<Réponse<GetAgentCustomAttributesResult>>

Exemple


getAgents()

getAgents(options?): Promise<Réponse<GetAgentsResult>>
Répertorie les agents avec des statistiques agrégées. Défini dans : src/weaveClient.ts:488

Paramètres

options ?
GetAgentsOptions = {}

Renvoie

Promise<Réponse<GetAgentsResult>>

Exemple


getAgentSpans()

getAgentSpans(options) : Promise<Réponse<GetAgentSpansResult>>
Interroge les spans d’agent, éventuellement filtrés par nom d’agent et/ou par une expression de requête de type Mongo. Défini dans : src/weaveClient.ts:566

Paramètres

options
GetAgentSpansOptions

Renvoie

Promise<Réponse<GetAgentSpansResult>>

Exemples


getAgentSpanStats()

getAgentSpanStats(options) : Promise<Réponse<GetAgentSpanStatsResult>>
Agrégations sur les agent spans 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. Défini dans : src/weaveClient.ts:621

Paramètres

options
GetAgentSpanStatsOptions

Renvoie

Promise<Réponse<GetAgentSpanStatsResult>>

Exemple


getAgentTurn()

getAgentTurn(options) : Promise<Réponse<AgentTraceChatRes>>
Obtenir les données, y compris les messages, d’un seul tour de conversation (par traceId). Défini dans : src/weaveClient.ts:655

Paramètres

options
GetAgentTurnOptions

Renvoie

Promise<Réponse<AgentTraceChatRes>>

Exemple


getAgentTurns()

getAgentTurns(options): Promise<Réponse<GetAgentTurnsResult>>
Obtenir les données (y compris les messages) de nombreux tours de conversation (par conversationId). Défini dans : src/weaveClient.ts:688

Paramètres

options
GetAgentTurnsOptions

Renvoie

Promise<Réponse<GetAgentTurnsResult>>

Exemple


getAgentVersions()

getAgentVersions(options) : Promise<Réponse<GetAgentVersionsResult>>
Liste les versions d’un agent donné. Défini dans : src/weaveClient.ts:522

Paramètres

options
GetAgentVersionsOptions

Renvoie

Promise<Réponse<GetAgentVersionsResult>>

Exemple


getCall()

getCall(callId, includeCosts?) : Promise<Call>
Défini dans : src/weaveClient.ts:902

Paramètres

callId
string
includeCosts ?
boolean = false

Renvoie

Promise<Call>

getCalls()

Signature de l’appel

getCalls(options?): Promise<Call[]>
Défini dans : src/weaveClient.ts:935
Paramètres
options ?
GetCallsOptions
Renvoie
Promise<Call[]>

Signature de l’appel

getCalls(options?, includeCosts?, limit?): Promise<Call[]>
Défini dans : src/weaveClient.ts:936
Paramètres
options ?
CallsFilter
includeCosts ?
boolean
limite ?
number
Renvoie
Promise<Call[]>

getCallsIterator()

Signature de l’appel

getCallsIterator(options?, includeCosts?, limit?): AsyncIterableIterator<CallSchema>
Défini dans : src/weaveClient.ts:957
Paramètres
options ?
CallsFilter
includeCosts ?
boolean
limite ?
number
Renvoie
AsyncIterableIterator<CallSchema>

Signature d’appel

getCallsIterator(options?): AsyncIterableIterator<CallSchema>
Défini dans : src/weaveClient.ts:962
Paramètres
options ?
GetCallsOptions
Renvoie
AsyncIterableIterator<CallSchema>

getCallStack()

getCallStack(): CallStack
Défini dans : src/weaveClient.ts:1482

Renvoie

CallStack

getCurrentAttributes()

getCurrentAttributes(): Record<string, any>
Défini dans : src/weaveClient.ts:1486

Renvoie

Record<string, any>

linkPromptToRegistry()

linkPromptToRegistry(prompt, options): Promise<LinkAssetToRegistryRes>
Associe une version publiée d’un prompt à un portefeuille de registre. Défini dans : src/weaveClient.ts:1181

Paramètres

prompt
RegistryLinkable
options
LinkPromptToRegistryOptions

Renvoie

Promise<LinkAssetToRegistryRes>

publish()

publish(obj, objId?): Promise<ObjectRef>
Défini dans : src/weaveClient.ts:890

Paramètres

obj
any
objId?
string

Renvoie

Promise<ObjectRef>

pushNewCall()

pushNewCall() : objet
Défini dans : src/weaveClient.ts:1490

Renvoie

objet
currentCall
currentCall : CallStackEntry
newStack
newStack : CallStack
parentCall
facultatif parentCall : CallStackEntry

runWithAttributes()

runWithAttributes<T>(attributes, fn): T
Défini dans : src/weaveClient.ts:1498

Paramètres de type

T
T

Paramètres

attributs
Record<string, any>
fn
() => T

Renvoie

T

runWithCallStack()

runWithCallStack<T>(callStack, fn) : T
Défini dans : src/weaveClient.ts:1494

Paramètres de type

T
T

Paramètres

pileDAppels
CallStack
fn
() => T

Renvoie

T

saveCallEnd()

saveCallEnd(callEnd) : void
Défini dans : src/weaveClient.ts:1477

Paramètres

callEnd
EndedCallSchemaForInsert

Renvoie

void

saveCallStart()

saveCallStart(callStart) : void
Défini dans : src/weaveClient.ts:1472

Paramètres

callStart
StartedCallSchemaForInsert

Renvoie

void

saveOp()

saveOp(op, objId?): Promise<OpRef>
Défini dans : src/weaveClient.ts:1537

Paramètres

op
Op<(…args) => any>
objId?
string

Renvoie

Promise<OpRef>

searchAgents()

searchAgents(options) : Promise<Réponse<SearchAgentsResult>>
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. Défini dans : src/weaveClient.ts:730

Paramètres

options
SearchAgentsOptions

Renvoie

Promise<Réponse<SearchAgentsResult>>

Exemple


serializeAudio()

serializeAudio(data, audioType?): Promise<SerializedFileBlob>
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é. Défini dans : src/weaveClient.ts:1424

Paramètres

data
Buffer Données audio brutes (WAV pour une compatibilité optimale avec les navigateurs)
audioType ?
"wav" = DEFAULT_AUDIO_TYPE Format de fichier — seul le format « wav » est actuellement pris en charge

Renvoie

Promise<SerializedFileBlob>

updateCall()

updateCall(callId, displayName) : Promise<void>
Défini dans : src/weaveClient.ts:1710

Paramètres

callId
string
nom d’affichage
string

Renvoie

Promise<void>

waitForBatchProcessing()

waitForBatchProcessing(): Promise<void>
Défini dans : src/weaveClient.ts:801

Renvoie

Promise<void>