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:Défini dans : src/weaveClient.ts:455Api<any>
Méthodes
addScore()
addScore(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:1727predictCallId,scorerCallId,runnableRefUri,scorerOutput) :Promise<string>
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(Défini dans : src/weaveClient.ts:1570internalCall,opRef,params,parameterNames,thisArg,currentCall,parentCall,startTime,displayName?,attributes?) :Promise<void>
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(Défini dans : src/weaveClient.ts:1630call,result,currentCall,parentCall,summarize,endTime,startCallPromise):Promise<void>
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(Défini dans : src/weaveClient.ts:1672call,error,currentCall,parentCall,endTime,startCallPromise):Promise<void>
Paramètres
appel
InternalCall
erreur
any
currentCall
CallStackEntry
parentCall
CallStackEntry | undefined
endTime
Date
startCallPromise
Promise<void>
Renvoie
Promise<void>
get()
get(Défini dans : src/weaveClient.ts:1025ref) :Promise<any>
Paramètres
réf.
ObjectRef
Renvoie
Promise<any>
getAgentCustomAttributes()
getAgentCustomAttributes(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 tripletoptions):Promise<Réponse<GetAgentCustomAttributesResult>>
(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(Répertorie les agents avec des statistiques agrégées. Défini dans : src/weaveClient.ts:488options?):Promise<Réponse<GetAgentsResult>>
Paramètres
options ?
GetAgentsOptions = {}
Renvoie
Promise<Réponse<GetAgentsResult>>
Exemple
getAgentSpans()
getAgentSpans(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:566options) :Promise<Réponse<GetAgentSpansResult>>
Paramètres
options
GetAgentSpansOptions
Renvoie
Promise<Réponse<GetAgentSpansResult>>
Exemples
getAgentSpanStats()
getAgentSpanStats(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.options) :Promise<Réponse<GetAgentSpanStatsResult>>
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(Obtenir les données, y compris les messages, d’un seul tour de conversation (par traceId). Défini dans : src/weaveClient.ts:655options) :Promise<Réponse<AgentTraceChatRes>>
Paramètres
options
GetAgentTurnOptions
Renvoie
Promise<Réponse<AgentTraceChatRes>>
Exemple
getAgentTurns()
getAgentTurns(Obtenir les données (y compris les messages) de nombreux tours de conversation (par conversationId). Défini dans : src/weaveClient.ts:688options):Promise<Réponse<GetAgentTurnsResult>>
Paramètres
options
GetAgentTurnsOptions
Renvoie
Promise<Réponse<GetAgentTurnsResult>>
Exemple
getAgentVersions()
getAgentVersions(Liste les versions d’un agent donné. Défini dans : src/weaveClient.ts:522options) :Promise<Réponse<GetAgentVersionsResult>>
Paramètres
options
GetAgentVersionsOptions
Renvoie
Promise<Réponse<GetAgentVersionsResult>>
Exemple
getCall()
getCall(Défini dans : src/weaveClient.ts:902callId,includeCosts?) :Promise<Call>
Paramètres
callId
string
includeCosts ?
boolean = false
Renvoie
Promise<Call>
getCalls()
Signature de l’appel
getCalls(Défini dans : src/weaveClient.ts:935options?):Promise<Call[]>
Paramètres
options ?
GetCallsOptions
Renvoie
Promise<Call[]>
Signature de l’appel
getCalls(Défini dans : src/weaveClient.ts:936options?,includeCosts?,limit?):Promise<Call[]>
Paramètres
options ?
CallsFilter
includeCosts ?
boolean
limite ?
number
Renvoie
Promise<Call[]>
getCallsIterator()
Signature de l’appel
getCallsIterator(Défini dans : src/weaveClient.ts:957options?,includeCosts?,limit?):AsyncIterableIterator<CallSchema>
Paramètres
options ?
CallsFilter
includeCosts ?
boolean
limite ?
number
Renvoie
AsyncIterableIterator<CallSchema>
Signature d’appel
getCallsIterator(Défini dans : src/weaveClient.ts:962options?):AsyncIterableIterator<CallSchema>
Paramètres
options ?
GetCallsOptions
Renvoie
AsyncIterableIterator<CallSchema>
getCallStack()
getCallStack(): CallStack
Défini dans : src/weaveClient.ts:1482
Renvoie
CallStack
getCurrentAttributes()
getCurrentAttributes():Défini dans : src/weaveClient.ts:1486Record<string,any>
Renvoie
Record<string, any>
linkPromptToRegistry()
linkPromptToRegistry(Associe une version publiée d’un prompt à un portefeuille de registre. Défini dans : src/weaveClient.ts:1181prompt,options):Promise<LinkAssetToRegistryRes>
Paramètres
prompt
RegistryLinkable
options
LinkPromptToRegistryOptions
Renvoie
Promise<LinkAssetToRegistryRes>
publish()
publish(Défini dans : src/weaveClient.ts:890obj,objId?):Promise<ObjectRef>
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
facultatifparentCall :CallStackEntry
runWithAttributes()
runWithAttributes<Défini dans : src/weaveClient.ts:1498T>(attributes,fn):T
Paramètres de type
T
T
Paramètres
attributs
Record<string, any>
fn
T
Renvoie
T
runWithCallStack()
runWithCallStack<Défini dans : src/weaveClient.ts:1494T>(callStack,fn) :T
Paramètres de type
T
T
Paramètres
pileDAppels
CallStack
fn
T
Renvoie
T
saveCallEnd()
saveCallEnd(Défini dans : src/weaveClient.ts:1477callEnd) :void
Paramètres
callEnd
EndedCallSchemaForInsert
Renvoie
void
saveCallStart()
saveCallStart(Défini dans : src/weaveClient.ts:1472callStart) :void
Paramètres
callStart
StartedCallSchemaForInsert
Renvoie
void
saveOp()
saveOp(Défini dans : src/weaveClient.ts:1537op,objId?):Promise<OpRef>
Paramètres
op
Op<(…args) => any>
objId?
string
Renvoie
Promise<OpRef>
searchAgents()
searchAgents(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.options) :Promise<Réponse<SearchAgentsResult>>
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(Téléverse des octets audio bruts vers le magasin de contenu Weave et renvoie l’espace réservédata,audioType?):Promise<SerializedFileBlob>
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(Défini dans : src/weaveClient.ts:1710callId,displayName) :Promise<void>
Paramètres
callId
string
nom d’affichage
string
Renvoie
Promise<void>
waitForBatchProcessing()
waitForBatchProcessing():Défini dans : src/weaveClient.ts:801Promise<void>
Renvoie
Promise<void>