Indexes - Get Statistics

Layanan:
Search Service
Versi API:
2023-11-01

Mengembalikan statistik untuk indeks yang diberikan, 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

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 up-to-date.
SearchError

Menjelaskan kondisi kesalahan untuk API.

GetIndexStatisticsResult

Objek

Statistik untuk indeks tertentu. Statistik dikumpulkan secara berkala dan tidak dijamin selalu up-to-date.

Nama Jenis Deskripsi
documentCount

integer (int64)

Jumlah dokumen dalam indeks.
storageSize

integer (int64)

Jumlah penyimpanan dalam byte yang digunakan oleh indeks.
vectorIndexSize

integer (int64)

Jumlah memori dalam byte yang dikonsumsi oleh vektor dalam indeks.

SearchError

Objek

Menjelaskan kondisi kesalahan untuk API.

Nama Jenis Deskripsi
code

string

Salah satu sekumpulan 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.