BaggageBuilder class

Paket:
@microsoft/agents-a365-observability

Bagagebyggare per begäran för OpenTelemetry-kontextspridning.

Den här klassen tillhandahåller ett fluent-API för att ange bagagevärden som ska spridas i OpenTelemetry-kontexten.

Exempel

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

Metoder

agentAuid(undefined | null | string)

Ange värdet för agentens AUID-bagage.
agentBlueprintId(undefined | null | string)

Ange agentens skiss-ID:ts bagagevärde.
agentDescription(undefined | null | string)

Ange värdet för agentbeskrivningens bagage.
agentEmail(undefined | null | string)

Ange värdet för e-postbagage för agenten.
agentId(undefined | null | string)

Ange värdet för agent-ID:ts bagage.
agentName(undefined | null | string)

Ange värdet för agentnamnet bagage.
agentPlatformId(undefined | null | string)

Ange värdet för agentplattforms-ID:ts bagage.
agentVersion(undefined | null | string)

Ange värdet för agentversionens bagage.
build()

Använd det insamlade bagaget i den aktuella kontexten.
callerAgentPlatformId(undefined | null | string)

Ange värdet för nummerpresentationens plattforms-ID.
callerClientIp(undefined | null | string)

Ange värdet för uppringarens klient-IP-bagage. Används för att samla in den ursprungliga klient-IP-adressen för begäran så att den kan spridas via OpenTelemetry-bagage.
channelLink(undefined | null | string)

Ange kanallänken/URL:en.
channelName(undefined | null | string)

Ange kanalnamnet (t.ex. Teams, Slack).
conversationId(undefined | null | string)

Ange värdet för konversations-ID:ts bagage.
conversationItemLink(undefined | null | string)

Ange värdet för konversationsobjektets länkbagage.
invokeAgentServer(undefined | null | string, number)

Anger värden för anropande agentserveradress och portbagage.
operationSource(undefined | null | string)

Ange värdet för åtgärdskällans bagage. Används för serverintervall för att identifiera tjänsten (t.ex. ATG, ACF).
sessionDescription(undefined | null | string)

Ange värdet för sessionsbeskrivningens bagage.
sessionId(string)

Ange värdet för sessions-ID:ts bagage.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)

Ange flera bagagepar från en ordlista eller itererbara.
setRequestContext(null | string, null | string)

Bekvämlighetsmetod för att påbörja ett omfång för begärandebagage med vanliga fält.
tenantId(undefined | null | string)

Ange värdet för innehavar-ID:ts bagage.
userEmail(undefined | null | string)

Ange värdet för användarens e-postbagage.
userId(undefined | null | string)

Ange värdet för användar-ID:ts bagage.
userName(undefined | null | string)

Ange värdet för användarnamnets bagage.

Metodinformation

agentAuid(undefined | null | string)

Ange värdet för agentens AUID-bagage.

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

Parametrar

value

undefined | null | string

Agenten AUID

Returer

BaggageBuilder

Själv för metodlänkning

agentBlueprintId(undefined | null | string)

Ange agentens skiss-ID:ts bagagevärde.

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

Parametrar

value

undefined | null | string

Agentens skiss-ID

Returer

BaggageBuilder

Själv för metodlänkning

agentDescription(undefined | null | string)

Ange värdet för agentbeskrivningens bagage.

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

Parametrar

value

undefined | null | string

Agentbeskrivningen

Returer

BaggageBuilder

Själv för metodlänkning

agentEmail(undefined | null | string)

Ange värdet för e-postbagage för agenten.

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

Parametrar

value

undefined | null | string

Agentens e-post

Returer

BaggageBuilder

Själv för metodlänkning

agentId(undefined | null | string)

Ange värdet för agent-ID:ts bagage.

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

Parametrar

value

undefined | null | string

Agent-ID

Returer

BaggageBuilder

Själv för metodlänkning

agentName(undefined | null | string)

Ange värdet för agentnamnet bagage.

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

Parametrar

value

undefined | null | string

Agentnamnet

Returer

BaggageBuilder

Själv för metodlänkning

agentPlatformId(undefined | null | string)

Ange värdet för agentplattforms-ID:ts bagage.

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

Parametrar

value

undefined | null | string

Agentplattforms-ID

Returer

BaggageBuilder

Själv för metodlänkning

agentVersion(undefined | null | string)

Ange värdet för agentversionens bagage.

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

Parametrar

value

undefined | null | string

Agentversionen (t.ex. "1.0.0", "2025-05-01")

Returer

BaggageBuilder

Själv för metodlänkning

build()

Använd det insamlade bagaget i den aktuella kontexten.

function build(): BaggageScope

Returer

BaggageScope

En kontexthanterare som återställer det tidigare bagaget vid avslut

callerAgentPlatformId(undefined | null | string)

Ange värdet för nummerpresentationens plattforms-ID.

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

Parametrar

value

undefined | null | string

Nummeragentens plattformsidentifierare

Returer

BaggageBuilder

Själv för metodlänkning

callerClientIp(undefined | null | string)

Ange värdet för uppringarens klient-IP-bagage. Används för att samla in den ursprungliga klient-IP-adressen för begäran så att den kan spridas via OpenTelemetry-bagage.

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

Parametrar

value

undefined | null | string

Anroparens klient-IP-adress

Returer

BaggageBuilder

Själv för metodlänkning

Ange kanallänken/URL:en.

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

Parametrar

value

undefined | null | string

Kanallänken

Returer

BaggageBuilder

Själv för metodlänkning

channelName(undefined | null | string)

Ange kanalnamnet (t.ex. Teams, Slack).

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

Parametrar

value

undefined | null | string

Kanalnamnet

Returer

BaggageBuilder

Själv för metodlänkning

conversationId(undefined | null | string)

Ange värdet för konversations-ID:ts bagage.

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

Parametrar

value

undefined | null | string

Konversations-ID

Returer

BaggageBuilder

Själv för metodlänkning

Ange värdet för konversationsobjektets länkbagage.

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

Parametrar

value

undefined | null | string

Länken för konversationsobjekt

Returer

BaggageBuilder

Själv för metodlänkning

invokeAgentServer(undefined | null | string, number)

Anger värden för anropande agentserveradress och portbagage.

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

Parametrar

address

undefined | null | string

Serveradressen (värdnamnet) för målagenttjänsten.

port

number

Valfri serverport. Registreras endast när det skiljer sig från 443.

Returer

BaggageBuilder

Den aktuella builder-instansen för metodlänkning.

operationSource(undefined | null | string)

Ange värdet för åtgärdskällans bagage. Används för serverintervall för att identifiera tjänsten (t.ex. ATG, ACF).

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

Parametrar

value

undefined | null | string

Åtgärdskällan

Returer

BaggageBuilder

Själv för metodlänkning

sessionDescription(undefined | null | string)

Ange värdet för sessionsbeskrivningens bagage.

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

Parametrar

value

undefined | null | string

Sessionsbeskrivningen

Returer

BaggageBuilder

Själv för metodlänkning

sessionId(string)

Ange värdet för sessions-ID:ts bagage.

function sessionId(value: string): BaggageBuilder

Parametrar

value

string

Sessions-ID

Returer

BaggageBuilder

Själv för metodlänkning

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

Ange flera bagagepar från en ordlista eller itererbara.

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

Parametrar

pairs

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

Ordlista eller itererbar för nyckel/värde-par

Returer

BaggageBuilder

Själv för metodlänkning

setRequestContext(null | string, null | string)

Bekvämlighetsmetod för att påbörja ett omfång för begärandebagage med vanliga fält.

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

Parametrar

tenantId

null | string

Klientorganisations-ID

agentId

null | string

Agent-ID

Returer

BaggageScope

En kontexthanterare som återställer det tidigare bagaget vid avslut

tenantId(undefined | null | string)

Ange värdet för innehavar-ID:ts bagage.

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

Parametrar

value

undefined | null | string

Klientorganisations-ID

Returer

BaggageBuilder

Själv för metodlänkning

userEmail(undefined | null | string)

Ange värdet för användarens e-postbagage.

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

Parametrar

value

undefined | null | string

Användarens e-post

Returer

BaggageBuilder

Själv för metodlänkning

userId(undefined | null | string)

Ange värdet för användar-ID:ts bagage.

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

Parametrar

value

undefined | null | string

Användar-ID

Returer

BaggageBuilder

Själv för metodlänkning

userName(undefined | null | string)

Ange värdet för användarnamnets bagage.

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

Parametrar

value

undefined | null | string

Användarnamnet

Returer

BaggageBuilder

Själv för metodlänkning