FormRecognizerClient class

初始化 FormRecognizerClient 類別的新實例。

new FormRecognizerClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)

參數

credentials: ServiceClientCredentials

屬性值

繼承自FormRecognizerClientContext.credentials

endpoint: string

屬性值

繼承自 formRecognizerClientContext.endpoint

從指定的檔擷取機碼/值組。 輸入文件必須是其中一個支援的內容類型 - 'application/pdf'、'image/jpeg' 或 'image/png'。 成功回應會以 JSON 傳回。

function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options?: FormRecognizerClientAnalyzeWithCustomModelOptionalParams): Promise<AnalyzeWithCustomModelResponse>

參數

傳回

Promise<Models.AnalyzeWithCustomModelResponse>

function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options: FormRecognizerClientAnalyzeWithCustomModelOptionalParams, callback: ServiceCallback<AnalyzeResult>)

參數

function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)

參數

批次讀取回條作業。 回應包含名為 『Operation-Location』 的欄位，其中包含您必須用於「取得讀取回條結果」作業的 URL。

function batchReadReceipt(url: string, options?: RequestOptionsBase): Promise<BatchReadReceiptResponse>

參數

傳回

Promise<Models.BatchReadReceiptResponse>

function batchReadReceipt(url: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

參數

function batchReadReceipt(url: string, callback: ServiceCallback<void>)

參數

讀取回條作業。 當您使用 『Batch Read Receipt』 介面時，回應會包含名為 『Operation-Location』 的字段。 [作業位置] 字段包含您必須用於「取得讀取回條結果」作業的 URL。

function batchReadReceiptInStream(image: HttpRequestBody, options?: RequestOptionsBase): Promise<BatchReadReceiptInStreamResponse>

參數

傳回

Promise<Models.BatchReadReceiptInStreamResponse>

function batchReadReceiptInStream(image: HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<void>)

參數

function batchReadReceiptInStream(image: HttpRequestBody, callback: ServiceCallback<void>)

參數

刪除模型成品。

function deleteCustomModel(id: string, options?: RequestOptionsBase): Promise<RestResponse>

參數

傳回

Promise<msRest.RestResponse>

function deleteCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

參數

function deleteCustomModel(id: string, callback: ServiceCallback<void>)

參數

取得模型的相關信息。

function getCustomModel(id: string, options?: RequestOptionsBase): Promise<GetCustomModelResponse>

參數

傳回

Promise<Models.GetCustomModelResponse>

function getCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<ModelResult>)

參數

function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)

參數

取得所有定型自定義模型的相關信息

function getCustomModels(options?: RequestOptionsBase): Promise<GetCustomModelsResponse>

參數

傳回

Promise<Models.GetCustomModelsResponse>

function getCustomModels(options: RequestOptionsBase, callback: ServiceCallback<ModelsResult>)

參數

function getCustomModels(callback: ServiceCallback<ModelsResult>)

參數

擷取在指定模型定型期間擷取的索引鍵。

function getExtractedKeys(id: string, options?: RequestOptionsBase): Promise<GetExtractedKeysResponse>

參數

傳回

Promise<Models.GetExtractedKeysResponse>

function getExtractedKeys(id: string, options: RequestOptionsBase, callback: ServiceCallback<KeysResult>)

參數

function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)

參數

此介面用於取得「批次讀取回條」作業的分析結果。 此介面的 URL 應該從 'Batch Read Receipt' 作業傳回的 'Operation-Location' 字段擷取。

function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>

參數

傳回

Promise<Models.GetReadReceiptResultResponse>

function getReadReceiptResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadReceiptResult>)

參數

function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)

參數

建立和定型自定義模型。 定型要求必須包含來源參數，該參數可以是外部可存取的 Azure 記憶體 Blob 容器 URI（最好是共用存取簽章 URI），或本機掛接磁碟驅動器中數據資料夾的有效路徑。 指定本機路徑時，它們必須遵循Linux/Unix路徑格式，而且是根植於輸入掛接組態設定值的絕對路徑，例如，如果 '{Mounts：Input}' 組態設定值為 '/input'，則有效的來源路徑會是 '/input/contosodataset'。 所有要定型的數據都應該直接在源數據夾底下。 不支援子資料夾。 模型是使用下列內容類型的檔來定型 - 'application/pdf'、'image/jpeg' 和 'image/png'。忽略其他類型的內容。

function trainCustomModel(trainRequest: TrainRequest, options?: RequestOptionsBase): Promise<TrainCustomModelResponse>

參數

傳回

Promise<Models.TrainCustomModelResponse>

function trainCustomModel(trainRequest: TrainRequest, options: RequestOptionsBase, callback: ServiceCallback<TrainResult>)

參數

function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)

參數

傳送使用提供的 OperationSpec 填入的 HTTP 要求。

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

參數

傳回

繼承自FormRecognizerClientContext.sendOperationRequest

傳送提供的 HTTPRequest。

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

參數

傳回

繼承自formRecognizerClientContext.sendRequest