Freigeben über

Indexstatistik abrufen (Vorschau-REST-API)

  • Artikel

gilt für: 2023-07-01-Preview. Diese Version wird nicht mehr unterstützt. Upgrade sofort auf eine neuere Version.

Wichtig

2023-07-01-Preview fügt vectorIndexSize bereichsbezogenen Index hinzu.

Der "Indexstatistik abrufen" Vorgang gibt die Anzahl der Dokumente für den aktuellen Index sowie den Gesamtspeicher zurück, der vom Index all-up verwendet wird, und die Menge, die nur von den Vektordaten verbraucht wird. Ein Suchdienst hat einen allgemeinen Grenzwert für die Menge des Vektorspeichers, wie von Get Service Statisticsgemeldet. Die Metrik "vectorIndexSize" gibt an, wie viel Vektorspeicher für Vektorfelder im aktuellen Suchindex verwendet wird.

Anmerkung

Statistiken zur Dokumentanzahl und Speichergröße werden alle paar Minuten und nicht in Echtzeit erfasst. Daher spiegeln die von dieser API zurückgegebenen Statistiken möglicherweise keine Änderungen wider, die durch die letzten Indizierungsvorgänge verursacht wurden.

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

URI-Parameter

Parameter Beschreibung
Dienstname Erforderlich. Legen Sie diesen Wert auf den eindeutigen, benutzerdefinierten Namen Ihres Suchdiensts fest.
Indexname Erforderlich. Der Anforderungs-URI gibt den Namen des Indexes an, für den Statistiken zurückgegeben werden sollen.
API-Version Erforderlich. Weitere Versionen finden Sie unter API-Versionen.

Anforderungsheader

In der folgenden Tabelle werden die erforderlichen und optionalen Anforderungsheader beschrieben.

Felder Beschreibung
Inhaltstyp Erforderlich. Legen Sie diesen Wert auf application/json
API-Schlüssel Optional, wenn Sie Azure-Rollen verwenden und ein Bearertoken für die Anforderung bereitgestellt wird, andernfalls ist ein Schlüssel erforderlich. Ein API-Schlüssel ist eine eindeutige vom System generierte Zeichenfolge, die die Anforderung an Ihren Suchdienst authentifiziert. Get requests for an object definition must include an api-key field set to your admin key (as as to a query key). Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Azure AI Search mithilfe der Schlüsselauthentifizierung.

Anforderungstext

Nichts.

Antwort

Statuscode: "200 OK" wird für eine erfolgreiche Antwort zurückgegeben. Der Antworttext weist das folgende Format auf:

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

Wenn im Index keine Vektorfelder vorhanden sind, ist "vectorIndexSize" null.

Siehe auch