InvokeAgentScope class

Pakiet:

@microsoft/agents-a365-observability

Udostępnia zakres śledzenia OpenTelemetry dla operacji wywołania agenta sztucznej inteligencji.

Rozszerzenie

OpenTelemetryScope

Metody

recordInputMessages(InputMessagesParam)	Rejestruje komunikaty wejściowe na potrzeby śledzenia danych telemetrycznych. Akceptuje pojedynczy ciąg, tablicę ciągów (automatycznie opakowanych jako OTEL ChatMessage z rolą user) lub opakowy versioned InputMessages.
recordOutputMessages(OutputMessagesParam)	Rejestruje komunikaty wyjściowe na potrzeby śledzenia danych telemetrycznych. Akceptuje pojedynczy ciąg, tablicę ciągów (automatycznie opakowaną jako OTEL OutputMessage z rolą assistant) lub wersję otoki OutputMessages.
recordResponse(string)	Rejestruje informacje o odpowiedzi na potrzeby śledzenia danych telemetrycznych.
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)	Tworzy i uruchamia nowy zakres śledzenia wywołań agenta.

Metody dziedziczone

dispose()	Starsza metoda usuwania pod kątem zgodności
getSpanContext()	Pobiera kontekst zakresu dla tego zakresu. Można go użyć do utworzenia elementu ParentSpanRef do jawnego łączenia elementów nadrzędny-podrzędny w granicach asynchronicznych.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Rejestruje wiele par klucz/wartość atrybutu na potrzeby śledzenia telemetrii.
recordCancellation(string)	Rejestruje zdarzenie anulowania w zakresie. Ustawia stan zakresu na ERROR z przyczyną anulowania i oznacza typ błędu jako "TaskCanceledException".
recordError(Error)	Rejestruje błąd, który wystąpił podczas operacji
setEndTime(TimeInput)	Ustawia niestandardowy czas zakończenia dla zakresu. Po ustawieniu metoda dispose przekaże tę wartość zamiast używać span.end() bieżącego czasu zegara ściany. Jest to przydatne, gdy rzeczywisty czas zakończenia operacji jest znany przed usunięciem zakresu.
withActiveSpanAsync<T>(() => Promise<T>)	Powoduje, że ten zakres jest aktywny przez czas trwania wykonywania wywołania zwrotnego asynchronicznego

Szczegóły metody

recordInputMessages(InputMessagesParam)

Rejestruje komunikaty wejściowe na potrzeby śledzenia danych telemetrycznych. Akceptuje pojedynczy ciąg, tablicę ciągów (automatycznie opakowanych jako OTEL ChatMessage z rolą user) lub opakowy versioned InputMessages.

function recordInputMessages(messages: InputMessagesParam)

Parametry

messages

InputMessagesParam

Ciąg, tablica ciągów lub otoka InputMessages

recordOutputMessages(OutputMessagesParam)

Rejestruje komunikaty wyjściowe na potrzeby śledzenia danych telemetrycznych. Akceptuje pojedynczy ciąg, tablicę ciągów (automatycznie opakowaną jako OTEL OutputMessage z rolą assistant) lub wersję otoki OutputMessages.

function recordOutputMessages(messages: OutputMessagesParam)

Parametry

messages

OutputMessagesParam

Ciąg, tablica ciągów lub otoka OutputMessages

recordResponse(string)

Rejestruje informacje o odpowiedzi na potrzeby śledzenia danych telemetrycznych.

function recordResponse(response: string)

Parametry

response

string

Odpowiedź wywołania

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

Tworzy i uruchamia nowy zakres śledzenia wywołań agenta.

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

Parametry

request

Request

Żądanie ładunku (kanał, identyfikator konwersacji, zawartość, identyfikator sesji).

invokeScopeDetails

InvokeAgentScopeDetails

Szczegóły na poziomie zakresu

agentDetails

AgentDetails

Tożsamość agenta. Identyfikator dzierżawy pochodzi z agentDetails.tenantId (wymagane).

callerDetails

CallerDetails

Opcjonalne informacje o obiekcie wywołującym. Obsługuje trzy scenariusze:

• Tylko obiekt wywołujący człowieka: { userDetails: { userId, userName, ... } }
• Tylko obiekt wywołujący agenta: { callerAgentDetails: { agentId, agentName, ... } }
• Oba (A2A z człowiekiem w łańcuchu): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails

SpanDetails

Opcjonalna konfiguracja zakresu (parentContext, startTime, endTime, spanKind, spanLinks).

Zwraca

InvokeAgentScope

Nowe wystąpienie InvokeAgentScope.

Szczegóły metody dziedziczonej

dispose()

Starsza metoda usuwania pod kątem zgodności

function dispose()

Dziedziczone zopenTelemetryScope.dispose

getSpanContext()

Pobiera kontekst zakresu dla tego zakresu. Można go użyć do utworzenia elementu ParentSpanRef do jawnego łączenia elementów nadrzędny-podrzędny w granicach asynchronicznych.

function getSpanContext(): SpanContext

Zwraca

SpanContext

Plik SpanContext zawierający traceId i spanId

Dziedziczone zopenTelemetryScope.getSpanContext

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

Rejestruje wiele par klucz/wartość atrybutu na potrzeby śledzenia telemetrii.

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

Parametry

attributes

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

Kolekcja par klucz/wartość atrybutu (tablica lub iterable [klucz, wartość] lub mapa obiektu).

Dziedziczone zatrybutów OpenTelemetryScope.recordAttributes

recordCancellation(string)

Rejestruje zdarzenie anulowania w zakresie. Ustawia stan zakresu na ERROR z przyczyną anulowania i oznacza typ błędu jako "TaskCanceledException".

function recordCancellation(reason?: string)

Parametry

reason

string

Opcjonalna przyczyna anulowania. Wartość domyślna to "Zadanie zostało anulowane".

Dziedziczone zopenTelemetryScope.recordCancellation

recordError(Error)

Rejestruje błąd, który wystąpił podczas operacji

function recordError(error: Error)

Parametry

error

Error

Błąd, który się pojawił

Dziedziczone zopenTelemetryScope.recordError

setEndTime(TimeInput)

Ustawia niestandardowy czas zakończenia dla zakresu. Po ustawieniu metoda dispose przekaże tę wartość zamiast używać span.end() bieżącego czasu zegara ściany. Jest to przydatne, gdy rzeczywisty czas zakończenia operacji jest znany przed usunięciem zakresu.

function setEndTime(endTime: TimeInput)

Parametry

endTime

TimeInput

Godzina zakończenia w milisekundach od epoki, daty lub krotki HrTime.

Dziedziczone zOpenTelemetryScope.setEndTime

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

Powoduje, że ten zakres jest aktywny przez czas trwania wykonywania wywołania zwrotnego asynchronicznego

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

Parametry

callback

() => Promise<T>

Zwraca

Promise<T>

Dziedziczone zopenTelemetryScope.withActiveSpanAsync