RealtimeServerMessageType Struct
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Rappresenta il tipo di un messaggio del server in tempo reale. Viene usato per identificare il tipo di messaggio ricevuto dal modello.
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)
- Ereditarietà
- Attributi
- Implementazioni
Commenti
I tipi di messaggio noti vengono forniti come proprietà statiche. I provider possono definire tipi di messaggi aggiuntivi creando nuove istanze con valori personalizzati.
Le implementazioni del provider che vogliono supportare la pipeline middleware predefinita (FunctionInvokingRealtimeClientSession e OpenTelemetryRealtimeClientSession) devono generare i tipi di messaggio seguenti nei punti appropriati durante la generazione della risposta:
- ResponseCreated — quando il modello inizia a generare una nuova risposta.
- ResponseDone — quando il modello ha terminato di generare una risposta (con i dati di utilizzo, se disponibili).
- ResponseOutputItemAdded — quando viene aggiunto un nuovo elemento di output (ad esempio, chiamata di funzione, messaggio) durante la generazione della risposta.
- ResponseOutputItemDone — quando un singolo elemento di output è stato completato. Questa operazione è necessaria per il middleware di chiamata di funzione per rilevare e richiamare le chiamate agli strumenti.
Costruttori
| Nome | Descrizione |
|---|---|
| RealtimeServerMessageType(String) |
Inizializza una nuova istanza dello RealtimeServerMessageType struct con il valore specificato. |
Proprietà
| Nome | Descrizione |
|---|---|
| ConversationItemAdded |
Ottiene un tipo di messaggio che indica che è stato aggiunto un elemento della conversazione. |
| ConversationItemDone |
Ottiene un tipo di messaggio che indica che un elemento della conversazione è stato completato. |
| Error |
Ottiene un tipo di messaggio che indica un errore durante l'elaborazione della richiesta. |
| InputAudioTranscriptionCompleted |
Ottiene un tipo di messaggio che indica l'output della trascrizione audio per l'audio dell'utente scritto nel buffer audio dell'utente. |
| InputAudioTranscriptionDelta |
Ottiene un tipo di messaggio che indica il valore di testo di una parte del contenuto della trascrizione audio di input viene aggiornato con risultati incrementali della trascrizione. |
| InputAudioTranscriptionFailed |
Ottiene un tipo di messaggio che indica che la trascrizione audio per l'audio dell'utente scritto nel buffer audio dell'utente non è riuscita. |
| OutputAudioDelta |
Ottiene un tipo di messaggio che indica l'output audio aggiornato. |
| OutputAudioDone |
Ottiene un tipo di messaggio che indica che l'output audio viene eseguito in streaming. |
| OutputAudioTranscriptionDelta |
Ottiene un tipo di messaggio che indica la trascrizione generata dal modello dell'output audio aggiornato. |
| OutputAudioTranscriptionDone |
Ottiene un tipo di messaggio che indica che la trascrizione generata dal modello dell'output audio viene eseguita in streaming. |
| OutputTextDelta |
Ottiene un tipo di messaggio che indica l'aggiornamento del testo di output con risultati incrementali. |
| OutputTextDone |
Ottiene un tipo di messaggio che indica che il testo di output è completo. |
| RawContentOnly |
Ottiene un tipo di messaggio che indica che la risposta contiene solo contenuto non elaborato. |
| ResponseCreated |
Ottiene un tipo di messaggio che indica che la risposta è stata creata. |
| ResponseDone |
Ottiene un tipo di messaggio che indica che la risposta è stata completata. |
| ResponseOutputItemAdded |
Ottiene un tipo di messaggio che indica che alla risposta è stato aggiunto un singolo elemento di output. |
| ResponseOutputItemDone |
Ottiene un tipo di messaggio che indica un singolo elemento di output nella risposta completata. |
| Value |
Ottiene il valore associato all'oggetto RealtimeServerMessageType. |
Metodi
| Nome | Descrizione |
|---|---|
| Equals(Object) |
Indica se questa istanza e un oggetto specificato sono uguali. |
| Equals(RealtimeServerMessageType) |
Indica se l'oggetto corrente è uguale a un altro oggetto dello stesso tipo. |
| GetHashCode() |
Restituisce il codice hash per questa istanza. |
| ToString() |
Restituisce il nome completo del tipo di questa istanza. |
Operatori
| Nome | Descrizione |
|---|---|
| Equality(RealtimeServerMessageType, RealtimeServerMessageType) |
Restituisce un valore che indica se due RealtimeServerMessageType istanze sono equivalenti, come determinato da un confronto senza distinzione tra maiuscole e minuscole dei relativi valori. |
| Inequality(RealtimeServerMessageType, RealtimeServerMessageType) |
Restituisce un valore che indica se due RealtimeServerMessageType istanze non sono equivalenti, come determinato da un confronto senza distinzione tra maiuscole e minuscole dei relativi valori. |