Class: WeaveClient

TypeScript SDK リファレンス

weave / WeaveClient

​

目次

​

コンストラクタ

• constructor

​

プロパティ

• projectId
• settings
• traceServerApi

​

メソッド

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

​

コンストラクタ

​

constructor

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

​

パラメータ

名前	型
traceServerApi	Api<any>
wandbServerApi	WandbServerApi
projectId	string
settings	Settings

​

返り値

WeaveClient

​

定義

weaveClient.ts:93

​

プロパティ

​

projectId

• projectId: string

​

定義

weaveClient.ts:96

---

​

settings

• settings: Settings

​

定義

weaveClient.ts:97

---

​

traceServerApi

• traceServerApi: Api<any>

​

定義

weaveClient.ts:94

​

メソッド

​

addScore

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

コールにスコアラーの結果（例：スコアラーの出力）を追加します。 命令型の評価において、スコアラーの結果を predict コールに紐付けるために使用されます。

​

パラメータ

名前	型	説明
predictCallId	string	フィードバックを紐付ける predict コールの ID
scorerCallId	string	フィードバックを生成したスコアラーコールの ID
runnableRefUri	string	スコアラーの URI (Op または Object 参照)
scorerOutput	any	スコアラーの出力

​

返り値

Promise<string>

​

定義

weaveClient.ts:865

---

​

createCall

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

​

パラメータ

名前	型
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>

​

パラメータ

名前	型
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>

​

パラメータ

名前	型
call	InternalCall
error	any
currentCall	CallStackEntry
parentCall	undefined | CallStackEntry
endTime	Date
startCallPromise	Promise<void>

​

返り値

Promise<void>

​

定義

weaveClient.ts:812

---

​

get

▸ get(ref): Promise<any>

​

パラメータ

名前	型
ref	ObjectRef

​

返り値

Promise<any>

​

定義

weaveClient.ts:282

---

​

getCall

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

​

パラメータ

名前	型	デフォルト値
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[]>

​

パラメータ

名前	型	デフォルト値
filter	CallsFilter	{}
includeCosts	boolean	false
limit	number	1000

​

返り値

Promise<Call[]>

​

定義

weaveClient.ts:223

---

​

getCallsIterator

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

​

パラメータ

名前	型	デフォルト値
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>

​

パラメータ

名前	型
obj	any
objId?	string

​

返り値

Promise<ObjectRef>

​

定義

weaveClient.ts:201

---

​

pushNewCall

▸ pushNewCall(): Object

​

返り値

Object

名前	型
currentCall	CallStackEntry
newStack	CallStack
parentCall?	CallStackEntry

​

定義

weaveClient.ts:644

---

​

runWithAttributes

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

​

型パラメータ

名前
T

​

パラメータ

名前	型
attributes	Record<string, any>
fn	() => T

​

返り値

T

​

定義

weaveClient.ts:652

---

​

runWithCallStack

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

​

型パラメータ

名前
T

​

パラメータ

名前	型
callStack	CallStack
fn	() => T

​

返り値

T

​

定義

weaveClient.ts:648

---

​

saveOp

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

​

パラメータ

名前	型
op	Op<(…args: any[]) => any>
objId?	string

​

返り値

Promise<any>

​

定義

weaveClient.ts:686

---

​

updateCall

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

​

パラメータ

名前	型
callId	string
displayName	string

​

返り値

Promise<void>

​

定義

weaveClient.ts:848

---

​

waitForBatchProcessing

▸ waitForBatchProcessing(): Promise<void>

​

返り値

Promise<void>

​

定義

weaveClient.ts:114