Table of contents
Constructors
Properties
Methods
- addScore
- createCall
- finishCall
- finishCallWithException
- get
- getCall
- getCallStack
- getCalls
- getCallsIterator
- getCurrentAttributes
- linkPromptToRegistry
- publish
- pushNewCall
- runWithAttributes
- runWithCallStack
- saveCallEnd
- saveCallStart
- saveOp
- serializeAudio
- updateCall
- waitForBatchProcessing
Constructors
constructor
• new WeaveClient(traceServerApi, wandbServerApi, projectId, settings?): WeaveClient
Parameters
Returns
WeaveClient
Defined in
weaveClient.ts:190Properties
projectId
• projectId:string
Defined in
weaveClient.ts:193settings
• settings:Settings
Defined in
weaveClient.ts:194traceServerApi
• traceServerApi:Api<any>
Defined in
weaveClient.ts:191Methods
addScore
▸ addScore(predictCallId, scorerCallId, runnableRefUri, scorerOutput): Promise<string>
Add a scorer result (e.g., scorer output) to a call.
Used in imperative evaluation to attach scorer results to predict calls.
Parameters
Returns
Promise<string>
Defined in
weaveClient.ts:1132createCall
▸ createCall(internalCall, opRef, params, parameterNames, thisArg, currentCall, parentCall, startTime, displayName?, attributes?): Promise<void>
Parameters
Returns
Promise<void>
Defined in
weaveClient.ts:979finishCall
▸ finishCall(call, result, currentCall, parentCall, summarize, endTime, startCallPromise): Promise<void>
Parameters
Returns
Promise<void>
Defined in
weaveClient.ts:1039finishCallWithException
▸ finishCallWithException(call, error, currentCall, parentCall, endTime, startCallPromise): Promise<void>
Parameters
Returns
Promise<void>
Defined in
weaveClient.ts:1079get
▸ get(ref): Promise<any>
Parameters
Returns
Promise<any>
Defined in
weaveClient.ts:435getCall
▸ getCall(callId, includeCosts?): Promise<Call>
Parameters
Returns
Promise<Call>
Defined in
weaveClient.ts:312getCallStack
▸ getCallStack():CallStack
Returns
CallStack
Defined in
weaveClient.ts:890getCalls
▸ getCalls(options?): Promise<Call[]>
Parameters
Returns
Promise<Call[]>
Defined in
weaveClient.ts:345 ▸ getCalls(options?, includeCosts?, limit?): Promise<Call[]>
Parameters
Returns
Promise<Call[]>
Defined in
weaveClient.ts:346getCallsIterator
▸ getCallsIterator(options?, includeCosts?, limit?): AsyncIterableIterator<CallSchema>
Parameters
Returns
AsyncIterableIterator<CallSchema>
Defined in
weaveClient.ts:367 ▸ getCallsIterator(options?): AsyncIterableIterator<CallSchema>
Parameters
Returns
AsyncIterableIterator<CallSchema>
Defined in
weaveClient.ts:372getCurrentAttributes
▸ getCurrentAttributes():Record<string, any>
Returns
Record<string, any>
Defined in
weaveClient.ts:894linkPromptToRegistry
▸ linkPromptToRegistry(prompt, options): Promise<LinkAssetToRegistryRes>
Link a published prompt version into a registry portfolio.
Parameters
Returns
Promise<LinkAssetToRegistryRes>
Defined in
weaveClient.ts:591publish
▸ publish(obj, objId?): Promise<ObjectRef>
Parameters
Returns
Promise<ObjectRef>
Defined in
weaveClient.ts:300pushNewCall
▸ pushNewCall():Object
Returns
Object
Defined in
weaveClient.ts:898runWithAttributes
▸ runWithAttributes<T>(attributes, fn): T
Type parameters
Parameters
Returns
T
Defined in
weaveClient.ts:906runWithCallStack
▸ runWithCallStack<T>(callStack, fn): T
Type parameters
Parameters
Returns
T
Defined in
weaveClient.ts:902saveCallEnd
▸ saveCallEnd(callEnd): void
Parameters
Returns
void
Defined in
weaveClient.ts:885saveCallStart
▸ saveCallStart(callStart): void
Parameters
Returns
void
Defined in
weaveClient.ts:880saveOp
▸ saveOp(op, objId?): Promise<OpRef>
Parameters
Returns
Promise<OpRef>
Defined in
weaveClient.ts:945serializeAudio
▸ serializeAudio(data, audioType?): Promise<SerializedFileBlob>
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
Returns
Promise<SerializedFileBlob>
Defined in
weaveClient.ts:832updateCall
▸ updateCall(callId, displayName): Promise<void>
Parameters
Returns
Promise<void>
Defined in
weaveClient.ts:1115waitForBatchProcessing
▸ waitForBatchProcessing():Promise<void>
Returns
Promise<void>