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

​

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

​

Returns

Promise<string>

​

Defined in

weaveClient.ts:847

---

​

createCall

▸ createCall(internalCall, opRef, params, parameterNames, thisArg, currentCall, parentCall, startTime, displayName?, attributes?): Promise<void>

​

Parameters

​

Returns

Promise<void>

​

Defined in

weaveClient.ts:707

---

​

finishCall

▸ finishCall(call, result, currentCall, parentCall, summarize, endTime, startCallPromise): Promise<void>

​

Parameters

​

Returns

Promise<void>

​

Defined in

weaveClient.ts:754

---

​

finishCallWithException

▸ finishCallWithException(call, error, currentCall, parentCall, endTime, startCallPromise): Promise<void>

​

Parameters

​

Returns

Promise<void>

​

Defined in

weaveClient.ts:794

---

​

get

▸ get(ref): Promise<any>

​

Parameters

​

Returns

Promise<any>

​

Defined in

weaveClient.ts:281

---

​

getCall

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

​

Parameters

​

Returns

Promise<Call>

​

Defined in

weaveClient.ts:212

---

​

getCallStack

▸ getCallStack(): CallStack

​

Returns

CallStack

​

Defined in

weaveClient.ts:635

---

​

getCalls

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

​

Parameters

​

Returns

Promise<Call[]>

​

Defined in

weaveClient.ts:222

---

​

getCallsIterator

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

​

Parameters

​

Returns

AsyncIterableIterator<CallSchema>

​

Defined in

weaveClient.ts:236

---

​

publish

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

​

Parameters

​

Returns

Promise<ObjectRef>

​

Defined in

weaveClient.ts:200

---

​

pushNewCall

▸ pushNewCall(): Object

​

Returns

Object

​

Defined in

weaveClient.ts:639

---

​

runWithCallStack

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

​

Type parameters

​

Parameters

​

Returns

T

​

Defined in

weaveClient.ts:643

---

​

saveOp

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

​

Parameters

​

Returns

Promise<any>

​

Defined in

weaveClient.ts:673

---

​

updateCall

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

​

Parameters

​

Returns

Promise<void>

​

Defined in

weaveClient.ts:830

---

​

waitForBatchProcessing

▸ waitForBatchProcessing(): Promise<void>

​

Returns

Promise<void>

​

Defined in

weaveClient.ts:113