InvokeAgentScope class

Paquet:: @microsoft/agents-a365-observability

Fournit l’étendue de suivi OpenTelemetry pour les opérations d’appel d’agent IA.

Extends: OpenTelemetryScope

Méthodes

recordInputMessages(InputMessagesParam)	Enregistre les messages d’entrée pour le suivi des données de télémétrie. Accepte une seule chaîne, un tableau de chaînes (encapsulés automatiquement en tant que chatMessage EAP avec rôle `user`) ou un wrapper InputMessages versionné.
recordOutputMessages(OutputMessagesParam)	Enregistre les messages de sortie pour le suivi des données de télémétrie. Accepte une seule chaîne, un tableau de chaînes (encapsulés automatiquement en tant que outputMessage EAP avec rôle `assistant`) ou un wrapper OutputMessages versionné.
recordResponse(string)	Enregistre les informations de réponse pour le suivi des données de télémétrie.
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)	Crée et démarre une nouvelle étendue pour le suivi d’appel d’agent.

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

recordInputMessages(InputMessagesParam)

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

function recordInputMessages(messages: InputMessagesParam)

Paramètres

messages: InputMessagesParam

Chaîne, tableau de chaînes ou wrapper InputMessages

recordOutputMessages(OutputMessagesParam)

Enregistre les messages de sortie pour le suivi des données de télémétrie. Accepte une seule chaîne, un tableau de chaînes (encapsulés automatiquement en tant que outputMessage EAP avec rôle assistant) ou un wrapper OutputMessages versionné.

function recordOutputMessages(messages: OutputMessagesParam)

Paramètres

messages: OutputMessagesParam

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

recordResponse(string)

Enregistre les informations de réponse pour le suivi des données de télémétrie.

function recordResponse(response: string)

Paramètres

response: string

Réponse d’appel

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

Crée et démarre une nouvelle étendue pour le suivi d’appel d’agent.

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

Paramètres

request: Request

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

invokeScopeDetails: InvokeAgentScopeDetails

Détails au niveau de l’étendue

agentDetails: AgentDetails

Identité de l’agent. L’ID de locataire est dérivé ( agentDetails.tenantId obligatoire).

callerDetails: CallerDetails

Informations facultatives sur l’appelant. Prend en charge trois scénarios :

Appelant humain uniquement : { userDetails: { userId, userName, ... } }
Appelant de l’agent uniquement : { callerAgentDetails: { agentId, agentName, ... } }
Les deux (A2A avec un humain en chaîne) : { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails: SpanDetails

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

Retours

InvokeAgentScope

Nouvelle instance InvokeAgentScope.

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