색인된 문서 조회

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

서비스 내 색인된 문서를 조회합니다. 문서의 상세 정보와 내용을 확인할 수 있습니다.

요청

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

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

요청 헤더

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' \
--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	-	문서의 고유 식별자 영문자, 숫자, 특수문자 '-', '_' 허용
`orgid`	String	-	원본 문서의 고유 식별자
`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영상을 편집해 본 적이 있다면 누구나 이런 경험이 있을 거예요. 수십 시간의 촬영본 중에서 특정 장면을 찾느라 시간을 허비하는 일 말이에요. 네이버클라우드의 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
            }
        ]
    }
}