Índices de Lista (API REST da Pesquisa de IA do Azure)
A operação Índices de Lista devolve uma lista dos índices atualmente no seu Serviço de pesquisa de IA do Azure.
GET https://[service name].search.windows.net/indexes?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parâmetros do URI
| Parâmetro | Description |
|---|---|
| nome do serviço | Obrigatório. Defina-o como o nome exclusivo definido pelo utilizador do seu serviço de pesquisa. |
| api-version | Obrigatório. A versão estável atual é api-version=2020-06-30. Veja Versões da API para obter mais versões. |
Cabeçalhos de Pedido
A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.
| Campos | Description |
|---|---|
| Content-Type | Obrigatório. Defina esta opção como application/json |
| api-key | Opcional se estiver a utilizar funções do Azure e for fornecido um token de portador no pedido, caso contrário, é necessária uma chave. Uma chave de API é uma cadeia exclusiva gerada pelo sistema que autentica o pedido no seu serviço de pesquisa. Obter pedidos para uma definição de objeto tem de incluir um campo de chave de api definido para a sua chave de administrador (por oposição a uma chave de consulta). Veja Connect to Azure AI Search using key authentication (Ligar à Pesquisa de IA do Azure com a autenticação de chaves ) para obter detalhes. |
Corpo do Pedido
Nenhum.
Resposta
Código de Estado: "200 OK" é devolvido para uma resposta com êxito.
Exemplos
{
"value": [
{
"name": "Books",
"fields": [
{"name": "ISBN", ...},
...
]
},
{
"name": "Games",
...
},
...
]
}
Pode filtrar a resposta apenas para as propriedades que lhe interessam. Por exemplo, se quiser apenas uma lista de nomes de índice, utilize a opção consulta OData $select :
GET /indexes?api-version=2020-06-30&$select=name
Neste caso, a resposta do exemplo acima seria apresentada da seguinte forma:
{
"value": [
{"name": "Books"},
{"name": "Games"},
...
]
}
Esta é uma técnica útil para guardar a largura de banda se tiver muitos índices no seu Serviço de pesquisa.