プロパティ
projectId
projectId: string
定義元: src/weaveClient.ts:456
settings
settings: Settings
定義元: src/weaveClient.ts:457
traceServerApi
traceServerApi:定義元: src/weaveClient.ts:455Api<any>
メソッド
addScore()
addScore(Scorer の結果 (Scorer の出力など) を Call に追加します。 命令型の評価で、Scorer の結果を予測 Call に関連付けるために使用します。 定義元: src/weaveClient.ts:1727predictCallId,scorerCallId,runnableRefUri,scorerOutput):Promise<string>
パラメーター
predictCallId
string
フィードバックを紐付ける予測CallのID
scorerCallId
string
feedback を生成した Scorer Call の ID
runnableRefUri
string
Scorer (Op または Object ref) のURI
scorerOutput
any
Scorer の出力
戻り値
Promise<string>
createCall()
createCall(定義元: src/weaveClient.ts:1570internalCall,opRef,params,parameterNames,thisArg,currentCall,parentCall,startTime,displayName?,attributes?):Promise<void>
パラメーター
internalCall
InternalCall
opRef
any
params
any[]
パラメーター名
ParameterNamesOption
thisArg
any
currentCall
CallStackEntry
parentCall
CallStackEntry | undefined
startTime
Date
表示名?
string
属性?
Record<string, any>
戻り値
Promise<void>
finishCall()
finishCall(定義元: src/weaveClient.ts:1630call,result,currentCall,parentCall,summarize,endTime,startCallPromise):Promise<void>
パラメーター
call
InternalCall
result
any
currentCall
CallStackEntry
parentCall
CallStackEntry | undefined
summarize
result) => Record<string, any>) | undefined
終了時刻
Date
startCallPromise
Promise<void>
戻り値
Promise<void>
finishCallWithException()
finishCallWithException(定義元: src/weaveClient.ts:1672call,error,currentCall,parentCall,endTime,startCallPromise):Promise<void>
パラメーター
call
InternalCall
error
any
currentCall
CallStackEntry
parentCall
CallStackEntry | undefined
終了時刻
Date
startCallPromise
Promise<void>
戻り値
Promise<void>
get()
get(定義元: src/weaveClient.ts:1025ref):Promise<any>
パラメーター
ref
ObjectRef
戻り値
Promise<any>
getAgentCustomAttributes()
getAgentCustomAttributes(project 内のエージェント スパンで検出された、型付きカスタム属性キーを取得します。各結果行は 1 つのoptions):Promise<Response<GetAgentCustomAttributesResult>>
(source, key, value_type) トリプルと、そのトリプルを持つスパン数で構成されます。スパンのクエリ、グループ化、統計 API では、この形式でカスタム属性を参照します。
query (構造化スパンフィルター) 、startedAfter / startedBefore (ISO-8601) 、または両方を指定して、対象のスパンをフィルターします。検出されたキーをページングするには、limit / offset を使用します。
定義元: src/weaveClient.ts:772
パラメーター
オプション
GetAgentCustomAttributesOptions
戻り値
Promise<Response<GetAgentCustomAttributesResult>>
例
getAgents()
getAgents(集計された統計情報を含むエージェントの一覧を取得します。 定義元: src/weaveClient.ts:488options?):Promise<Response<GetAgentsResult>>
パラメーター
オプション?
GetAgentsOptions = {}
戻り値
Promise<Response<GetAgentsResult>>
例
getAgentSpans()
getAgentSpans(エージェント スパンをクエリします。必要に応じて、エージェント名や Mongo スタイルのクエリ式でフィルターできます。 定義元: src/weaveClient.ts:566options):Promise<Response<GetAgentSpansResult>>
パラメーター
オプション
GetAgentSpansOptions
戻り値
Promise<Response<GetAgentSpansResult>>
例
getAgentSpanStats()
getAgentSpanStats(project 内のエージェント スパンに対する集約結果を、時系列または時間バケットの可視化に適した行と列のメタデータとして返します。options):Promise<Response<GetAgentSpanStatsResult>>
start (必須) とendで時間範囲を指定します。metricsの各エントリでは、抽出するフィールドと集約方法 (sum、avg、count、パーセンタイルなど) を指定します。行を時間単位でバケット化するにはgranularity (秒) を指定し、エージェント/provider/モデルなどごとに結果を分けるにはgroupByを指定します。queryは、集約前に対象となるスパンをフィルターします。
定義元: src/weaveClient.ts:621
パラメーター
オプション
GetAgentSpanStatsOptions
戻り値
Promise<Response<GetAgentSpanStatsResult>>
例
getAgentTurn()
getAgentTurn(指定した traceId の単一ターンに関するデータ (メッセージを含む) を取得します。 定義元: src/weaveClient.ts:655options):Promise<Response<AgentTraceChatRes>>
パラメーター
オプション
GetAgentTurnOptions
戻り値
Promise<Response<AgentTraceChatRes>>
例
getAgentTurns()
getAgentTurns(会話 ID を指定して、複数のターンのデータ (メッセージを含む) を取得します。 定義元: src/weaveClient.ts:688options):Promise<Response<GetAgentTurnsResult>>
パラメーター
オプション
GetAgentTurnsOptions
戻り値
Promise<Response<GetAgentTurnsResult>>
例
getAgentVersions()
getAgentVersions(指定したエージェントのバージョンを一覧表示します。 定義元: src/weaveClient.ts:522options):Promise<Response<GetAgentVersionsResult>>
パラメーター
オプション
GetAgentVersionsOptions
戻り値
Promise<Response<GetAgentVersionsResult>>
例
getCall()
getCall(定義元: src/weaveClient.ts:902callId,includeCosts?):Promise<Call>
パラメーター
callId
string
includeCosts?
boolean = false
戻り値
Promise<Call>
getCalls()
Call Signature
getCalls(定義元: src/weaveClient.ts:935options?):Promise<Call[]>
パラメーター
オプション
GetCallsOptions
戻り値
Promise<Call[]>
Call Signature
getCalls(定義元: src/weaveClient.ts:936options?,includeCosts?,limit?):Promise<Call[]>
パラメーター
オプション?
CallsFilter
includeCosts?
boolean
limit?
数値
戻り値
Promise<Call[]>
getCallsIterator()
Call Signature
getCallsIterator(定義元: src/weaveClient.ts:957options?,includeCosts?,limit?):AsyncIterableIterator<CallSchema>
パラメーター
オプション?
CallsFilter
includeCosts?
boolean
limit?
数値
戻り値
AsyncIterableIterator<CallSchema>
Call Signature
getCallsIterator(定義元: src/weaveClient.ts:962options?):AsyncIterableIterator<CallSchema>
パラメーター
オプション?
GetCallsOptions
戻り値
AsyncIterableIterator<CallSchema>
getCallStack()
getCallStack(): CallStack
定義元: src/weaveClient.ts:1482
戻り値
CallStack
getCurrentAttributes()
getCurrentAttributes():定義元: src/weaveClient.ts:1486Record<string,any>
戻り値
Record<string, any>
linkPromptToRegistry()
linkPromptToRegistry(公開済みの prompt バージョンを Registry ポートフォリオにリンクします。 定義元: src/weaveClient.ts:1181prompt,options):Promise<LinkAssetToRegistryRes>
パラメーター
プロンプト
RegistryLinkable
オプション
LinkPromptToRegistryOptions
戻り値
Promise<LinkAssetToRegistryRes>
publish()
publish(定義元: src/weaveClient.ts:890obj,objId?):Promise<ObjectRef>
パラメーター
obj
any
objId?
string
戻り値
Promise<ObjectRef>
pushNewCall()
pushNewCall(): object
定義元: src/weaveClient.ts:1490
戻り値
object
currentCall
currentCall: CallStackEntry
newStack
newStack: CallStack
parentCall
optional親Call:CallStackEntry
runWithAttributes()
runWithAttributes<定義元: src/weaveClient.ts:1498T>(attributes,fn):T
タイプパラメーター
T
T
パラメーター
属性
Record<string, any>
fn
T
戻り値
T
runWithCallStack()
runWithCallStack<定義元: src/weaveClient.ts:1494T>(callStack,fn):T
タイプパラメーター
T
T
パラメーター
callStack
CallStack
fn
T
戻り値
T
saveCallEnd()
saveCallEnd(定義元: src/weaveClient.ts:1477callEnd):void
パラメーター
callEnd
EndedCallSchemaForInsert
戻り値
void
saveCallStart()
saveCallStart(定義元: src/weaveClient.ts:1472callStart):void
パラメーター
callStart
StartedCallSchemaForInsert
戻り値
void
saveOp()
saveOp(定義元: src/weaveClient.ts:1537op,objId?):Promise<OpRef>
パラメーター
op
Op<(…args) => any>
objId?
string
戻り値
Promise<OpRef>
searchAgents()
searchAgents(project 内のエージェントメッセージを全文検索します。一致したメッセージのプレビューを含む結果を、会話ごとにグループ化して返します。options):Promise<Response<SearchAgentsResult>>
query は全文検索の検索語です。空の文字列を渡すと、テキスト検索を行わずに構造化フィルター (agentName、conversationId、traceId) に一致するすべてのメッセージを取得します。limit / offset を使用して結果をページネーションします。
定義元: src/weaveClient.ts:730
パラメーター
オプション
SearchAgentsOptions
戻り値
Promise<Response<SearchAgentsResult>>
例
serializeAudio()
serializeAudio(生のオーディオバイトを Weave コンテンツストアにアップロードし、Call の出力に埋め込み可能なdata,audioType?):Promise<SerializedFileBlob>
CustomWeaveType プレースホルダーを返します。
finishCall の自動シリアル化パイプラインを使用せずに、saveCallEnd 経由などで Call の出力を手動で構築する場合に使用します。
定義元: src/weaveClient.ts:1424
パラメーター
data
Buffer
生のオーディオバイト (ブラウザとの互換性を最大限確保するには WAV)
audioType?
"wav" = DEFAULT_AUDIO_TYPE
file 形式 — 現在サポートされているのは「wav」のみです
戻り値
Promise<SerializedFileBlob>
updateCall()
updateCall(定義元: src/weaveClient.ts:1710callId,displayName):Promise<void>
パラメーター
callId
string
displayName
string
戻り値
Promise<void>
waitForBatchProcessing()
waitForBatchProcessing():定義元: src/weaveClient.ts:801Promise<void>
戻り値
Promise<void>