InvokeAgentScope class

Пакет:: @microsoft/agents-a365-observability

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

Extends: OpenTelemetryScope

Методы

recordInputMessages(InputMessagesParam)	Записывает входные сообщения для отслеживания телеметрии. Принимает одну строку, массив строк (автоматически упакованный как OTEL ChatMessage с ролью `user`) или оболочку inputMessagesages с версиями.
recordOutputMessages(OutputMessagesParam)	Записывает выходные сообщения для отслеживания телеметрии. Принимает одну строку, массив строк (автоматически упакованный как OTEL OutputMessage с ролью `assistant`) или оболочку OutputMessages с версией OutputMessages.
recordResponse(string)	Записывает сведения об ответе для отслеживания телеметрии.
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, 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>)	Делает этот диапазон активным в течение длительности асинхронного выполнения обратного вызова

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

recordInputMessages(InputMessagesParam)

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

function recordInputMessages(messages: InputMessagesParam)

Параметры

messages: InputMessagesParam

Строка, массив строк или оболочка InputMessages

recordOutputMessages(OutputMessagesParam)

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

function recordOutputMessages(messages: OutputMessagesParam)

Параметры

messages: OutputMessagesParam

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

recordResponse(string)

Записывает сведения об ответе для отслеживания телеметрии.

function recordResponse(response: string)

Параметры

response: string

Ответ вызова

start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)

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

static function start(request: Request, invokeScopeDetails: InvokeAgentScopeDetails, agentDetails: AgentDetails, callerDetails?: CallerDetails, spanDetails?: SpanDetails): InvokeAgentScope

Параметры

request: Request

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

invokeScopeDetails: InvokeAgentScopeDetails

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

agentDetails: AgentDetails

Удостоверение агента. Идентификатор клиента является производным от agentDetails.tenantId (обязательно).

callerDetails: CallerDetails

Необязательные сведения о вызывающем объекте. Поддерживает три сценария:

Только вызывающий человек: { userDetails: { userId, userName, ... } }
Только вызывающий агент: { callerAgentDetails: { agentId, agentName, ... } }
Оба (A2A с человеком в цепочке): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails: SpanDetails

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

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

InvokeAgentScope

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

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

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