RealtimeServerMessageType Structure

Définition

Représente le type d’un message serveur en temps réel. Il est utilisé pour identifier le type de message reçu du modèle.

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)
Héritage
RealtimeServerMessageType
Attributs
Implémente

Remarques

Les types de messages connus sont fournis en tant que propriétés statiques. Les fournisseurs peuvent définir des types de messages supplémentaires en construisant de nouvelles instances avec des valeurs personnalisées.

Les implémentations de fournisseurs qui souhaitent prendre en charge le pipeline d’intergiciel intégré (FunctionInvokingRealtimeClientSession et OpenTelemetryRealtimeClientSession) doivent émettre les types de messages suivants aux points appropriés pendant la génération de réponse :

  • ResponseCreated — lorsque le modèle commence à générer une nouvelle réponse.
  • ResponseDone — lorsque le modèle a terminé de générer une réponse (avec des données d’utilisation si disponibles).
  • ResponseOutputItemAdded — lorsqu’un nouvel élément de sortie (par exemple, appel de fonction, message) est ajouté pendant la génération de la réponse.
  • ResponseOutputItemDone — lorsqu’un élément de sortie individuel est terminé. Cela est nécessaire pour que l’intergiciel d’appel de fonction détecte et appelle les appels d’outil.

Constructeurs

Nom Description
RealtimeServerMessageType(String)

Initialise une nouvelle instance du RealtimeServerMessageType struct avec la valeur fournie.

Propriétés

Nom Description
ConversationItemAdded

Obtient un type de message indiquant qu’un élément de conversation a été ajouté.

ConversationItemDone

Obtient un type de message indiquant qu’un élément de conversation est terminé.

Error

Obtient un type de message indiquant qu’une erreur s’est produite lors du traitement de la requête.

InputAudioTranscriptionCompleted

Obtient un type de message indiquant la sortie de la transcription audio pour l’audio utilisateur écrit dans la mémoire tampon audio utilisateur.

InputAudioTranscriptionDelta

Obtient un type de message indiquant la valeur texte d’une partie de contenu de transcription audio d’entrée est mise à jour avec des résultats de transcription incrémentiels.

InputAudioTranscriptionFailed

Obtient un type de message indiquant que la transcription audio pour l’audio utilisateur écrite dans la mémoire tampon audio de l’utilisateur a échoué.

OutputAudioDelta

Obtient un type de message indiquant la sortie audio mise à jour.

OutputAudioDone

Obtient un type de message indiquant que la sortie audio est effectuée en streaming.

OutputAudioTranscriptionDelta

Obtient un type de message indiquant la transcription générée par le modèle de sortie audio mise à jour.

OutputAudioTranscriptionDone

Obtient un type de message indiquant que la transcription générée par le modèle de sortie audio est effectuée en streaming.

OutputTextDelta

Obtient un type de message indiquant la mise à jour du texte de sortie avec des résultats incrémentiels.

OutputTextDone

Obtient un type de message indiquant que le texte de sortie est terminé.

RawContentOnly

Obtient un type de message indiquant que la réponse contient uniquement du contenu brut.

ResponseCreated

Obtient un type de message indiquant que la réponse a été créée.

ResponseDone

Obtient un type de message indiquant que la réponse est terminée.

ResponseOutputItemAdded

Obtient un type de message indiquant qu’un élément de sortie individuel a été ajouté à la réponse.

ResponseOutputItemDone

Obtient un type de message indiquant qu’un élément de sortie individuel dans la réponse est terminé.

Value

Obtient la valeur associée à ce RealtimeServerMessageType.

Méthodes

Nom Description
Equals(Object)

Indique si cette instance et un objet spécifié sont égaux.

Equals(RealtimeServerMessageType)

Indique si l’objet actuel est égal à un autre objet du même type.

GetHashCode()

Retourne le code de hachage pour cette instance.

ToString()

Retourne le nom de type complet de cette instance.

Opérateurs

Nom Description
Equality(RealtimeServerMessageType, RealtimeServerMessageType)

Retourne une valeur indiquant si deux RealtimeServerMessageType instances sont équivalentes, comme déterminé par une comparaison sans respect de la casse de leurs valeurs.

Inequality(RealtimeServerMessageType, RealtimeServerMessageType)

Retourne une valeur indiquant si deux RealtimeServerMessageType instances ne sont pas équivalentes, comme déterminé par une comparaison sans respect de la casse de leurs valeurs.

S’applique à