CreateDocumentModelOptions interface
模型建立作業的選項。
- Extends
繼承的屬性
abort |
可用來中止要求的訊號。 |
description | 模型的文字描述(可以是任何文字)。 |
on |
選擇性的初始進度處理程式,會在輪詢器狀態更新時呼叫。 此處理程式會在輪詢器狀態初始化後立即呼叫一次。 |
on |
每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。 |
request |
建立和傳送此作業之 HTTP 要求時所使用的選項。 |
resume |
串行化輪詢器狀態。 如果提供,輪詢作業將會從指定的狀態繼續執行,而不是啟動,就像是新的作業一樣。 |
serializer |
覆寫串行化/取消串行化行為的選項。 |
tags | 其他使用者指定的索引鍵/值組,以將模型關聯為持續性元數據。 |
tracing |
啟用追蹤時所使用的選項。 |
update |
與相同作業相關的後續要求之間等候的時間量(以毫秒為單位)。 |
繼承的屬性詳細資料
abortSignal
description
onProgress
選擇性的初始進度處理程式,會在輪詢器狀態更新時呼叫。 此處理程式會在輪詢器狀態初始化後立即呼叫一次。
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