BetaVoiceAgentsConversationsOperations interface

Paket:

@azure/ai-projects

Betrieb zur Verwaltung von Sprachagenten-Gesprächen.

Eigenschaften

delete	Löscht eine Unterhaltung und alle gespeicherten Daten – Antworten, Einträge und jegliche Audiodateien (Kaskade). Dies ist die explizite Kontrolle des Kunden zur Datenlöschung für Sprachgespräche.
downloadAudio	Streamt die gesamte zusammengeführte Stereoaufnahme als WAV-(audio/wav)-Byte-Stream durch den Dienst (keine SAS-URL). Diese Route dient ausschließlich dem von der Foundry verwalteten Speicher. Bei Bring-your-own-Storage (BYOS)-Aufnahmen werden die Bytes nicht geproxiet – der Anrufer muss direkt aus dem Kundenspeicher über die blob_uri vom Metadaten-Kanal zurückgegebene Route herunterladen – daher kehrt diese Route für BYOS-Aufzeichnungen zurück.409 Conflict Während das Gespräch istin_progress, kehrt diese Route mit und einem Retry-After Header zurück, 409 Conflicterror.code = recording_not_ready wenn Anleitung zum Wiederholen verfügbar ist. Wenn das Gespräch ist failed, kehrt es mit terminal 409 Conflict zurück error.code = recording_unavailable. Für ein completed Gespräch ist Inhalt verfügbar, vorbehaltlich des bestehenden BYOS-Verhaltens. Ein Gespräch ohne anhaltende Audioaufnahme (store = false) kehrt zurück.404
downloadAudioItem	Streamt den Ton eines einzelnen Gesprächselements als WAV-(audio/wav)-Byte-Stream durch den Dienst (keine SAS-URL). Diese Route dient ausschließlich dem von der Foundry verwalteten Speicher. Bei Bring-your-own-Storage (BYOS)-Aufnahmen werden die Bytes nicht per Proxy gekoppelt – der Anrufer muss direkt aus dem Kundenspeicher über die blob_uri vom Item zurückgegebene /audio Metadatenroute herunterladen – daher kehrt diese Route für BYOS-Aufzeichnungen zurück.409 Conflict Kehrt zurück, 404 wenn das Gespräch, der Gegenstand oder dessen Audio nicht fortgesetzt wurde (store = false).
downloadGeneratedAudioItem	Streamt das erzeugte Audio eines Konversationselements als WAV-(audio/wav)-Byte-Stream durch den Service. Dieses untergeordnete Artefakt existiert nur, wenn die Wiedergabe unterbrochen wurde und der Dienst mehr Audio lieferte, als der Hörer hörte, auch wenn die Antwort als abgebrochen endet. Diese Route dient ausschließlich dem von der Foundry verwalteten Speicher. Bei Bring-your-own-Storage (BYOS)-Aufnahmen werden die Bytes nicht geproxiet, daher gibt diese Route . zurück.409 Conflict Kehrt zurück, 404 wenn das Gespräch oder der Beitrag nicht fortgesetzt wurde oder wenn kein erzeugtes Audio über das gehörte Segment hinaus vorhanden ist.
get	Ruft ein einzelnes Gespräch ab, das für den angegebenen Sprachagenten-Endpunkt mit seiner ID aufgezeichnet wurde. Gibt zurück, 404 wenn das Gespräch nicht aufbewahrt wurde (store = false) oder nicht existiert.
getAudio	Gibt Metadaten für die gesamte Call-Merged Stereo-Aufnahme zurück (Benutzer-Audio auf dem linken Kanal, Agent-Audio auf der rechten Kanal). Die gängigen Metadaten (Format, Abtastrate, Kanäle, Kanallayout, Dauer) werden sowohl für Foundry-verwaltete als auch für Bring-your-own-Storage (BYOS)-Aufnahmen zurückgegeben; für BYOS enthält blob_uridie Antwort zusätzlich , die URI der Aufnahme im eigenen Speicher des Kunden (ohne SAS), die der Kunde mit seinen eigenen Zugangsdaten herunterlädt. Die Aufnahme wird einmal aus den Segmenten pro Zug aufgebaut, nachdem die Persistenz abgeschlossen ist. Während das Gespräch istin_progress, kehrt diese Route mit und einem Retry-After Header zurück, 409 Conflicterror.code = recording_not_ready wenn Anleitung zum Wiederholen verfügbar ist. Wenn das Gespräch ist failed, kehrt es mit terminal 409 Conflict zurück error.code = recording_unavailable. Für ein completed Gespräch sind Metadaten verfügbar, vorbehaltlich des bestehenden BYOS-Verhaltens. Erfordert, dass das Gespräch weiterhin Audio enthält (store = true); andernfalls gibt es . zurück.404
getAudioItem	Gibt Metadaten für das Audiosegment eines einzelnen Gesprächselements zurück, einschließlich der gemeinsamen Wiedergabedaten (Rolle, Format/Codec, Abtastrate, Kanäle, Offset, Dauer) sowohl für Foundry-verwaltete als auch für Bring-your-own-Storage (BYOS)-Aufnahmen; für BYOS enthält blob_uridie Antwort zusätzlich , die URI der Aufnahme im eigenen Speicher des Kunden (ohne SAS), die der Kunde mit seinen eigenen Zugangsdaten herunterlädt. Erfordert, dass das Gespräch weiterhin Audio enthält (store = true); kehrt zurück, 404 wenn das Gespräch, das Element oder dessen Audio nicht getragen wurde.
getGeneratedAudioItem	Gibt Metadaten für das von einem Gesprächselement generierte Audiomaterial zurück. Dieses untergeordnete Artefakt ist vom kanonischen Heard-Audio-Segment getrennt und existiert nur, wenn die Wiedergabe unterbrochen wurde und der Dienst mehr Audio lieferte, als der Hörer hörte, einschließlich wenn die Antwort als abgebrochen endet. Kehrt zurück, 404 wenn das Gespräch oder der Beitrag nicht fortgesetzt wurde oder wenn kein erzeugtes Audio über das gehörte Segment hinaus vorhanden ist.
getItem	Ruft ein einzelnes Element aus der angegebenen Konversation anhand seiner ID ab, einschließlich des Transkripts. Ein input_audio/output_audio Inhaltsteil zeigt an, dass Audio für das Element verfügbar ist; die kanonischen Audiometadaten pro Item sind die /items/{item_id}/audio Ressource, und die Bytes werden von /items/{item_id}/audio/contentgestreamt. Rücksendungen 404 , wenn das Gespräch oder der Artikel nicht fortgesetzt wurde (store = false).
getResponse	Ruft eine einzelne Antwort aus der angegebenen Unterhaltung über deren ID ab, einschließlich ihrer output Elemente, usage, und des Status. Kehrt zurück, 404 wenn das Gespräch oder die Antwort nicht fortgesetzt wurde (store = false).
list	Gibt die gespeicherten Gespräche für den angegebenen Sprachagenten-Endpunkt zurück. Gespräche sind vorhanden, wenn die effektive store Einstellung der Sitzung , truesei es von der Agentendefinition übernommen oder durch die WebSocket-Session-Überschreibung aktiviert.
listItems	Liefert eine pagente Sammlung von Elementen zurück – die vollständige geordnete Konversationshistorie, einschließlich Benutzereingaben, Assistentenausgaben und vom Client erstellten Werkzeugausgaben (Transkripte + Werkzeugereignisse). Kehrt zurück, 404 wenn das Gespräch nicht fortgesetzt wurde (store = false).
listResponseItems	Gibt eine pagedierte Sammlung der von einer bestimmten Antwort erzeugten Ausgabeobjekte zurück (die Output-Projektion der Antwort). Für den vollständigen geordneten Konversationsverlauf – einschließlich Benutzereingaben und vom Client erstellten Werkzeugausgaben – verwenden Sie stattdessen den Weg über Konversationsobjekte. Kehrt zurück, 404 wenn das Gespräch oder die Antwort nicht fortgesetzt wurde (store = false).
listResponses	Gibt eine pagedierte Sammlung der für das angegebene Gespräch aufgezeichneten Antworten (Modellinferenz-Turns) zurück. Die Projizierung pro Antwort output kann hier ausgelassen werden; verwenden Sie die Antwort-Items-Route für die kanonisch ausgeschriebene Ausgabe. Kehrt zurück, 404 wenn das Gespräch nicht fortgesetzt wurde (store = false).

Details zur Eigenschaft

delete

Löscht eine Unterhaltung und alle gespeicherten Daten – Antworten, Einträge und jegliche Audiodateien (Kaskade). Dies ist die explizite Kontrolle des Kunden zur Datenlöschung für Sprachgespräche.

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

Eigenschaftswert

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

downloadAudio

Streamt die gesamte zusammengeführte Stereoaufnahme als WAV-(audio/wav)-Byte-Stream durch den Dienst (keine SAS-URL). Diese Route dient ausschließlich dem von der Foundry verwalteten Speicher. Bei Bring-your-own-Storage (BYOS)-Aufnahmen werden die Bytes nicht geproxiet – der Anrufer muss direkt aus dem Kundenspeicher über die blob_uri vom Metadaten-Kanal zurückgegebene Route herunterladen – daher kehrt diese Route für BYOS-Aufzeichnungen zurück.409 Conflict Während das Gespräch istin_progress, kehrt diese Route mit und einem Retry-After Header zurück, 409 Conflicterror.code = recording_not_ready wenn Anleitung zum Wiederholen verfügbar ist. Wenn das Gespräch ist failed, kehrt es mit terminal 409 Conflict zurück error.code = recording_unavailable. Für ein completed Gespräch ist Inhalt verfügbar, vorbehaltlich des bestehenden BYOS-Verhaltens. Ein Gespräch ohne anhaltende Audioaufnahme (store = false) kehrt zurück.404

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

Eigenschaftswert

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

downloadAudioItem

Streamt den Ton eines einzelnen Gesprächselements als WAV-(audio/wav)-Byte-Stream durch den Dienst (keine SAS-URL). Diese Route dient ausschließlich dem von der Foundry verwalteten Speicher. Bei Bring-your-own-Storage (BYOS)-Aufnahmen werden die Bytes nicht per Proxy gekoppelt – der Anrufer muss direkt aus dem Kundenspeicher über die blob_uri vom Item zurückgegebene /audio Metadatenroute herunterladen – daher kehrt diese Route für BYOS-Aufzeichnungen zurück.409 Conflict Kehrt zurück, 404 wenn das Gespräch, der Gegenstand oder dessen Audio nicht fortgesetzt wurde (store = false).

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

Eigenschaftswert

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

downloadGeneratedAudioItem

Streamt das erzeugte Audio eines Konversationselements als WAV-(audio/wav)-Byte-Stream durch den Service. Dieses untergeordnete Artefakt existiert nur, wenn die Wiedergabe unterbrochen wurde und der Dienst mehr Audio lieferte, als der Hörer hörte, auch wenn die Antwort als abgebrochen endet. Diese Route dient ausschließlich dem von der Foundry verwalteten Speicher. Bei Bring-your-own-Storage (BYOS)-Aufnahmen werden die Bytes nicht geproxiet, daher gibt diese Route . zurück.409 Conflict Kehrt zurück, 404 wenn das Gespräch oder der Beitrag nicht fortgesetzt wurde oder wenn kein erzeugtes Audio über das gehörte Segment hinaus vorhanden ist.

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

Eigenschaftswert

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

get

Ruft ein einzelnes Gespräch ab, das für den angegebenen Sprachagenten-Endpunkt mit seiner ID aufgezeichnet wurde. Gibt zurück, 404 wenn das Gespräch nicht aufbewahrt wurde (store = false) oder nicht existiert.

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

Eigenschaftswert

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

getAudio

Gibt Metadaten für die gesamte Call-Merged Stereo-Aufnahme zurück (Benutzer-Audio auf dem linken Kanal, Agent-Audio auf der rechten Kanal). Die gängigen Metadaten (Format, Abtastrate, Kanäle, Kanallayout, Dauer) werden sowohl für Foundry-verwaltete als auch für Bring-your-own-Storage (BYOS)-Aufnahmen zurückgegeben; für BYOS enthält blob_uridie Antwort zusätzlich , die URI der Aufnahme im eigenen Speicher des Kunden (ohne SAS), die der Kunde mit seinen eigenen Zugangsdaten herunterlädt. Die Aufnahme wird einmal aus den Segmenten pro Zug aufgebaut, nachdem die Persistenz abgeschlossen ist. Während das Gespräch istin_progress, kehrt diese Route mit und einem Retry-After Header zurück, 409 Conflicterror.code = recording_not_ready wenn Anleitung zum Wiederholen verfügbar ist. Wenn das Gespräch ist failed, kehrt es mit terminal 409 Conflict zurück error.code = recording_unavailable. Für ein completed Gespräch sind Metadaten verfügbar, vorbehaltlich des bestehenden BYOS-Verhaltens. Erfordert, dass das Gespräch weiterhin Audio enthält (store = true); andernfalls gibt es . zurück.404

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

Eigenschaftswert

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

getAudioItem

Gibt Metadaten für das Audiosegment eines einzelnen Gesprächselements zurück, einschließlich der gemeinsamen Wiedergabedaten (Rolle, Format/Codec, Abtastrate, Kanäle, Offset, Dauer) sowohl für Foundry-verwaltete als auch für Bring-your-own-Storage (BYOS)-Aufnahmen; für BYOS enthält blob_uridie Antwort zusätzlich , die URI der Aufnahme im eigenen Speicher des Kunden (ohne SAS), die der Kunde mit seinen eigenen Zugangsdaten herunterlädt. Erfordert, dass das Gespräch weiterhin Audio enthält (store = true); kehrt zurück, 404 wenn das Gespräch, das Element oder dessen Audio nicht getragen wurde.

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

Eigenschaftswert

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

getGeneratedAudioItem

Gibt Metadaten für das von einem Gesprächselement generierte Audiomaterial zurück. Dieses untergeordnete Artefakt ist vom kanonischen Heard-Audio-Segment getrennt und existiert nur, wenn die Wiedergabe unterbrochen wurde und der Dienst mehr Audio lieferte, als der Hörer hörte, einschließlich wenn die Antwort als abgebrochen endet. Kehrt zurück, 404 wenn das Gespräch oder der Beitrag nicht fortgesetzt wurde oder wenn kein erzeugtes Audio über das gehörte Segment hinaus vorhanden ist.

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

Eigenschaftswert

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

getItem

Ruft ein einzelnes Element aus der angegebenen Konversation anhand seiner ID ab, einschließlich des Transkripts. Ein input_audio/output_audio Inhaltsteil zeigt an, dass Audio für das Element verfügbar ist; die kanonischen Audiometadaten pro Item sind die /items/{item_id}/audio Ressource, und die Bytes werden von /items/{item_id}/audio/contentgestreamt. Rücksendungen 404 , wenn das Gespräch oder der Artikel nicht fortgesetzt wurde (store = false).

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

Eigenschaftswert

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

getResponse

Ruft eine einzelne Antwort aus der angegebenen Unterhaltung über deren ID ab, einschließlich ihrer output Elemente, usage, und des Status. Kehrt zurück, 404 wenn das Gespräch oder die Antwort nicht fortgesetzt wurde (store = false).

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

Eigenschaftswert

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

list

Gibt die gespeicherten Gespräche für den angegebenen Sprachagenten-Endpunkt zurück. Gespräche sind vorhanden, wenn die effektive store Einstellung der Sitzung , truesei es von der Agentendefinition übernommen oder durch die WebSocket-Session-Überschreibung aktiviert.

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

Eigenschaftswert

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

listItems

Liefert eine pagente Sammlung von Elementen zurück – die vollständige geordnete Konversationshistorie, einschließlich Benutzereingaben, Assistentenausgaben und vom Client erstellten Werkzeugausgaben (Transkripte + Werkzeugereignisse). Kehrt zurück, 404 wenn das Gespräch nicht fortgesetzt wurde (store = false).

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

Eigenschaftswert

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

listResponseItems

Gibt eine pagedierte Sammlung der von einer bestimmten Antwort erzeugten Ausgabeobjekte zurück (die Output-Projektion der Antwort). Für den vollständigen geordneten Konversationsverlauf – einschließlich Benutzereingaben und vom Client erstellten Werkzeugausgaben – verwenden Sie stattdessen den Weg über Konversationsobjekte. Kehrt zurück, 404 wenn das Gespräch oder die Antwort nicht fortgesetzt wurde (store = false).

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

Eigenschaftswert

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

listResponses

Gibt eine pagedierte Sammlung der für das angegebene Gespräch aufgezeichneten Antworten (Modellinferenz-Turns) zurück. Die Projizierung pro Antwort output kann hier ausgelassen werden; verwenden Sie die Antwort-Items-Route für die kanonisch ausgeschriebene Ausgabe. Kehrt zurück, 404 wenn das Gespräch nicht fortgesetzt wurde (store = false).

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

Eigenschaftswert

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