ExecuteToolScope class

Balíček:

@microsoft/agents-a365-observability

Poskytuje rozsah trasování OpenTelemetry pro operace provádění nástrojů AI.

Extends

OpenTelemetryScope

Metody

recordResponse(string | Record<string, unknown>)	Zaznamenává informace o odpovědích pro sledování telemetrie.
start(Request, ToolCallDetails, AgentDetails, UserDetails, SpanDetails)	Vytvoří a spustí nový obor pro trasování provádění nástrojů.

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

recordResponse(string | Record<string, unknown>)

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

function recordResponse(response: string | Record<string, unknown>)

Parametry

response

string | Record<string, unknown>

Odpověď na spuštění nástroje. Objekty se serializují do formátu JSON automaticky.

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

Vytvoří a spustí nový obor pro trasování provádění nástrojů.

static function start(request: Request, details: ToolCallDetails, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): ExecuteToolScope

Parametry

request

Request

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

details

ToolCallDetails

Podrobnosti volání nástroje (název, typ, args, ID volání atd.).

agentDetails

AgentDetails

Agent, který nástroj spouští. ID tenanta je odvozeno od agentDetails.tenantId.

userDetails

UserDetails

Volitelná identita volajícího.

spanDetails

SpanDetails

Volitelná konfigurace rozsahu (parentContext, startTime, endTime, spanLinks, spanKind). Výchozí hodnota je SpanKind.INTERNAL.

Návraty

ExecuteToolScope

Nová instance ExecuteToolScope.

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