BetaVoiceAgentsConversationsOperations interface

Package:

@azure/ai-projects

Opérations pour gérer les conversations des agents vocaux.

Propriétés

delete	Supprime une conversation et toutes ses données stockées — réponses, éléments et tout son (cascade). Il s’agit du contrôle explicite de suppression des données du client pour les conversations vocales.
downloadAudio	Diffuse l’enregistrement stéréo fusionné de l’appel entier en flux WAV (audio/wav) bytes via le service (sans URL SAS). Cette ligne ne sert qu’à gérer le stockage géré par Foundry. Pour les enregistrements bring-your-own-storage (BYOS), les octets ne sont pas proxiés — l’appelant doit télécharger directement depuis le stockage client en utilisant la blob_uri route des métadonnées renvoyée — cette route est donc rendue 409 Conflict pour les enregistrements BYOS. Pendant que la conversation est in_progress, cette route retourne retryable 409 Conflict avec error.code = recording_not_ready et un Retry-After en-tête lorsque des instructions de réessayage sont disponibles. Lorsque la conversation est failed, elle retourne terminal 409 Conflict avec error.code = recording_unavailable. Pour une completed conversation, le contenu est disponible sous réserve du comportement BYOS existant. Une conversation sans son persistant (store = false) renvoie 404.
downloadAudioItem	Diffuse l’audio d’un seul élément de conversation sous forme d’un flux d’octets WAV (audio/wav) via le service (sans URL SAS). Cette ligne ne sert qu’à gérer le stockage géré par Foundry. Pour les enregistrements « apportez votre propre stockage » (BYOS), les octets ne sont pas proxiés — l’appelant doit télécharger directement depuis le stockage client en utilisant la blob_uri route de métadonnées renvoyée par l’élément /audio — donc cette route revient 409 Conflict pour les enregistrements BYOS. Retours 404 lorsque la conversation, l’élément ou son audio n’a pas été maintenu (store = false).
downloadGeneratedAudioItem	Diffuse l’audio généré par un élément de conversation sous forme d’un flux d’octets WAV (audio/wav) via le service. Cet artefact subordonné n’existe que lorsque la lecture a été interrompue et que le service a rendu plus d’audio que ce que l’auditeur a entendu, y compris lorsque la réponse se termine comme annulée. Cette ligne ne sert qu’à gérer le stockage géré par Foundry. Pour les enregistrements BYOS (apporte votre propre stockage), les octets ne sont pas proxyés, donc cette route retourne 409 Conflict. Revient 404 lorsque la conversation ou l’élément n’a pas été maintenu, ou lorsqu’aucun audio généré n’existe au-delà du segment entendu.
get	Récupère une seule conversation enregistrée pour le point de terminaison de l’agent vocal spécifié par son identifiant. Retourne 404 lorsque la conversation n’a pas été poursuivie (store = false) ou n’existe pas.
getAudio	Retourne les métadonnées pour l’enregistrement stéréo fusionné de l’appel complet (audio utilisateur sur le canal gauche, audio agent sur le canal droit). Les métadonnées courantes (format, fréquence d’échantillonnage, canaux, disposition du canal, durée) sont retournées pour les enregistrements gérés par Foundry et ceux du stockage BYOS (bring-your-own-storage) ; pour BYOS, la réponse inclut blob_uriégalement , l’URI de l’enregistrement dans le stockage propre du client (sans SAS) que le client télécharge avec ses propres identifiants. L’enregistrement est construit une fois à partir des segments par tour après la finalisation de la persistance. Pendant que la conversation est in_progress, cette route retourne retryable 409 Conflict avec error.code = recording_not_ready et un Retry-After en-tête lorsque des instructions de réessayage sont disponibles. Lorsque la conversation est failed, elle retourne terminal 409 Conflict avec error.code = recording_unavailable. Pour une completed conversation, les métadonnées sont disponibles sous réserve du comportement BYOS existant. Nécessite que la conversation ait un audio persistant (store = true) ; sinon retourne 404.
getAudioItem	Retourne les métadonnées pour le segment audio d’un seul élément de conversation, incluant les faits de lecture courants (rôle, format/codec, fréquence d’échantillonnage, canaux, décalage, durée) pour les enregistrements gérés par Foundry et ceux bring-your-own-storage (BYOS) ; pour BYOS, la réponse inclut blob_uriégalement , l’URI de l’enregistrement dans le stockage propre du client (sans SAS) que le client télécharge avec ses propres identifiants. Exige que la conversation ait un audio persisté (store = true) ; revient 404 lorsque la conversation, l’élément ou son audio n’a pas été persisté.
getGeneratedAudioItem	Retourne les métadonnées pour l’audio généré par un élément de conversation. Cet artefact subordonné est distinct du segment audio entendu canonique et n’existe que lorsque la lecture a été interrompue et que le service a rendu plus d’audio que ce que l’auditeur a entendu, y compris lorsque la réponse s’arrête comme annulée. Revient 404 lorsque la conversation ou l’élément n’a pas été maintenu, ou lorsqu’aucun audio généré n’existe au-delà du segment entendu.
getItem	Récupère un seul élément de la conversation spécifiée via son id, y compris sa transcription. Une input_audio/output_audio partie de contenu indique que l’audio est disponible pour l’élément ; les métadonnées audio canoniques par article sont la /items/{item_id}/audio ressource, et les octets sont diffusés en flux par ./items/{item_id}/audio/content Revient 404 lorsque la conversation ou l’élément n’a pas été poursuivi (store = false).
getResponse	Récupère une seule réponse de la conversation spécifiée via son id, incluant ses output éléments, usage, et statut. Retour 404 lorsque la conversation ou la réponse n’a pas été poursuivie (store = false).
list	Retourne les conversations persistantes pour le point d’accès de l’agent vocal spécifié. Les conversations sont présentes lorsque le réglage effectif store de la session est true, qu’il soit hérité de la définition de l’agent ou activé par la dérogation de session WebSocket.
listItems	Retourne une collection paginate d’éléments — l’historique complet des conversations ordonnées, incluant les entrées utilisateur, les sorties de l’assistant et les sorties d’outils créées par le client (transcriptions + événements d’outils). Retour 404 lorsque la conversation n’a pas été poursuivie (store = false).
listResponseItems	Retourne une collection paginate des éléments de sortie produits par une réponse spécifique (la projection de sortie de la réponse). Pour l’historique complet ordonné des conversations — y compris les entrées utilisateur et les sorties d’outils créées par le client — utilisez plutôt la voie des éléments de conversation. Retour 404 lorsque la conversation ou la réponse n’a pas été poursuivie (store = false).
listResponses	Retourne une collection paginée des réponses (retournements d’inférence de modèle) enregistrées pour la conversation spécifiée. La projection par réponse output peut être omise ici ; utilisez la route des items de réponse pour la sortie paginée canonique. Retour 404 lorsque la conversation n’a pas été poursuivie (store = false).

Détails de la propriété

delete

Supprime une conversation et toutes ses données stockées — réponses, éléments et tout son (cascade). Il s’agit du contrôle explicite de suppression des données du client pour les conversations vocales.

delete: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDeleteOptionalParams) => Promise<void>

Valeur de propriété

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDeleteOptionalParams) => Promise<void>

downloadAudio

Diffuse l’enregistrement stéréo fusionné de l’appel entier en flux WAV (audio/wav) bytes via le service (sans URL SAS). Cette ligne ne sert qu’à gérer le stockage géré par Foundry. Pour les enregistrements bring-your-own-storage (BYOS), les octets ne sont pas proxiés — l’appelant doit télécharger directement depuis le stockage client en utilisant la blob_uri route des métadonnées renvoyée — cette route est donc rendue 409 Conflict pour les enregistrements BYOS. Pendant que la conversation est in_progress, cette route retourne retryable 409 Conflict avec error.code = recording_not_ready et un Retry-After en-tête lorsque des instructions de réessayage sont disponibles. Lorsque la conversation est failed, elle retourne terminal 409 Conflict avec error.code = recording_unavailable. Pour une completed conversation, le contenu est disponible sous réserve du comportement BYOS existant. Une conversation sans son persistant (store = false) renvoie 404.

downloadAudio: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDownloadAudioOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioResponse>

Valeur de propriété

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDownloadAudioOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioResponse>

downloadAudioItem

Diffuse l’audio d’un seul élément de conversation sous forme d’un flux d’octets WAV (audio/wav) via le service (sans URL SAS). Cette ligne ne sert qu’à gérer le stockage géré par Foundry. Pour les enregistrements « apportez votre propre stockage » (BYOS), les octets ne sont pas proxiés — l’appelant doit télécharger directement depuis le stockage client en utilisant la blob_uri route de métadonnées renvoyée par l’élément /audio — donc cette route revient 409 Conflict pour les enregistrements BYOS. Retours 404 lorsque la conversation, l’élément ou son audio n’a pas été maintenu (store = false).

downloadAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioItemResponse>

Valeur de propriété

(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioItemResponse>

downloadGeneratedAudioItem

Diffuse l’audio généré par un élément de conversation sous forme d’un flux d’octets WAV (audio/wav) via le service. Cet artefact subordonné n’existe que lorsque la lecture a été interrompue et que le service a rendu plus d’audio que ce que l’auditeur a entendu, y compris lorsque la réponse se termine comme annulée. Cette ligne ne sert qu’à gérer le stockage géré par Foundry. Pour les enregistrements BYOS (apporte votre propre stockage), les octets ne sont pas proxyés, donc cette route retourne 409 Conflict. Revient 404 lorsque la conversation ou l’élément n’a pas été maintenu, ou lorsqu’aucun audio généré n’existe au-delà du segment entendu.

downloadGeneratedAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse>

Valeur de propriété

(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse>

get

Récupère une seule conversation enregistrée pour le point de terminaison de l’agent vocal spécifié par son identifiant. Retourne 404 lorsque la conversation n’a pas été poursuivie (store = false) ou n’existe pas.

get: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetOptionalParams) => Promise<VoiceConversation>

Valeur de propriété

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetOptionalParams) => Promise<VoiceConversation>

getAudio

Retourne les métadonnées pour l’enregistrement stéréo fusionné de l’appel complet (audio utilisateur sur le canal gauche, audio agent sur le canal droit). Les métadonnées courantes (format, fréquence d’échantillonnage, canaux, disposition du canal, durée) sont retournées pour les enregistrements gérés par Foundry et ceux du stockage BYOS (bring-your-own-storage) ; pour BYOS, la réponse inclut blob_uriégalement , l’URI de l’enregistrement dans le stockage propre du client (sans SAS) que le client télécharge avec ses propres identifiants. L’enregistrement est construit une fois à partir des segments par tour après la finalisation de la persistance. Pendant que la conversation est in_progress, cette route retourne retryable 409 Conflict avec error.code = recording_not_ready et un Retry-After en-tête lorsque des instructions de réessayage sont disponibles. Lorsque la conversation est failed, elle retourne terminal 409 Conflict avec error.code = recording_unavailable. Pour une completed conversation, les métadonnées sont disponibles sous réserve du comportement BYOS existant. Nécessite que la conversation ait un audio persistant (store = true) ; sinon retourne 404.

getAudio: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetAudioOptionalParams) => Promise<VoiceRecording>

Valeur de propriété

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetAudioOptionalParams) => Promise<VoiceRecording>

getAudioItem

Retourne les métadonnées pour le segment audio d’un seul élément de conversation, incluant les faits de lecture courants (rôle, format/codec, fréquence d’échantillonnage, canaux, décalage, durée) pour les enregistrements gérés par Foundry et ceux bring-your-own-storage (BYOS) ; pour BYOS, la réponse inclut blob_uriégalement , l’URI de l’enregistrement dans le stockage propre du client (sans SAS) que le client télécharge avec ses propres identifiants. Exige que la conversation ait un audio persisté (store = true) ; revient 404 lorsque la conversation, l’élément ou son audio n’a pas été persisté.

getAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetAudioItemOptionalParams) => Promise<VoiceAudioItem>

Valeur de propriété

(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetAudioItemOptionalParams) => Promise<VoiceAudioItem>

getGeneratedAudioItem

Retourne les métadonnées pour l’audio généré par un élément de conversation. Cet artefact subordonné est distinct du segment audio entendu canonique et n’existe que lorsque la lecture a été interrompue et que le service a rendu plus d’audio que ce que l’auditeur a entendu, y compris lorsque la réponse s’arrête comme annulée. Revient 404 lorsque la conversation ou l’élément n’a pas été maintenu, ou lorsqu’aucun audio généré n’existe au-delà du segment entendu.

getGeneratedAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams) => Promise<VoiceGeneratedAudioItem>

Valeur de propriété

(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams) => Promise<VoiceGeneratedAudioItem>

getItem

Récupère un seul élément de la conversation spécifiée via son id, y compris sa transcription. Une input_audio/output_audio partie de contenu indique que l’audio est disponible pour l’élément ; les métadonnées audio canoniques par article sont la /items/{item_id}/audio ressource, et les octets sont diffusés en flux par ./items/{item_id}/audio/content Revient 404 lorsque la conversation ou l’élément n’a pas été poursuivi (store = false).

getItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetItemOptionalParams) => Promise<RealtimeConversationItemUnion>

Valeur de propriété

(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetItemOptionalParams) => Promise<RealtimeConversationItemUnion>

getResponse

Récupère une seule réponse de la conversation spécifiée via son id, incluant ses output éléments, usage, et statut. Retour 404 lorsque la conversation ou la réponse n’a pas été poursuivie (store = false).

getResponse: (agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsGetResponseOptionalParams) => Promise<VoiceResponse>

Valeur de propriété

(agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsGetResponseOptionalParams) => Promise<VoiceResponse>

list

Retourne les conversations persistantes pour le point d’accès de l’agent vocal spécifié. Les conversations sont présentes lorsque le réglage effectif store de la session est true, qu’il soit hérité de la définition de l’agent ou activé par la dérogation de session WebSocket.

list: (agentName: string, options?: BetaVoiceAgentsConversationsListOptionalParams) => PagedAsyncIterableIterator<VoiceConversation, VoiceConversation[], PageSettings>

Valeur de propriété

(agentName: string, options?: BetaVoiceAgentsConversationsListOptionalParams) => PagedAsyncIterableIterator<VoiceConversation, VoiceConversation[], PageSettings>

listItems

Retourne une collection paginate d’éléments — l’historique complet des conversations ordonnées, incluant les entrées utilisateur, les sorties de l’assistant et les sorties d’outils créées par le client (transcriptions + événements d’outils). Retour 404 lorsque la conversation n’a pas été poursuivie (store = false).

listItems: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>

Valeur de propriété

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>

listResponseItems

Retourne une collection paginate des éléments de sortie produits par une réponse spécifique (la projection de sortie de la réponse). Pour l’historique complet ordonné des conversations — y compris les entrées utilisateur et les sorties d’outils créées par le client — utilisez plutôt la voie des éléments de conversation. Retour 404 lorsque la conversation ou la réponse n’a pas été poursuivie (store = false).

listResponseItems: (agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsListResponseItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>

Valeur de propriété

(agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsListResponseItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>

listResponses

Retourne une collection paginée des réponses (retournements d’inférence de modèle) enregistrées pour la conversation spécifiée. La projection par réponse output peut être omise ici ; utilisez la route des items de réponse pour la sortie paginée canonique. Retour 404 lorsque la conversation n’a pas été poursuivie (store = false).

listResponses: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListResponsesOptionalParams) => PagedAsyncIterableIterator<VoiceResponse, VoiceResponse[], PageSettings>

Valeur de propriété

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListResponsesOptionalParams) => PagedAsyncIterableIterator<VoiceResponse, VoiceResponse[], PageSettings>