FormRecognizerClient class

套件:

@azure/cognitiveservices-formrecognizer

Extends

FormRecognizerClientContext

建構函式

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

初始化 FormRecognizerClient 類別的新實例。

繼承的屬性

credentials
endpoint

方法

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)	從指定的檔擷取機碼/值組。 輸入文件必須是其中一個支援的內容類型 - 'application/pdf'、'image/jpeg' 或 'image/png'。 成功回應會以 JSON 傳回。
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)	批次讀取回條作業。 回應包含名為 『Operation-Location』 的欄位，其中包含您必須用於「取得讀取回條結果」作業的 URL。
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)	讀取回條作業。 當您使用 『Batch Read Receipt』 介面時，回應會包含名為 『Operation-Location』 的字段。 [作業位置] 字段包含您必須用於「取得讀取回條結果」作業的 URL。
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
deleteCustomModel(string, RequestOptionsBase)	刪除模型成品。
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
deleteCustomModel(string, ServiceCallback<void>)
getCustomModel(string, RequestOptionsBase)	取得模型的相關信息。
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)	取得所有定型自定義模型的相關信息
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)	擷取在指定模型定型期間擷取的索引鍵。
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)	此介面用於取得「批次讀取回條」作業的分析結果。 此介面的 URL 應該從 'Batch Read Receipt' 作業傳回的 'Operation-Location' 字段擷取。
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)	建立和定型自定義模型。 定型要求必須包含來源參數，該參數可以是外部可存取的 Azure 記憶體 Blob 容器 URI（最好是共用存取簽章 URI），或本機掛接磁碟驅動器中數據資料夾的有效路徑。 指定本機路徑時，它們必須遵循Linux/Unix路徑格式，而且是根植於輸入掛接組態設定值的絕對路徑，例如，如果 '{Mounts：Input}' 組態設定值為 '/input'，則有效的來源路徑會是 '/input/contosodataset'。 所有要定型的數據都應該直接在源數據夾底下。 不支援子資料夾。 模型是使用下列內容類型的檔來定型 - 'application/pdf'、'image/jpeg' 和 'image/png'。忽略其他類型的內容。
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

繼承的方法

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	傳送使用提供的 OperationSpec 填入的 HTTP 要求。
sendRequest(RequestPrepareOptions | WebResourceLike)	傳送提供的 HTTPRequest。

建構函式詳細資料

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

初始化 FormRecognizerClient 類別的新實例。

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

參數

credentials

ServiceClientCredentials

可唯一識別用戶端訂用帳戶的訂用帳戶認證。

endpoint

string

支援的認知服務端點（通訊協定和主機名，例如：https://westus2.api.cognitive.microsoft.com）。

options

ServiceClientOptions

參數選項

繼承的屬性詳細資料

credentials

credentials: ServiceClientCredentials

屬性值

ServiceClientCredentials

繼承自FormRecognizerClientContext.credentials

endpoint

endpoint: string

屬性值

string

繼承自 formRecognizerClientContext.endpoint

方法詳細資料

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

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

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

參數

id

string

用來分析檔的模型標識碼。

formStream

HttpRequestBody

要分析的 pdf 檔或影像 （jpg，png） 檔案。

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

選擇性參數

傳回

Promise<AnalyzeWithCustomModelResponse>

Promise<Models.AnalyzeWithCustomModelResponse>

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)

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

參數

id

string

用來分析檔的模型標識碼。

formStream

HttpRequestBody

要分析的 pdf 檔或影像 （jpg，png） 檔案。

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

選擇性參數

callback

ServiceCallback<AnalyzeResult>

回呼

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

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

參數

id

string

用來分析檔的模型標識碼。

formStream

HttpRequestBody

要分析的 pdf 檔或影像 （jpg，png） 檔案。

callback

ServiceCallback<AnalyzeResult>

回呼

batchReadReceipt(string, RequestOptionsBase)

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

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

參數

url

string

影像的可公開連線 URL。

options

RequestOptionsBase

選擇性參數

傳回

Promise<BatchReadReceiptResponse>

Promise<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)

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

參數

url

string

影像的可公開連線 URL。

options

RequestOptionsBase

選擇性參數

callback

ServiceCallback<void>

回呼

batchReadReceipt(string, ServiceCallback<void>)

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

參數

url

string

影像的可公開連線 URL。

callback

ServiceCallback<void>

回呼

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

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

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

參數

image

HttpRequestBody

影像數據流。

options

RequestOptionsBase

選擇性參數

傳回

Promise<BatchReadReceiptInStreamResponse>

Promise<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

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

參數

image

HttpRequestBody

影像數據流。

options

RequestOptionsBase

選擇性參數

callback

ServiceCallback<void>

回呼

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

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

參數

image

HttpRequestBody

影像數據流。

callback

ServiceCallback<void>

回呼

deleteCustomModel(string, RequestOptionsBase)

刪除模型成品。

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

參數

id

string

要刪除之模型的標識碼。

options

RequestOptionsBase

選擇性參數

傳回

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)

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

參數

id

string

要刪除之模型的標識碼。

options

RequestOptionsBase

選擇性參數

callback

ServiceCallback<void>

回呼

deleteCustomModel(string, ServiceCallback<void>)

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

參數

id

string

要刪除之模型的標識碼。

callback

ServiceCallback<void>

回呼

getCustomModel(string, RequestOptionsBase)

取得模型的相關信息。

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

參數

id

string

模型標識碼。

options

RequestOptionsBase

選擇性參數

傳回

Promise<GetCustomModelResponse>

Promise<Models.GetCustomModelResponse>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)

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

參數

id

string

模型標識碼。

options

RequestOptionsBase

選擇性參數

callback

ServiceCallback<ModelResult>

回呼

getCustomModel(string, ServiceCallback<ModelResult>)

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

參數

id

string

模型標識碼。

callback

ServiceCallback<ModelResult>

回呼

getCustomModels(RequestOptionsBase)

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

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

參數

options

RequestOptionsBase

選擇性參數

傳回

Promise<GetCustomModelsResponse>

Promise<Models.GetCustomModelsResponse>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)

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

參數

options

RequestOptionsBase

選擇性參數

callback

ServiceCallback<ModelsResult>

回呼

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

參數

callback

ServiceCallback<ModelsResult>

回呼

getExtractedKeys(string, RequestOptionsBase)

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

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

參數

id

string

模型標識碼。

options

RequestOptionsBase

選擇性參數

傳回

Promise<GetExtractedKeysResponse>

Promise<Models.GetExtractedKeysResponse>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)

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

參數

id

string

模型標識碼。

options

RequestOptionsBase

選擇性參數

callback

ServiceCallback<KeysResult>

回呼

getExtractedKeys(string, ServiceCallback<KeysResult>)

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

參數

id

string

模型標識碼。

callback

ServiceCallback<KeysResult>

回呼

getReadReceiptResult(string, RequestOptionsBase)

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

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

參數

operationId

string

在「批次讀取回條」作業回應中傳回的讀取作業標識碼。

options

RequestOptionsBase

選擇性參數

傳回

Promise<GetReadReceiptResultResponse>

Promise<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

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

參數

operationId

string

在「批次讀取回條」作業回應中傳回的讀取作業標識碼。

options

RequestOptionsBase

選擇性參數

callback

ServiceCallback<ReadReceiptResult>

回呼

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

參數

operationId

string

在「批次讀取回條」作業回應中傳回的讀取作業標識碼。

callback

ServiceCallback<ReadReceiptResult>

回呼

trainCustomModel(TrainRequest, RequestOptionsBase)

建立和定型自定義模型。 定型要求必須包含來源參數，該參數可以是外部可存取的 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>

參數

trainRequest

TrainRequest

用於定型的要求物件。

options

RequestOptionsBase

選擇性參數

傳回

Promise<TrainCustomModelResponse>

Promise<Models.TrainCustomModelResponse>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)

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

參數

trainRequest

TrainRequest

用於定型的要求物件。

options

RequestOptionsBase

選擇性參數

callback

ServiceCallback<TrainResult>

回呼

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

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

參數

trainRequest

TrainRequest

用於定型的要求物件。

callback

ServiceCallback<TrainResult>

回呼

繼承的方法的詳細資料

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

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

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

參數

operationArguments

OperationArguments

HTTP 要求樣板化值的自變數將會從 中填入。

operationSpec

OperationSpec

要用來填入 HTTPRequest 的 OperationSpec。

callback

ServiceCallback<any>

收到回應時要呼叫的回呼。

傳回

Promise<RestResponse>

繼承自FormRecognizerClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

傳送提供的 HTTPRequest。

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

參數

options

RequestPrepareOptions | WebResourceLike

傳回

Promise<HttpOperationResponse>

繼承自formRecognizerClientContext.sendRequest