Получение статистики индекса (предварительная версия REST API)
применимо к: 2023-07-01-Preview. Эта версия больше не поддерживается. немедленное обновление до более новой версии.
Важный
2023-07-01-Preview добавляет в индекс vectorIndexSize.
Операция получения статистики индекса возвращает количество документов для текущего индекса, а также общий объем хранилища, используемого индексом all-up, и объем хранилища, потребляемого только его векторными данными. Служба поиска имеет общее ограничение на объем векторного хранилища, как сообщается получение статистики служб. Метрика vectorIndexSize указывает, сколько векторных хранилищ используется для векторных полей в текущем индексе поиска.
Заметка
Статистика по количеству документов и размеру хранилища собираются каждые несколько минут, а не в режиме реального времени. Поэтому статистика, возвращаемая этим API, может не отражать изменения, вызванные недавними операциями индексирования.
GET https://[service name].search.windows.net/indexes/[index name]/stats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Параметры URI
| Параметр | Описание |
|---|---|
| Имя службы | Обязательно. Задайте для этого значения уникальное, определяемое пользователем имя службы поиска. |
| Имя индекса | Обязательно. URI запроса указывает имя индекса, для которого должна быть возвращена статистика. |
| версия API | Обязательно. Дополнительные версии API см. в версиях API. |
Заголовки запросов
В следующей таблице описаны обязательные и необязательные заголовки запросов.
| Поля | Описание |
|---|---|
| Тип контента | Обязательно. Задайте для этого значения значение application/json |
| api-key | Необязательно, если вы используете роли Azure и маркер носителя предоставляется в запросе, в противном случае требуется ключ. Ключ API — это уникальная, созданная системой строка, которая проверяет подлинность запроса в службе поиска. Запросы к определению объекта должны содержать поле api-key, заданное для ключа администратора (в отличие от ключа запроса). Дополнительные сведения см. в статье Connect to Azure AI Search using key authentication. |
Текст запроса
Никакой.
Ответ
Код состояния: "200 ОК" возвращается для успешного ответа. Текст ответа имеет следующий формат:
{
"documentCount": number,
"storageSize": number (size of the index in bytes),
"vectorIndexSize": number (size of the index in bytes)
}
Если в индексе нет векторных полей, значение vectorIndexSize равно нулю.