BetaVoiceAgentsConversationsOperations interface

Pakiet:

@azure/ai-projects

Operacje zarządzania rozmowami agentów głosowych.

Właściwości

delete	Usuwa rozmowę i wszystkie jej przechowywane dane — odpowiedzi, elementy oraz wszelkie nagrania audio (kaskadowe). To jest jawna kontrola usuwania danych klienta dla rozmów głosowych.
downloadAudio	Przesyła całe połączenie połączone z połączeniem jako strumień bajtów WAV (audio/wav) przez usługę (bez adresu SAS). Ta trasa obsługuje wyłącznie przechowywanie przechowywane przez Foundry. W przypadku nagrań typu bring your-own-storage (BYOS) bajty nie są proxy — dzwoniący musi pobierać bezpośrednio z pamięci klienta, korzystając z trasy metadanych zwracanych blob_uri — więc ta trasa 409 Conflict zwraca się do nagrań BYOS. Podczas rozmowy in_progressta trasa zwraca się do odzyskania 409 Conflict z nagłówkiem error.code = recording_not_readyRetry-After , gdy dostępne są wskazówki powtórki. Gdy rozmowa jest , failedzwraca 409 Conflict się terminalnie z .error.code = recording_unavailable W przypadku completed rozmowy dostępne są treści, pod warunkiem istniejącego zachowania BYOS. Rozmowa bez utrzymującego się dźwięku (store = false) wraca 404.
downloadAudioItem	Przesyła dźwięk pojedynczego elementu rozmowy jako strumień bajtów WAV (audio/wav) przez usługę (bez adresu URL SAS). Ta trasa obsługuje wyłącznie przechowywanie przechowywane przez Foundry. W przypadku nagrań typu bring-your-own-storage (BYOS) bajty nie są proxyowane — dzwoniący musi pobierać je bezpośrednio z pamięci klienta, korzystając z trasy metadanych zwróconej blob_uri przez metadane przedmiotu /audio — więc ta trasa zwraca 409 Conflict się do nagrań BYOS. Wraca, 404 gdy rozmowa, przedmiot lub jego dźwięk nie zostały utrzymane (store = false).
downloadGeneratedAudioItem	Przesyła wygenerowany dźwięk elementu rozmowy jako strumień bajtów WAV (audio/wav) przez usługę. Ten artefakt podrzędny występuje tylko wtedy, gdy odtwarzanie zostało przerwane, a usługa przekazała więcej dźwięku niż słuchacz usłyszał, w tym gdy odpowiedź zakończyła się jako anulowana. Ta trasa obsługuje wyłącznie przechowywanie przechowywane przez Foundry. W przypadku nagrań typu bring-your-own-storage (BYOS) bajty nie są proxyowane, więc ta trasa zwraca 409 Conflict. Wraca, 404 gdy rozmowa lub element nie został kontynuowany, albo gdy nie ma wygenerowanego dźwięku poza wysłuchanym segmentem.
get	Pobiera pojedynczą rozmowę zarejestrowaną dla określonego punktu końcowego agenta głosowego na podstawie jej identyfikatora. Zwraca, 404 gdy rozmowa nie została kontynuowana (store = false) lub nie istnieje.
getAudio	Zwraca metadane dla całego połączenia połączonego nagrania stereo (audio użytkownika na lewym kanale, dźwięk agenta na prawym). Wspólne metadane (format, częstotliwość próbkowania, kanały, układ kanałów, czas trwania) są zwracane zarówno dla nagrań zarządzanych przez Foundry, jak i z możliwością przyniesienia własnej pamięci (BYOS); dla BYOS odpowiedź dodatkowo zawiera blob_uri, URI nagrania z własnej pamięci klienta (bez SAS), które klient pobiera ze swoimi uprawnieniami. Nagranie jest budowane raz z segmentów na turę po zakończeniu zakończenia wytrwałości. Podczas rozmowy in_progressta trasa zwraca się do odzyskania 409 Conflict z nagłówkiem error.code = recording_not_readyRetry-After , gdy dostępne są wskazówki powtórki. Gdy rozmowa jest , failedzwraca 409 Conflict się terminalnie z .error.code = recording_unavailable Dla completed rozmowy dostępne są metadane pod warunkiem istniejącego zachowania BYOS. Wymaga, aby rozmowa miała trwały dźwięk (store = true); w przeciwnym razie zwraca 404.
getAudioItem	Zwraca metadane dla segmentu audio pojedynczego elementu rozmowy, w tym wspólne fakty odtwarzania (rola, format/kodek, częstotliwość próbkowania, kanały, offset, czas trwania) zarówno dla nagrań zarządzanych przez Foundry, jak i z możliwością przyniesienia własnej pamięci (BYOS); dla BYOS odpowiedź dodatkowo zawiera blob_uri, URI nagrania w pamięci użytkownika (bez SAS), które klient pobiera za pomocą własnych danych uwierzytelniających. Wymaga, aby rozmowa miała trwały dźwięk (store = true); wraca, 404 gdy rozmowa, element lub jego dźwięk nie był kontynuowany.
getGeneratedAudioItem	Zwraca metadane wygenerowanego dźwięku w treści rozmowy. Ten podrzędny artefakt jest oddzielny od kanonicznego segmentu słyszanego i występuje tylko wtedy, gdy odtwarzanie zostało przerwane, a usługa wygenerowała więcej dźwięku niż usłyszał słuchacz, w tym gdy odpowiedź zakończyła się jako anulowana. Wraca, 404 gdy rozmowa lub element nie został kontynuowany, albo gdy nie ma wygenerowanego dźwięku poza wysłuchanym segmentem.
getItem	Pobiera pojedynczy element z podanej rozmowy na podstawie jego identyfikatora, w tym transkrypcję. Część input_audio/output_audio treści wskazuje, że dla elementu dostępny jest dźwięk; kanoniczne metadane audio dla elementu są zasobem /items/{item_id}/audio , a bajty są przesyłane strumieniowo przez /items/{item_id}/audio/content. Wraca, 404 gdy rozmowa lub element nie został kontynuowany (store = false).
getResponse	Pobiera pojedynczą odpowiedź z podanej rozmowy za pomocą jej identyfikatora, w tym output przedmioty, usage, oraz status. Wraca, 404 gdy rozmowa lub odpowiedź nie została kontynuowana (store = false).
list	Zwraca rozmowy kontynuowane dla określonego punktu końcowego agenta głosowego. Rozmowy są obecne, gdy efektywne store ustawienie sesji jest , trueniezależnie od tego, czy zostało odziedziczone z definicji agenta, czy włączone przez override sesji WebSocket.
listItems	Zwraca stronicowaną kolekcję elementów — pełną uporządkowaną historię rozmów, w tym dane wejściowe użytkownika, wyjścia asystenta oraz dane narzędzi stworzone przez klienta (transkrypcje + zdarzenia narzędzi). Wraca, 404 gdy rozmowa nie była kontynuowana (store = false).
listResponseItems	Zwraca stronicowaną kolekcję elementów wyjściowych wygenerowanych przez konkretną odpowiedź (projekcję wyjściową odpowiedzi). Aby uzyskać pełną uporządkowaną historię rozmów — w tym wkład użytkownika i narzędzia tworzone przez klienta — zamiast tego użyj ścieżki elementów rozmowy. Wraca, 404 gdy rozmowa lub odpowiedź nie została kontynuowana (store = false).
listResponses	Zwraca zbiór stron odpowiedzi (zwroty wnioskowania modelu) zarejestrowanych dla określonej rozmowy. Projekcja na pojedynczą odpowiedź output może być tutaj pominięta; dla kanonicznego wyjścia stronicowanego można użyć ścieżki odpowiedzi-elementów. Wraca, 404 gdy rozmowa nie była kontynuowana (store = false).

Szczegóły właściwości

delete

Usuwa rozmowę i wszystkie jej przechowywane dane — odpowiedzi, elementy oraz wszelkie nagrania audio (kaskadowe). To jest jawna kontrola usuwania danych klienta dla rozmów głosowych.

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

Wartość właściwości

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

downloadAudio

Przesyła całe połączenie połączone z połączeniem jako strumień bajtów WAV (audio/wav) przez usługę (bez adresu SAS). Ta trasa obsługuje wyłącznie przechowywanie przechowywane przez Foundry. W przypadku nagrań typu bring your-own-storage (BYOS) bajty nie są proxy — dzwoniący musi pobierać bezpośrednio z pamięci klienta, korzystając z trasy metadanych zwracanych blob_uri — więc ta trasa 409 Conflict zwraca się do nagrań BYOS. Podczas rozmowy in_progressta trasa zwraca się do odzyskania 409 Conflict z nagłówkiem error.code = recording_not_readyRetry-After , gdy dostępne są wskazówki powtórki. Gdy rozmowa jest , failedzwraca 409 Conflict się terminalnie z .error.code = recording_unavailable W przypadku completed rozmowy dostępne są treści, pod warunkiem istniejącego zachowania BYOS. Rozmowa bez utrzymującego się dźwięku (store = false) wraca 404.

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

Wartość właściwości

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

downloadAudioItem

Przesyła dźwięk pojedynczego elementu rozmowy jako strumień bajtów WAV (audio/wav) przez usługę (bez adresu URL SAS). Ta trasa obsługuje wyłącznie przechowywanie przechowywane przez Foundry. W przypadku nagrań typu bring-your-own-storage (BYOS) bajty nie są proxyowane — dzwoniący musi pobierać je bezpośrednio z pamięci klienta, korzystając z trasy metadanych zwróconej blob_uri przez metadane przedmiotu /audio — więc ta trasa zwraca 409 Conflict się do nagrań BYOS. Wraca, 404 gdy rozmowa, przedmiot lub jego dźwięk nie zostały utrzymane (store = false).

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

Wartość właściwości

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

downloadGeneratedAudioItem

Przesyła wygenerowany dźwięk elementu rozmowy jako strumień bajtów WAV (audio/wav) przez usługę. Ten artefakt podrzędny występuje tylko wtedy, gdy odtwarzanie zostało przerwane, a usługa przekazała więcej dźwięku niż słuchacz usłyszał, w tym gdy odpowiedź zakończyła się jako anulowana. Ta trasa obsługuje wyłącznie przechowywanie przechowywane przez Foundry. W przypadku nagrań typu bring-your-own-storage (BYOS) bajty nie są proxyowane, więc ta trasa zwraca 409 Conflict. Wraca, 404 gdy rozmowa lub element nie został kontynuowany, albo gdy nie ma wygenerowanego dźwięku poza wysłuchanym segmentem.

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

Wartość właściwości

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

get

Pobiera pojedynczą rozmowę zarejestrowaną dla określonego punktu końcowego agenta głosowego na podstawie jej identyfikatora. Zwraca, 404 gdy rozmowa nie została kontynuowana (store = false) lub nie istnieje.

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

Wartość właściwości

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

getAudio

Zwraca metadane dla całego połączenia połączonego nagrania stereo (audio użytkownika na lewym kanale, dźwięk agenta na prawym). Wspólne metadane (format, częstotliwość próbkowania, kanały, układ kanałów, czas trwania) są zwracane zarówno dla nagrań zarządzanych przez Foundry, jak i z możliwością przyniesienia własnej pamięci (BYOS); dla BYOS odpowiedź dodatkowo zawiera blob_uri, URI nagrania z własnej pamięci klienta (bez SAS), które klient pobiera ze swoimi uprawnieniami. Nagranie jest budowane raz z segmentów na turę po zakończeniu zakończenia wytrwałości. Podczas rozmowy in_progressta trasa zwraca się do odzyskania 409 Conflict z nagłówkiem error.code = recording_not_readyRetry-After , gdy dostępne są wskazówki powtórki. Gdy rozmowa jest , failedzwraca 409 Conflict się terminalnie z .error.code = recording_unavailable Dla completed rozmowy dostępne są metadane pod warunkiem istniejącego zachowania BYOS. Wymaga, aby rozmowa miała trwały dźwięk (store = true); w przeciwnym razie zwraca 404.

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

Wartość właściwości

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

getAudioItem

Zwraca metadane dla segmentu audio pojedynczego elementu rozmowy, w tym wspólne fakty odtwarzania (rola, format/kodek, częstotliwość próbkowania, kanały, offset, czas trwania) zarówno dla nagrań zarządzanych przez Foundry, jak i z możliwością przyniesienia własnej pamięci (BYOS); dla BYOS odpowiedź dodatkowo zawiera blob_uri, URI nagrania w pamięci użytkownika (bez SAS), które klient pobiera za pomocą własnych danych uwierzytelniających. Wymaga, aby rozmowa miała trwały dźwięk (store = true); wraca, 404 gdy rozmowa, element lub jego dźwięk nie był kontynuowany.

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

Wartość właściwości

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

getGeneratedAudioItem

Zwraca metadane wygenerowanego dźwięku w treści rozmowy. Ten podrzędny artefakt jest oddzielny od kanonicznego segmentu słyszanego i występuje tylko wtedy, gdy odtwarzanie zostało przerwane, a usługa wygenerowała więcej dźwięku niż usłyszał słuchacz, w tym gdy odpowiedź zakończyła się jako anulowana. Wraca, 404 gdy rozmowa lub element nie został kontynuowany, albo gdy nie ma wygenerowanego dźwięku poza wysłuchanym segmentem.

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

Wartość właściwości

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

getItem

Pobiera pojedynczy element z podanej rozmowy na podstawie jego identyfikatora, w tym transkrypcję. Część input_audio/output_audio treści wskazuje, że dla elementu dostępny jest dźwięk; kanoniczne metadane audio dla elementu są zasobem /items/{item_id}/audio , a bajty są przesyłane strumieniowo przez /items/{item_id}/audio/content. Wraca, 404 gdy rozmowa lub element nie został kontynuowany (store = false).

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

Wartość właściwości

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

getResponse

Pobiera pojedynczą odpowiedź z podanej rozmowy za pomocą jej identyfikatora, w tym output przedmioty, usage, oraz status. Wraca, 404 gdy rozmowa lub odpowiedź nie została kontynuowana (store = false).

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

Wartość właściwości

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

list

Zwraca rozmowy kontynuowane dla określonego punktu końcowego agenta głosowego. Rozmowy są obecne, gdy efektywne store ustawienie sesji jest , trueniezależnie od tego, czy zostało odziedziczone z definicji agenta, czy włączone przez override sesji WebSocket.

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

Wartość właściwości

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

listItems

Zwraca stronicowaną kolekcję elementów — pełną uporządkowaną historię rozmów, w tym dane wejściowe użytkownika, wyjścia asystenta oraz dane narzędzi stworzone przez klienta (transkrypcje + zdarzenia narzędzi). Wraca, 404 gdy rozmowa nie była kontynuowana (store = false).

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

Wartość właściwości

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

listResponseItems

Zwraca stronicowaną kolekcję elementów wyjściowych wygenerowanych przez konkretną odpowiedź (projekcję wyjściową odpowiedzi). Aby uzyskać pełną uporządkowaną historię rozmów — w tym wkład użytkownika i narzędzia tworzone przez klienta — zamiast tego użyj ścieżki elementów rozmowy. Wraca, 404 gdy rozmowa lub odpowiedź nie została kontynuowana (store = false).

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

Wartość właściwości

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

listResponses

Zwraca zbiór stron odpowiedzi (zwroty wnioskowania modelu) zarejestrowanych dla określonej rozmowy. Projekcja na pojedynczą odpowiedź output może być tutaj pominięta; dla kanonicznego wyjścia stronicowanego można użyć ścieżki odpowiedzi-elementów. Wraca, 404 gdy rozmowa nie była kontynuowana (store = false).

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

Wartość właściwości

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