Class: WeaveClient

TypeScript SDK 레퍼런스

weave / WeaveClient

​

목차

​

생성자 (Constructors)

• constructor

​

속성 (Properties)

• projectId
• settings
• traceServerApi

​

메소드 (Methods)

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

​

생성자 (Constructors)

​

constructor

• new WeaveClient(traceServerApi, wandbServerApi, projectId, settings?): WeaveClient

​

파라미터

Name	Type
traceServerApi	Api<any>
wandbServerApi	WandbServerApi
projectId	string
settings	Settings

​

반환값

WeaveClient

​

정의 위치

weaveClient.ts:93

​

속성 (Properties)

​

projectId

• projectId: string

​

정의 위치

weaveClient.ts:96

---

​

settings

• settings: Settings

​

정의 위치

weaveClient.ts:97

---

​

traceServerApi

• traceServerApi: Api<any>

​

정의 위치

weaveClient.ts:94

​

메소드 (Methods)

​

addScore

▸ addScore(predictCallId, scorerCallId, runnableRefUri, scorerOutput): Promise<string>

Call에 scorer 결과(예: scorer 출력값)를 추가합니다. 명령형 평가(imperative evaluation)에서 scorer 결과를 predict call에 연결하는 데 사용됩니다.

​

파라미터

Name	Type	Description
predictCallId	string	피드백을 연결할 predict call의 ID
scorerCallId	string	피드백을 생성한 scorer call의 ID
runnableRefUri	string	scorer의 URI (Op 또는 Object 참조)
scorerOutput	any	scorer의 출력값

​

반환값

Promise<string>

​

정의 위치

weaveClient.ts:865

---

​

createCall

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

​

파라미터

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>

​

반환값

Promise<void>

​

정의 위치

weaveClient.ts:720

---

​

finishCall

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

​

파라미터

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

​

반환값

Promise<void>

​

정의 위치

weaveClient.ts:772

---

​

finishCallWithException

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

​

파라미터

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

​

반환값

Promise<void>

​

정의 위치

weaveClient.ts:812

---

​

get

▸ get(ref): Promise<any>

​

파라미터

Name	Type
ref	ObjectRef

​

반환값

Promise<any>

​

정의 위치

weaveClient.ts:282

---

​

getCall

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

​

파라미터

Name	Type	Default value
callId	string	undefined
includeCosts	boolean	false

​

반환값

Promise<Call>

​

정의 위치

weaveClient.ts:213

---

​

getCallStack

▸ getCallStack(): CallStack

​

반환값

CallStack

​

정의 위치

weaveClient.ts:636

---

​

getCalls

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

​

파라미터

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

​

반환값

Promise<Call[]>

​

정의 위치

weaveClient.ts:223

---

​

getCallsIterator

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

​

파라미터

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

​

반환값

AsyncIterableIterator<CallSchema>

​

정의 위치

weaveClient.ts:237

---

​

getCurrentAttributes

▸ getCurrentAttributes(): Record<string, any>

​

반환값

Record<string, any>

​

정의 위치

weaveClient.ts:640

---

​

publish

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

​

파라미터

Name	Type
obj	any
objId?	string

​

반환값

Promise<ObjectRef>

​

정의 위치

weaveClient.ts:201

---

​

pushNewCall

▸ pushNewCall(): Object

​

반환값

Object

Name	Type
currentCall	CallStackEntry
newStack	CallStack
parentCall?	CallStackEntry

​

정의 위치

weaveClient.ts:644

---

​

runWithAttributes

▸ runWithAttributes<T>(attributes, fn): T

​

타입 파라미터

Name
T

​

파라미터

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

​

반환값

T

​

정의 위치

weaveClient.ts:652

---

​

runWithCallStack

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

​

타입 파라미터

Name
T

​

파라미터

Name	Type
callStack	CallStack
fn	() => T

​

반환값

T

​

정의 위치

weaveClient.ts:648

---

​

saveOp

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

​

파라미터

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

​

반환값

Promise<any>

​

정의 위치

weaveClient.ts:686

---

​

updateCall

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

​

파라미터

Name	Type
callId	string
displayName	string

​

반환값

Promise<void>

​

정의 위치

weaveClient.ts:848

---

​

waitForBatchProcessing

▸ waitForBatchProcessing(): Promise<void>

​

반환값

Promise<void>

​

정의 위치

weaveClient.ts:114