Compartir a través de

BaggageBuilder class

Paquete:
@microsoft/agents-a365-observability

Generador de equipaje por solicitud para la propagación de contexto de OpenTelemetry.

Esta clase proporciona una API fluida para establecer valores de equipaje que se propagarán en el contexto de OpenTelemetry.

Ejemplo

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

Métodos

agentAuid(undefined | null | string)

Establezca el valor del equipaje AUID del agente.
agentBlueprintId(undefined | null | string)

Establezca el valor del equipaje del id. de plano técnico del agente.
agentDescription(undefined | null | string)

Establezca el valor de equipaje de descripción del agente.
agentEmail(undefined | null | string)

Establezca el valor del equipaje de correo electrónico del agente.
agentId(undefined | null | string)

Establezca el valor del equipaje del id. del agente.
agentName(undefined | null | string)

Establezca el valor del equipaje de nombre del agente.
agentPlatformId(undefined | null | string)

Establezca el valor de equipaje del id. de la plataforma del agente.
agentVersion(undefined | null | string)

Establezca el valor del equipaje de la versión del agente.
build()

Aplique el equipaje recogido al contexto actual.
callerAgentPlatformId(undefined | null | string)

Establezca el valor de equipaje del id. de la plataforma del agente de llamada.
callerClientIp(undefined | null | string)

Establezca el valor de equipaje IP del cliente de llamada. Se usa para capturar la dirección IP del cliente de origen de la solicitud para que se pueda propagar a través del equipaje de OpenTelemetry.
channelLink(undefined | null | string)

Establezca el vínculo o la dirección URL del canal.
channelName(undefined | null | string)

Establezca el nombre del canal (por ejemplo, Teams, Slack).
conversationId(undefined | null | string)

Establezca el valor del equipaje del identificador de conversación.
conversationItemLink(undefined | null | string)

Establezca el valor de equipaje del vínculo del artículo de conversación.
invokeAgentServer(undefined | null | string, number)

Establece los valores de dirección del servidor del agente de invocación y equipaje de puerto.
operationSource(undefined | null | string)

Establezca el valor del equipaje de origen de la operación. Se usa para los intervalos de servidor para identificar el servicio (por ejemplo, ATG, ACF).
sessionDescription(undefined | null | string)

Establezca el valor de equipaje de descripción de sesión.
sessionId(string)

Establezca el valor de equipaje del identificador de sesión.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)

Establezca varios pares de equipaje de un diccionario o iterable.
setRequestContext(null | string, null | string)

Método de conveniencia para comenzar un ámbito de equipaje de solicitud con campos comunes.
tenantId(undefined | null | string)

Establezca el valor de equipaje del identificador de inquilino.
userEmail(undefined | null | string)

Establezca el valor del equipaje de correo electrónico del usuario.
userId(undefined | null | string)

Establezca el valor de equipaje del identificador de usuario.
userName(undefined | null | string)

Establezca el valor de equipaje de nombre de usuario.

Detalles del método

agentAuid(undefined | null | string)

Establezca el valor del equipaje AUID del agente.

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

Parámetros

value

undefined | null | string

AuID del agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentBlueprintId(undefined | null | string)

Establezca el valor del equipaje del id. de plano técnico del agente.

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

Parámetros

value

undefined | null | string

Identificador del plano técnico del agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentDescription(undefined | null | string)

Establezca el valor de equipaje de descripción del agente.

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

Parámetros

value

undefined | null | string

Descripción del agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentEmail(undefined | null | string)

Establezca el valor del equipaje de correo electrónico del agente.

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

Parámetros

value

undefined | null | string

Correo electrónico del agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentId(undefined | null | string)

Establezca el valor del equipaje del id. del agente.

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

Parámetros

value

undefined | null | string

El ID de agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentName(undefined | null | string)

Establezca el valor del equipaje de nombre del agente.

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

Parámetros

value

undefined | null | string

Nombre del agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentPlatformId(undefined | null | string)

Establezca el valor de equipaje del id. de la plataforma del agente.

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

Parámetros

value

undefined | null | string

Identificador de la plataforma del agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentVersion(undefined | null | string)

Establezca el valor del equipaje de la versión del agente.

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

Parámetros

value

undefined | null | string

La versión del agente (por ejemplo, "1.0.0", "2025-05-01")

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

build()

Aplique el equipaje recogido al contexto actual.

function build(): BaggageScope

Devoluciones

BaggageScope

Administrador de contexto que restaura el equipaje anterior al salir

callerAgentPlatformId(undefined | null | string)

Establezca el valor de equipaje del id. de la plataforma del agente de llamada.

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

Parámetros

value

undefined | null | string

Identificador de la plataforma del agente de llamada

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

callerClientIp(undefined | null | string)

Establezca el valor de equipaje IP del cliente de llamada. Se usa para capturar la dirección IP del cliente de origen de la solicitud para que se pueda propagar a través del equipaje de OpenTelemetry.

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

Parámetros

value

undefined | null | string

Dirección IP del cliente de llamada

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

Establezca el vínculo o la dirección URL del canal.

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

Parámetros

value

undefined | null | string

Vínculo del canal

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

channelName(undefined | null | string)

Establezca el nombre del canal (por ejemplo, Teams, Slack).

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

Parámetros

value

undefined | null | string

Nombre del canal

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

conversationId(undefined | null | string)

Establezca el valor del equipaje del identificador de conversación.

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

Parámetros

value

undefined | null | string

Identificador de conversación

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

Establezca el valor de equipaje del vínculo del artículo de conversación.

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

Parámetros

value

undefined | null | string

Vínculo del elemento de conversación

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

invokeAgentServer(undefined | null | string, number)

Establece los valores de dirección del servidor del agente de invocación y equipaje de puerto.

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

Parámetros

address

undefined | null | string

Dirección del servidor (nombre de host) del servicio del agente de destino.

port

number

Puerto de servidor opcional. Solo se registra cuando es diferente de 443.

Devoluciones

BaggageBuilder

Instancia del generador actual para el encadenamiento de métodos.

operationSource(undefined | null | string)

Establezca el valor del equipaje de origen de la operación. Se usa para los intervalos de servidor para identificar el servicio (por ejemplo, ATG, ACF).

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

Parámetros

value

undefined | null | string

Origen de la operación

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

sessionDescription(undefined | null | string)

Establezca el valor de equipaje de descripción de sesión.

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

Parámetros

value

undefined | null | string

Descripción de la sesión

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

sessionId(string)

Establezca el valor de equipaje del identificador de sesión.

function sessionId(value: string): BaggageBuilder

Parámetros

value

string

El ID de sesión

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

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

Establezca varios pares de equipaje de un diccionario o iterable.

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

Parámetros

pairs

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

Diccionario o iterable de pares clave-valor

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

setRequestContext(null | string, null | string)

Método de conveniencia para comenzar un ámbito de equipaje de solicitud con campos comunes.

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

Parámetros

tenantId

null | string

Identificador de inquilino

agentId

null | string

El ID de agente

Devoluciones

BaggageScope

Administrador de contexto que restaura el equipaje anterior al salir

tenantId(undefined | null | string)

Establezca el valor de equipaje del identificador de inquilino.

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

Parámetros

value

undefined | null | string

Identificador de inquilino

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

userEmail(undefined | null | string)

Establezca el valor del equipaje de correo electrónico del usuario.

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

Parámetros

value

undefined | null | string

Correo electrónico del usuario

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

userId(undefined | null | string)

Establezca el valor de equipaje del identificador de usuario.

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

Parámetros

value

undefined | null | string

Identificador de usuario

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

userName(undefined | null | string)

Establezca el valor de equipaje de nombre de usuario.

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

Parámetros

value

undefined | null | string

Nombre del usuario

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos