インデックスされた文書の照会

Prev Next

VPC環境で利用できます。

サービス内でインデックスされた文書を照会します。文書の詳細情報と内容を確認します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/svc/{serviceId}/doc/{docId}

リクエストヘッダ

RAG APIで共通して使用されるヘッダの詳細は、RAGのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceId String Required サービスの固有 ID
docId String Required 文書の固有 ID

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://kr-pub-gateway.rag.naverncp.com/api/v1/svc/{serviceId}/doc/12345' \
--header 'Authorization: Bearer {apiKey}' \
--header 'Content-Type: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
status Object - API処理結果
status.code Integer - APIレスポンスステータスコード
status.message String - APIレスポンスステータスメッセージ
result Object - 文書の照会結果
result.has_next Boolean - 次のページは存在するか
  • true: 次のページがある
  • false: 最後のページ
result.next_url String - 次のページ URL
  • 次のページがない場合、空文字列
result.documents Array - 文書の詳細情報

result.documents

検索された文書の詳細情報です。

フィールド タイプ 必須の有無 説明
id String - 文書の固有 ID
  • 英数字、記号の「-」、「_」のみ使用可能
orgid String - 原本文書の固有 ID
title String - 文書の件名
file_name String - ファイル名
body String - 文書の本文
url String - ウェブサイト URL
created_at String - 作成日時
  • ISO 8601形式
updated_at String - 更新日時
  • ISO 8601形式
  • インデックスに反映された日時をシステムが自動で追加
extra Object Optional 付加情報
  • 文書の転送時、ユーザーが任意のフィールドをextra配下に追加可能
    • extra.bucket、extra.key、extra.last_modified、extra.size、extra.{userField}
  • フィールドタイプは初回データ入力時に自動的に決定
  • 文書の分類、絞り込みなどに利用
salt Integer - 分散処理のためにシステムが自動で追加する番号

レスポンスステータスコード

RAG APIで共通して使用されるレスポンスステータスコードの詳細は、RAGのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "status": {
        "code": 200,
        "message": ""
    },
    "result": {
        "has_next": false,
        "next_url": "",
        "documents": [
            {
                "id": "12345",
                "orgid": "naver:media-ai-understanding.txt",
                "title": "Media AI Understanding",
                "file_name": "media-ai-understanding.txt",
                "body": "あのシーン、どの辺だっけ。映像編集の救い主、Media AI\n\n映像の編集したことがある人なら誰でもこのような経験はあるでしょう。数十時間の撮影映像の中から特定のシーンを探すのに無駄な時間を費やしたこと。NAVERクラウドの Media AIは、映像の制作を効率化します。映像をアップロードするだけで、AIがシーンに登場する人物や行動を自動的に分析し、スクリプトまで整理してくれます。\n\n\"主人公が走るシーンだけ集めて\"とリクエストすれば、特定の人物が走るすべてのシーンをあっという間に見つけてくれるんだから、編集者は定時退社もできますし、クリエイティブな作業にもっと集中できます。メタ情報を編集ツールと連携して、映像の編集を効率的に完成してみませんか?",
                "url": "www.naver.com",
                "created_at": "2025-07-09T19:45:11.000000+00:00",
                "updated_at": "2025-07-09T10:58:39.723905+00:00",
                "extra": {
                    "bucket": "naver",
                    "size": 1024,
                    "last_modified": "2025-07-09T19:45:11+00:00",
                    "key": "media-ai-understanding.txt"
                },
                "salt": 33404
            }
        ]
    }
}