Freigeben über

InferenceScope class

Paket:
@microsoft/agents-a365-observability

Stellt openTelemetry-Ablaufverfolgungsbereich für generative KI-Ableitungsvorgänge bereit.

Extends
OpenTelemetryScope

Methoden

recordFinishReasons(string[])

Zeichnet die Endgründe für die Telemetrienachverfolgung auf.
recordInputMessages(InputMessagesParam)

Zeichnet die Eingabemeldungen für die Telemetrienachverfolgung auf. Akzeptiert einfache Zeichenfolgen (automatisch umschlossen als OTEL ChatMessage mit Rolle user) oder einen versionsgesteuerten InputMessages-Wrapper.
recordInputTokens(number)

Zeichnet die Anzahl der Eingabetoken für die Telemetrienachverfolgung auf.
recordOutputMessages(OutputMessagesParam)

Zeichnet die Ausgabemeldungen für die Telemetrienachverfolgung auf. Akzeptiert einfache Zeichenfolgen (automatisch als OTEL OutputMessage mit Rolle assistant) oder einen versionsgesteuerten OutputMessages-Wrapper.
recordOutputTokens(number)

Zeichnet die Anzahl der Ausgabetoken für die Telemetrienachverfolgung auf.
start(Request, InferenceDetails, AgentDetails, UserDetails, SpanDetails)

Erstellt und startet einen neuen Bereich für die Rückschlussablaufverfolgung.

Geerbte Methoden

dispose()

Legacy-Dispose-Methode zur Kompatibilität
getSpanContext()

Ruft den Span-Kontext für diesen Bereich ab. Dies kann verwendet werden, um eine ParentSpanRef für explizite verknüpfung zwischen übergeordneten und untergeordneten Elementen über asynchrone Grenzen hinweg zu erstellen.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Zeichnet mehrere Attributschlüssel-Wert-Paare für die Telemetrienachverfolgung auf.
recordCancellation(string)

Zeichnet ein Abbruchereignis auf der Spanne auf. Legt den Span-Status auf ERROR mit dem Abbruchgrund fest und markiert den Fehlertyp als "TaskCanceledException".
recordError(Error)

Zeichnet einen Fehler auf, der während des Vorgangs aufgetreten ist.
setEndTime(TimeInput)

Legt eine benutzerdefinierte Endzeit für den Bereich fest. Wenn dieser Wert festgelegt ist, übergibt Dispose diesen Wert span.end() anstelle der aktuellen Zeit für die Wanduhr. Dies ist nützlich, wenn die tatsächliche Endzeit des Vorgangs bekannt ist, bevor der Bereich verworfen wird.
withActiveSpanAsync<T>(() => Promise<T>)

Macht diese Spanne für die Dauer der asynchronen Rückrufausführung aktiv

Details zur Methode

recordFinishReasons(string[])

Zeichnet die Endgründe für die Telemetrienachverfolgung auf.

function recordFinishReasons(finishReasons: string[])

Parameter

finishReasons

string[]

Array von Endgründen

recordInputMessages(InputMessagesParam)

Zeichnet die Eingabemeldungen für die Telemetrienachverfolgung auf. Akzeptiert einfache Zeichenfolgen (automatisch umschlossen als OTEL ChatMessage mit Rolle user) oder einen versionsgesteuerten InputMessages-Wrapper.

function recordInputMessages(messages: InputMessagesParam)

Parameter

messages
InputMessagesParam

Array von Eingabemeldungszeichenfolgen oder einem InputMessages-Wrapper

recordInputTokens(number)

Zeichnet die Anzahl der Eingabetoken für die Telemetrienachverfolgung auf.

function recordInputTokens(inputTokens: number)

Parameter

inputTokens

number

Anzahl der Eingabetoken

recordOutputMessages(OutputMessagesParam)

Zeichnet die Ausgabemeldungen für die Telemetrienachverfolgung auf. Akzeptiert einfache Zeichenfolgen (automatisch als OTEL OutputMessage mit Rolle assistant) oder einen versionsgesteuerten OutputMessages-Wrapper.

function recordOutputMessages(messages: OutputMessagesParam)

Parameter

messages
OutputMessagesParam

Array von Ausgabenachrichtenzeichenfolgen oder einem OutputMessages-Wrapper

recordOutputTokens(number)

Zeichnet die Anzahl der Ausgabetoken für die Telemetrienachverfolgung auf.

function recordOutputTokens(outputTokens: number)

Parameter

outputTokens

number

Anzahl der Ausgabetoken

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

Erstellt und startet einen neuen Bereich für die Rückschlussablaufverfolgung.

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

Parameter

request
Request

Anforderungsnutzlast (Kanal, conversationId, Inhalt, sessionId).

details
InferenceDetails

Die Ableitungsaufrufdetails (Modell, Anbieter, Token usw.).

agentDetails
AgentDetails

Der Agent, der die Ableitung durchführt. Die Mandanten-ID wird von agentDetails.tenantId.

userDetails
UserDetails

Optionale menschliche Anruferidentität.

spanDetails
SpanDetails

Optionale Span-Konfiguration (parentContext, startTime, endTime, spanLinks). Hinweis: spanKind wird ignoriert; InferenceScope verwendet SpanKind.CLIENTimmer .

Gibt zurück

InferenceScope

Eine neue InferenceScope-Instanz

Details zur geerbten Methode

dispose()

Legacy-Dispose-Methode zur Kompatibilität

function dispose()

Geerbt vonOpenTelemetryScope.dispose

getSpanContext()

Ruft den Span-Kontext für diesen Bereich ab. Dies kann verwendet werden, um eine ParentSpanRef für explizite verknüpfung zwischen übergeordneten und untergeordneten Elementen über asynchrone Grenzen hinweg zu erstellen.

function getSpanContext(): SpanContext

Gibt zurück

SpanContext

Der SpanContext mit traceId und spanId

Geerbt vonOpenTelemetryScope.getSpanContext

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

Zeichnet mehrere Attributschlüssel-Wert-Paare für die Telemetrienachverfolgung auf.

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

Parameter

attributes

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

Auflistung von Attributschlüssel-Wert-Paaren (Array oder iterierbar von [Schlüssel, Wert] oder Objektzuordnung).

Geerbt vonOpenTelemetryScope.recordAttributes

recordCancellation(string)

Zeichnet ein Abbruchereignis auf der Spanne auf. Legt den Span-Status auf ERROR mit dem Abbruchgrund fest und markiert den Fehlertyp als "TaskCanceledException".

function recordCancellation(reason?: string)

Parameter

reason

string

Optionaler Abbruchgrund. Der Standardwert ist "Vorgang wurde abgebrochen".

Geerbt vonOpenTelemetryScope.recordCancellation

recordError(Error)

Zeichnet einen Fehler auf, der während des Vorgangs aufgetreten ist.

function recordError(error: Error)

Parameter

error

Error

Der Fehler, der aufgetreten ist

Geerbt vonOpenTelemetryScope.recordError

setEndTime(TimeInput)

Legt eine benutzerdefinierte Endzeit für den Bereich fest. Wenn dieser Wert festgelegt ist, übergibt Dispose diesen Wert span.end() anstelle der aktuellen Zeit für die Wanduhr. Dies ist nützlich, wenn die tatsächliche Endzeit des Vorgangs bekannt ist, bevor der Bereich verworfen wird.

function setEndTime(endTime: TimeInput)

Parameter

endTime

TimeInput

Die Endzeit als Millisekunden seit Epoche, Datum oder HrTime-Tupel.

Geerbt vonOpenTelemetryScope.setEndTime

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

Macht diese Spanne für die Dauer der asynchronen Rückrufausführung aktiv

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

Parameter

callback

() => Promise<T>

Gibt zurück

Promise<T>

Geerbt vonOpenTelemetryScope.withActiveSpanAsync