문서의 색인 상태 조회

VPC 환경에서 이용 가능합니다.

색인 요청한 문서의 처리 상태를 조회합니다. 문서가 색인 시스템에서 어느 단계까지 처리되었는지 확인할 수 있습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/svc/{serviceId}/doc/{docId}/status

요청 헤더

RAG API 에서 공통으로 사용하는 헤더에 대한 정보는 RAG 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`serviceId`	String	Required	서비스의 고유 식별자
`docId`	String	Required	문서의 고유 식별자

요청 예시

요청 예시는 다음과 같습니다.

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	-	서비스의 고유 식별자
`data.docid`	String	-	문서의 고유 식별자
`data.orgid`	String	-	원본 문서의 고유 식별자
`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"
    }
}