BeginComposeDocumentModelOptions interface
モデル作成操作のオプション。
- Extends
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| description | モデルのテキスト説明 (任意のテキストを指定できます)。 |
| on |
ポーリングの状態が更新されたときに呼び出される、省略可能な初期進行状況ハンドラー。 このハンドラーは、ポーリングの状態が初期化された直後に 1 回呼び出されます。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| resume |
シリアル化されたポーリングの状態。 指定した場合、ポーリング操作は、新しい操作のように開始されるのではなく、指定された状態から再開されます。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tags | 永続的なメタデータとしてモデルに関連付ける追加のユーザー指定のキーと値のペア。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
| update |
同じ操作に関連する後続の要求の間で待機する時間 (ミリ秒単位)。 |
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLikeプロパティ値
description
モデルのテキスト説明 (任意のテキストを指定できます)。
description?: stringプロパティ値
string
onProgress
ポーリングの状態が更新されたときに呼び出される、省略可能な初期進行状況ハンドラー。 このハンドラーは、ポーリングの状態が初期化された直後に 1 回呼び出されます。
onProgress?: (state: DocumentModelOperationState) => voidプロパティ値
(state: DocumentModelOperationState) => void
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallbackプロパティ値
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptionsプロパティ値
resumeFrom
シリアル化されたポーリングの状態。 指定した場合、ポーリング操作は、新しい操作のように開始されるのではなく、指定された状態から再開されます。
resumeFrom?: stringプロパティ値
string
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptionsプロパティ値
tags
永続的なメタデータとしてモデルに関連付ける追加のユーザー指定のキーと値のペア。
tags?: Record<string, string>プロパティ値
Record<string, string>
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
updateIntervalInMs
同じ操作に関連する後続の要求の間で待機する時間 (ミリ秒単位)。
updateIntervalInMs?: numberプロパティ値
number