FormRecognizerClient class
- Extends
コンストラクター
| Form |
FormRecognizerClient クラスの新しいインスタンスを初期化します。 |
継承されたプロパティ
| credentials | |
| endpoint |
メソッド
継承されたメソッド
| send |
指定された OperationSpec を使用して設定された HTTP 要求を送信します。 |
| send |
指定された 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プロパティ値
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) ファイル。
省略可能なパラメーター
戻り値
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) ファイル。
省略可能なパラメーター
- callback
コールバック。
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)パラメーター
- id
-
string
ドキュメントを分析するモデル識別子。
- formStream
- HttpRequestBody
分析する PDF ドキュメントまたは画像 (jpg,png) ファイル。
- callback
コールバック。
batchReadReceipt(string, RequestOptionsBase)
バッチ読み取りレシート操作。 応答には、'Operation-Location' という名前のフィールドが含まれています。このフィールドには、'Get Read Receipt Result' 操作に使用する必要がある 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" というフィールドが含まれます。 "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
コールバック。
getCustomModel(string, ServiceCallback<ModelResult>)
function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)パラメーター
- id
-
string
モデル識別子。
- callback
コールバック。
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
コールバック。
getCustomModels(ServiceCallback<ModelsResult>)
function getCustomModels(callback: ServiceCallback<ModelsResult>)パラメーター
- callback
コールバック。
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
コールバック。
getExtractedKeys(string, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)パラメーター
- id
-
string
モデル識別子。
- callback
コールバック。
getReadReceiptResult(string, RequestOptionsBase)
このインターフェイスは、"バッチ読み取りレシート" 操作の分析結果を取得するために使用されます。 このインターフェイスの URL は、'Batch Read Receipt' 操作から返された 'Operation-Location' フィールドから取得する必要があります。
function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>パラメーター
- operationId
-
string
'Batch Read Receipt' 操作の応答で返される読み取り操作の ID。
- options
- RequestOptionsBase
省略可能なパラメーター
戻り値
Promise<GetReadReceiptResultResponse>
Promise<Models.GetReadReceiptResultResponse>
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadReceiptResult>)パラメーター
- operationId
-
string
'Batch Read Receipt' 操作の応答で返される読み取り操作の ID。
- options
- RequestOptionsBase
省略可能なパラメーター
- callback
コールバック。
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)パラメーター
- operationId
-
string
'Batch Read Receipt' 操作の応答で返される読み取り操作の ID。
- callback
コールバック。
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<TrainCustomModelResponse>
Promise<Models.TrainCustomModelResponse>
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, options: RequestOptionsBase, callback: ServiceCallback<TrainResult>)パラメーター
- trainRequest
- TrainRequest
トレーニング用のオブジェクトを要求します。
- options
- RequestOptionsBase
省略可能なパラメーター
- callback
コールバック。
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)パラメーター
- trainRequest
- TrainRequest
トレーニング用のオブジェクトを要求します。
- callback
コールバック。
継承済みメソッドの詳細
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>
sendRequest(RequestPrepareOptions | WebResourceLike)
指定された httpRequest を送信します。
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>パラメーター
- options
戻り値
Promise<HttpOperationResponse>
Azure SDK for JavaScript
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示