InferenceScope class

Paquet:
@microsoft/agents-a365-observability

Fournit l’étendue de suivi OpenTelemetry pour les opérations d’inférence IA génératives.

Extends
OpenTelemetryScope

Méthodes

recordFinishReasons(string[])

Enregistre les raisons de fin du suivi des données de télémétrie.
recordInputMessages(InputMessagesParam)

Enregistre les messages d’entrée pour le suivi des données de télémétrie. Accepte des chaînes simples (encapsulées automatiquement en tant que chatMessage AUTHENTIFICATION avec rôle user) ou un wrapper InputMessages versionné.
recordInputTokens(number)

Enregistre le nombre de jetons d’entrée pour le suivi des données de télémétrie.
recordOutputMessages(OutputMessagesParam)

Enregistre les messages de sortie pour le suivi des données de télémétrie. Accepte des chaînes simples (encapsulées automatiquement en tant que OutputMessage AUTHENTIFICATION avec rôle assistant) ou un wrapper OutputMessages versionné.
recordOutputTokens(number)

Enregistre le nombre de jetons de sortie pour le suivi des données de télémétrie.
start(Request, InferenceDetails, AgentDetails, UserDetails, SpanDetails)

Crée et démarre une nouvelle étendue pour le suivi d’inférence.

Méthodes héritées

dispose()

Méthode de suppression héritée pour la compatibilité
getSpanContext()

Obtient le contexte d’étendue pour cette étendue. Cela peut être utilisé pour créer un ParentSpanRef pour la liaison parent-enfant explicite entre les limites asynchrones.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Enregistre plusieurs paires clé/valeur d’attribut pour le suivi des données de télémétrie.
recordCancellation(string)

Enregistre un événement d’annulation sur l’étendue. Définit l’état de l’étendue sur ERROR avec la raison de l’annulation et marque le type d’erreur « TaskCanceledException ».
recordError(Error)

Enregistre une erreur qui s’est produite pendant l’opération
setEndTime(TimeInput)

Définit une heure de fin personnalisée pour l’étendue. Lorsque la valeur est définie, dispose passe cette valeur au span.end() lieu d’utiliser l’heure de l’horloge murale actuelle. Cela est utile lorsque l’heure de fin réelle de l’opération est connue avant la suppression de l’étendue.
withActiveSpanAsync<T>(() => Promise<T>)

Rend cette étendue active pendant la durée de l’exécution de rappel asynchrone

Détails de la méthode

recordFinishReasons(string[])

Enregistre les raisons de fin du suivi des données de télémétrie.

function recordFinishReasons(finishReasons: string[])

Paramètres

finishReasons

string[]

Tableau des raisons de fin

recordInputMessages(InputMessagesParam)

Enregistre les messages d’entrée pour le suivi des données de télémétrie. Accepte des chaînes simples (encapsulées automatiquement en tant que chatMessage AUTHENTIFICATION avec rôle user) ou un wrapper InputMessages versionné.

function recordInputMessages(messages: InputMessagesParam)

Paramètres

messages
InputMessagesParam

Tableau de chaînes de message d’entrée ou wrapper InputMessages

recordInputTokens(number)

Enregistre le nombre de jetons d’entrée pour le suivi des données de télémétrie.

function recordInputTokens(inputTokens: number)

Paramètres

inputTokens

number

Nombre de jetons d’entrée

recordOutputMessages(OutputMessagesParam)

Enregistre les messages de sortie pour le suivi des données de télémétrie. Accepte des chaînes simples (encapsulées automatiquement en tant que OutputMessage AUTHENTIFICATION avec rôle assistant) ou un wrapper OutputMessages versionné.

function recordOutputMessages(messages: OutputMessagesParam)

Paramètres

messages
OutputMessagesParam

Tableau de chaînes de message de sortie ou wrapper OutputMessages

recordOutputTokens(number)

Enregistre le nombre de jetons de sortie pour le suivi des données de télémétrie.

function recordOutputTokens(outputTokens: number)

Paramètres

outputTokens

number

Nombre de jetons de sortie

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

Crée et démarre une nouvelle étendue pour le suivi d’inférence.

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

Paramètres

request
Request

Charge utile de la requête (canal, conversationId, contenu, sessionId).

details
InferenceDetails

Détails de l’appel d’inférence (modèle, fournisseur, jetons, etc.).

agentDetails
AgentDetails

Agent effectuant l’inférence. L’ID de locataire est dérivé de agentDetails.tenantId.

userDetails
UserDetails

Identité facultative de l’appelant humain.

spanDetails
SpanDetails

Configuration d’étendue facultative (parentContext, startTime, endTime, spanLinks). Remarque : spanKind est ignorée ; InferenceScope utilise SpanKind.CLIENTtoujours .

Retours

InferenceScope

Nouvelle instance InferenceScope

Détails de la méthode héritée

dispose()

Méthode de suppression héritée pour la compatibilité

function dispose()

Héritéd’OpenTelemetryScope.dispose

getSpanContext()

Obtient le contexte d’étendue pour cette étendue. Cela peut être utilisé pour créer un ParentSpanRef pour la liaison parent-enfant explicite entre les limites asynchrones.

function getSpanContext(): SpanContext

Retours

SpanContext

SpanContext contenant traceId et spanId

Héritéd’OpenTelemetryScope.getSpanContext

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

Enregistre plusieurs paires clé/valeur d’attribut pour le suivi des données de télémétrie.

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

Paramètres

attributes

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

Collection de paires clé/valeur d’attribut (tableau ou itérable de [clé, valeur] ou mappage d’objets).

Héritéd’OpenTelemetryScope.recordAttributes

recordCancellation(string)

Enregistre un événement d’annulation sur l’étendue. Définit l’état de l’étendue sur ERROR avec la raison de l’annulation et marque le type d’erreur « TaskCanceledException ».

function recordCancellation(reason?: string)

Paramètres

reason

string

Motif d’annulation facultatif. La valeur par défaut est « La tâche a été annulée ».

Héritéd’OpenTelemetryScope.recordCancellation

recordError(Error)

Enregistre une erreur qui s’est produite pendant l’opération

function recordError(error: Error)

Paramètres

error

Error

L’erreur qui s’est produite

Héritéd’OpenTelemetryScope.recordError

setEndTime(TimeInput)

Définit une heure de fin personnalisée pour l’étendue. Lorsque la valeur est définie, dispose passe cette valeur au span.end() lieu d’utiliser l’heure de l’horloge murale actuelle. Cela est utile lorsque l’heure de fin réelle de l’opération est connue avant la suppression de l’étendue.

function setEndTime(endTime: TimeInput)

Paramètres

endTime

TimeInput

Heure de fin en millisecondes depuis l’époque, une date ou un tuple HrTime.

Héritéd’OpenTelemetryScope.setEndTime

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

Rend cette étendue active pendant la durée de l’exécution de rappel asynchrone

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

Paramètres

callback

() => Promise<T>

Retours

Promise<T>

Héritéd’OpenTelemetryScope.withActiveSpanAsync