共用方式為


BeginComposeDocumentModelOptions interface

模型撰寫作業的選項。

Extends

繼承的屬性

abortSignal

可用來中止要求的訊號。

description

模型的文字描述(可以是任何文字)。

onProgress

選擇性的初始進度處理程式,會在輪詢器狀態更新時呼叫。 此處理程式會在輪詢器狀態初始化後立即呼叫一次。

onResponse

每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

resumeFrom

串行化輪詢器狀態。 如果提供,輪詢作業將會從指定的狀態繼續執行,而不是啟動,就像是新的作業一樣。

serializerOptions

覆寫串行化/取消串行化行為的選項。

tags

其他使用者指定的索引鍵/值組,以將模型關聯為持續性元數據。

tracingOptions

啟用追蹤時所使用的選項。

updateIntervalInMs

與相同作業相關的後續要求之間等候的時間量(以毫秒為單位)。

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

繼承自createDocumentModelOptions.abortSignal

description

模型的文字描述(可以是任何文字)。

description?: string

屬性值

string

繼承自CreateDocumentModelOptions.description

onProgress

選擇性的初始進度處理程式,會在輪詢器狀態更新時呼叫。 此處理程式會在輪詢器狀態初始化後立即呼叫一次。

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