InferenceScope class

Pakiet:

@microsoft/agents-a365-observability

Udostępnia zakres śledzenia OpenTelemetry dla operacji wnioskowania generowania sztucznej inteligencji.

Rozszerzenie

OpenTelemetryScope

Metody

recordFinishReasons(string[])	Rejestruje przyczyny zakończenia śledzenia danych telemetrycznych.
recordInputMessages(InputMessagesParam)	Rejestruje komunikaty wejściowe na potrzeby śledzenia danych telemetrycznych. Akceptuje zwykłe ciągi (automatycznie opakowane jako OTEL ChatMessage z rolą user) lub opakowy versioned InputMessages.
recordInputTokens(number)	Rejestruje liczbę tokenów wejściowych na potrzeby śledzenia danych telemetrycznych.
recordOutputMessages(OutputMessagesParam)	Rejestruje komunikaty wyjściowe na potrzeby śledzenia danych telemetrycznych. Akceptuje zwykłe ciągi (automatycznie opakowane jako OTEL OutputMessage z rolą assistant) lub wersję otoki OutputMessages.
recordOutputTokens(number)	Rejestruje liczbę tokenów wyjściowych na potrzeby śledzenia danych telemetrycznych.
start(Request, InferenceDetails, AgentDetails, UserDetails, SpanDetails)	Tworzy i uruchamia nowy zakres śledzenia wnioskowania.

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

recordFinishReasons(string[])

Rejestruje przyczyny zakończenia śledzenia danych telemetrycznych.

function recordFinishReasons(finishReasons: string[])

Parametry

finishReasons

string[]

Tablica przyczyn zakończenia

recordInputMessages(InputMessagesParam)

Rejestruje komunikaty wejściowe na potrzeby śledzenia danych telemetrycznych. Akceptuje zwykłe ciągi (automatycznie opakowane jako OTEL ChatMessage z rolą user) lub opakowy versioned InputMessages.

function recordInputMessages(messages: InputMessagesParam)

Parametry

messages

InputMessagesParam

Tablica ciągów komunikatów wejściowych lub otoki InputMessages

recordInputTokens(number)

Rejestruje liczbę tokenów wejściowych na potrzeby śledzenia danych telemetrycznych.

function recordInputTokens(inputTokens: number)

Parametry

inputTokens

number

Liczba tokenów wejściowych

recordOutputMessages(OutputMessagesParam)

Rejestruje komunikaty wyjściowe na potrzeby śledzenia danych telemetrycznych. Akceptuje zwykłe ciągi (automatycznie opakowane jako OTEL OutputMessage z rolą assistant) lub wersję otoki OutputMessages.

function recordOutputMessages(messages: OutputMessagesParam)

Parametry

messages

OutputMessagesParam

Tablica ciągów komunikatów wyjściowych lub otoki OutputMessages

recordOutputTokens(number)

Rejestruje liczbę tokenów wyjściowych na potrzeby śledzenia danych telemetrycznych.

function recordOutputTokens(outputTokens: number)

Parametry

outputTokens

number

Liczba tokenów wyjściowych

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

Tworzy i uruchamia nowy zakres śledzenia wnioskowania.

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

Parametry

request

Request

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

details

InferenceDetails

Szczegóły wywołania wnioskowania (model, dostawca, tokeny itp.).

agentDetails

AgentDetails

Agent wykonujący wnioskowanie. Identyfikator dzierżawy pochodzi z elementu agentDetails.tenantId.

userDetails

UserDetails

Opcjonalna tożsamość rozmówców.

spanDetails

SpanDetails

Opcjonalna konfiguracja zakresu (parentContext, startTime, endTime, spanLinks). Uwaga: spanKind jest ignorowana; InferenceScope zawsze używa elementu SpanKind.CLIENT.

Zwraca

InferenceScope

Nowe wystąpienie InferenceScope

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