Abrufen von Indexstatistiken (Vorschau-REST-API)

  • Artikel

Gilt für: 2023-07-01-Preview

Wichtig

2023-07-01-Preview fügt vectorIndexSize scoped zu einem Index hinzu.

Der Vorgang Indexstatistik abrufen gibt die Dokumentanzahl für den aktuellen Index sowie die Gesamtmenge des vom Index all-up verwendeten Speichers und die Menge des Speichers zurück, die nur von den Vektordaten verbraucht wird. Ein Suchdienst hat eine Gesamtgrenze für die Menge des Vektorspeichers, wie von Get Service Statistics gemeldet. Die Metrik "vectorIndexSize" gibt an, wie viel Vektorspeicher für Vektorfelder im aktuellen Suchindex verwendet wird.

Hinweis

Statistiken zur Anzahl und Speichergröße von Dokumenten werden im Abstand von einigen Minuten gesammelt, nicht in Echtzeit. Daher spiegeln die von dieser API zurückgegebenen Statistiken möglicherweise nicht die von kürzlich durchgeführten Indizierungsvorgängen verursachten Änderungen wider.

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. Die aktuelle stabile Version ist api-version=2020-06-30. Weitere Versionen finden Sie unter API-Versionen .

Anforderungsheader

Die folgende Tabelle beschreibt die erforderlichen und optionalen Anforderungsheader.

Felder BESCHREIBUNG
Content-Type Erforderlich. Legen Sie diesen Wert auf fest. application/json
api-key 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 bei Ihrem Suchdienst authentifiziert. Abrufen von Anforderungen für eine Objektdefinition muss ein API-Schlüsselfeld enthalten, das auf Ihren Administratorschlüssel festgelegt ist (im Gegensatz zu einem Abfrageschlüssel). Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Azure AI Search mithilfe der Schlüsselauthentifizierung .

Anforderungstext

Keine.

Antwort

Statuscode: "200 OK" wird für eine erfolgreiche Antwort zurückgegeben. Der Antworttext hat folgendes Format:

{  
  "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" 0.

Weitere Informationen