RealtimeServerMessageType Estrutura

Definição

Representa o tipo de mensagem de servidor em tempo real. Isto é usado para identificar o tipo de mensagem recebida 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
RealtimeServerMessageType
Atributos
Implementações

Observações

Tipos de mensagens bem conhecidos são fornecidos como propriedades estáticas. Os fornecedores podem definir tipos de mensagens adicionais construindo novas instâncias com valores personalizados.

As implementações de fornecedores que pretendem suportar o pipeline de middleware incorporado (FunctionInvokingRealtimeClientSession e OpenTelemetryRealtimeClientSession) devem emitir os seguintes tipos de mensagens em pontos apropriados durante a geração de respostas:

  • ResponseCreated — quando o modelo começa a gerar uma nova resposta.
  • ResponseDone — quando o modelo termina de gerar uma resposta (com dados de utilização, se disponíveis).
  • ResponseOutputItemAdded — quando um novo item de saída (por exemplo, chamada de função, mensagem) é adicionado durante a geração da resposta.
  • ResponseOutputItemDone — quando um item de saída individual está concluído. Isto é necessário para o middleware de invocação de funções detetar e invocar chamadas de ferramenta.

Construtores

Name Description
RealtimeServerMessageType(String)

Inicializa uma nova instância da RealtimeServerMessageType estrutura com o valor fornecido.

Propriedades

Name Description
ConversationItemAdded

Recebe um tipo de mensagem a indicar que um item de conversa foi adicionado.

ConversationItemDone

Recebe um tipo de mensagem a indicar que um item da conversa está concluído.

Error

Recebe um tipo de mensagem a indicar que ocorreu um erro durante o processamento do pedido.

InputAudioTranscriptionCompleted

Recebe um tipo de mensagem indicando a saída da transcrição de áudio do áudio do utilizador escrita no buffer de áudio do utilizador.

InputAudioTranscriptionDelta

Recebe um tipo de mensagem que indica que o valor de texto de uma parte de transcrição áudio de entrada é atualizado com resultados incrementais de transcrição.

InputAudioTranscriptionFailed

Recebe um tipo de mensagem indicando que a transcrição áudio do áudio do utilizador escrito no buffer de áudio do utilizador falhou.

OutputAudioDelta

Recebe um tipo de mensagem a indicar que a saída de áudio foi atualizada.

OutputAudioDone

Recebe um tipo de mensagem a indicar que a saída de áudio terminou o streaming.

OutputAudioTranscriptionDelta

Recebe um tipo de mensagem que indica a transcrição gerada pelo modelo da saída áudio atualizada.

OutputAudioTranscriptionDone

Recebe um tipo de mensagem que indica que a transcrição gerada pelo modelo da saída de áudio está feita em streaming.

OutputTextDelta

Recebe um tipo de mensagem que indica a atualização de texto de saída com resultados incrementais.

OutputTextDone

Recebe um tipo de mensagem a indicar que o texto de saída está completo.

RawContentOnly

Recebe um tipo de mensagem que indica que a resposta contém apenas conteúdo bruto.

ResponseCreated

Recebe um tipo de mensagem a indicar que a resposta foi criada.

ResponseDone

Recebe um tipo de mensagem a indicar que a resposta foi concluída.

ResponseOutputItemAdded

Recebe um tipo de mensagem que indica que um item de saída individual foi adicionado à resposta.

ResponseOutputItemDone

Recebe 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 este RealtimeServerMessageType.

Métodos

Name Description
Equals(Object)

Indica se esta instância e um objeto especificado são iguais.

Equals(RealtimeServerMessageType)

Indica se o objeto atual é igual a outro objeto do mesmo tipo.

GetHashCode()

Devolve o código de hash para esta instância.

ToString()

Devolve o nome do tipo totalmente qualificado desta instância.

Operadores

Name Description
Equality(RealtimeServerMessageType, RealtimeServerMessageType)

Devolve um valor que indica se duas RealtimeServerMessageType instâncias são equivalentes, conforme determinado por uma comparação insensível a maiúsculas minúsculas dos seus valores.

Inequality(RealtimeServerMessageType, RealtimeServerMessageType)

Devolve um valor que indica se duas RealtimeServerMessageType instâncias não são equivalentes, conforme determinado por uma comparação insensível a maiúsculas e maiúsculas dos seus valores.

Aplica-se a