BaggageBuilder class

Paket:

@microsoft/agents-a365-observability

Gepäck-Generator pro Anforderung für die OpenTelemetry-Kontextverteilung.

Diese Klasse bietet eine Fluent-API zum Festlegen von Gepäckwerten, die im OpenTelemetry-Kontext weitergegeben werden.

Beispiel

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

Methoden

agentAuid(undefined | null | string)	Legen Sie den AuID-Gepäckwert des Agenten fest.
agentBlueprintId(undefined | null | string)	Legen Sie den Gepäckwert für die Agent-Blueprint-ID fest.
agentDescription(undefined | null | string)	Legen Sie den Gepäckwert für die Agentbeschreibung fest.
agentId(undefined | null | string)	Legen Sie den Gepäckwert für die Agent-ID fest.
agentName(undefined | null | string)	Legen Sie den Gepäckwert für den Agentennamen fest.
agentUpn(undefined | null | string)	Legen Sie den UPN-Gepäckwert des Agenten fest.
build()	Wenden Sie das gesammelte Gepäck auf den aktuellen Kontext an.
callerId(undefined | null | string)	Legen Sie den Gepäckwert der Anrufer-ID fest.
callerName(undefined | null | string)	Legen Sie den Gepäckwert des Anrufers fest.
callerUpn(undefined | null | string)	Legen Sie den UPN-Gepäckwert des Anrufers fest.
conversationId(undefined | null | string)	Legen Sie den Gepäckwert der Unterhaltungs-ID fest.
conversationItemLink(undefined | null | string)	Legen Sie den Link-Gepäckwert für Unterhaltungsartikel fest.
correlationId(undefined | null | string)	Legen Sie den Korrelations-ID-Gepäckwert fest.
hiringManagerId(undefined | null | string)	Legen Sie den Einstellungsmanager-ID-Gepäckwert fest.
operationSource(undefined | null | string)	Legen Sie den Gepäckwert für den Betrieb fest.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	Legen Sie mehrere Gepäckpaare aus einem Wörterbuch oder iterierbar fest.
setRequestContext(null | string, null | string, null | string)	Convenience-Methode, um einen Anforderungsgepäckbereich mit gemeinsamen Feldern zu beginnen.
sourceMetadataDescription(undefined | null | string)	Legen Sie die Beschreibung der Ausführungsquellenmetadaten fest (z. B. Kanalbeschreibung).
sourceMetadataId(undefined | null | string)	Legen Sie die Metadaten-ID der Ausführungsquelle fest (z. B. Kanal-ID).
sourceMetadataName(undefined | null | string)	Legen Sie den Namen der Ausführungsquellenmetadaten fest (z. B. Kanalname).
tenantId(undefined | null | string)	Legen Sie den Gepäckwert der Mandanten-ID fest.

Details zur Methode

agentAuid(undefined | null | string)

Legen Sie den AuID-Gepäckwert des Agenten fest.

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

Parameter

value

undefined | null | string

Der Agent AUID

Gibt zurück

BaggageBuilder

Self for method chaining

agentBlueprintId(undefined | null | string)

Legen Sie den Gepäckwert für die Agent-Blueprint-ID fest.

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

Parameter

value

undefined | null | string

Die Agent-Blueprint-ID

Gibt zurück

BaggageBuilder

Self for method chaining

agentDescription(undefined | null | string)

Legen Sie den Gepäckwert für die Agentbeschreibung fest.

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

Parameter

value

undefined | null | string

Die Agentbeschreibung

Gibt zurück

BaggageBuilder

Self for method chaining

agentId(undefined | null | string)

Legen Sie den Gepäckwert für die Agent-ID fest.

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

Parameter

value

undefined | null | string

Die Agenten-ID

Gibt zurück

BaggageBuilder

Self for method chaining

agentName(undefined | null | string)

Legen Sie den Gepäckwert für den Agentennamen fest.

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

Parameter

value

undefined | null | string

Der Agentname

Gibt zurück

BaggageBuilder

Self for method chaining

agentUpn(undefined | null | string)

Legen Sie den UPN-Gepäckwert des Agenten fest.

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

Parameter

value

undefined | null | string

Der Agent-UPN

Gibt zurück

BaggageBuilder

Self for method chaining

build()

Wenden Sie das gesammelte Gepäck auf den aktuellen Kontext an.

function build(): BaggageScope

Gibt zurück

BaggageScope

Ein Kontextmanager, der das vorherige Gepäck beim Verlassen wiederhergestellt

callerId(undefined | null | string)

Legen Sie den Gepäckwert der Anrufer-ID fest.

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

Parameter

value

undefined | null | string

Die Anrufer-ID

Gibt zurück

BaggageBuilder

Self for method chaining

callerName(undefined | null | string)

Legen Sie den Gepäckwert des Anrufers fest.

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

Parameter

value

undefined | null | string

Der Name des Anrufers

Gibt zurück

BaggageBuilder

Self for method chaining

callerUpn(undefined | null | string)

Legen Sie den UPN-Gepäckwert des Anrufers fest.

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

Parameter

value

undefined | null | string

UpN des Anrufers

Gibt zurück

BaggageBuilder

Self for method chaining

conversationId(undefined | null | string)

Legen Sie den Gepäckwert der Unterhaltungs-ID fest.

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

Parameter

value

undefined | null | string

Die Unterhaltungs-ID

Gibt zurück

BaggageBuilder

Self for method chaining

conversationItemLink(undefined | null | string)

Legen Sie den Link-Gepäckwert für Unterhaltungsartikel fest.

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

Parameter

value

undefined | null | string

Der Link "Unterhaltungselement"

Gibt zurück

BaggageBuilder

Self for method chaining

correlationId(undefined | null | string)

Legen Sie den Korrelations-ID-Gepäckwert fest.

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

Parameter

value

undefined | null | string

Die Korrelations-ID

Gibt zurück

BaggageBuilder

Self for method chaining

hiringManagerId(undefined | null | string)

Legen Sie den Einstellungsmanager-ID-Gepäckwert fest.

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

Parameter

value

undefined | null | string

Die Einstellungsmanager-ID

Gibt zurück

BaggageBuilder

Self for method chaining

operationSource(undefined | null | string)

Legen Sie den Gepäckwert für den Betrieb fest.

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

Parameter

value

undefined | null | string

Der Wert der Vorgangsquelle

Gibt zurück

BaggageBuilder

Self for method chaining

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

Legen Sie mehrere Gepäckpaare aus einem Wörterbuch oder iterierbar fest.

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

Parameter

pairs

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

Wörterbuch oder iterierbare Schlüsselwertpaare

Gibt zurück

BaggageBuilder

Self for method chaining

setRequestContext(null | string, null | string, null | string)

Convenience-Methode, um einen Anforderungsgepäckbereich mit gemeinsamen Feldern zu beginnen.

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

Parameter

tenantId

null | string

Die Mandanten-ID

agentId

null | string

Die Agenten-ID

correlationId

null | string

Die Korrelations-ID

Gibt zurück

BaggageScope

Ein Kontextmanager, der das vorherige Gepäck beim Verlassen wiederhergestellt

sourceMetadataDescription(undefined | null | string)

Legen Sie die Beschreibung der Ausführungsquellenmetadaten fest (z. B. Kanalbeschreibung).

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

Parameter

value

undefined | null | string

Die Beschreibung der Quellmetadaten

Gibt zurück

BaggageBuilder

Self for method chaining

sourceMetadataId(undefined | null | string)

Legen Sie die Metadaten-ID der Ausführungsquelle fest (z. B. Kanal-ID).

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

Parameter

value

undefined | null | string

Die Quellmetadaten-ID

Gibt zurück

BaggageBuilder

Self for method chaining

sourceMetadataName(undefined | null | string)

Legen Sie den Namen der Ausführungsquellenmetadaten fest (z. B. Kanalname).

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

Parameter

value

undefined | null | string

Der Name der Quellmetadaten

Gibt zurück

BaggageBuilder

Self for method chaining

tenantId(undefined | null | string)

Legen Sie den Gepäckwert der Mandanten-ID fest.

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

Parameter

value

undefined | null | string

Die Mandanten-ID

Gibt zurück

BaggageBuilder

Self for method chaining