RealtimeServerMessageType Struct-datatyp

Definition

Namnområde:
Microsoft.Extensions.AI
Sammansättning:
Microsoft.Extensions.AI.Abstractions.dll
Paket:
Microsoft.Extensions.AI.Abstractions v10.6.0
Källa:
RealtimeServerMessageType.cs

Representerar typen av ett servermeddelande i realtid. Detta används för att identifiera den meddelandetyp som tas emot från modellen.

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)
Arv
Object
ValueType
RealtimeServerMessageType
Attribut
ExperimentalAttribute JsonConverterAttribute
Implementeringar
IEquatable<RealtimeServerMessageType>

Kommentarer

Välkända meddelandetyper tillhandahålls som statiska egenskaper. Leverantörer kan definiera ytterligare meddelandetyper genom att skapa nya instanser med anpassade värden.

Providerimplementeringar som vill stödja den inbyggda pipelinen för mellanprogram (FunctionInvokingRealtimeClientSession och OpenTelemetryRealtimeClientSession) måste generera följande meddelandetyper vid lämpliga tidpunkter under genereringen av svar:

  • ResponseCreated — när modellen börjar generera ett nytt svar.
  • ResponseDone — när modellen har genererat ett svar (med användningsdata om tillgängligt).
  • ResponseOutputItemAdded – när ett nytt utdataobjekt (t.ex. funktionsanrop, meddelande) läggs till under svarsgenereringen.
  • ResponseOutputItemDone — när ett enskilt utdataobjekt har slutförts. Detta krävs för att funktionsanrop mellanprogram ska kunna identifiera och anropa verktygsanrop.

Konstruktorer

Name Description
RealtimeServerMessageType(String)

Initierar en ny instans av RealtimeServerMessageType structen med det angivna värdet.

Egenskaper

Name Description
ConversationItemAdded

Hämtar en meddelandetyp som anger att ett konversationsobjekt har lagts till.
ConversationItemDone

Hämtar en meddelandetyp som anger att ett konversationsobjekt är klart.
Error

Hämtar en meddelandetyp som anger att ett fel uppstod när begäran bearbetades.
InputAudioTranscriptionCompleted

Hämtar en meddelandetyp som anger utdata från ljudavskrift för användarljud som skrivits till användarens ljudbuffert.
InputAudioTranscriptionDelta

Hämtar en meddelandetyp som anger textvärdet för en indatainnehållsdel för ljudranskription uppdateras med inkrementella transkriptionsresultat.
InputAudioTranscriptionFailed

Hämtar en meddelandetyp som anger att ljudavskriften för användarljud som skrivits till användarens ljudbuffert har misslyckats.
OutputAudioDelta

Hämtar en meddelandetyp som anger att ljudutdata har uppdaterats.
OutputAudioDone

Hämtar en meddelandetyp som anger att ljudutdata har strömmats.
OutputAudioTranscriptionDelta

Hämtar en meddelandetyp som anger den modellgenererade transkriptionen av ljudutdata som uppdaterats.
OutputAudioTranscriptionDone

Hämtar en meddelandetyp som anger att den modellgenererade transkriptionen av ljudutdata har strömmats.
OutputTextDelta

Hämtar en meddelandetyp som anger utdatatextuppdateringen med inkrementella resultat.
OutputTextDone

Hämtar en meddelandetyp som anger att utdatatexten är klar.
RawContentOnly

Hämtar en meddelandetyp som anger att svaret endast innehåller råinnehåll.
ResponseCreated

Hämtar en meddelandetyp som anger att svaret har skapats.
ResponseDone

Hämtar en meddelandetyp som anger att svaret har slutförts.
ResponseOutputItemAdded

Hämtar en meddelandetyp som anger att ett enskilt utdataobjekt har lagts till i svaret.
ResponseOutputItemDone

Hämtar en meddelandetyp som anger att ett enskilt utdataobjekt i svaret har slutförts.
Value

Hämtar värdet som är associerat med den här RealtimeServerMessageType.

Metoder

Name Description
Equals(Object)

Anger om den här instansen och ett angivet objekt är lika.
Equals(RealtimeServerMessageType)

Anger om det aktuella objektet är lika med ett annat objekt av samma typ.
GetHashCode()

Returnerar hash-koden för den här instansen.
ToString()

Returnerar det fullständigt kvalificerade typnamnet för den här instansen.

Operatorer

Name Description
Equality(RealtimeServerMessageType, RealtimeServerMessageType)

Returnerar ett värde som anger om två RealtimeServerMessageType instanser är likvärdiga, enligt en skiftlägeskänslig jämförelse av deras värden.
Inequality(RealtimeServerMessageType, RealtimeServerMessageType)

Returnerar ett värde som anger om två RealtimeServerMessageType instanser inte är likvärdiga, vilket bestäms av en skiftlägeskänslig jämförelse av deras värden.

Gäller för