Condividi tramite


Ottenere statistiche del servizio (API REST di anteprima)

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 servizio di ricerca.

2021-04-30-Preview aggiunge aliasesCount.

L'operazione statistiche del servizio restituisce il numero e il tipo di oggetti nel servizio, il valore massimo consentito per ogni tipo di oggetto in base al livello di servizio, all'archiviazione effettiva e massima e ad altri limiti che variano in base al livello. Questa richiesta esegue il pull delle informazioni dal servizio in modo che non sia necessario cercare o calcolare i limiti del servizio .

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/servicestats?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. 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. Ottenere le richieste nel servizio di ricerca deve includere un'intestazione api-key impostata sulla chiave di amministrazione 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:

{
    "counters": {
        "documentCount": {
            "usage": number,
            "quota": number | null (if the service has unlimited document counts, the quota will be null)
        },
        "indexesCount": {
            "usage": number,
            "quota": number
        },
        "indexersCount": {
            "usage": number,
            "quota": number
        },
        "dataSourcesCount": {
            "usage": number,
            "quota": number
        },
        "storageSize": {
            "usage": number (bytes),
            "quota": number (bytes) 
        },
        "synonymMaps": {
            "usage": number,
            "quota": number
        },
        "aliasesCount": {
            "usage": number,
            "quota": number
        },
        "vectorIndexSize": {
            "usage": number (bytes),
            "quota": number (bytes)
        }
    },
    "limits": {
        "maxFieldsPerIndex": number,
        "maxIndexerRunTime": string,
        "maxFileExtractionSize": number,
        "maxFileContentCharactersToExtract": number,
        "maxFieldNestingDepthPerIndex": number,
        "maxComplexCollectionFieldsPerIndex": number,
        "maxComplexObjectsInCollectionsPerDocument": number
    }
}
Statistica Digitare Descrizione
documentCount Contare Aggregazione di tutti i documenti di tutti gli indici. Le versioni precedenti di Ricerca intelligenza artificiale di Azure applicano i limiti relativi al numero di documenti, ma tale limite non esiste più. La quota è sempre Null che indica che il servizio può avere conteggi di documenti illimitati.
indexesCount Contare Numero di indici nel servizio di ricerca. Gli indici massimi variano in base al livello, come indicato dalla quota.
indexersCount Contare Numero di indicizzatori nel servizio di ricerca. Il numero massimo di indicizzatori varia in base al livello, come indicato dalla quota.
dataSourcesCount Contare Numero di origini dati nel servizio di ricerca. Le origini dati massime variano in base al livello, come indicato dalla quota. Il numero massimo di origini dati è uguale a quello degli indicizzatori massimi.
aliasesCount Contare Numero di alias di indice nel servizio di ricerca. Il valore massimo varia in base al livello, come indicato dalla quota.
synonymMaps Contare Numero di mappe sinonimie nel servizio di ricerca. Il valore massimo varia in base al livello, come indicato dalla quota.
storageSize Byte L'utilizzo è lo spazio di archiviazione usato da tutti gli oggetti nel servizio. La quota è l'archiviazione massima disponibile in base alle dimensioni e al numero di partizioni configurate per il servizio. La quota aumenta e diminuisce in risposta al numero di partizioni di cui è stato effettuato il provisioning nel servizio di ricerca. Le dimensioni della partizione variano in base al livello.
vectorIndexSize Byte Un indice vettoriale è una struttura interna, un indice vettoriale per campo vettore come definito in un indice di ricerca. L'utilizzo totale viene segnalato nel servizio in modo da poter monitorare il consumo di spazio vettoriale rispetto al limite di indice vettoriale del servizio di ricerca. La quota varia in base all'età del servizio di ricerca, al numero di partizioni e alle dimensioni delle partizioni come determinato dal livello.

Per altre informazioni su tutti i limiti, vedere limiti del servizio .

Esempi

Questa API è il piano dati. Per altre informazioni su un servizio, ad esempio il livello o la posizione, vedere l'API REST di gestione .

{
    "@odata.context": "https://my-search-service.search.windows.net/$metadata#Microsoft.Azure.Search.V2019_05_06.ServiceStatistics",
    "counters": {
        "documentCount": {
            "usage": 5072,
            "quota": null
        },
        "indexesCount": {
            "usage": 10,
            "quota": 15
        },
        "indexersCount": {
            "usage": 8,
            "quota": 15
        },
        "dataSourcesCount": {
            "usage": 9,
            "quota": 15
        },
        "storageSize": {
            "usage": 22265221,
            "quota": 2147483648
        },
        "synonymMaps": {
            "usage": 0,
            "quota": 3
        },
        "aliasesCount": {
            "usage": 7,
            "quota": 30
        },
        "vectorIndexSize": {
            "usage": 1342476,
            "quota": 1073741824
    },
    "limits": {
        "maxFieldsPerIndex": 1000,
        "maxIndexerRunTime": "P1D",
        "maxFileExtractionSize": 16777216,
        "maxFileContentCharactersToExtract": 65536,
        "maxFieldNestingDepthPerIndex": 10,
        "maxComplexCollectionFieldsPerIndex": 40,
        "maxComplexObjectsInCollectionsPerDocument": 3000
    }
}

Vedere anche