BaggageBuilder class

Paketti:

@microsoft/agents-a365-observability

Pyynnön matkatavaranmuodostin OpenTelemetry-kontekstin levittämistä varten.

Tämä luokka tarjoaa sujuvan ohjelmointirajapinnan matkatavaraarvojen asettamiseen, jotka välitetään OpenTelemetry-kontekstissa.

Esimerkki

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

Menetelmät

agentAuid(undefined | null | string)	Määritä agentin AUID-matkatavaran arvo.
agentBlueprintId(undefined | null | string)	Määritä agentin suunnitelman matkatavaran arvo.
agentDescription(undefined | null | string)	Määritä agentin kuvaus matkatavaran arvo.
agentEmail(undefined | null | string)	Määritä agentin sähköpostimatkatavaran arvo.
agentId(undefined | null | string)	Määritä agent id -matkatavaran arvo.
agentName(undefined | null | string)	Määritä agentin nimi matkatavaran arvo.
agentPlatformId(undefined | null | string)	Määritä agent platform ID -matkatavaran arvo.
agentVersion(undefined | null | string)	Määritä agentin version matkatavaran arvo.
build()	Käytä kerättyjä matkatavaroita nykyiseen kontekstiin.
callerAgentPlatformId(undefined | null | string)	Määritä soittaja-agentin alustan id-matkatavaran arvo.
callerClientIp(undefined | null | string)	Määritä soittajan asiakkaan IP-matkatavaran arvo. Käytetään pyynnön alkuperänä olevan asiakkaan IP-osoitteen sieppaamiseen, jotta se voidaan lisätä OpenTelemetry-matkatavaroiden kautta.
channelLink(undefined | null | string)	Määritä kanavan linkki/URL-osoite.
channelName(undefined | null | string)	Määritä kanavan nimi (esimerkiksi Teams, Slack).
conversationId(undefined | null | string)	Määritä keskustelun tunnuksen matkatavaran arvo.
conversationItemLink(undefined | null | string)	Määritä keskustelukohteen linkin matkatavaran arvo.
invokeAgentServer(undefined | null | string, number)	Määrittää agentin palvelimen osoitteen ja portin matkatavaraarvot.
operationSource(undefined | null | string)	Määritä käyttölähteen matkatavaran arvo. Käytetään palvelinvälien palvelun tunnistamiseen (esimerkiksi ATG, ACF).
sessionDescription(undefined | null | string)	Määritä istunnon kuvaus matkatavaran arvo.
sessionId(string)	Määritä istuntotunnuksen matkatavaran arvo.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	Määritä useita matkatavarapareja sanastosta tai iterable.
setRequestContext(null | string, null | string)	Kätevyysmenetelmä, jolla voit aloittaa matkatavarasäädännän, joka sisältää yleisiä kenttiä.
tenantId(undefined | null | string)	Määritä vuokraajan tunnuksen matkatavaran arvo.
userEmail(undefined | null | string)	Määritä käyttäjän sähköpostin matkatavaran arvo.
userId(undefined | null | string)	Määritä matkatavaran käyttäjätunnus.
userName(undefined | null | string)	Määritä käyttäjänimen matkatavaran arvo.

Menetelmän tiedot

agentAuid(undefined | null | string)

Määritä agentin AUID-matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Agentti AUID

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

agentBlueprintId(undefined | null | string)

Määritä agentin suunnitelman matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Agentin suunnitelman tunnus

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

agentDescription(undefined | null | string)

Määritä agentin kuvaus matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Agentin kuvaus

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

agentEmail(undefined | null | string)

Määritä agentin sähköpostimatkatavaran arvo.

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

Parametrit

value

undefined | null | string

Agentin sähköpostiosoite

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

agentId(undefined | null | string)

Määritä agent id -matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Agenttitunnus

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

agentName(undefined | null | string)

Määritä agentin nimi matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Agentin nimi

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

agentPlatformId(undefined | null | string)

Määritä agent platform ID -matkatavaran arvo.

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

Parametrit

value

undefined | null | string

The agent platform ID

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

agentVersion(undefined | null | string)

Määritä agentin version matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Agentin versio (esim. '1.0.0', '2025-05-01')

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

build()

Käytä kerättyjä matkatavaroita nykyiseen kontekstiin.

function build(): BaggageScope

Palautukset

BaggageScope

Kontekstipäällikkö, joka palauttaa edellisen matkatavaran poistumisen yhteydessä

callerAgentPlatformId(undefined | null | string)

Määritä soittaja-agentin alustan id-matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Soittaja-agentin käyttöympäristön tunniste

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

callerClientIp(undefined | null | string)

Määritä soittajan asiakkaan IP-matkatavaran arvo. Käytetään pyynnön alkuperänä olevan asiakkaan IP-osoitteen sieppaamiseen, jotta se voidaan lisätä OpenTelemetry-matkatavaroiden kautta.

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

Parametrit

value

undefined | null | string

Soittajan asiakkaan IP-osoite

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

channelLink(undefined | null | string)

Määritä kanavan linkki/URL-osoite.

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

Parametrit

value

undefined | null | string

Kanavalinkki

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

channelName(undefined | null | string)

Määritä kanavan nimi (esimerkiksi Teams, Slack).

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

Parametrit

value

undefined | null | string

Kanavan nimi

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

conversationId(undefined | null | string)

Määritä keskustelun tunnuksen matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Keskustelun tunnus

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

conversationItemLink(undefined | null | string)

Määritä keskustelukohteen linkin matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Keskustelukohteen linkki

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

invokeAgentServer(undefined | null | string, number)

Määrittää agentin palvelimen osoitteen ja portin matkatavaraarvot.

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

Parametrit

address

undefined | null | string

Kohdeagenttipalvelun palvelimen osoite (isäntänimi).

port

number

Valinnainen palvelinportti. Tallennetaan vain, kun arvo on eri kuin 443.

Palautukset

BaggageBuilder

Nykyinen muodostimen esiintymä menetelmän ketjutusta varten.

operationSource(undefined | null | string)

Määritä käyttölähteen matkatavaran arvo. Käytetään palvelinvälien palvelun tunnistamiseen (esimerkiksi ATG, ACF).

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

Parametrit

value

undefined | null | string

Toimintolähde

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

sessionDescription(undefined | null | string)

Määritä istunnon kuvaus matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Istunnon kuvaus

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

sessionId(string)

Määritä istuntotunnuksen matkatavaran arvo.

function sessionId(value: string): BaggageBuilder

Parametrit

value

string

Istunnon tunnus

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

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

Määritä useita matkatavarapareja sanastosta tai iterable.

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

Parametrit

pairs

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

Sanasto tai key-value-parien iterable

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

setRequestContext(null | string, null | string)

Kätevyysmenetelmä, jolla voit aloittaa matkatavarasäädännän, joka sisältää yleisiä kenttiä.

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

Parametrit

tenantId

null | string

Vuokraajan tunnus

agentId

null | string

Agenttitunnus

Palautukset

BaggageScope

Kontekstipäällikkö, joka palauttaa edellisen matkatavaran poistumisen yhteydessä

tenantId(undefined | null | string)

Määritä vuokraajan tunnuksen matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Vuokraajan tunnus

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

userEmail(undefined | null | string)

Määritä käyttäjän sähköpostin matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Käyttäjän sähköpostiosoite

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

userId(undefined | null | string)

Määritä matkatavaran käyttäjätunnus.

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

Parametrit

value

undefined | null | string

Käyttäjätunnus

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse

userName(undefined | null | string)

Määritä käyttäjänimen matkatavaran arvo.

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

Parametrit

value

undefined | null | string

Käyttäjänimi

Palautukset

BaggageBuilder

Menetelmän ketjutuksen itse