VPC環境で利用できます。
サービス内でインデックスされた文書数を照会します。検索に使用可能な文書の総数を確認します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /api/v1/svc/{serviceId}/doc-count |
リクエストヘッダ
RAG APIで共通して使用されるヘッダの詳細は、RAGのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | サービスの固有 ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
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'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
status |
Object | - | API処理結果 |
status.code |
Integer | - | APIレスポンスステータスコード |
status.message |
String | - | APIレスポンスステータスメッセージ |
result |
Object | - | 文書の照会結果 |
result.total_count |
Integer | - | インデックスされた文書の総数 |
レスポンスステータスコード
RAG APIで共通して使用されるレスポンスステータスコードの詳細は、RAGのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"status": {
"code": 200,
"message": ""
},
"result": {
"total_count": 33
}
}