目次
コンストラクタ
プロパティ
メソッド
- addScore
- createCall
- finishCall
- finishCallWithException
- get
- getCall
- getCallStack
- getCalls
- getCallsIterator
- getCurrentAttributes
- publish
- pushNewCall
- runWithAttributes
- runWithCallStack
- saveCallEnd
- saveCallStart
- saveOp
- serializeAudio
- updateCall
- waitForBatchProcessing
コンストラクタ
コンストラクター
traceServerApi, wandbServerApi, projectId, settings?): WeaveClient
パラメーター
| 名 | タイプ |
|---|---|
traceServerApi | Api<any> |
wandbServerApi | WandbServerApi |
projectId | string |
settings | Settings |
戻り値
WeaveClient
定義箇所
プロパティ
projectId
string
定義箇所
settings
Settings
定義箇所
traceServerApi
Api<any>
定義箇所
メソッド
addScore
predictCallId, scorerCallId, runnableRefUri, scorerOutput): Promise<string>
call に scorer の結果 (例: scorer output) を追加します。
命令型評価で、predict call に scorer の結果を関連付けるために使用します。
パラメーター
| 名 | タイプ | 説明 |
|---|---|---|
predictCallId | string | フィードバックの関連付け先となる predict call のID |
scorerCallId | string | フィードバックを生成した scorer call のID |
runnableRefUri | string | scorer (Op または Object ref) のURI |
scorerOutput | any | scorerの出力 |
戻り値
Promise<string>
定義箇所
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>
定義箇所
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>
定義箇所
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>
定義箇所
get
ref): Promise<any>
パラメーター
| 名 | タイプ |
|---|---|
ref | ObjectRef |
戻り値
Promise<any>
定義箇所
getCall
callId, includeCosts?): Promise<Call>
パラメーター
| 名 | タイプ | デフォルト値 |
|---|---|---|
callId | string | undefined |
includeCosts | boolean | false |
戻り値
Promise<Call>
定義箇所
getCallStack
CallStack
戻り値
CallStack
定義箇所
getCalls
filter?, includeCosts?, limit?): Promise<Call[]>
パラメーター
| 名 | タイプ | デフォルト値 |
|---|---|---|
filter | CallsFilter | {} |
includeCosts | boolean | false |
limit | number | 1000 |
戻り値
Promise<Call[]>
定義箇所
getCallsIterator
filter?, includeCosts?, limit?): AsyncIterableIterator<CallSchema>
パラメーター
| 名 | タイプ | デフォルト値 |
|---|---|---|
filter | CallsFilter | {} |
includeCosts | boolean | false |
limit | number | 1000 |
戻り値
AsyncIterableIterator<CallSchema>
定義箇所
getCurrentAttributes
Record<string, any>
戻り値
Record<string, any>
定義箇所
publish
obj, objId?): Promise<ObjectRef>
パラメーター
| 名 | タイプ |
|---|---|
obj | any |
objId? | string |
戻り値
Promise<ObjectRef>
定義箇所
pushNewCall
Object
戻り値
Object
| 名 | タイプ |
|---|---|
currentCall | CallStackEntry |
newStack | CallStack |
parentCall? | CallStackEntry |
定義箇所
runWithAttributes
T>(attributes, fn): T
型パラメーター
| 名 |
|---|
T |
パラメーター
| 名 | タイプ |
|---|---|
attributes | Record<string, any> |
fn | () => T |
戻り値
T
定義箇所
runWithCallStack
T>(callStack, fn): T
型パラメーター
| 名 |
|---|
T |
パラメーター
| 名 | タイプ |
|---|---|
callStack | CallStack |
fn | () => T |
戻り値
T
定義箇所
saveCallEnd
callEnd): void
パラメーター
| 名 | タイプ |
|---|---|
callEnd | EndedCallSchemaForInsert |
戻り値
void
定義箇所
saveCallStart
callStart): void
パラメーター
| 名 | タイプ |
|---|---|
callStart | StartedCallSchemaForInsert |
戻り値
void
定義箇所
saveOp
op, objId?): Promise<any>
パラメーター
| 名 | タイプ |
|---|---|
op | Op<(…args: any[]) => any> |
objId? | string |
戻り値
Promise<any>
定義箇所
serializeAudio
data, audioType?): Promise<any>
生のオーディオバイトを Weave のコンテンツストアにアップロードし、
Call の出力に埋め込める CustomWeaveType プレースホルダーを返します。
これは、finishCall の自動シリアライズパイプラインを使用せずに、
Call の出力を手動で構築する場合 (たとえば saveCallEnd 経由) に使用します。
パラメーター
| 名 | タイプ | 既定値 | 説明 |
|---|---|---|---|
data | Buffer | undefined | 生のオーディオバイト (ブラウザーとの互換性を最大限にするには WAV) |
audioType | "wav" | DEFAULT_AUDIO_TYPE | ファイル形式 — 現在サポートされているのは ‘wav’ のみです |
戻り値
Promise<any>
定義箇所
updateCall
callId, displayName): Promise<void>
パラメーター
| 名 | タイプ |
|---|---|
callId | string |
displayName | string |
戻り値
Promise<void>
定義箇所
waitForBatchProcessing
Promise<void>
戻り値
Promise<void>