AI Service > OCR > Document AI > APIガイド

Document AI分析API

リクエスト

  • {appKey}と{secretKey}は、右側のコンソール上部のURL & Appkeyメニューで確認できます。

[URI]

メソッド URI
POST https://ocr.api.nhncloudservice.com/v1.0/appkeys/{appKey}/document-ai

[リクエストヘッダ]

名前 値 説明
Authorization {secretKey} コンソールで発行された秘密鍵
Content-Type multipart/form-data コンテンツタイプ

[リクエスト本文]

curl -X POST 'https://ocr.api.nhncloudservice.com/v1.0/appkeys/{appKey}/document-ai' \
-H 'Authorization: ${secretKey}' \
-F 'image=@sample.png' \
-F 'prompt="簡潔に要約してくれ"' \
-F 'documentTypeCode="GENERAL"'

[フィールド]

名前 タイプ 必須かどうか デフォルト値 有効範囲 説明
image file O イメージファイル
documentTypeCode text X GENERAL GENERAL, BUSINESS_REGISTRATION, BUSINESS_CARD 文書タイプ
一般: GENERAL
事業者登録証: BUSINESS_REGISTRATION
名刺: BUSINESS_CARD
prompt text O 質問内容
最大1000文字

レスポンス

[レスポンス本文]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "result": {
        "llmResponse": "この文書は、意味のないテキストである'ローレンipsum'を使用して、文字はあるが読みにくい、可読性が落ちる文章を作成したようです。"
    }
}

[ヘッダ]

名前 タイプ 説明
isSuccessful Boolean 分析API成否
resultCode Integer 結果コード
resultMessage String 結果メッセージ(成功時はsuccess、失敗時はエラー内容)

[フィールド]

名前 タイプ 説明
llmResponse String LLM分析回答
目次
TOP