InvokeAgentScope class

Balíček:

@microsoft/agents-a365-observability

Poskytuje rozsah trasování OpenTelemetry pro operace vyvolání agenta AI.

Extends

OpenTelemetryScope

Metody

recordInputMessages(InputMessagesParam)	Zaznamenává vstupní zprávy pro sledování telemetrie. Přijímá jeden řetězec, pole řetězců (automaticky zabalené jako OTEL ChatMessage s rolí user) nebo obálku InputMessages verze.
recordOutputMessages(OutputMessagesParam)	Zaznamenává výstupní zprávy pro sledování telemetrie. Přijímá jeden řetězec, pole řetězců (automaticky zabalené jako OTEL OutputMessage s rolí assistant) nebo obálku s verzí OutputMessages.
recordResponse(string)	Zaznamenává informace o odpovědích pro sledování telemetrie.
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)	Vytvoří a spustí nový obor pro trasování volání agenta.

Zděděné metody

dispose()	Starší metoda Dispose pro zajištění kompatibility
getSpanContext()	Získá kontext rozsahu pro tento obor. To lze použít k vytvoření ParentSpanRef pro explicitní propojení nadřazené-podřízené přes async hranice.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Zaznamenává několik párů klíč/hodnota atributu pro sledování telemetrie.
recordCancellation(string)	Zaznamenává událost zrušení v rozsahu. Nastaví stav rozsahu na ERROR s důvodem zrušení a označí typ chyby jako TaskCanceledException.
recordError(Error)	Zaznamenává chybu, ke které došlo během operace.
setEndTime(TimeInput)	Nastaví vlastní koncový čas oboru. Při nastavení funkce Dispose tuto hodnotu span.end() předá místo použití aktuálního času na zdi. To je užitečné, když je skutečný čas ukončení operace známý před odstraněním oboru.
withActiveSpanAsync<T>(() => Promise<T>)	Nastaví toto rozsah aktivní po dobu provádění asynchronního zpětného volání.

Podrobnosti metody

recordInputMessages(InputMessagesParam)

Zaznamenává vstupní zprávy pro sledování telemetrie. Přijímá jeden řetězec, pole řetězců (automaticky zabalené jako OTEL ChatMessage s rolí user) nebo obálku InputMessages verze.

function recordInputMessages(messages: InputMessagesParam)

Parametry

messages

InputMessagesParam

Řetězec, pole řetězců nebo obálka InputMessages

recordOutputMessages(OutputMessagesParam)

Zaznamenává výstupní zprávy pro sledování telemetrie. Přijímá jeden řetězec, pole řetězců (automaticky zabalené jako OTEL OutputMessage s rolí assistant) nebo obálku s verzí OutputMessages.

function recordOutputMessages(messages: OutputMessagesParam)

Parametry

messages

OutputMessagesParam

Řetězec, pole řetězců nebo obálka OutputMessages

recordResponse(string)

Zaznamenává informace o odpovědích pro sledování telemetrie.

function recordResponse(response: string)

Parametry

response

string

Odpověď na vyvolání

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

Vytvoří a spustí nový obor pro trasování volání agenta.

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

Parametry

request

Request

Žádost o datovou část (kanál, id konverzace, obsah, id relace).

invokeScopeDetails

InvokeAgentScopeDetails

Podrobnosti na úrovni oboru

agentDetails

AgentDetails

Identita agenta. ID tenanta je odvozeno od agentDetails.tenantId (povinné).

callerDetails

CallerDetails

Volitelné informace o volajícím Podporuje tři scénáře:

• Pouze člověk volající: { userDetails: { userId, userName, ... } }
• Pouze volající agent: { callerAgentDetails: { agentId, agentName, ... } }
• Oba (A2A s člověkem v řetězci): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails

SpanDetails

Volitelná konfigurace rozsahu (parentContext, startTime, endTime, spanKind, spanLinks).

Návraty

InvokeAgentScope

Nová instance InvokeAgentScope.

Podrobnosti zděděných metod

dispose()

Starší metoda Dispose pro zajištění kompatibility

function dispose()

Zděděno zOpenTelemetryScope.dispose

getSpanContext()

Získá kontext rozsahu pro tento obor. To lze použít k vytvoření ParentSpanRef pro explicitní propojení nadřazené-podřízené přes async hranice.

function getSpanContext(): SpanContext

Návraty

SpanContext

SpanContext obsahující traceId a spanId

Zděděno zOpenTelemetryScope.getSpanContext

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

Zaznamenává několik párů klíč/hodnota atributu pro sledování telemetrie.

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

Parametry

attributes

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

Kolekce párů klíč/hodnota atributu (pole nebo iterable z [klíč, hodnota] nebo mapování objektů).

Zděděno zOpenTelemetryScope.recordAttributes

recordCancellation(string)

Zaznamenává událost zrušení v rozsahu. Nastaví stav rozsahu na ERROR s důvodem zrušení a označí typ chyby jako TaskCanceledException.

function recordCancellation(reason?: string)

Parametry

reason

string

Volitelný důvod zrušení Výchozí hodnota je "Úkol byl zrušen".

Zděděno zOpenTelemetryScope.recordCancellation

recordError(Error)

Zaznamenává chybu, ke které došlo během operace.

function recordError(error: Error)

Parametry

error

Error

Chyba, která nastala

Zděděno zOpenTelemetryScope.recordError

setEndTime(TimeInput)

Nastaví vlastní koncový čas oboru. Při nastavení funkce Dispose tuto hodnotu span.end() předá místo použití aktuálního času na zdi. To je užitečné, když je skutečný čas ukončení operace známý před odstraněním oboru.

function setEndTime(endTime: TimeInput)

Parametry

endTime

TimeInput

Koncový čas jako milisekundy od epochy, data nebo řazené kolekce členů HrTime.

Zděděno zOpenTelemetryScope.setEndTime

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

Nastaví toto rozsah aktivní po dobu provádění asynchronního zpětného volání.

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

Parametry

callback

() => Promise<T>

Návraty

Promise<T>

Zděděno zOpenTelemetryScope.withActiveSpanAsync