RealtimeServerMessageType Struktur

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Paket:
Microsoft.Extensions.AI.Abstractions v10.4.1
Quelle:
RealtimeServerMessageType.cs

Stellt den Typ einer Echtzeitservernachricht dar. Dies wird verwendet, um den Nachrichtentyp zu identifizieren, der vom Modell empfangen wird.

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)
Vererbung
Object
ValueType
RealtimeServerMessageType
Attribute
ExperimentalAttribute JsonConverterAttribute
Implementiert
IEquatable<RealtimeServerMessageType>

Hinweise

Bekannte Nachrichtentypen werden als statische Eigenschaften bereitgestellt. Anbieter können zusätzliche Nachrichtentypen definieren, indem neue Instanzen mit benutzerdefinierten Werten erstellt werden.

Anbieterimplementierungen, die die integrierte Middleware-Pipeline (FunctionInvokingRealtimeClientSession und OpenTelemetryRealtimeClientSession) unterstützen möchten, müssen die folgenden Nachrichtentypen an geeigneten Stellen während der Antwortgenerierung ausgeben:

  • ResponseCreated — wenn das Modell mit dem Generieren einer neuen Antwort beginnt.
  • ResponseDone — wenn das Modell die Erstellung einer Antwort abgeschlossen hat (mit Nutzungsdaten, sofern verfügbar).
  • ResponseOutputItemAdded — wenn während der Antwortgenerierung ein neues Ausgabeelement (z. B. Funktionsaufruf, Nachricht) hinzugefügt wird.
  • ResponseOutputItemDone — wenn ein einzelnes Ausgabeelement abgeschlossen ist. Dies ist erforderlich, um Funktionsaufrufe von Middleware zu erkennen und aufzurufen.

Konstruktoren

Name Beschreibung
RealtimeServerMessageType(String)

Initialisiert eine neue Instanz der RealtimeServerMessageType Struktur mit dem bereitgestellten Wert.

Eigenschaften

Name Beschreibung
ConversationItemAdded

Ruft einen Nachrichtentyp ab, der angibt, dass ein Unterhaltungselement hinzugefügt wurde.
ConversationItemDone

Ruft einen Nachrichtentyp ab, der angibt, dass ein Unterhaltungselement abgeschlossen ist.
Error

Ruft einen Nachrichtentyp ab, der angibt, dass beim Verarbeiten der Anforderung ein Fehler aufgetreten ist.
InputAudioTranscriptionCompleted

Ruft einen Nachrichtentyp ab, der die Ausgabe der Audiotranskription für Benutzeraudio angibt, die in den Benutzeraudiopuffer geschrieben wurde.
InputAudioTranscriptionDelta

Ruft einen Nachrichtentyp ab, der den Textwert eines Inhaltsteils der Eingabeauskription angibt, mit inkrementellen Transkriptionsergebnissen aktualisiert wird.
InputAudioTranscriptionFailed

Ruft einen Nachrichtentyp ab, der angibt, dass die Audiotranskription für Benutzeraudio, die in den Benutzeraudiopuffer geschrieben wurde, fehlgeschlagen ist.
OutputAudioDelta

Ruft einen Nachrichtentyp ab, der die Audioausgabe aktualisiert.
OutputAudioDone

Ruft einen Nachrichtentyp ab, der angibt, dass die Audioausgabe das Streaming abgeschlossen ist.
OutputAudioTranscriptionDelta

Ruft einen Nachrichtentyp ab, der die modellgenerierte Transkription der Audioausgabe aktualisiert.
OutputAudioTranscriptionDone

Ruft einen Nachrichtentyp ab, der angibt, dass die vom Modell generierte Transkription der Audioausgabe streamingt wird.
OutputTextDelta

Ruft einen Nachrichtentyp ab, der die Ausgabetextaktualisierung mit inkrementellen Ergebnissen angibt.
OutputTextDone

Ruft einen Nachrichtentyp ab, der angibt, dass der Ausgabetext abgeschlossen ist.
RawContentOnly

Ruft einen Nachrichtentyp ab, der angibt, dass die Antwort nur unformatierten Inhalt enthält.
ResponseCreated

Ruft einen Nachrichtentyp ab, der angibt, dass die Antwort erstellt wurde.
ResponseDone

Ruft einen Nachrichtentyp ab, der angibt, dass die Antwort abgeschlossen wurde.
ResponseOutputItemAdded

Ruft einen Nachrichtentyp ab, der angibt, dass ein einzelnes Ausgabeelement der Antwort hinzugefügt wurde.
ResponseOutputItemDone

Ruft einen Nachrichtentyp ab, der angibt, dass ein einzelnes Ausgabeelement in der Antwort abgeschlossen ist.
Value

Ruft den diesem zugeordneten Wert ab RealtimeServerMessageType.

Methoden

Name Beschreibung
Equals(Object)

Gibt an, ob diese Instanz und ein angegebenes Objekt gleich sind.
Equals(RealtimeServerMessageType)

Gibt an, ob das aktuelle Objekt einem anderen Objekt desselben Typs entspricht.
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.
ToString()

Gibt den vollqualifizierten Typnamen dieser Instanz zurück.

Operatoren

Name Beschreibung
Equality(RealtimeServerMessageType, RealtimeServerMessageType)

Gibt einen Wert zurück, der angibt, ob zwei RealtimeServerMessageType Instanzen gleichwertig sind, wie durch einen Vergleich zwischen Groß- und Kleinschreibung ermittelt.
Inequality(RealtimeServerMessageType, RealtimeServerMessageType)

Gibt einen Wert zurück, der angibt, ob zwei RealtimeServerMessageType Instanzen nicht gleichwertig sind, wie durch einen Vergleich zwischen Groß- und Kleinschreibung ermittelt.

Gilt für: