Indexes - Get Statistics
Возвращает статистику по заданному индексу, включая количество документов и использование хранилища.
GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2023-11-01Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
URL-адрес конечной точки службы поиска. |
|
index
|
path | True |
string |
Имя индекса, для которого требуется получить статистику. |
|
api-version
|
query | True |
string |
Версия API клиента. |
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| x-ms-client-request-id |
string uuid |
Идентификатор отслеживания, отправленный с запросом для помощи в отладке. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK | ||
| Other Status Codes |
Ответ об ошибке. |
Примеры
SearchServiceGetIndexStatistics
Образец запроса
GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2023-11-01
Пример ответа
{
"documentCount": 239572,
"storageSize": 72375920,
"vectorIndexSize": 123456
}Определения
| Имя | Описание |
|---|---|
|
Get |
Статистика по заданному индексу. Статистические данные собираются периодически и не всегда будут актуальными. |
|
Search |
Описывает условие ошибки для API. |
GetIndexStatisticsResult
Статистика по заданному индексу. Статистические данные собираются периодически и не всегда будут актуальными.
| Имя | Тип | Описание |
|---|---|---|
| documentCount |
integer |
Количество документов в индексе. |
| storageSize |
integer |
Объем хранилища в байтах, используемый индексом. |
| vectorIndexSize |
integer |
Объем памяти в байтах, потребляемый векторами в индексе. |
SearchError
Описывает условие ошибки для API.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Один из серверных наборов кодов ошибок. |
| details |
Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке. |
|
| message |
string |
Понятное представление ошибки. |