Ottenere statistiche sugli indici (API REST di anteprima)

Articolo
06/28/2024

si applica a: 2023-07-01-Preview. Questa versione non è più supportata. Aggiornare immediatamente a una versione più recente.

Importante

2023-07-01-Preview aggiunge vectorIndexSize con ambito a un indice.

L'operazione Get Index Statistics restituisce il conteggio dei documenti per l'indice corrente, oltre alla quantità di spazio di archiviazione totale utilizzato dall'indice all-up e alla quantità di spazio di archiviazione utilizzato solo dai dati vettoriali. Un servizio di ricerca ha un limite complessivo per la quantità di archiviazione vettoriale segnalata da Ottenere statistiche del servizio. La metrica "vectorIndexSize" indica quanto spazio di archiviazione vettoriale viene usato per i campi vettoriali nell'indice di ricerca corrente.

Nota

Le statistiche sul numero di documenti e sulle dimensioni di archiviazione vengono raccolte ogni pochi minuti, non in tempo reale. Di conseguenza, le statistiche restituite da questa API potrebbero non riflettere le modifiche causate da operazioni di indicizzazione recenti.

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

Parametri URI

Parametro	Descrizione
nome del servizio	Obbligatorio. Impostare questo valore sul nome univoco definito dall'utente del servizio di ricerca.
nome indice	Obbligatorio. L'URI della richiesta specifica il nome dell'indice per il quale devono essere restituite le statistiche.
api-version	Obbligatorio. Per altre versioni, vedere versioni dell'API.

Intestazioni della richiesta

Nella tabella seguente vengono descritte le intestazioni di richiesta obbligatorie e facoltative.

Campi Descrizione

Tipo di contenuto Obbligatorio. Impostare questo valore su application/json

api-key Facoltativo se si usano ruoli di Azure e viene fornito un token di connessione nella richiesta; in caso contrario, è necessaria una chiave. Una chiave API è una stringa univoca generata dal sistema che autentica la richiesta al servizio di ricerca. Le richieste Get per una definizione di oggetto devono includere un campo della chiave API impostato sulla chiave amministratore anziché su una chiave di query. Per informazioni dettagliate, vedere Connettersi a Ricerca di intelligenza artificiale di Azure usando l'autenticazione della chiave.

Campi	Descrizione
Tipo di contenuto	Obbligatorio. Impostare questo valore su `application/json`
api-key	Facoltativo se si usano ruoli di Azure e viene fornito un token di connessione nella richiesta; in caso contrario, è necessaria una chiave. Una chiave API è una stringa univoca generata dal sistema che autentica la richiesta al servizio di ricerca. Le richieste Get per una definizione di oggetto devono includere un campo della chiave API impostato sulla chiave amministratore anziché su una chiave di query. Per informazioni dettagliate, vedere Connettersi a Ricerca di intelligenza artificiale di Azure usando l'autenticazione della chiave.

Corpo della richiesta

Nessuno.

Risposta

Codice di stato: "200 OK" viene restituito per una risposta con esito positivo. Il corpo della risposta è nel formato seguente:

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

Se nell'indice non sono presenti campi vettoriali, "vectorIndexSize" è zero.

Vedere anche

API REST di Ricerca intelligenza artificiale di Azure
limiti del servizio

Condividi tramite