共用方式為


AnalyzeDocumentOptions interface

檔分析作業的選項。

Extends

屬性

features

模型中要啟用的功能清單。 啟用功能可能會產生額外的成本,因此請務必參閱服務檔,以瞭解功能的性質,以及與其使用相關的任何新增成本。

如需表單辨識器中可用功能的詳細資訊,請參閱服務檔:https://aka.ms/azsdk/formrecognizer/features

locale

文字辨識和檔分析的地區設定提示。

值只能指定兩個字母的語言代碼或指出語言和區域的 BCP-47 語言標記。

例子:

  • “en-US” (美式英文)
  • “fr” (法文 - 沒有區域)
pages

輸入檔內要分析的頁面範圍清單(1 個索引),並以逗號分隔

範例:“1”、“3-5”、“1,3-5”

繼承的屬性

abortSignal

可用來中止要求的訊號。

onProgress

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

onResponse

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

requestOptions

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

resumeFrom

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

serializerOptions

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

tracingOptions

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

updateIntervalInMs

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

屬性詳細資料

features

模型中要啟用的功能清單。 啟用功能可能會產生額外的成本,因此請務必參閱服務檔,以瞭解功能的性質,以及與其使用相關的任何新增成本。

如需表單辨識器中可用功能的詳細資訊,請參閱服務檔:https://aka.ms/azsdk/formrecognizer/features

features?: FormRecognizerFeature[]

屬性值

FormRecognizerFeature[]

locale

文字辨識和檔分析的地區設定提示。

值只能指定兩個字母的語言代碼或指出語言和區域的 BCP-47 語言標記。

例子:

  • “en-US” (美式英文)
  • “fr” (法文 - 沒有區域)
locale?: string

屬性值

string

pages

輸入檔內要分析的頁面範圍清單(1 個索引),並以逗號分隔

範例:“1”、“3-5”、“1,3-5”

pages?: string

屬性值

string

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

繼承自PollerOptions.abortSignal

onProgress

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

onProgress?: (state: DocumentAnalysisPollOperationState<Result>) => void

屬性值

(state: DocumentAnalysisPollOperationState<Result>) => void

繼承自PollerOptions.onProgress

onResponse

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

onResponse?: RawResponseCallback

屬性值

繼承自PollerOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

屬性值

繼承自PollerOptions.requestOptions

resumeFrom

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

resumeFrom?: string

屬性值

string

繼承自PollerOptions.resumeFrom

serializerOptions

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

serializerOptions?: SerializerOptions

屬性值

繼承自PollerOptions.serializerOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

屬性值

繼承自PollerOptions.tracingOptions

updateIntervalInMs

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

updateIntervalInMs?: number

屬性值

number

繼承自PollerOptions.updateIntervalInMs