CreateMessageOptions interface

パッケージ:

@azure/openai-assistants

メッセージの作成に使用される詳細。

Extends

OperationOptions

プロパティ

fileIds	ファイルを読み取ることができる 'code_interpreter' や "取得" などのツールで使用される、メッセージに関連付ける最大 10 個のファイル ID の一覧。
metadata	オブジェクトにアタッチできる最大 16 個のキーと値のペアのセット。そのオブジェクトに関する追加情報を構造化形式で格納するために使用されます。 キーの長さは最大 64 文字で、値の長さは最大 512 文字です。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
onResponse	要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
requestOptions	この操作の HTTP 要求を作成および送信するときに使用されるオプション。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

fileIds

ファイルを読み取ることができる 'code_interpreter' や "取得" などのツールで使用される、メッセージに関連付ける最大 10 個のファイル ID の一覧。

fileIds?: string[]

プロパティ値

string[]

metadata

オブジェクトにアタッチできる最大 16 個のキーと値のペアのセット。そのオブジェクトに関する追加情報を構造化形式で格納するために使用されます。 キーの長さは最大 64 文字で、値の長さは最大 512 文字です。

metadata?: Record<string, string>

プロパティ値

Record<string, string>

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

継承元 OperationOptions.abortSignal

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

RawResponseCallback

継承元 OperationOptions.onResponse

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationRequestOptions

継承元 OperationOptions.requestOptions

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

継承元 OperationOptions.tracingOptions