Documentation Index
Fetch the complete documentation index at: https://wb-21fd5541-update-reference-docs-34.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
weave / WeaveClient
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new WeaveClient(traceServerApi, wandbServerApi, projectId, settings?): WeaveClient
Parameters
| Name | Type |
|---|
traceServerApi | Api<any> |
wandbServerApi | WandbServerApi |
projectId | string |
settings | Settings |
Returns
WeaveClient
Defined in
weaveClient.ts:190
Properties
projectId
• projectId: string
Defined in
weaveClient.ts:193
settings
• settings: Settings
Defined in
weaveClient.ts:194
traceServerApi
• traceServerApi: Api<any>
Defined in
weaveClient.ts:191
Methods
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
| Name | Type | Description |
|---|
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>
Defined in
weaveClient.ts:1128
createCall
▸ createCall(internalCall, opRef, params, parameterNames, thisArg, currentCall, parentCall, startTime, displayName?, attributes?): Promise<void>
Parameters
| Name | Type |
|---|
internalCall | InternalCall |
opRef | any |
params | any[] |
parameterNames | ParameterNamesOption |
thisArg | any |
currentCall | CallStackEntry |
parentCall | undefined | CallStackEntry |
startTime | Date |
displayName? | string |
attributes? | Record<string, any> |
Returns
Promise<void>
Defined in
weaveClient.ts:975
finishCall
▸ finishCall(call, result, currentCall, parentCall, summarize, endTime, startCallPromise): Promise<void>
Parameters
| Name | Type |
|---|
call | InternalCall |
result | any |
currentCall | CallStackEntry |
parentCall | undefined | CallStackEntry |
summarize | undefined | (result: any) => Record<string, any> |
endTime | Date |
startCallPromise | Promise<void> |
Returns
Promise<void>
Defined in
weaveClient.ts:1035
finishCallWithException
▸ finishCallWithException(call, error, currentCall, parentCall, endTime, startCallPromise): Promise<void>
Parameters
| Name | Type |
|---|
call | InternalCall |
error | any |
currentCall | CallStackEntry |
parentCall | undefined | CallStackEntry |
endTime | Date |
startCallPromise | Promise<void> |
Returns
Promise<void>
Defined in
weaveClient.ts:1075
get
▸ get(ref): Promise<any>
Parameters
Returns
Promise<any>
Defined in
weaveClient.ts:435
getCall
▸ getCall(callId, includeCosts?): Promise<Call>
Parameters
| Name | Type | Default value |
|---|
callId | string | undefined |
includeCosts | boolean | false |
Returns
Promise<Call>
Defined in
weaveClient.ts:312
getCallStack
▸ getCallStack(): CallStack
Returns
CallStack
Defined in
weaveClient.ts:886
getCalls
▸ getCalls(options?): Promise<Call[]>
Parameters
| Name | Type |
|---|
options? | GetCallsOptions |
Returns
Promise<Call[]>
Defined in
weaveClient.ts:345
▸ getCalls(options?, includeCosts?, limit?): Promise<Call[]>
Parameters
| Name | Type |
|---|
options? | CallsFilter |
includeCosts? | boolean |
limit? | number |
Returns
Promise<Call[]>
Defined in
weaveClient.ts:346
getCallsIterator
▸ getCallsIterator(options?, includeCosts?, limit?): AsyncIterableIterator<CallSchema>
Parameters
| Name | Type |
|---|
options? | CallsFilter |
includeCosts? | boolean |
limit? | number |
Returns
AsyncIterableIterator<CallSchema>
Defined in
weaveClient.ts:367
▸ getCallsIterator(options?): AsyncIterableIterator<CallSchema>
Parameters
| Name | Type |
|---|
options? | GetCallsOptions |
Returns
AsyncIterableIterator<CallSchema>
Defined in
weaveClient.ts:372
getCurrentAttributes
▸ getCurrentAttributes(): Record<string, any>
Returns
Record<string, any>
Defined in
weaveClient.ts:890
linkPromptToRegistry
▸ linkPromptToRegistry(prompt, options): Promise<LinkAssetToRegistryRes>
Link a published prompt version into a registry portfolio.
Parameters
| Name | Type |
|---|
prompt | RegistryLinkable |
options | LinkPromptToRegistryOptions |
Returns
Promise<LinkAssetToRegistryRes>
Defined in
weaveClient.ts:591
publish
▸ publish(obj, objId?): Promise<ObjectRef>
Parameters
| Name | Type |
|---|
obj | any |
objId? | string |
Returns
Promise<ObjectRef>
Defined in
weaveClient.ts:300
pushNewCall
▸ pushNewCall(): Object
Returns
Object
| Name | Type |
|---|
currentCall | CallStackEntry |
newStack | CallStack |
parentCall? | CallStackEntry |
Defined in
weaveClient.ts:894
runWithAttributes
▸ runWithAttributes<T>(attributes, fn): T
Type parameters
Parameters
| Name | Type |
|---|
attributes | Record<string, any> |
fn | () => T |
Returns
T
Defined in
weaveClient.ts:902
runWithCallStack
▸ runWithCallStack<T>(callStack, fn): T
Type parameters
Parameters
| Name | Type |
|---|
callStack | CallStack |
fn | () => T |
Returns
T
Defined in
weaveClient.ts:898
saveCallEnd
▸ saveCallEnd(callEnd): void
Parameters
| Name | Type |
|---|
callEnd | EndedCallSchemaForInsert |
Returns
void
Defined in
weaveClient.ts:881
saveCallStart
▸ saveCallStart(callStart): void
Parameters
| Name | Type |
|---|
callStart | StartedCallSchemaForInsert |
Returns
void
Defined in
weaveClient.ts:876
saveOp
▸ saveOp(op, objId?): Promise<OpRef>
Parameters
| Name | Type |
|---|
op | Op<(…args: any[]) => any> |
objId? | string |
Returns
Promise<OpRef>
Defined in
weaveClient.ts:941
serializeAudio
▸ 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
| Name | Type | Default value | Description |
|---|
data | Buffer | undefined | Raw audio bytes (WAV for best browser compatibility) |
audioType | "wav" | DEFAULT_AUDIO_TYPE | File format — currently only ‘wav’ is supported |
Returns
Promise<SerializedFileBlob>
Defined in
weaveClient.ts:828
updateCall
▸ updateCall(callId, displayName): Promise<void>
Parameters
| Name | Type |
|---|
callId | string |
displayName | string |
Returns
Promise<void>
Defined in
weaveClient.ts:1111
waitForBatchProcessing
▸ waitForBatchProcessing(): Promise<void>
Returns
Promise<void>
Defined in
weaveClient.ts:211
