Class: WeaveClient

weave / WeaveClient

​

Table of contents

​

Constructors

• constructor

​

Properties

• projectId
• settings
• traceServerApi

​

Methods

• addScore
• createCall
• finishCall
• finishCallWithException
• get
• getCall
• getCallStack
• getCalls
• getCallsIterator
• publish
• pushNewCall
• runWithCallStack
• saveOp
• updateCall
• waitForBatchProcessing

​

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:92

​

Properties

​

projectId

• projectId: string

​

Defined in

weaveClient.ts:95

---

​

settings

• settings: Settings

​

Defined in

weaveClient.ts:96

---

​

traceServerApi

• traceServerApi: Api<any>

​

Defined in

weaveClient.ts:93

​

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:841

---

​

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:701

---

​

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:748

---

​

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:788

---

​

get

▸ get(ref): Promise<any>

​

Parameters

Name	Type
ref	ObjectRef

​

Returns

Promise<any>

​

Defined in

weaveClient.ts:281

---

​

getCall

▸ getCall(callId, includeCosts?): Promise<Call>

​

Parameters

Name	Type	Default value
callId	string	undefined
includeCosts	boolean	false

​

Returns

Promise<Call>

​

Defined in

weaveClient.ts:212

---

​

getCallStack

▸ getCallStack(): CallStack

​

Returns

CallStack

​

Defined in

weaveClient.ts:629

---

​

getCalls

▸ getCalls(filter?, includeCosts?, limit?): Promise<Call[]>

​

Parameters

Name	Type	Default value
filter	CallsFilter	{}
includeCosts	boolean	false
limit	number	1000

​

Returns

Promise<Call[]>

​

Defined in

weaveClient.ts:222

---

​

getCallsIterator

▸ getCallsIterator(filter?, includeCosts?, limit?): AsyncIterableIterator<CallSchema>

​

Parameters

Name	Type	Default value
filter	CallsFilter	{}
includeCosts	boolean	false
limit	number	1000

​

Returns

AsyncIterableIterator<CallSchema>

​

Defined in

weaveClient.ts:236

---

​

publish

▸ publish(obj, objId?): Promise<ObjectRef>

​

Parameters

Name	Type
obj	any
objId?	string

​

Returns

Promise<ObjectRef>

​

Defined in

weaveClient.ts:200

---

​

pushNewCall

▸ pushNewCall(): Object

​

Returns

Object

Name	Type
currentCall	CallStackEntry
newStack	CallStack
parentCall?	CallStackEntry

​

Defined in

weaveClient.ts:633

---

​

runWithCallStack

▸ runWithCallStack<T>(callStack, fn): T

​

Type parameters

Name
T

​

Parameters

Name	Type
callStack	CallStack
fn	() => T

​

Returns

T

​

Defined in

weaveClient.ts:637

---

​

saveOp

▸ saveOp(op, objId?): Promise<any>

​

Parameters

Name	Type
op	Op<(…args: any[]) => any>
objId?	string

​

Returns

Promise<any>

​

Defined in

weaveClient.ts:667

---

​

updateCall

▸ updateCall(callId, displayName): Promise<void>

​

Parameters

Name	Type
callId	string
displayName	string

​

Returns

Promise<void>

​

Defined in

weaveClient.ts:824

---

​

waitForBatchProcessing

▸ waitForBatchProcessing(): Promise<void>

​

Returns

Promise<void>

​

Defined in

weaveClient.ts:113