BaggageBuilder class

パッケージ:

@microsoft/agents-a365-observability

OpenTelemetry コンテキスト伝達の要求手荷物ビルダーごと。

このクラスは、OpenTelemetry コンテキストで伝達される手荷物の値を設定するための fluent API を提供します。

例

const scope = new BaggageBuilder()
  .tenantId("tenant-123")
  .agentId("agent-456")
  .correlationId("corr-789")
  .build();

scope.enter();
// Baggage is set in this context
// ... do work ...
scope.exit();
// Baggage is restored after exiting the context

メソッド

agentAuid(undefined | null | string)	エージェント AUID 手荷物の値を設定します。
agentBlueprintId(undefined | null | string)	エージェントのブループリント ID 手荷物の値を設定します。
agentDescription(undefined | null | string)	エージェントの説明の手荷物の値を設定します。
agentId(undefined | null | string)	エージェント ID の手荷物の値を設定します。
agentName(undefined | null | string)	エージェント名の手荷物の値を設定します。
agentUpn(undefined | null | string)	エージェント UPN 手荷物の値を設定します。
build()	収集した手荷物を現在のコンテキストに適用します。
callerId(undefined | null | string)	発信者番号の手荷物の値を設定します。
callerName(undefined | null | string)	発信者名の手荷物の値を設定します。
callerUpn(undefined | null | string)	発信者の UPN 手荷物の値を設定します。
conversationId(undefined | null | string)	会話 ID の手荷物の値を設定します。
conversationItemLink(undefined | null | string)	会話項目リンク手荷物の値を設定します。
correlationId(undefined | null | string)	関連付け ID 手荷物の値を設定します。
hiringManagerId(undefined | null | string)	雇用管理者 ID 手荷物の値を設定します。
operationSource(undefined | null | string)	操作ソースの手荷物の値を設定します。
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	辞書または iterable から複数の手荷物ペアを設定します。
setRequestContext(null | string, null | string, null | string)	共通フィールドを使用して手荷物の範囲を要求する便利な方法。
sourceMetadataDescription(undefined | null | string)	実行ソース メタデータの説明 (チャネルの説明など) を設定します。
sourceMetadataId(undefined | null | string)	実行ソース メタデータ ID (チャネル ID など) を設定します。
sourceMetadataName(undefined | null | string)	実行ソース メタデータ名 (チャネル名など) を設定します。
tenantId(undefined | null | string)	テナント ID の手荷物の値を設定します。

メソッドの詳細

agentAuid(undefined | null | string)

エージェント AUID 手荷物の値を設定します。

function agentAuid(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

エージェント AUID

戻り値

BaggageBuilder

メソッド チェーン用の自己

agentBlueprintId(undefined | null | string)

エージェントのブループリント ID 手荷物の値を設定します。

function agentBlueprintId(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

エージェントブループリント ID

戻り値

BaggageBuilder

メソッド チェーン用の自己

agentDescription(undefined | null | string)

エージェントの説明の手荷物の値を設定します。

function agentDescription(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

エージェントの説明

戻り値

BaggageBuilder

メソッド チェーン用の自己

agentId(undefined | null | string)

エージェント ID の手荷物の値を設定します。

function agentId(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

エージェントの ID

戻り値

BaggageBuilder

メソッド チェーン用の自己

agentName(undefined | null | string)

エージェント名の手荷物の値を設定します。

function agentName(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

エージェント名

戻り値

BaggageBuilder

メソッド チェーン用の自己

agentUpn(undefined | null | string)

エージェント UPN 手荷物の値を設定します。

function agentUpn(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

エージェント UPN

戻り値

BaggageBuilder

メソッド チェーン用の自己

build()

収集した手荷物を現在のコンテキストに適用します。

function build(): BaggageScope

戻り値

BaggageScope

出口で前の手荷物を復元するコンテキスト マネージャー

callerId(undefined | null | string)

発信者番号の手荷物の値を設定します。

function callerId(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

呼び出し元 ID

戻り値

BaggageBuilder

メソッド チェーン用の自己

callerName(undefined | null | string)

発信者名の手荷物の値を設定します。

function callerName(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

呼び出し元名

戻り値

BaggageBuilder

メソッド チェーン用の自己

callerUpn(undefined | null | string)

発信者の UPN 手荷物の値を設定します。

function callerUpn(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

呼び出し元 UPN

戻り値

BaggageBuilder

メソッド チェーン用の自己

conversationId(undefined | null | string)

会話 ID の手荷物の値を設定します。

function conversationId(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

会話 ID

戻り値

BaggageBuilder

メソッド チェーン用の自己

conversationItemLink(undefined | null | string)

会話項目リンク手荷物の値を設定します。

function conversationItemLink(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

会話アイテムのリンク

戻り値

BaggageBuilder

メソッド チェーン用の自己

correlationId(undefined | null | string)

関連付け ID 手荷物の値を設定します。

function correlationId(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

関連付け ID

戻り値

BaggageBuilder

メソッド チェーン用の自己

hiringManagerId(undefined | null | string)

雇用管理者 ID 手荷物の値を設定します。

function hiringManagerId(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

採用マネージャー ID

戻り値

BaggageBuilder

メソッド チェーン用の自己

operationSource(undefined | null | string)

操作ソースの手荷物の値を設定します。

function operationSource(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

操作ソースの値

戻り値

BaggageBuilder

メソッド チェーン用の自己

setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)

辞書または iterable から複数の手荷物ペアを設定します。

function setPairs(pairs: undefined | null | Record<string, any> | Iterable<[string, any]>): BaggageBuilder

パラメーター

pairs

undefined | null | Record<string, any> | Iterable<[string, any]>

キーと値のペアのディクショナリまたはイターブル

戻り値

BaggageBuilder

メソッド チェーン用の自己

setRequestContext(null | string, null | string, null | string)

共通フィールドを使用して手荷物の範囲を要求する便利な方法。

static function setRequestContext(tenantId?: null | string, agentId?: null | string, correlationId?: null | string): BaggageScope

パラメーター

tenantId

null | string

テナント ID

agentId

null | string

エージェントの ID

correlationId

null | string

関連付け ID

戻り値

BaggageScope

出口で前の手荷物を復元するコンテキスト マネージャー

sourceMetadataDescription(undefined | null | string)

実行ソース メタデータの説明 (チャネルの説明など) を設定します。

function sourceMetadataDescription(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

ソース メタデータの説明

戻り値

BaggageBuilder

メソッド チェーン用の自己

sourceMetadataId(undefined | null | string)

実行ソース メタデータ ID (チャネル ID など) を設定します。

function sourceMetadataId(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

ソース メタデータ ID

戻り値

BaggageBuilder

メソッド チェーン用の自己

sourceMetadataName(undefined | null | string)

実行ソース メタデータ名 (チャネル名など) を設定します。

function sourceMetadataName(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

ソース メタデータ名

戻り値

BaggageBuilder

メソッド チェーン用の自己

tenantId(undefined | null | string)

テナント ID の手荷物の値を設定します。

function tenantId(value: undefined | null | string): BaggageBuilder

パラメーター

value

undefined | null | string

テナント ID

戻り値

BaggageBuilder

メソッド チェーン用の自己