ドキュメント解析操作は、ドキュメントの主要なコンテンツを抽出し、事前に設定されたキーと値のテンプレートに基づいてキーと値の情報を抽出するために使用されます。この操作は非同期で行われます。ドキュメントを解析するには、まず非同期送信サービスを呼び出し、次に GetDocumentAnalyzeResult 操作を呼び出して結果をポーリングする必要があります。非同期送信サービスでは、ローカルファイルと URL ファイルの 2 つのメソッドがサポートされています。URL ファイルをアップロードする場合は SubmitDocumentAnalyzeJob 操作を、ローカルファイルをアップロードする場合は SubmitDocumentAnalyzeJobAdvance 操作を呼び出します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
energy:SubmitDocumentAnalyzeJob |
none |
*All Resource
|
なし | なし |
リクエスト構文
POST /api/v1/aidoc/document/submitDocumentAnalyzeJob HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| fileUrl |
string |
任意 |
fileUrl と fileUrlObject のいずれかを選択します。
説明
ファイル解析メソッドとサポートされるドキュメントタイプの関係。
|
fileUrl:https://example.com/example.pdf fileUrlObject:本地文件生成的FileInputStream |
| fileName |
string |
必須 |
ファイル名にはファイルタイプの拡張子を含める必要があります。 |
example.pdf |
| templateId |
string |
必須 |
一意の抽出テンプレート ID です。ドキュメントから抽出するキーと値のペアを指定するために使用されます。テンプレート管理ページにログインしてテンプレートを設定し、対応するテンプレート ID を取得する必要があります。 |
572d24k0c95a |
| folderId |
string |
任意 |
一意のナレッジベースフォルダ ID です。ドキュメントの分類やオンライン Q&A クエリの範囲のコントロールに使用されます。空のままにした場合、ドキュメントはテナントのルートディレクトリにアップロードされます。 |
默认为空 |
| analysisType |
string |
任意 |
デフォルトの抽出メソッドは "doc" です。オプション値は次のとおりです。
|
doc |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマ |
||
| requestId |
string |
リクエスト ID |
4A0AEC56-5C9A-5D47-93DF-7227836FFF82 |
| data |
object |
返されるデータ。 |
|
| jobId |
string |
ジョブ ID。 |
bfce2248-1546-4298-8bcf-70ac26e69646 |
例
成功レスポンス
JSONJSON
{
"requestId": "4A0AEC56-5C9A-5D47-93DF-7227836FFF82",
"data": {
"jobId": "bfce2248-1546-4298-8bcf-70ac26e69646"
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。