BaggageBuilder class

Balíček:

@microsoft/agents-a365-observability

Podle požadavku tvůrce zavazadel pro šíření kontextu OpenTelemetry.

Tato třída poskytuje plynulé rozhraní API pro nastavení hodnot zavazadel, které se rozšíří v kontextu OpenTelemetry.

Příklad

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

Metody

agentAuid(undefined | null | string)	Nastavte hodnotu zavazadla AUID agenta.
agentBlueprintId(undefined | null | string)	Nastavte hodnotu id podrobného plánu agenta.
agentDescription(undefined | null | string)	Nastavte hodnotu zavazadlového popisu agenta.
agentEmail(undefined | null | string)	Nastavte hodnotu e-mailového zavazadla agenta.
agentId(undefined | null | string)	Nastavte hodnotu zavazadla ID agenta.
agentName(undefined | null | string)	Nastavte hodnotu zavazadlového jména agenta.
agentPlatformId(undefined | null | string)	Nastavte hodnotu zavazadlového čísla platformy agenta.
agentVersion(undefined | null | string)	Nastavte hodnotu zavazadlového prostoru verze agenta.
build()	Použijte shromážděné zavazadlo na aktuální kontext.
callerAgentPlatformId(undefined | null | string)	Nastavte hodnotu zavazadlového prostoru identifikačního čísla volajícího.
callerClientIp(undefined | null | string)	Nastavte hodnotu IP zavazadel volajícího klienta. Slouží k zachycení IP adresy původního klienta pro žádost, aby bylo možné ji rozšířit prostřednictvím zavazadla OpenTelemetry.
channelLink(undefined | null | string)	Nastavte odkaz na kanál nebo adresu URL.
channelName(undefined | null | string)	Nastavte název kanálu (např. Teams, Slack).
conversationId(undefined | null | string)	Nastavte hodnotu zavazadla ID konverzace.
conversationItemLink(undefined | null | string)	Nastavte hodnotu zavazadlového prostoru položky konverzace.
invokeAgentServer(undefined | null | string, number)	Nastaví adresu serveru vyvolání agenta a hodnoty portových zavazadel.
operationSource(undefined | null | string)	Nastavte hodnotu zdrojového zavazadla provozu. Používá se pro rozsahy serverů k identifikaci služby (např. ATG, ACF).
sessionDescription(undefined | null | string)	Nastavte hodnotu zavazadla popisu relace.
sessionId(string)	Nastavte hodnotu zavazadla ID relace.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	Nastavte několik párů zavazadel ze slovníku nebo iterovatelné.
setRequestContext(null | string, null | string)	Metoda pohodlí pro zahájení žádosti o rozsah zavazadel se společnými poli.
tenantId(undefined | null | string)	Nastavte hodnotu zavazadla ID tenanta.
userEmail(undefined | null | string)	Nastavte hodnotu e-mailového zavazadla uživatele.
userId(undefined | null | string)	Nastavte hodnotu zavazadla ID uživatele.
userName(undefined | null | string)	Nastavte hodnotu zavazadla uživatelského jména.

Podrobnosti metody

agentAuid(undefined | null | string)

Nastavte hodnotu zavazadla AUID agenta.

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

Parametry

value

undefined | null | string

AUID agenta

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

agentBlueprintId(undefined | null | string)

Nastavte hodnotu id podrobného plánu agenta.

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

Parametry

value

undefined | null | string

ID podrobného plánu agenta

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

agentDescription(undefined | null | string)

Nastavte hodnotu zavazadlového popisu agenta.

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

Parametry

value

undefined | null | string

Popis agenta

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

agentEmail(undefined | null | string)

Nastavte hodnotu e-mailového zavazadla agenta.

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

Parametry

value

undefined | null | string

E-mail agenta

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

agentId(undefined | null | string)

Nastavte hodnotu zavazadla ID agenta.

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

Parametry

value

undefined | null | string

ID agenta

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

agentName(undefined | null | string)

Nastavte hodnotu zavazadlového jména agenta.

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

Parametry

value

undefined | null | string

Název agenta

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

agentPlatformId(undefined | null | string)

Nastavte hodnotu zavazadlového čísla platformy agenta.

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

Parametry

value

undefined | null | string

ID platformy agenta

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

agentVersion(undefined | null | string)

Nastavte hodnotu zavazadlového prostoru verze agenta.

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

Parametry

value

undefined | null | string

Verze agenta (např. 1.0.0, 2025-05-01)

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

build()

Použijte shromážděné zavazadlo na aktuální kontext.

function build(): BaggageScope

Návraty

BaggageScope

Kontextový manažer, který obnoví předchozí zavazadlo při opuštění

callerAgentPlatformId(undefined | null | string)

Nastavte hodnotu zavazadlového prostoru identifikačního čísla volajícího.

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

Parametry

value

undefined | null | string

Identifikátor platformy agenta volajícího

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

callerClientIp(undefined | null | string)

Nastavte hodnotu IP zavazadel volajícího klienta. Slouží k zachycení IP adresy původního klienta pro žádost, aby bylo možné ji rozšířit prostřednictvím zavazadla OpenTelemetry.

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

Parametry

value

undefined | null | string

IP adresa klienta volajícího

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

channelLink(undefined | null | string)

Nastavte odkaz na kanál nebo adresu URL.

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

Parametry

value

undefined | null | string

Odkaz na kanál

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

channelName(undefined | null | string)

Nastavte název kanálu (např. Teams, Slack).

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

Parametry

value

undefined | null | string

Název kanálu

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

conversationId(undefined | null | string)

Nastavte hodnotu zavazadla ID konverzace.

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

Parametry

value

undefined | null | string

ID konverzace

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

conversationItemLink(undefined | null | string)

Nastavte hodnotu zavazadlového prostoru položky konverzace.

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

Parametry

value

undefined | null | string

Odkaz na položku konverzace

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

invokeAgentServer(undefined | null | string, number)

Nastaví adresu serveru vyvolání agenta a hodnoty portových zavazadel.

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

Parametry

address

undefined | null | string

Adresa serveru (název hostitele) cílové služby agenta.

port

number

Volitelný port serveru. Zaznamenáno pouze v jiném než 443.

Návraty

BaggageBuilder

Aktuální instance tvůrce pro řetězení metod.

operationSource(undefined | null | string)

Nastavte hodnotu zdrojového zavazadla provozu. Používá se pro rozsahy serverů k identifikaci služby (např. ATG, ACF).

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

Parametry

value

undefined | null | string

Zdroj operace

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

sessionDescription(undefined | null | string)

Nastavte hodnotu zavazadla popisu relace.

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

Parametry

value

undefined | null | string

Popis relace

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

sessionId(string)

Nastavte hodnotu zavazadla ID relace.

function sessionId(value: string): BaggageBuilder

Parametry

value

string

ID relace

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

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

Nastavte několik párů zavazadel ze slovníku nebo iterovatelné.

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

Parametry

pairs

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

Slovník nebo iterable párů klíč-hodnota

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

setRequestContext(null | string, null | string)

Metoda pohodlí pro zahájení žádosti o rozsah zavazadel se společnými poli.

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

Parametry

tenantId

null | string

ID tenanta

agentId

null | string

ID agenta

Návraty

BaggageScope

Kontextový manažer, který obnoví předchozí zavazadlo při opuštění

tenantId(undefined | null | string)

Nastavte hodnotu zavazadla ID tenanta.

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

Parametry

value

undefined | null | string

ID tenanta

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

userEmail(undefined | null | string)

Nastavte hodnotu e-mailového zavazadla uživatele.

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

Parametry

value

undefined | null | string

E-mail uživatele

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

userId(undefined | null | string)

Nastavte hodnotu zavazadla ID uživatele.

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

Parametry

value

undefined | null | string

ID uživatele

Návraty

BaggageBuilder

Samoobslužné zřetězování metod

userName(undefined | null | string)

Nastavte hodnotu zavazadla uživatelského jména.

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

Parametry

value

undefined | null | string

Uživatelské jméno

Návraty

BaggageBuilder

Samoobslužné zřetězování metod