RealtimeServerMessageType 構造体

定義

リアルタイム サーバー メッセージの種類を表します。 これは、モデルから受信されるメッセージの種類を識別するために使用されます。

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)
継承
RealtimeServerMessageType
属性
実装

注釈

既知のメッセージの種類は、静的プロパティとして提供されます。 プロバイダーは、カスタム値を使用して新しいインスタンスを構築することで、追加のメッセージの種類を定義できます。

組み込みのミドルウェア パイプライン (FunctionInvokingRealtimeClientSessionOpenTelemetryRealtimeClientSession) をサポートするプロバイダーの実装では、応答の生成時に適切なポイントで次のメッセージの種類を出力する必要があります。

  • ResponseCreated — モデルが新しい応答の生成を開始したとき。
  • ResponseDone — モデルが応答の生成を完了したとき (使用可能な場合は使用状況データを含む)。
  • ResponseOutputItemAdded — 応答の生成中に新しい出力項目 (関数呼び出し、メッセージなど) が追加されたとき。
  • ResponseOutputItemDone — 個々の出力項目が完了したとき。 これは、関数呼び出しミドルウェアがツール呼び出しを検出して呼び出すために必要です。

コンストラクター

名前 説明
RealtimeServerMessageType(String)

指定された値を使用して、 RealtimeServerMessageType 構造体の新しいインスタンスを初期化します。

プロパティ

名前 説明
ConversationItemAdded

会話アイテムが追加されたことを示すメッセージの種類を取得します。

ConversationItemDone

会話アイテムが完了したことを示すメッセージの種類を取得します。

Error

要求の処理中にエラーが発生したことを示すメッセージの種類を取得します。

InputAudioTranscriptionCompleted

ユーザー オーディオ バッファーに書き込まれたユーザー オーディオのオーディオ文字起こしの出力を示すメッセージの種類を取得します。

InputAudioTranscriptionDelta

入力オーディオ文字起こしコンテンツ パーツのテキスト値が増分文字起こしの結果で更新されていることを示すメッセージの種類を取得します。

InputAudioTranscriptionFailed

ユーザー オーディオ バッファーに書き込まれたユーザー オーディオのオーディオ文字起こしが失敗したことを示すメッセージの種類を取得します。

OutputAudioDelta

更新されたオーディオ出力を示すメッセージの種類を取得します。

OutputAudioDone

オーディオ出力のストリーミングが完了したことを示すメッセージの種類を取得します。

OutputAudioTranscriptionDelta

更新されたオーディオ出力のモデルによって生成された文字起こしを示すメッセージの種類を取得します。

OutputAudioTranscriptionDone

モデルによって生成されたオーディオ出力の文字起こしがストリーミング実行されていることを示すメッセージの種類を取得します。

OutputTextDelta

増分結果を含む出力テキストの更新を示すメッセージの種類を取得します。

OutputTextDone

出力テキストが完了したことを示すメッセージの種類を取得します。

RawContentOnly

応答に生コンテンツのみが含まれていることを示すメッセージの種類を取得します。

ResponseCreated

応答が作成されたことを示すメッセージの種類を取得します。

ResponseDone

応答が完了したことを示すメッセージの種類を取得します。

ResponseOutputItemAdded

個々の出力項目が応答に追加されたことを示すメッセージの種類を取得します。

ResponseOutputItemDone

応答内の個々の出力項目が完了したことを示すメッセージの種類を取得します。

Value

この RealtimeServerMessageTypeに関連付けられている値を取得します。

メソッド

名前 説明
Equals(Object)

このインスタンスと指定したオブジェクトが等しいかどうかを示します。

Equals(RealtimeServerMessageType)

現在のオブジェクトが同じ型の別のオブジェクトと等しいかどうかを示します。

GetHashCode()

このインスタンスのハッシュ コードを返します。

ToString()

このインスタンスの完全修飾型名を返します。

演算子

名前 説明
Equality(RealtimeServerMessageType, RealtimeServerMessageType)

大文字と小文字を区別しない値の比較によって決定される、2 つの RealtimeServerMessageType インスタンスが等価かどうかを示す値を返します。

Inequality(RealtimeServerMessageType, RealtimeServerMessageType)

大文字と小文字を区別しない値の比較によって決定される、2 つの RealtimeServerMessageType インスタンスが等価でないかどうかを示す値を返します。

適用対象