BaggageBuilder class

Pacchetto:

@microsoft/agents-a365-observability

Generatore di bagagli per richiesta per la propagazione del contesto OpenTelemetry.

Questa classe fornisce un'API Fluent per impostare i valori dei bagagli che verranno propagati nel contesto OpenTelemetry.

Esempio

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

Metodi

agentAuid(undefined | null | string)	Impostare il valore auid del bagaglio dell'agente.
agentBlueprintId(undefined | null | string)	Impostare il valore del bagaglio id progetto agente.
agentDescription(undefined | null | string)	Impostare il valore del bagaglio della descrizione dell'agente.
agentEmail(undefined | null | string)	Impostare il valore del bagaglio di posta elettronica dell'agente.
agentId(undefined | null | string)	Impostare il valore del bagaglio id agente.
agentName(undefined | null | string)	Impostare il valore del nome dell'agente per il bagaglio.
agentPlatformId(undefined | null | string)	Impostare il valore del bagaglio id piattaforma agente.
agentVersion(undefined | null | string)	Impostare il valore del bagaglio della versione dell'agente.
build()	Applicare il bagaglio raccolto al contesto corrente.
callerAgentPlatformId(undefined | null | string)	Impostare il valore dell'ID piattaforma dell'agente chiamante.
callerClientIp(undefined | null | string)	Impostare il valore del bagaglio IP del chiamante client. Usato per acquisire l'IP client di origine per la richiesta in modo che possa essere propagato tramite il bagaglio OpenTelemetry.
channelLink(undefined | null | string)	Impostare il collegamento o l'URL del canale.
channelName(undefined | null | string)	Impostare il nome del canale, ad esempio Teams, Slack.
conversationId(undefined | null | string)	Impostare il valore del bagaglio id conversazione.
conversationItemLink(undefined | null | string)	Impostare il valore del bagaglio di collegamento dell'elemento della conversazione.
invokeAgentServer(undefined | null | string, number)	Imposta l'indirizzo del server dell'agente invoke e i valori dei bagagli di porta.
operationSource(undefined | null | string)	Impostare il valore del bagaglio di origine dell'operazione. Usato per l'identificazione del servizio (ad esempio, ATG, ACF).
sessionDescription(undefined | null | string)	Impostare il valore del bagaglio della descrizione della sessione.
sessionId(string)	Impostare il valore del bagaglio id sessione.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	Impostare più coppie di bagagli da un dizionario o iterabile.
setRequestContext(null | string, null | string)	Metodo pratico per avviare un ambito bagaglio di richiesta con campi comuni.
tenantId(undefined | null | string)	Impostare il valore del bagaglio ID tenant.
userEmail(undefined | null | string)	Impostare il valore del bagaglio tramite posta elettronica dell'utente.
userId(undefined | null | string)	Impostare il valore del bagaglio ID utente.
userName(undefined | null | string)	Impostare il valore del bagaglio del nome utente.

Dettagli metodo

agentAuid(undefined | null | string)

Impostare il valore auid del bagaglio dell'agente.

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

Parametri

value

undefined | null | string

AUID agente

Valori restituiti

BaggageBuilder

Self-for method chaining

agentBlueprintId(undefined | null | string)

Impostare il valore del bagaglio id progetto agente.

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

Parametri

value

undefined | null | string

ID progetto agente

Valori restituiti

BaggageBuilder

Self-for method chaining

agentDescription(undefined | null | string)

Impostare il valore del bagaglio della descrizione dell'agente.

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

Parametri

value

undefined | null | string

Descrizione dell'agente

Valori restituiti

BaggageBuilder

Self-for method chaining

agentEmail(undefined | null | string)

Impostare il valore del bagaglio di posta elettronica dell'agente.

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

Parametri

value

undefined | null | string

Indirizzo di posta elettronica dell'agente

Valori restituiti

BaggageBuilder

Self-for method chaining

agentId(undefined | null | string)

Impostare il valore del bagaglio id agente.

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

Parametri

value

undefined | null | string

L'ID dell'agente

Valori restituiti

BaggageBuilder

Self-for method chaining

agentName(undefined | null | string)

Impostare il valore del nome dell'agente per il bagaglio.

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

Parametri

value

undefined | null | string

Nome dell'agente

Valori restituiti

BaggageBuilder

Self-for method chaining

agentPlatformId(undefined | null | string)

Impostare il valore del bagaglio id piattaforma agente.

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

Parametri

value

undefined | null | string

ID piattaforma agente

Valori restituiti

BaggageBuilder

Self-for method chaining

agentVersion(undefined | null | string)

Impostare il valore del bagaglio della versione dell'agente.

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

Parametri

value

undefined | null | string

Versione dell'agente (ad esempio, '1.0.0', '2025-05-01')

Valori restituiti

BaggageBuilder

Self-for method chaining

build()

Applicare il bagaglio raccolto al contesto corrente.

function build(): BaggageScope

Valori restituiti

BaggageScope

Gestore del contesto che ripristina il bagaglio precedente all'uscita

callerAgentPlatformId(undefined | null | string)

Impostare il valore dell'ID piattaforma dell'agente chiamante.

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

Parametri

value

undefined | null | string

Identificatore della piattaforma dell'agente chiamante

Valori restituiti

BaggageBuilder

Self-for method chaining

callerClientIp(undefined | null | string)

Impostare il valore del bagaglio IP del chiamante client. Usato per acquisire l'IP client di origine per la richiesta in modo che possa essere propagato tramite il bagaglio OpenTelemetry.

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

Parametri

value

undefined | null | string

Indirizzo IP del client chiamante

Valori restituiti

BaggageBuilder

Self-for method chaining

channelLink(undefined | null | string)

Impostare il collegamento o l'URL del canale.

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

Parametri

value

undefined | null | string

Collegamento al canale

Valori restituiti

BaggageBuilder

Self-for method chaining

channelName(undefined | null | string)

Impostare il nome del canale, ad esempio Teams, Slack.

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

Parametri

value

undefined | null | string

Nome del canale

Valori restituiti

BaggageBuilder

Self-for method chaining

conversationId(undefined | null | string)

Impostare il valore del bagaglio id conversazione.

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

Parametri

value

undefined | null | string

ID conversazione

Valori restituiti

BaggageBuilder

Self-for method chaining

conversationItemLink(undefined | null | string)

Impostare il valore del bagaglio di collegamento dell'elemento della conversazione.

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

Parametri

value

undefined | null | string

Collegamento all'elemento della conversazione

Valori restituiti

BaggageBuilder

Self-for method chaining

invokeAgentServer(undefined | null | string, number)

Imposta l'indirizzo del server dell'agente invoke e i valori dei bagagli di porta.

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

Parametri

address

undefined | null | string

Indirizzo del server (nome host) del servizio agente di destinazione.

port

number

Porta server facoltativa. Registrato solo se diverso da 443.

Valori restituiti

BaggageBuilder

Istanza del generatore corrente per il concatenamento dei metodi.

operationSource(undefined | null | string)

Impostare il valore del bagaglio di origine dell'operazione. Usato per l'identificazione del servizio (ad esempio, ATG, ACF).

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

Parametri

value

undefined | null | string

Origine dell'operazione

Valori restituiti

BaggageBuilder

Self-for method chaining

sessionDescription(undefined | null | string)

Impostare il valore del bagaglio della descrizione della sessione.

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

Parametri

value

undefined | null | string

Descrizione della sessione

Valori restituiti

BaggageBuilder

Self-for method chaining

sessionId(string)

Impostare il valore del bagaglio id sessione.

function sessionId(value: string): BaggageBuilder

Parametri

value

string

L'ID della sessione

Valori restituiti

BaggageBuilder

Self-for method chaining

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

Impostare più coppie di bagagli da un dizionario o iterabile.

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

Parametri

pairs

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

Dizionario o iterabile di coppie chiave-valore

Valori restituiti

BaggageBuilder

Self-for method chaining

setRequestContext(null | string, null | string)

Metodo pratico per avviare un ambito bagaglio di richiesta con campi comuni.

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

Parametri

tenantId

null | string

The tenant ID

agentId

null | string

L'ID dell'agente

Valori restituiti

BaggageScope

Gestore del contesto che ripristina il bagaglio precedente all'uscita

tenantId(undefined | null | string)

Impostare il valore del bagaglio ID tenant.

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

Parametri

value

undefined | null | string

The tenant ID

Valori restituiti

BaggageBuilder

Self-for method chaining

userEmail(undefined | null | string)

Impostare il valore del bagaglio tramite posta elettronica dell'utente.

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

Parametri

value

undefined | null | string

Indirizzo di posta elettronica dell'utente

Valori restituiti

BaggageBuilder

Self-for method chaining

userId(undefined | null | string)

Impostare il valore del bagaglio ID utente.

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

Parametri

value

undefined | null | string

ID utente

Valori restituiti

BaggageBuilder

Self-for method chaining

userName(undefined | null | string)

Impostare il valore del bagaglio del nome utente.

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

Parametri

value

undefined | null | string

Nome dell'utente

Valori restituiti

BaggageBuilder

Self-for method chaining