Indexes - Get Statistics

Layanan:

Search Service

Versi API:

2023-11-01

Mengembalikan statistik untuk indeks tertentu, termasuk jumlah dokumen dan penggunaan penyimpanan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	URL titik akhir layanan pencarian.
indexName	path	True	string	Nama indeks untuk mengambil statistik.
api-version	query	True	string	Versi Api Klien.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string uuid	ID pelacakan yang dikirim dengan permintaan untuk membantu penelusuran kesalahan.

Respons

Nama	Jenis	Deskripsi
200 OK	GetIndexStatisticsResult
Other Status Codes	SearchError	Respons kesalahan.

Contoh

SearchServiceGetIndexStatistics

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

200

{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Definisi

Nama	Deskripsi
GetIndexStatisticsResult	Statistik untuk indeks tertentu. Statistik dikumpulkan secara berkala dan tidak dijamin selalu diperbarui.
SearchError	Menjelaskan kondisi kesalahan untuk API.

GetIndexStatisticsResult

Statistik untuk indeks tertentu. Statistik dikumpulkan secara berkala dan tidak dijamin selalu diperbarui.

Nama	Jenis	Deskripsi
documentCount	integer	Jumlah dokumen dalam indeks.
storageSize	integer	Jumlah penyimpanan dalam byte yang digunakan oleh indeks.
vectorIndexSize	integer	Jumlah memori dalam byte yang dikonsumsi oleh vektor dalam indeks.

SearchError

Menjelaskan kondisi kesalahan untuk API.

Nama	Jenis	Deskripsi
code	string	Salah satu set kode kesalahan yang ditentukan server.
details	SearchError[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
message	string	Representasi kesalahan yang dapat dibaca manusia.