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>)

パラメーター

開封確認操作。 "バッチ開封確認" インターフェイスを使用する場合、応答には "Operation-Location" というフィールドが含まれます。 '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 Storage BLOB コンテナー URI (可能であれば Shared Access Signature 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 から継承