VoiceResponse Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A persisted voice response representing one model inference turn within a conversation. In list results the
output projection may be omitted; retrieve the
full response (GET .../responses/{response_id}) or the paged response-items route
(GET .../responses/{response_id}/items) for its output items. created_at/completed_at are Foundry
durable ordering extensions.
public class VoiceResponse : Azure.AI.Projects.Agents.VoiceResponseBase, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.VoiceResponse>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.VoiceResponse>type VoiceResponse = class
inherit VoiceResponseBase
interface IJsonModel<VoiceResponse>
interface IPersistableModel<VoiceResponse>Public Class VoiceResponse
Inherits VoiceResponseBase
Implements IJsonModel(Of VoiceResponse), IPersistableModel(Of VoiceResponse)- Inheritance
- Implements
Properties
| Name | Description |
|---|---|
| Audio |
The audio configuration used for the response, including the voice and audio format used for output. |
| CompletedOn |
The Unix timestamp (in seconds) for when the response completed. |
| ConversationId |
The id of the conversation this response belongs to. |
| CreatedOn |
The Unix timestamp (in seconds) for when the response was created. |
| Id |
The unique id of the response. |
| MaxOutputTokens |
Maximum number of output tokens for a single assistant response, inclusive of tool calls, that was used in this response. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). <remarks> Supported types:
Examples:
|
| Metadata |
A set of key-value pairs attached to the response. |
| Object |
The object type, must be |
| Output |
The output items produced by the response. May be omitted in list results; retrieve the full response (GET .../responses/{response_id}) or use the paged response-items route (GET .../responses/{response_id}/items) for its output items. Each item's |
| OutputModalities |
The set of modalities the model used to respond, currently the only possible values are
|
| Status |
The final status of the response ( |
| StatusDetails |
Additional details about the status. (Inherited from VoiceResponseBase) |
| Temperature |
The sampling temperature used for the response. |
| Usage |
Usage statistics for the Response, this will correspond to billing. A Realtime API session will maintain a conversation context and append new Items to the Conversation, thus output from previous turns (text and audio tokens) will become the input for later turns. (Inherited from VoiceResponseBase) |
Methods
Operators
| Name | Description |
|---|---|
| Explicit(ClientResult to VoiceResponse) | |
