Get indexed document count

Prev Next

Available in VPC

Get the number of indexed documents in the service. You can check the total number of documents available for search.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/svc/{serviceId}/doc-count

Request headers

For information about the headers common to all RAG APIs, see RAG request headers.

Request path parameters

The following describes the parameters.

Field Type Required Description
serviceId String Required Service's unique identifier

Request example

The request example is as follows:

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

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
status Object - API processing result
status.code Integer - API response status code
status.message String - API response status message
result Object - Document query result
result.total_count Integer - Total number of indexed documents

Response status codes

For information about the HTTP status codes common to all RAG APIs, see RAG response status codes.

Response example

The response example is as follows:

{
    "status": {
        "code": 200,
        "message": ""
    },
    "result": {
        "total_count": 33
    }
}