Skip to main content
Defined in: src/weaveClient.ts:445

Properties

projectId

projectId: string
Defined in: src/weaveClient.ts:456

settings

settings: Settings
Defined in: src/weaveClient.ts:457

traceServerApi

traceServerApi: Api<any>
Defined in: src/weaveClient.ts:455

Methods

addScore()

addScore(predictCallId, scorerCallId, runnableRefUri, scorerOutput): Promise<string>
Defined in: src/weaveClient.ts:1727 Add a scorer result (e.g., scorer output) to a call. Used in imperative evaluation to attach scorer results to predict calls.

Parameters

predictCallId
string ID of the predict call to attach feedback to
scorerCallId
string ID of the scorer call that generated the feedback
runnableRefUri
string URI of the scorer (Op or Object ref)
scorerOutput
any Output of the scorer

Returns

Promise<string>

createCall()

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

Parameters

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

Returns

Promise<void>

finishCall()

finishCall(call, result, currentCall, parentCall, summarize, endTime, startCallPromise): Promise<void>
Defined in: src/weaveClient.ts:1630

Parameters

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

Returns

Promise<void>

finishCallWithException()

finishCallWithException(call, error, currentCall, parentCall, endTime, startCallPromise): Promise<void>
Defined in: src/weaveClient.ts:1672

Parameters

call
InternalCall
error
any
currentCall
CallStackEntry
parentCall
CallStackEntry | undefined
endTime
Date
startCallPromise
Promise<void>

Returns

Promise<void>

get()

get(ref): Promise<any>
Defined in: src/weaveClient.ts:1025

Parameters

ref
ObjectRef

Returns

Promise<any>

getAgentCustomAttributes()

getAgentCustomAttributes(options): Promise<Response<GetAgentCustomAttributesResult>>
Defined in: src/weaveClient.ts:772 Discover typed custom-attribute keys observed on agent spans in the project. Each result row is one (source, key, value_type) triple plus a count of how many spans carry it, which is what the spans query/group/stats APIs use to reference custom attrs. Filter the spans considered by passing query (a structured span filter), startedAfter / startedBefore (ISO-8601), or both. Use limit / offset to page through the discovered keys.

Parameters

options
GetAgentCustomAttributesOptions

Returns

Promise<Response<GetAgentCustomAttributesResult>>

Example


getAgents()

getAgents(options?): Promise<Response<GetAgentsResult>>
Defined in: src/weaveClient.ts:488 List agents with aggregated stats.

Parameters

options?
GetAgentsOptions = {}

Returns

Promise<Response<GetAgentsResult>>

Example


getAgentSpans()

getAgentSpans(options): Promise<Response<GetAgentSpansResult>>
Defined in: src/weaveClient.ts:566 Query agent spans, optionally filtered by agent name and/or a mongo-style query expression.

Parameters

options
GetAgentSpansOptions

Returns

Promise<Response<GetAgentSpansResult>>

Examples


getAgentSpanStats()

getAgentSpanStats(options): Promise<Response<GetAgentSpanStatsResult>>
Defined in: src/weaveClient.ts:621 Agregations over agent spans in the project, returned as rows + column metadata suitable for time-series / bucketed visualizations. start (required) and end define the time window. Each entry in metrics declares a field to extract and how to aggregate it (sum, avg, count, percentiles, etc.). Pass granularity (seconds) to bucket rows by time, or groupBy to break results out per agent / provider / model / etc. query filters the underlying spans before aggregation.

Parameters

options
GetAgentSpanStatsOptions

Returns

Promise<Response<GetAgentSpanStatsResult>>

Example


getAgentTurn()

getAgentTurn(options): Promise<Response<AgentTraceChatRes>>
Defined in: src/weaveClient.ts:655 Get data (including messages) for a single turn (by traceId).

Parameters

options
GetAgentTurnOptions

Returns

Promise<Response<AgentTraceChatRes>>

Example


getAgentTurns()

getAgentTurns(options): Promise<Response<GetAgentTurnsResult>>
Defined in: src/weaveClient.ts:688 Get data (including messages) for many turns (by conversationId).

Parameters

options
GetAgentTurnsOptions

Returns

Promise<Response<GetAgentTurnsResult>>

Example


getAgentVersions()

getAgentVersions(options): Promise<Response<GetAgentVersionsResult>>
Defined in: src/weaveClient.ts:522 List versions for a given agent.

Parameters

options
GetAgentVersionsOptions

Returns

Promise<Response<GetAgentVersionsResult>>

Example


getCall()

getCall(callId, includeCosts?): Promise<Call>
Defined in: src/weaveClient.ts:902

Parameters

callId
string
includeCosts?
boolean = false

Returns

Promise<Call>

getCalls()

Call Signature

getCalls(options?): Promise<Call[]>
Defined in: src/weaveClient.ts:935
Parameters
options?
GetCallsOptions
Returns
Promise<Call[]>

Call Signature

getCalls(options?, includeCosts?, limit?): Promise<Call[]>
Defined in: src/weaveClient.ts:936
Parameters
options?
CallsFilter
includeCosts?
boolean
limit?
number
Returns
Promise<Call[]>

getCallsIterator()

Call Signature

getCallsIterator(options?, includeCosts?, limit?): AsyncIterableIterator<CallSchema>
Defined in: src/weaveClient.ts:957
Parameters
options?
CallsFilter
includeCosts?
boolean
limit?
number
Returns
AsyncIterableIterator<CallSchema>

Call Signature

getCallsIterator(options?): AsyncIterableIterator<CallSchema>
Defined in: src/weaveClient.ts:962
Parameters
options?
GetCallsOptions
Returns
AsyncIterableIterator<CallSchema>

getCallStack()

getCallStack(): CallStack
Defined in: src/weaveClient.ts:1482

Returns

CallStack

getCurrentAttributes()

getCurrentAttributes(): Record<string, any>
Defined in: src/weaveClient.ts:1486

Returns

Record<string, any>

linkPromptToRegistry()

linkPromptToRegistry(prompt, options): Promise<LinkAssetToRegistryRes>
Defined in: src/weaveClient.ts:1181 Link a published prompt version into a registry portfolio.

Parameters

prompt
RegistryLinkable
options
LinkPromptToRegistryOptions

Returns

Promise<LinkAssetToRegistryRes>

publish()

publish(obj, objId?): Promise<ObjectRef>
Defined in: src/weaveClient.ts:890

Parameters

obj
any
objId?
string

Returns

Promise<ObjectRef>

pushNewCall()

pushNewCall(): object
Defined in: src/weaveClient.ts:1490

Returns

object
currentCall
currentCall: CallStackEntry
newStack
newStack: CallStack
parentCall?
optional parentCall?: CallStackEntry

runWithAttributes()

runWithAttributes<T>(attributes, fn): T
Defined in: src/weaveClient.ts:1498

Type Parameters

T
T

Parameters

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

Returns

T

runWithCallStack()

runWithCallStack<T>(callStack, fn): T
Defined in: src/weaveClient.ts:1494

Type Parameters

T
T

Parameters

callStack
CallStack
fn
() => T

Returns

T

saveCallEnd()

saveCallEnd(callEnd): void
Defined in: src/weaveClient.ts:1477

Parameters

callEnd
EndedCallSchemaForInsert

Returns

void

saveCallStart()

saveCallStart(callStart): void
Defined in: src/weaveClient.ts:1472

Parameters

callStart
StartedCallSchemaForInsert

Returns

void

saveOp()

saveOp(op, objId?): Promise<OpRef>
Defined in: src/weaveClient.ts:1537

Parameters

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

Returns

Promise<OpRef>

searchAgents()

searchAgents(options): Promise<Response<SearchAgentsResult>>
Defined in: src/weaveClient.ts:730 Full-text search across agent messages in the project. Returns hits grouped by conversation, with a preview of each matched message. query is the full-text search term. Pass an empty string to retrieve all messages matching the structured filters (agentName, conversationId, traceId) without text matching. Use limit / offset to page through results.

Parameters

options
SearchAgentsOptions

Returns

Promise<Response<SearchAgentsResult>>

Example


serializeAudio()

serializeAudio(data, audioType?): Promise<SerializedFileBlob>
Defined in: src/weaveClient.ts:1424 Upload raw audio bytes to the Weave content store and return the CustomWeaveType placeholder that can be embedded in a call output. Use this when building call outputs manually (e.g. via saveCallEnd) where the automatic serialization pipeline from finishCall is not used.

Parameters

data
Buffer Raw audio bytes (WAV for best browser compatibility)
audioType?
"wav" = DEFAULT_AUDIO_TYPE File format — currently only ‘wav’ is supported

Returns

Promise<SerializedFileBlob>

updateCall()

updateCall(callId, displayName): Promise<void>
Defined in: src/weaveClient.ts:1710

Parameters

callId
string
displayName
string

Returns

Promise<void>

waitForBatchProcessing()

waitForBatchProcessing(): Promise<void>
Defined in: src/weaveClient.ts:801

Returns

Promise<void>