OutputScope class

Пакет:

@microsoft/agents-a365-observability

Предоставляет область трассировки OpenTelemetry для трассировки выходных сообщений с привязкой родительского диапазона.

Extends

OpenTelemetryScope

Методы

recordOutputMessages(ResponseMessagesParam)	Записывает выходные сообщения для отслеживания телеметрии. Перезаписывает все ранее записанные выходные сообщения в диапазоне. Принимает одну строку, массив строк (автоматически упакованный как OTEL OutputMessage), оболочку outputMessages с версией или необработанный дикт (рассматривается как результат вызова средства для спецификации OTEL, сериализованный напрямую).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)	Создает и запускает новую область для трассировки выходных сообщений.

Наследуемые методы

dispose()	Устаревший метод удаления для совместимости
getSpanContext()	Возвращает контекст диапазона для этой области. Это можно использовать для создания объекта ParentSpanRef для явного связывания родительского-дочернего элемента между асинхронными границами.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Записывает несколько пар "ключ-значение" для отслеживания телеметрии.
recordCancellation(string)	Записывает событие отмены в диапазоне. Задает состояние диапазона ERROR с причиной отмены и помечает тип ошибки как TaskCanceledException.
recordError(Error)	Записывает ошибку, которая произошла во время операции
setEndTime(TimeInput)	Задает настраиваемое время окончания области. Если задано, удаление будет передавать это значение span.end() вместо использования текущего времени настенные часы. Это полезно, если фактическое время окончания операции известно до удаления области.
withActiveSpanAsync<T>(() => Promise<T>)	Делает этот диапазон активным в течение длительности асинхронного выполнения обратного вызова

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

recordOutputMessages(ResponseMessagesParam)

Записывает выходные сообщения для отслеживания телеметрии. Перезаписывает все ранее записанные выходные сообщения в диапазоне. Принимает одну строку, массив строк (автоматически упакованный как OTEL OutputMessage), оболочку outputMessages с версией или необработанный дикт (рассматривается как результат вызова средства для спецификации OTEL, сериализованный напрямую).

function recordOutputMessages(messages: ResponseMessagesParam)

Параметры

messages

ResponseMessagesParam

Строка, массив строк, оболочка OutputMessages или дикт.

start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)

Создает и запускает новую область для трассировки выходных сообщений.

static function start(request: Request, response: OutputResponse, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): OutputScope

Параметры

request

Request

Запрос полезных данных (канал, conversationId, содержимое, sessionId).

response

OutputResponse

Ответ, содержащий начальные выходные сообщения.

agentDetails

AgentDetails

Агент, создающий выходные данные. Идентификатор клиента является производным от agentDetails.tenantId.

userDetails

UserDetails

Необязательные сведения об удостоверениях вызывающего человека.

spanDetails

SpanDetails

Необязательная конфигурация диапазона (parentContext, startTime, endTime, spanLinks).

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

OutputScope

Новый экземпляр OutputScope.

Сведения о наследуемом методе

dispose()

Устаревший метод удаления для совместимости

function dispose()

Наследуется отOpenTelemetryScope.dispose

getSpanContext()

Возвращает контекст диапазона для этой области. Это можно использовать для создания объекта ParentSpanRef для явного связывания родительского-дочернего элемента между асинхронными границами.

function getSpanContext(): SpanContext

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

SpanContext

SpanContext, содержащий traceId и spanId

Унаследовано отOpenTelemetryScope.getSpanContext

recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Записывает несколько пар "ключ-значение" для отслеживания телеметрии.

function recordAttributes(attributes: undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Параметры

attributes

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

Коллекция пар "ключ-значение" атрибута (массив или итерация [ключ, значение] или карта объектов).

Наследуется отOpenTelemetryScope.recordAttributes

recordCancellation(string)

Записывает событие отмены в диапазоне. Задает состояние диапазона ERROR с причиной отмены и помечает тип ошибки как TaskCanceledException.

function recordCancellation(reason?: string)

Параметры

reason

string

Необязательная причина отмены. По умолчанию значение "Задача отменена".

Унаследовано отOpenTelemetryScope.recordCancellation

recordError(Error)

Записывает ошибку, которая произошла во время операции

function recordError(error: Error)

Параметры

error

Error

Ошибка, которая произошла

Унаследовано отOpenTelemetryScope.recordError

setEndTime(TimeInput)

Задает настраиваемое время окончания области. Если задано, удаление будет передавать это значение span.end() вместо использования текущего времени настенные часы. Это полезно, если фактическое время окончания операции известно до удаления области.

function setEndTime(endTime: TimeInput)

Параметры

endTime

TimeInput

Время окончания в миллисекундах с эпохи, даты или кортежа HrTime.

Наследуется отOpenTelemetryScope.setEndTime

withActiveSpanAsync<T>(() => Promise<T>)

Делает этот диапазон активным в течение длительности асинхронного выполнения обратного вызова

function withActiveSpanAsync<T>(callback: () => Promise<T>): Promise<T>

Параметры

callback

() => Promise<T>

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

Promise<T>

Наследуется отOpenTelemetryScope.withActiveSpanAsync