VoiceResponse interface

Pacote:

@azure/ai-projects

Uma resposta de voz persistente que representa uma reviravolta de inferência de modelo dentro de uma conversa. Nos resultados da lista, a output projeção pode ser omitida; recuperar a resposta completa (GET .../responses/{response_id}) ou a rota dos itens de resposta paginados (GET .../responses/{response_id}/items) para os seus itens de saída. created_at / completed_at são extensões de encomenda duráveis da Foundry.

Extends

VoiceResponseBase

Propriedades

audio	A configuração de áudio usada para a resposta, incluindo a voz e o formato de áudio usados para a saída.
completed_at	O carimbo temporal do Unix (em segundos) para quando a resposta foi concluída.
conversation_id	O id da conversa a que esta resposta pertence.
created_at	O carimbo temporal do Unix (em segundos) para quando a resposta foi criada.
id	O id único da resposta.
metadata	Um conjunto de pares-chave-valor associado à resposta.
output	Os itens de saída produzidos pela resposta. Podem ser omitidos nos resultados da lista; recuperar a resposta completa (GET .../responses/{response_id}) ou usar a rota paginada dos itens de resposta (GET .../responses/{response_id}/items) para os seus itens de saída. Cada item response_id também o liga para esta resposta na lista de itens ao nível da conversa.
temperature	A temperatura de amostragem utilizada para a resposta.

Propriedades Herdadas

max_output_tokens	Número máximo de tokens de saída para uma resposta de um único assistente, incluindo chamadas de ferramenta, que foi usado nesta resposta.
object	O tipo de objeto, deve ser realtime.response.
output_modalities	O conjunto de modalidades que o modelo usou para responder, atualmente os únicos valores possíveis são [\"audio\"], [\"text\"]. A saída de áudio inclui sempre uma transcrição de texto. Definir a saída para modo text desativa a saída de áudio do modelo.
status	O estado final da resposta (completed, cancelled, failed, ou incomplete, in_progress).
status_details	Detalhes adicionais sobre o estado.
usage	Estatísticas de utilização para a Resposta, isto corresponderá à faturação. Uma sessão de API em tempo real manterá um contexto de conversa e adicionará novos Itens à conversa, pelo que a saída de turnos anteriores (tokens de texto e áudio) passará a ser a entrada para turnos posteriores.

Detalhes de Propriedade

audio

A configuração de áudio usada para a resposta, incluindo a voz e o formato de áudio usados para a saída.

audio?: VoiceResponseAudio

Valor de Propriedade

VoiceResponseAudio

completed_at

O carimbo temporal do Unix (em segundos) para quando a resposta foi concluída.

completed_at?: Date

Valor de Propriedade

Date

conversation_id

O id da conversa a que esta resposta pertence.

conversation_id: string

Valor de Propriedade

string

created_at

O carimbo temporal do Unix (em segundos) para quando a resposta foi criada.

created_at?: Date

Valor de Propriedade

Date

id

O id único da resposta.

id: string

Valor de Propriedade

string

metadata

Um conjunto de pares-chave-valor associado à resposta.

metadata?: Record<string, string>

Valor de Propriedade

Record<string, string>

output

Os itens de saída produzidos pela resposta. Podem ser omitidos nos resultados da lista; recuperar a resposta completa (GET .../responses/{response_id}) ou usar a rota paginada dos itens de resposta (GET .../responses/{response_id}/items) para os seus itens de saída. Cada item response_id também o liga para esta resposta na lista de itens ao nível da conversa.

output?: RealtimeConversationItemUnion[]

Valor de Propriedade

RealtimeConversationItemUnion[]

temperature

A temperatura de amostragem utilizada para a resposta.

temperature?: number

Valor de Propriedade

number

Detalhes da Propriedade Herdada

max_output_tokens

Número máximo de tokens de saída para uma resposta de um único assistente, incluindo chamadas de ferramenta, que foi usado nesta resposta.

max_output_tokens?: number | "inf"

Valor de Propriedade

number | "inf"

Herdado deVoiceResponseBase.max_output_tokens

object

O tipo de objeto, deve ser realtime.response.

object?: "realtime.response"

Valor de Propriedade

"realtime.response"

Herdado doVoiceResponseBase.object

output_modalities

O conjunto de modalidades que o modelo usou para responder, atualmente os únicos valores possíveis são [\"audio\"], [\"text\"]. A saída de áudio inclui sempre uma transcrição de texto. Definir a saída para modo text desativa a saída de áudio do modelo.

output_modalities?: ("text" | "audio")[]

Valor de Propriedade

("text" | "audio")[]

Herdado deVoiceResponseBase.output_modalities

status

O estado final da resposta (completed, cancelled, failed, ou incomplete, in_progress).

status?: "failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

Valor de Propriedade

"failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

Herdado deVoiceResponseBase.status

status_details

Detalhes adicionais sobre o estado.

status_details?: RealtimeResponseStatusDetails

Valor de Propriedade

RealtimeResponseStatusDetails

Herdado deVoiceResponseBase.status_details

usage

Estatísticas de utilização para a Resposta, isto corresponderá à faturação. Uma sessão de API em tempo real manterá um contexto de conversa e adicionará novos Itens à conversa, pelo que a saída de turnos anteriores (tokens de texto e áudio) passará a ser a entrada para turnos posteriores.

usage?: RealtimeResponseUsage

Valor de Propriedade

RealtimeResponseUsage

Herdado deVoiceResponseBase.usage