RealtimeServerMessageType Estrutura
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Representa o tipo de uma mensagem de servidor em tempo real. Isso é usado para identificar o tipo de mensagem que está sendo recebido do modelo.
public value class RealtimeServerMessageType : IEquatable<Microsoft::Extensions::AI::RealtimeServerMessageType>
[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
[System.Text.Json.Serialization.JsonConverter(typeof(Microsoft.Extensions.AI.RealtimeServerMessageType+Converter))]
public readonly struct RealtimeServerMessageType : IEquatable<Microsoft.Extensions.AI.RealtimeServerMessageType>
[System.Text.Json.Serialization.JsonConverter(typeof(Microsoft.Extensions.AI.RealtimeServerMessageType+Converter))]
public readonly struct RealtimeServerMessageType : IEquatable<Microsoft.Extensions.AI.RealtimeServerMessageType>
[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
[<System.Text.Json.Serialization.JsonConverter(typeof(Microsoft.Extensions.AI.RealtimeServerMessageType+Converter))>]
type RealtimeServerMessageType = struct
[<System.Text.Json.Serialization.JsonConverter(typeof(Microsoft.Extensions.AI.RealtimeServerMessageType+Converter))>]
type RealtimeServerMessageType = struct
Public Structure RealtimeServerMessageType
Implements IEquatable(Of RealtimeServerMessageType)
- Herança
- Atributos
- Implementações
Comentários
Tipos de mensagem conhecidos são fornecidos como propriedades estáticas. Os provedores podem definir tipos de mensagem adicionais construindo novas instâncias com valores personalizados.
As implementações de provedor que desejam dar suporte ao pipeline de middleware interno (FunctionInvokingRealtimeClientSession e OpenTelemetryRealtimeClientSession) devem emitir os seguintes tipos de mensagem em pontos apropriados durante a geração de resposta:
- ResponseCreated — quando o modelo começa a gerar uma nova resposta.
- ResponseDone — quando o modelo terminar de gerar uma resposta (com dados de uso, se disponível).
- ResponseOutputItemAdded — quando um novo item de saída (por exemplo, chamada de função, mensagem) é adicionado durante a geração de resposta.
- ResponseOutputItemDone — quando um item de saída individual for concluído. Isso é necessário para que o middleware de invocação de função detecte e invoque chamadas de ferramenta.
Construtores
| Nome | Description |
|---|---|
| RealtimeServerMessageType(String) |
Inicializa uma nova instância do RealtimeServerMessageType struct com o valor fornecido. |
Propriedades
| Nome | Description |
|---|---|
| ConversationItemAdded |
Obtém um tipo de mensagem que indica que um item de conversa foi adicionado. |
| ConversationItemDone |
Obtém um tipo de mensagem que indica que um item de conversa está concluído. |
| Error |
Obtém um tipo de mensagem indicando que ocorreu um erro ao processar a solicitação. |
| InputAudioTranscriptionCompleted |
Obtém um tipo de mensagem que indica a saída da transcrição de áudio do áudio do usuário gravado no buffer de áudio do usuário. |
| InputAudioTranscriptionDelta |
Obtém um tipo de mensagem que indica que o valor de texto de uma parte de conteúdo de transcrição de áudio de entrada é atualizado com resultados de transcrição incremental. |
| InputAudioTranscriptionFailed |
Obtém um tipo de mensagem que indica que a transcrição de áudio do áudio do usuário gravado no buffer de áudio do usuário falhou. |
| OutputAudioDelta |
Obtém um tipo de mensagem que indica a saída de áudio atualizada. |
| OutputAudioDone |
Obtém um tipo de mensagem que indica que a saída de áudio é feita em streaming. |
| OutputAudioTranscriptionDelta |
Obtém um tipo de mensagem que indica a transcrição gerada pelo modelo da saída de áudio atualizada. |
| OutputAudioTranscriptionDone |
Obtém um tipo de mensagem que indica que a transcrição gerada pelo modelo da saída de áudio é feita em streaming. |
| OutputTextDelta |
Obtém um tipo de mensagem que indica a atualização de texto de saída com resultados incrementais. |
| OutputTextDone |
Obtém um tipo de mensagem que indica que o texto de saída está concluído. |
| RawContentOnly |
Obtém um tipo de mensagem que indica que a resposta contém apenas conteúdo bruto. |
| ResponseCreated |
Obtém um tipo de mensagem que indica que a resposta foi criada. |
| ResponseDone |
Obtém um tipo de mensagem que indica que a resposta foi concluída. |
| ResponseOutputItemAdded |
Obtém um tipo de mensagem que indica que um item de saída individual foi adicionado à resposta. |
| ResponseOutputItemDone |
Obtém um tipo de mensagem que indica que um item de saída individual na resposta foi concluído. |
| Value |
Obtém o valor associado a isso RealtimeServerMessageType. |
Métodos
| Nome | Description |
|---|---|
| Equals(Object) |
Indica se essa instância e um objeto especificado são iguais. |
| Equals(RealtimeServerMessageType) |
Indica se o objeto atual é igual a outro objeto do mesmo tipo. |
| GetHashCode() |
Retorna o código hash dessa instância. |
| ToString() |
Retorna o nome de tipo totalmente qualificado dessa instância. |
Operadores
| Nome | Description |
|---|---|
| Equality(RealtimeServerMessageType, RealtimeServerMessageType) |
Retorna um valor que indica se duas RealtimeServerMessageType instâncias são equivalentes, conforme determinado por uma comparação que não diferencia maiúsculas de minúsculas de seus valores. |
| Inequality(RealtimeServerMessageType, RealtimeServerMessageType) |
Retorna um valor que indica se duas RealtimeServerMessageType instâncias não são equivalentes, conforme determinado por uma comparação que não diferencia maiúsculas de minúsculas de seus valores. |