BeginComposeDocumentModelOptions interface

モデル作成操作のオプション。

Extends

継承されたプロパティ

abortSignal

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

description

モデルのテキスト説明 (任意のテキストを指定できます)。

onProgress

ポーリングの状態が更新されたときに呼び出される、省略可能な初期進行状況ハンドラー。 このハンドラーは、ポーリングの状態が初期化された直後に 1 回呼び出されます。

onResponse

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

requestOptions

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

resumeFrom

シリアル化されたポーリングの状態。 指定した場合、ポーリング操作は、新しい操作のように開始されるのではなく、指定された状態から再開されます。

serializerOptions

シリアル化/シリアル化解除の動作をオーバーライドするオプション。

tags

永続的なメタデータとしてモデルに関連付ける追加のユーザー指定のキーと値のペア。

tracingOptions

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

updateIntervalInMs

同じ操作に関連する後続の要求の間で待機する時間 (ミリ秒単位)。

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

abortSignal

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

abortSignal?: AbortSignalLike

プロパティ値

CreateDocumentModelOptions.abortSignalから継承

description

モデルのテキスト説明 (任意のテキストを指定できます)。

description?: string

プロパティ値

string

CreateDocumentModelOptions.descriptionから継承

onProgress

ポーリングの状態が更新されたときに呼び出される、省略可能な初期進行状況ハンドラー。 このハンドラーは、ポーリングの状態が初期化された直後に 1 回呼び出されます。

onProgress?: (state: DocumentModelOperationState) => void

プロパティ値

(state: DocumentModelOperationState) => void

CreateDocumentModelOptions.onProgressから継承

onResponse

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

onResponse?: RawResponseCallback

プロパティ値

CreateDocumentModelOptions.onResponseから継承

requestOptions

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

requestOptions?: OperationRequestOptions

プロパティ値

CreateDocumentModelOptions.requestOptionsから継承

resumeFrom

シリアル化されたポーリングの状態。 指定した場合、ポーリング操作は、新しい操作のように開始されるのではなく、指定された状態から再開されます。

resumeFrom?: string

プロパティ値

string

CreateDocumentModelOptions.resumeFrom から継承

serializerOptions

シリアル化/シリアル化解除の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

CreateDocumentModelOptions.serializerOptionsから継承

tags

永続的なメタデータとしてモデルに関連付ける追加のユーザー指定のキーと値のペア。

tags?: Record<string, string>

プロパティ値

Record<string, string>

CreateDocumentModelOptions.tagsから継承

tracingOptions

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

tracingOptions?: OperationTracingOptions

プロパティ値

CreateDocumentModelOptions.tracingOptionsから継承

updateIntervalInMs

同じ操作に関連する後続の要求の間で待機する時間 (ミリ秒単位)。

updateIntervalInMs?: number

プロパティ値

number

CreateDocumentModelOptions.updateIntervalInMsから継承