OutputScope class

Paquet:
@microsoft/agents-a365-observability

Fournit l’étendue de suivi OpenTelemetry pour le suivi des messages de sortie avec la liaison d’étendue parente.

Extends
OpenTelemetryScope

Méthodes

recordOutputMessages(ResponseMessagesParam)

Enregistre les messages de sortie pour le suivi des données de télémétrie. Remplace les messages de sortie enregistrés précédemment sur l’étendue. Accepte une chaîne unique, un tableau de chaînes (encapsulés automatiquement en tant que outputMessage EAP), un wrapper OutputMessages versionné ou une dictée brute (traitée comme un résultat d’appel d’outil par spécification EAP, sérialisée directement).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)

Crée et démarre une nouvelle étendue pour le suivi des messages de sortie.

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

recordOutputMessages(ResponseMessagesParam)

Enregistre les messages de sortie pour le suivi des données de télémétrie. Remplace les messages de sortie enregistrés précédemment sur l’étendue. Accepte une chaîne unique, un tableau de chaînes (encapsulés automatiquement en tant que outputMessage EAP), un wrapper OutputMessages versionné ou une dictée brute (traitée comme un résultat d’appel d’outil par spécification EAP, sérialisée directement).

function recordOutputMessages(messages: ResponseMessagesParam)

Paramètres

messages
ResponseMessagesParam

Chaîne, tableau de chaînes, wrapper OutputMessages ou dict.

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

Crée et démarre une nouvelle étendue pour le suivi des messages de sortie.

static function start(request: Request, response: OutputResponse, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): OutputScope

Paramètres

request
Request

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

response
OutputResponse

Réponse contenant les messages de sortie initiaux.

agentDetails
AgentDetails

Agent produisant la sortie. L’ID de locataire est dérivé de agentDetails.tenantId.

userDetails
UserDetails

Détails facultatifs de l’identité de l’appelant humain.

spanDetails
SpanDetails

Configuration d’étendue facultative (parentContext, startTime, endTime, spanLinks).

Retours

OutputScope

Nouvelle instance OutputScope.

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