BaggageBuilder class

Пакет:

@microsoft/agents-a365-observability

По запросу построителя багажа для распространения контекста OpenTelemetry.

Этот класс предоставляет простой API для задания значений багажа, которые будут распространяться в контексте OpenTelemetry.

Пример

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

Методы

agentAuid(undefined | null | string)	Задайте значение багажа AUID агента.
agentBlueprintId(undefined | null | string)	Задайте значение багажа идентификатора идентификатора агента.
agentDescription(undefined | null | string)	Задайте значение багажа описания агента.
agentEmail(undefined | null | string)	Задайте значение багажа электронной почты агента.
agentId(undefined | null | string)	Задайте значение багажа идентификатора агента.
agentName(undefined | null | string)	Задайте значение багажа имени агента.
agentPlatformId(undefined | null | string)	Задайте значение идентификатора платформы агента.
agentVersion(undefined | null | string)	Задайте значение багажа версии агента.
build()	Примените собранный багаж к текущему контексту.
callerAgentPlatformId(undefined | null | string)	Задайте значение идентификатора багажа платформы агента вызывающего абонента.
callerClientIp(undefined | null | string)	Задайте значение ip-адреса клиента вызывающего клиента. Используется для записи исходного IP-адреса клиента для запроса, чтобы его можно было распространять с помощью багажа OpenTelemetry.
channelLink(undefined | null | string)	Задайте ссылку или URL-адрес канала.
channelName(undefined | null | string)	Задайте имя канала (например, Teams, Slack).
conversationId(undefined | null | string)	Задайте значение идентификатора беседы.
conversationItemLink(undefined | null | string)	Задайте значение багажа ссылки для элемента беседы.
invokeAgentServer(undefined | null | string, number)	Задает значения адреса сервера агента вызова и значения багажа порта.
operationSource(undefined | null | string)	Задайте значение исходного багажа операции. Используется для определения службы (например, ATG, ACF).
sessionDescription(undefined | null | string)	Задайте значение багажа описания сеанса.
sessionId(string)	Задайте значение багажа идентификатора сеанса.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	Задайте несколько пар багажа из словаря или итерируемых.
setRequestContext(null | string, null | string)	Удобный метод для запуска области багажа запроса с общими полями.
tenantId(undefined | null | string)	Задайте значение багажа идентификатора клиента.
userEmail(undefined | null | string)	Задайте значение багажа электронной почты пользователя.
userId(undefined | null | string)	Задайте значение багажа идентификатора пользователя.
userName(undefined | null | string)	Задайте значение багажа имени пользователя.

Сведения о методе

agentAuid(undefined | null | string)

Задайте значение багажа AUID агента.

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

Параметры

value

undefined | null | string

Идентификатор AUID агента

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

agentBlueprintId(undefined | null | string)

Задайте значение багажа идентификатора идентификатора агента.

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

Параметры

value

undefined | null | string

Идентификатор схемы агента

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

agentDescription(undefined | null | string)

Задайте значение багажа описания агента.

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

Параметры

value

undefined | null | string

Описание агента

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

agentEmail(undefined | null | string)

Задайте значение багажа электронной почты агента.

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

Параметры

value

undefined | null | string

Электронная почта агента

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

agentId(undefined | null | string)

Задайте значение багажа идентификатора агента.

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

Параметры

value

undefined | null | string

Идентификатор агента

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

agentName(undefined | null | string)

Задайте значение багажа имени агента.

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

Параметры

value

undefined | null | string

Имя агента

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

agentPlatformId(undefined | null | string)

Задайте значение идентификатора платформы агента.

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

Параметры

value

undefined | null | string

Идентификатор платформы агента

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

agentVersion(undefined | null | string)

Задайте значение багажа версии агента.

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

Параметры

value

undefined | null | string

Версия агента (например, 1.0.0, '2025-05-01')

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

build()

Примените собранный багаж к текущему контексту.

function build(): BaggageScope

Возвращаемое значение

BaggageScope

Диспетчер контекстов, который восстанавливает предыдущий багаж при выходе

callerAgentPlatformId(undefined | null | string)

Задайте значение идентификатора багажа платформы агента вызывающего абонента.

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

Параметры

value

undefined | null | string

Идентификатор платформы агента вызывающего абонента

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

callerClientIp(undefined | null | string)

Задайте значение ip-адреса клиента вызывающего клиента. Используется для записи исходного IP-адреса клиента для запроса, чтобы его можно было распространять с помощью багажа OpenTelemetry.

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

Параметры

value

undefined | null | string

IP-адрес вызывающего клиента

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

channelLink(undefined | null | string)

Задайте ссылку или URL-адрес канала.

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

Параметры

value

undefined | null | string

Ссылка на канал

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

channelName(undefined | null | string)

Задайте имя канала (например, Teams, Slack).

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

Параметры

value

undefined | null | string

Имя канала

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

conversationId(undefined | null | string)

Задайте значение идентификатора беседы.

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

Параметры

value

undefined | null | string

Идентификатор беседы

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

conversationItemLink(undefined | null | string)

Задайте значение багажа ссылки для элемента беседы.

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

Параметры

value

undefined | null | string

Ссылка на элемент беседы

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

invokeAgentServer(undefined | null | string, number)

Задает значения адреса сервера агента вызова и значения багажа порта.

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

Параметры

address

undefined | null | string

Адрес сервера (имя узла) целевой службы агента.

port

number

Необязательный порт сервера. Записывается только в том случае, если отличается от 443.

Возвращаемое значение

BaggageBuilder

Текущий экземпляр построителя для цепочки методов.

operationSource(undefined | null | string)

Задайте значение исходного багажа операции. Используется для определения службы (например, ATG, ACF).

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

Параметры

value

undefined | null | string

Источник операции

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

sessionDescription(undefined | null | string)

Задайте значение багажа описания сеанса.

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

Параметры

value

undefined | null | string

Описание сеанса

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

sessionId(string)

Задайте значение багажа идентификатора сеанса.

function sessionId(value: string): BaggageBuilder

Параметры

value

string

Идентификатор сеанса

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

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

Задайте несколько пар багажа из словаря или итерируемых.

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

Параметры

pairs

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

Словарь или итератор пар "ключ-значение"

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

setRequestContext(null | string, null | string)

Удобный метод для запуска области багажа запроса с общими полями.

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

Параметры

tenantId

null | string

Идентификатор клиента

agentId

null | string

Идентификатор агента

Возвращаемое значение

BaggageScope

Диспетчер контекстов, который восстанавливает предыдущий багаж при выходе

tenantId(undefined | null | string)

Задайте значение багажа идентификатора клиента.

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

Параметры

value

undefined | null | string

Идентификатор клиента

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

userEmail(undefined | null | string)

Задайте значение багажа электронной почты пользователя.

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

Параметры

value

undefined | null | string

Электронная почта пользователя

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

userId(undefined | null | string)

Задайте значение багажа идентификатора пользователя.

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

Параметры

value

undefined | null | string

Идентификатор пользователя

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов

userName(undefined | null | string)

Задайте значение багажа имени пользователя.

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

Параметры

value

undefined | null | string

Имя пользователя

Возвращаемое значение

BaggageBuilder

Самостоятельная цепочка методов