Indici di elenco (API REST ricerca intelligenza artificiale di Azure)
L'operazione List Indexes restituisce un elenco degli indici attualmente presenti nell'servizio di ricerca di intelligenza artificiale di Azure.
GET https://[service name].search.windows.net/indexes?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parametri dell'URI
| Parametro | Descrizione |
|---|---|
| nome servizio | Obbligatorio. Impostare questo valore sul nome univoco definito dall'utente del servizio di ricerca. |
| api-version | Obbligatorio. La versione stabile corrente è api-version=2020-06-30. Per altre versioni, vedere Versioni API . |
Intestazioni richiesta
La tabella seguente descrive le intestazioni della richiesta obbligatorie e facoltative.
| Campi | Descrizione |
|---|---|
| Content-Type | Obbligatorio. Impostare il valore su application/json |
| api-key | Facoltativo se si usano ruoli di Azure e viene fornito un token di connessione nella richiesta, altrimenti è necessaria una chiave. Una chiave API è una stringa univoca generata dal sistema che autentica la richiesta al servizio di ricerca. Ottenere le richieste per una definizione dell'oggetto deve includere un campo api-key impostato sulla chiave di amministrazione , anziché una chiave di query. Per informazioni dettagliate, vedere Connettersi a Ricerca intelligenza artificiale di Azure usando l'autenticazione delle chiavi . |
Corpo della richiesta
Nessuno.
Risposta
Codice di stato: "200 OK" viene restituito per una risposta riuscita.
Esempio
{
"value": [
{
"name": "Books",
"fields": [
{"name": "ISBN", ...},
...
]
},
{
"name": "Games",
...
},
...
]
}
È possibile filtrare la risposta in base alle proprietà desiderate. Ad esempio, se si vuole solo un elenco di nomi di indice, usare l'opzione di query $select di OData:
GET /indexes?api-version=2020-06-30&$select=name
In questo caso, la risposta dell'esempio precedente sarà simile alla seguente:
{
"value": [
{"name": "Books"},
{"name": "Games"},
...
]
}
Questa è una tecnica utile per risparmiare larghezza di banda, se nel servizio di ricerca sono presenti numerosi indici.