OpenSearch:ドキュメントコンテンツの解析

前提条件

• 認証情報を取得します。

  API を使用して AI Search Open Platform サービスを呼び出す場合は、呼び出し元の ID を認証する必要があります。

• サービスアクセスアドレスを取得します。

  インターネットまたは VPC（Virtual Private Cloud）経由でサービスを呼び出すことができます。 詳細については、「サービス登録アドレスを取得する」をご参照ください。

一般情報

• リクエスト本文の最大サイズは 8 MB を超えることはできません。

概要

ドキュメントコンテンツの解析では、同期インターフェイスと非同期インターフェイスの両方が提供されます。 HTTP タイムアウトのリスクがあるため、本番環境では同期インターフェイスは推奨されず、デバッグに使用できます。 本番環境では非同期インターフェイスが推奨され、2 つのステップが含まれます。まず、非同期抽出タスクを作成して task_id を取得し、次に非同期タスク取得インターフェイスを呼び出して、タスクが完了するまでステータスを継続的にクエリします。

非同期抽出タスクを作成する

リクエストメソッド

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/document-analyze/{service_id}/async

• host：サービスを呼び出すためのアドレス。 インターネットまたは VPC 経由で API サービスを呼び出すことができます。 詳細については、「サービス登録アドレスを取得する」をご参照ください。

• workspace_name：ワークスペースの名前（例：default）。

• service_id：組み込みサービス ID（例：ops-document-analyze-001）。

リクエスト パラメーター

ヘッダーパラメーター

API キー認証

ボディ パラメーター

目次と本文の区別が明確でないドキュメントの場合、セマンティック階層抽出により、結果の階層構造がより正確になります。

次の表に基づいて、セマンティック階層抽出を有効にした後の時間とトークンの消費量を見積もることができます。

レスポンスパラメーター

cURL リクエスト例

curl --location 'http://****shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/document-analyze/ops-document-analyze-001/async/' \
--header 'Authorization: Bearer your API Key' \
--header 'Content-Type: application/json' \
--data '{  
  "document":{
      "url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20241018/jahnyn/%E8%A7%A3%E6%9E%90%E6%B5%8B%E8%AF%95.doc"
    },
    "output" :{
      "image_storage":"base64"
    },
    "strategy": {
      "enable_semantic":true
    }
}'

レスポンス例

正常なレスポンスの例

{
    "request_id": "D5A4019E-853A-4E20-****-8053D9F5A9FC",
    "latency": 5.0,
    "http_code": 200,
    "result": {
        "task_id": "d5a4019e-853a-****-b5b6-8053d9f5a9fc"
    }
}

異常なレスポンスの例

アクセスリクエストエラーが発生した場合、出力結果にはコードとメッセージによってエラー理由が示されます。

{
    "request_id": "590A7EB8-AA84-****-AF31-8C35DC965972",
    "latency": 0.0,
    "code": "InvalidParameter",
    "http_code": 400,
    "message": "document.file_name は必須です"
}

非同期抽出タスクを取得する

リクエストメソッド

取得

URL

{host}/v3/openapi/workspaces/{workspace_name}/document-analyze/{service_id}/async/task-status?task_id=${task_id}

• host：サービスを呼び出すためのアドレス。 インターネットまたは VPC 経由で API サービスを呼び出すことができます。 詳細については、「サービス登録アドレスを取得する」をご参照ください。

• workspace_name：ワークスペースの名前（例：default）。

• service_id：組み込みサービス ID（例：ops-document-analyze-001）。

• task_id：ドキュメント解析レスポンスで返された非同期タスク ID（例：d5a4019e-853a-****-b5b6-8053d9f5a9fc）。

リクエストパラメーター

ヘッダー パラメーター

API キー認証

レスポンスパラメーター

cURL リクエスト例

curl -XGET -H"Content-Type: application/json" 
"http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/document-analyze/ops-document-analyze-001/async/task-status?task_id=110d6349-2e51-****-8bfb-25e5de434686" 
-H "Authorization: Bearer Your API-KEY"

レスポンス例

通常の応答例

{
    "request_id": "27F9CEC3-9052-****-83FF-E7957B680492",
    "latency": 13.0,
    "http_code": 200,
    "result": {
        "status": "SUCCESS",
        "data": {
            "content": "適切な帰属表示が提供されている場合、Alibaba は、ジャーナリズムまたは学術的な著作物での使用のみを目的として、本書の表と図を複製する許可をここに付与します....",
            "content_type": "markdown",
            "page_num": 15
        },
        "task_id": "24c3ad59-b196-****-974b-b63d63e05895"
    },
    "usage": {
        "token_count": 31867,
        "table_count": 4,
        "image_count": 8,
        "semantic_token_count":3068
    }
}

異常なレスポンスの例

アクセスリクエストエラーが発生した場合、出力結果にはコードとメッセージによってエラーの理由が示されます。

{
    "request_id": "0F94BD89-989C-****-963C-6E4F3FF99445",
    "latency": 3.0,
    "code": "BadRequest.TaskNotExist",
    "http_code": 404,
    "message": "task[2fda34f5-40b4-****-a9a2-3e2c1e807361] not exist" // タスクが存在しません
}

同期抽出タスクを作成する

リクエストメソッド

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/document-analyze/{service_id}/sync

パラメーターの説明

• host：サービスを呼び出すためのアドレス。 インターネットまたは VPC 経由で API サービスを呼び出すことができます。 詳細については、「サービス登録アドレスを取得する」をご参照ください。

• workspace_name：ワークスペースの名前（例：default）。

• service_id：組み込みサービス ID（例：ops-document-analyze-001）。

リクエストパラメータ

ヘッダー パラメーター

API キー認証

ボディ パラメーター

レスポンスパラメーター

cURL リクエスト例

curl --location 'http://****shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/document-analyze/ops-document-analyze-001/sync/' \
--header 'Authorization: Bearer your API Key' \
--header 'Content-Type: application/json' \
--data '{  
  "document":{
      "url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20241018/jahnyn/%E8%A7%A3%E6%9E%90%E6%B5%8B%E8%AF%95.doc"
    },
    "output" :{
      "image_storage":"base64"
    },
    "strategy": {
      "enable_semantic":true
    }
}'

レスポンス例

通常の応答例

{
    "request_id": "27F9CEC3-9052-****-83FF-E7957B689D04",
    "latency": 13.0,
    "http_code": 200,
    "result": {
        "status": "SUCCESS",
        "data": {
            "content": "適切な帰属表示が提供されている場合、Alibaba は、ジャーナリズムまたは学術的作品での使用のみを目的として、本書の表と図を複製する許可をここに付与します....",
            "content_type": "markdown",
            "page_num": 15
        }
    },
    "usage": {
        "token_count": 31867,
        "table_count": 4,
        "image_count": 8,
        "semantic_token_count":3068
    }
}

異常なレスポンスの例

アクセスリクエストエラーが発生した場合、出力結果にはコードとメッセージによってエラー理由が示されます。

{
    "request_id": "6F33AFB6-A35C-****-AFD2-9EA16CCF4383",
    "latency": 2.0,
    "code": "InvalidParameter",
    "http_code": 400,
    "message": "JSON parse error: Cannot deserialize value of type `ImageStorage` from String \\"xxx\\"  // JSON解析エラー: 文字列 \\"xxx\\" から `ImageStorage` 型の値をデシリアライズできません
}

ステータスコードの説明