FormRecognizerClient class

Extends

コンストラクター

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)

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

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://westus2.api.cognitive.microsoft.com)。

options
ServiceClientOptions

パラメーター のオプション

継承されたプロパティの詳細

credentials

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

開封確認操作。 "バッチ開封確認" インターフェイスを使用する場合、応答には "Operation-Location" というフィールドが含まれます。 'Operation-Location' フィールドには、'開封確認結果の取得' 操作に使用する必要がある URL が含まれています。

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

パラメーター

image
HttpRequestBody

イメージ ストリーム。

options
RequestOptionsBase

省略可能なパラメーター

戻り値

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

'バッチ読み取りレシート' 操作の応答で返される読み取り操作の ID。

options
RequestOptionsBase

省略可能なパラメーター

戻り値

Promise<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

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

パラメーター

operationId

string

'バッチ読み取りレシート' 操作の応答で返される読み取り操作の ID。

options
RequestOptionsBase

省略可能なパラメーター

callback

ServiceCallback<ReadReceiptResult>

コールバック

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

パラメーター

operationId

string

'バッチ読み取りレシート' 操作の応答で返される読み取り操作の ID。

callback

ServiceCallback<ReadReceiptResult>

コールバック

trainCustomModel(TrainRequest, RequestOptionsBase)

カスタム モデルを作成してトレーニングします。 トレーニング要求には、外部からアクセス可能な 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>

パラメーター

trainRequest
TrainRequest

トレーニング用のオブジェクトを要求します。

options
RequestOptionsBase

省略可能なパラメーター

戻り値

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>

パラメーター

戻り値

FormRecognizerClientContext.sendRequest から継承