Delen via

Indexstatistieken ophalen (preview-REST API)

  • Artikel

is van toepassing op: 2023-07-01-Preview. Deze versie wordt niet meer ondersteund. upgrade onmiddellijk naar een nieuwere versie.

Belangrijk

2023-07-01-Preview voegt vectorIndexSize toe beperkt tot een index.

De Indexstatistieken ophalen bewerking retourneert het aantal documenten voor de huidige index, plus de totale opslagruimte die door de index wordt gebruikt en de hoeveelheid opslagruimte die alleen door de vectorgegevens wordt verbruikt. Een zoekservice heeft een algemene limiet voor de hoeveelheid vectoropslag zoals gerapporteerd door Servicestatistieken ophalen. De metrische waarde vectorIndexSize geeft aan hoeveel vectoropslag wordt gebruikt voor vectorvelden in de huidige zoekindex.

Notitie

Statistieken over het aantal documenten en de opslaggrootte worden om de paar minuten verzameld, niet in realtime. De statistieken die door deze API worden geretourneerd, geven daarom mogelijk geen wijzigingen weer die worden veroorzaakt door recente indexeringsbewerkingen.

GET https://[service name].search.windows.net/indexes/[index name]/stats?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

URI-parameters

Parameter Beschrijving
servicenaam Vereist. Stel deze waarde in op de unieke, door de gebruiker gedefinieerde naam van uw zoekservice.
indexnaam Vereist. De aanvraag-URI geeft de naam op van de index waarvoor statistieken moeten worden geretourneerd.
api-version Vereist. Zie API-versies voor meer versies.

Aanvraagheaders

In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.

Velden Beschrijving
Inhoudstype Vereist. Stel deze waarde in op application/json
api-key Optioneel als u Azure-rollen gebruikt en er een bearer-token wordt opgegeven in de aanvraag, anders is een sleutel vereist. Een API-sleutel is een unieke, door het systeem gegenereerde tekenreeks waarmee de aanvraag wordt geverifieerd bij uw zoekservice. Aanvragen voor een objectdefinitie ophalen moet een api-sleutelveld bevatten dat is ingesteld op uw beheersleutel (in plaats van een querysleutel). Zie Verbinding maken met Azure AI Search met behulp van sleutelverificatie voor meer informatie.

Hoofdtekst van aanvraag

Geen.

Antwoord

Statuscode: '200 OK' wordt geretourneerd voor een geslaagd antwoord. De hoofdtekst van het antwoord heeft de volgende indeling:

{  
  "documentCount": number,  
  "storageSize": number (size of the index in bytes), 
  "vectorIndexSize": number (size of the index in bytes) 
}

Als de index geen vectorvelden bevat, is vectorIndexSize nul.

Zie ook