Indexes - Get Statistics

Служба:
Search Service
Версия API:
2023-11-01

Возвращает статистику для заданного индекса, включая количество документов и использование хранилища.

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2023-11-01

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string

URL-адрес конечной точки службы поиска.
indexName
 path True

string

Имя индекса, для которого требуется получить статистику.
api-version
 query True

string

Версия клиентского API.

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-request-id

string (uuid)

Идентификатор отслеживания, отправляемый запросом на отладку.

Ответы

Имя Тип Описание
200 OK

GetIndexStatisticsResult

Other Status Codes

SearchError

Ответ на ошибку.

Примеры

SearchServiceGetIndexStatistics

Образец запроса

GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2023-11-01

Пример ответа

Код состояния:
200 
{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Определения

Имя Описание
GetIndexStatisticsResult

Статистика по заданному индексу. Статистика собирается периодически и не гарантируется всегда быть up-to-date.
SearchError

Описывает условие ошибки для API.

GetIndexStatisticsResult

Объект

Статистика по заданному индексу. Статистика собирается периодически и не гарантируется всегда быть up-to-date.

Имя Тип Описание
documentCount

integer (int64)

Количество документов в индексе.
storageSize

integer (int64)

Объем хранилища в байтах, потребляемых индексом.
vectorIndexSize

integer (int64)

Объем памяти в байтах, потребляемых векторами в индексе.

SearchError

Объект

Описывает условие ошибки для API.

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
details

SearchError[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
message

string

Читаемое пользователем представление ошибки.