RealtimeConversationItemMessageSystem interface

リアルタイム会話におけるシステムメッセージは、モデルに追加のコンテキストや指示を提供するために使用できます。 これは会話開始時に提供される指示プロンプトとは異なりますが、システムメッセージは会話の任意の時点で追加可能です。 会話の挙動に大きな変更がある場合は指示を使い、小さな更新(例:「ユーザーが別のトピックについて質問しています」)にはシステムメッセージを使いましょう。

Extends

プロパティ

content

メッセージの内容。

created_at

項目が永続化された時間を示すUnixのタイムスタンプ(秒単位)。

id

アイテムのユニークなID。 これはクライアントが提供する場合もあれば、サーバーによって生成される場合もあります。

object

返されるAPIオブジェクトの識別子は常に realtime.itemです。 新しいアイテムを作成する際はオプションです。

response_id

該当する場合、このアイテムを生成した応答のIDです。

role

メッセージ送信者のロール。 常に system です。

status

アイテムの状態。 会話には影響しません。

type

アイテムの種類。 常に message です。

プロパティの詳細

content

メッセージの内容。

content: RealtimeConversationItemMessageSystemContent[]

プロパティ値

created_at

項目が永続化された時間を示すUnixのタイムスタンプ(秒単位)。

created_at?: Date

プロパティ値

Date

id

アイテムのユニークなID。 これはクライアントが提供する場合もあれば、サーバーによって生成される場合もあります。

id?: string

プロパティ値

string

object

返されるAPIオブジェクトの識別子は常に realtime.itemです。 新しいアイテムを作成する際はオプションです。

object?: "realtime.item"

プロパティ値

"realtime.item"

response_id

該当する場合、このアイテムを生成した応答のIDです。

response_id?: string

プロパティ値

string

role

メッセージ送信者のロール。 常に system です。

role: "system"

プロパティ値

"system"

status

アイテムの状態。 会話には影響しません。

status?: "in_progress" | "completed" | "incomplete"

プロパティ値

"in_progress" | "completed" | "incomplete"

type

アイテムの種類。 常に message です。

type: "message"

プロパティ値

"message"