BaggageBuilder class

Paket:

@microsoft/agents-a365-observability

OpenTelemetry bağlam yayma için istek bagaj oluşturucusu başına.

Bu sınıf, OpenTelemetry bağlamında yayılacak bagaj değerlerini ayarlamak için akıcı bir API sağlar.

Örnek

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

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

Yöntemler

agentAuid(undefined | null | string)	Aracı AUID bagaj değerini ayarlayın.
agentBlueprintId(undefined | null | string)	Aracı şema kimliği bagaj değerini ayarlayın.
agentDescription(undefined | null | string)	Aracı açıklaması bagaj değerini ayarlayın.
agentEmail(undefined | null | string)	Aracı e-posta bagaj değerini ayarlayın.
agentId(undefined | null | string)	Aracı kimliği bagaj değerini ayarlayın.
agentName(undefined | null | string)	Aracı adı bagaj değerini ayarlayın.
agentPlatformId(undefined | null | string)	Aracı platform kimliği bagaj değerini ayarlayın.
agentVersion(undefined | null | string)	Aracı sürümü bagaj değerini ayarlayın.
build()	Toplanan bagajları geçerli bağlama uygulayın.
callerAgentPlatformId(undefined | null | string)	Arayan aracı platform kimliği bagaj değerini ayarlayın.
callerClientIp(undefined | null | string)	Arayan istemci IP bagaj değerini ayarlayın. OpenTelemetry bagaj aracılığıyla yayılabilmesi için isteğin kaynak istemci IP'sini yakalamak için kullanılır.
channelLink(undefined | null | string)	Kanal bağlantısını/URL'sini ayarlayın.
channelName(undefined | null | string)	Kanal adını (teams, slack gibi) ayarlayın.
conversationId(undefined | null | string)	Konuşma kimliği bagaj değerini ayarlayın.
conversationItemLink(undefined | null | string)	Konuşma öğesi bağlantı bagaj değerini ayarlayın.
invokeAgentServer(undefined | null | string, number)	Çağırma aracısı sunucu adresini ve bağlantı noktası bagaj değerlerini ayarlar.
operationSource(undefined | null | string)	İşlem kaynağı bagaj değerini ayarlayın. Hizmeti tanımlamak için sunucu yayılmaları için kullanılır (örneğin, ATG, ACF).
sessionDescription(undefined | null | string)	Oturum açıklaması bagaj değerini ayarlayın.
sessionId(string)	Oturum kimliği bagaj değerini ayarlayın.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	Bir sözlükten veya yinelenebilir bir sözlükten birden çok bagaj çifti ayarlayın.
setRequestContext(null | string, null | string)	Ortak alanlarla bir istek bagaj kapsamı başlatmak için kolaylık yöntemi.
tenantId(undefined | null | string)	Kiracı kimliği bagaj değerini ayarlayın.
userEmail(undefined | null | string)	Kullanıcı e-posta bagaj değerini ayarlayın.
userId(undefined | null | string)	Kullanıcı kimliği bagaj değerini ayarlayın.
userName(undefined | null | string)	Kullanıcı adı bagaj değerini ayarlayın.

Yöntem Ayrıntıları

agentAuid(undefined | null | string)

Aracı AUID bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Aracı AUID

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

agentBlueprintId(undefined | null | string)

Aracı şema kimliği bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Aracı şema kimliği

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

agentDescription(undefined | null | string)

Aracı açıklaması bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Aracı açıklaması

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

agentEmail(undefined | null | string)

Aracı e-posta bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Aracı e-postası

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

agentId(undefined | null | string)

Aracı kimliği bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Aracı kimliği

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

agentName(undefined | null | string)

Aracı adı bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Aracı adı

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

agentPlatformId(undefined | null | string)

Aracı platform kimliği bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Aracı platform kimliği

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

agentVersion(undefined | null | string)

Aracı sürümü bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Aracı sürümü (örneğin, '1.0.0', '2025-05-01')

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

build()

Toplanan bagajları geçerli bağlama uygulayın.

function build(): BaggageScope

Döndürülenler

BaggageScope

Çıkışta önceki bagajı geri yükleyen bağlam yöneticisi

callerAgentPlatformId(undefined | null | string)

Arayan aracı platform kimliği bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Çağıran aracı platform tanımlayıcısı

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

callerClientIp(undefined | null | string)

Arayan istemci IP bagaj değerini ayarlayın. OpenTelemetry bagaj aracılığıyla yayılabilmesi için isteğin kaynak istemci IP'sini yakalamak için kullanılır.

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

Parametreler

value

undefined | null | string

Çağıran istemci IP adresi

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

channelLink(undefined | null | string)

Kanal bağlantısını/URL'sini ayarlayın.

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

Parametreler

value

undefined | null | string

Kanal bağlantısı

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

channelName(undefined | null | string)

Kanal adını (teams, slack gibi) ayarlayın.

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

Parametreler

value

undefined | null | string

Kanal adı

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

conversationId(undefined | null | string)

Konuşma kimliği bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Konuşma kimliği

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

conversationItemLink(undefined | null | string)

Konuşma öğesi bağlantı bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Konuşma öğesi bağlantısı

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

invokeAgentServer(undefined | null | string, number)

Çağırma aracısı sunucu adresini ve bağlantı noktası bagaj değerlerini ayarlar.

function invokeAgentServer(address: undefined | null | string, port?: number): BaggageBuilder

Parametreler

address

undefined | null | string

Hedef aracı hizmetinin sunucu adresi (konak adı).

port

number

İsteğe bağlı sunucu bağlantı noktası. Yalnızca 443'ten farklı olduğunda kaydedilir.

Döndürülenler

BaggageBuilder

Yöntem zinciri için geçerli oluşturucu örneği.

operationSource(undefined | null | string)

İşlem kaynağı bagaj değerini ayarlayın. Hizmeti tanımlamak için sunucu yayılmaları için kullanılır (örneğin, ATG, ACF).

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

Parametreler

value

undefined | null | string

İşlem kaynağı

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

sessionDescription(undefined | null | string)

Oturum açıklaması bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Oturum açıklaması

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

sessionId(string)

Oturum kimliği bagaj değerini ayarlayın.

function sessionId(value: string): BaggageBuilder

Parametreler

value

string

Oturum kimliği

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

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

Bir sözlükten veya yinelenebilir bir sözlükten birden çok bagaj çifti ayarlayın.

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

Parametreler

pairs

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

Sözlük veya anahtar-değer çiftlerinin yinelenebilir olması

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

setRequestContext(null | string, null | string)

Ortak alanlarla bir istek bagaj kapsamı başlatmak için kolaylık yöntemi.

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

Parametreler

tenantId

null | string

Kiracı kimliği

agentId

null | string

Aracı kimliği

Döndürülenler

BaggageScope

Çıkışta önceki bagajı geri yükleyen bağlam yöneticisi

tenantId(undefined | null | string)

Kiracı kimliği bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Kiracı kimliği

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

userEmail(undefined | null | string)

Kullanıcı e-posta bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Kullanıcı e-postası

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

userId(undefined | null | string)

Kullanıcı kimliği bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Kullanıcı kimliği

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self

userName(undefined | null | string)

Kullanıcı adı bagaj değerini ayarlayın.

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

Parametreler

value

undefined | null | string

Kullanıcı adı

Döndürülenler

BaggageBuilder

Yöntem zincirleme için self