文書のインデックス状態の照会

VPC環境で利用できます。

インデックスリクエストした文書の処理状態を照会します。文書がインデックスシステムでどの段階まで処理されたか確認できます。

リクエスト

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

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

リクエストヘッダ

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/status' \
--header 'Authorization: Bearer {apiKey}' \
--header 'Content-Type: application/json'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	Integer	-	APIレスポンスステータスコード
`message`	String	-	APIレスポンスステータスメッセージ
`data`	Object	-	文書の照会結果
`data.serviceId`	String	-	サービスの固有 ID
`data.docid`	String	-	文書の固有 ID
`data.orgid`	String	-	原本文書の固有 ID
`data.step`	Object	-	インデックスの手順 `EXTRACT` \| `CHUNK` \| `EMBED` \| `INDEX` \| `DONE` \| `DELETE` `EXTRACT`: 文書からテキストを抽出 `CHUNK`: 抽出されたテキストを意味をなす最低限の単位に分割 `EMBED`: 分割されたテキストをベクトルに変換 `INDEX`: ベクトル化したデータを検索インデックスに保存 `DONE`: インデックスの全プロセスが完了 `DELETE`: 文書が削除される (削除時にのみ表示)
`data.step.{stepName}.isFailed`	Boolean	-	段階ごとの成否 `true` \| `false` `true`: 失敗 `false`: 成功
`data.step.{stepName}.startedAt`	String	-	開始日時 ISO 8601形式
`data.step.{stepName}.finishedAt`	String	-	終了日時 ISO 8601形式
`data.step.{stepName}.info`	Object	-	付加情報
`data.status`	String	-	文書の最終インデックス状態 `NONE` \| `INDEXING` \| `FAILED` \| `PARTIAL` \| `DONE` \| `DELETED` `NONE`: インデックス前 `INDEXING`: インデックス中 `FAILED`: インデックス失敗 `PARTIAL`: インデックスが一部成功 `DONE`: インデックス完了 `DELETED`: 削除
`data.updatedAt`	String	-	更新日時 ISO 8601形式インデックスが反映された日時をシステムが自動で追加

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

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

レスポンス例

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

{
    "code": 20000,
    "message": "Success",
    "data": {
        "serviceId": "{serviceId}",
        "docid": "12345",
        "orgid": "naver:media-ai-understanding.txt",
        "step": {
            "EXTRACT": {
                "isFailed": false,
                "startedAt": "2025-07-09T11:31:39.123000+00:00",
                "finishedAt": "2025-07-09T11:31:39.123000+00:00",
                "info": {}
            },
            "CHUNK": {
                "isFailed": false,
                "startedAt": "2025-07-09T11:31:39.768000+00:00",
                "finishedAt": "2025-07-09T11:31:39.768000+00:00",
                "info": {}
            },
            "EMBED": {
                "isFailed": false,
                "startedAt": "2025-07-09T11:31:39.784000+00:00",
                "finishedAt": "2025-07-09T11:31:39.825000+00:00",
                "info": {}
            },
            "INDEX": {
                "isFailed": false,
                "startedAt": "2025-07-09T11:31:39.837000+00:00",
                "finishedAt": "2025-07-09T11:31:39.856000+00:00",
                "info": {}
            },
            "DONE": {
                "isFailed": false,
                "startedAt": "2025-07-09T11:31:39.768000+00:00",
                "finishedAt": "2025-07-09T11:31:39.891000+00:00",
                "info": {}
            }
        },
        "status": "DONE",
        "updatedAt": "2025-07-09T11:31:39.897000+00:00"
    }
}