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")
  .correlationId("corr-789")
  .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.
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.
agentUpn(undefined | null | string)	Impostare il valore upN del bagaglio dell'agente.
build()	Applicare il bagaglio raccolto al contesto corrente.
callerId(undefined | null | string)	Impostare il valore del bagaglio ID chiamante.
callerName(undefined | null | string)	Impostare il valore del nome del chiamante.
callerUpn(undefined | null | string)	Impostare il valore UPN del chiamante.
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.
correlationId(undefined | null | string)	Impostare il valore del bagaglio ID di correlazione.
hiringManagerId(undefined | null | string)	Impostare il valore dell'ID del responsabile delle assunzioni.
operationSource(undefined | null | string)	Impostare il valore del bagaglio di origine dell'operazione.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	Impostare più coppie di bagagli da un dizionario o iterabile.
setRequestContext(null | string, null | string, null | string)	Metodo pratico per avviare un ambito bagaglio di richiesta con campi comuni.
sourceMetadataDescription(undefined | null | string)	Impostare la descrizione dei metadati dell'origine di esecuzione, ad esempio la descrizione del canale.
sourceMetadataId(undefined | null | string)	Impostare l'ID dei metadati dell'origine di esecuzione, ad esempio l'ID canale.
sourceMetadataName(undefined | null | string)	Impostare il nome dei metadati dell'origine di esecuzione, ad esempio il nome del canale.
tenantId(undefined | null | string)	Impostare il valore del bagaglio ID tenant.

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

Restituisce

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

Restituisce

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

Restituisce

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

Restituisce

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

Restituisce

BaggageBuilder

Self-for method chaining

agentUpn(undefined | null | string)

Impostare il valore upN del bagaglio dell'agente.

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

Parametri

value

undefined | null | string

UPN agente

Restituisce

BaggageBuilder

Self-for method chaining

build()

Applicare il bagaglio raccolto al contesto corrente.

function build(): BaggageScope

Restituisce

BaggageScope

Gestore del contesto che ripristina il bagaglio precedente all'uscita

callerId(undefined | null | string)

Impostare il valore del bagaglio ID chiamante.

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

Parametri

value

undefined | null | string

ID chiamante

Restituisce

BaggageBuilder

Self-for method chaining

callerName(undefined | null | string)

Impostare il valore del nome del chiamante.

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

Parametri

value

undefined | null | string

Nome del chiamante

Restituisce

BaggageBuilder

Self-for method chaining

callerUpn(undefined | null | string)

Impostare il valore UPN del chiamante.

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

Parametri

value

undefined | null | string

UPN del chiamante

Restituisce

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

Restituisce

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

Restituisce

BaggageBuilder

Self-for method chaining

correlationId(undefined | null | string)

Impostare il valore del bagaglio ID di correlazione.

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

Parametri

value

undefined | null | string

ID correlazione

Restituisce

BaggageBuilder

Self-for method chaining

hiringManagerId(undefined | null | string)

Impostare il valore dell'ID del responsabile delle assunzioni.

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

Parametri

value

undefined | null | string

ID responsabile assunzioni

Restituisce

BaggageBuilder

Self-for method chaining

operationSource(undefined | null | string)

Impostare il valore del bagaglio di origine dell'operazione.

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

Parametri

value

undefined | null | string

Valore dell'origine dell'operazione

Restituisce

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

Restituisce

BaggageBuilder

Self-for method chaining

setRequestContext(null | string, 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, correlationId?: null | string): BaggageScope

Parametri

tenantId

null | string

The tenant ID

agentId

null | string

L'ID dell'agente

correlationId

null | string

ID correlazione

Restituisce

BaggageScope

Gestore del contesto che ripristina il bagaglio precedente all'uscita

sourceMetadataDescription(undefined | null | string)

Impostare la descrizione dei metadati dell'origine di esecuzione, ad esempio la descrizione del canale.

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

Parametri

value

undefined | null | string

Descrizione dei metadati di origine

Restituisce

BaggageBuilder

Self-for method chaining

sourceMetadataId(undefined | null | string)

Impostare l'ID dei metadati dell'origine di esecuzione, ad esempio l'ID canale.

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

Parametri

value

undefined | null | string

ID metadati di origine

Restituisce

BaggageBuilder

Self-for method chaining

sourceMetadataName(undefined | null | string)

Impostare il nome dei metadati dell'origine di esecuzione, ad esempio il nome del canale.

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

Parametri

value

undefined | null | string

Nome dei metadati di origine

Restituisce

BaggageBuilder

Self-for method chaining

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

Restituisce

BaggageBuilder

Self-for method chaining