Listar índices (API REST da Pesquisa de IA do Azure)
A operação Listar Índices retorna uma lista dos índices atualmente em seu serviço 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 de URI
| Parâmetro | Descrição |
|---|---|
| nome do serviço | Obrigatórios. Defina isso como o nome exclusivo definido pelo usuário do serviço de pesquisa. |
| api-version | Obrigatórios. A versão estável atual é api-version=2020-06-30. Consulte Versões de API para obter mais versões. |
Cabeçalhos de solicitação
A tabela a seguir descreve os cabeçalhos de solicitação necessários e opcionais
| Campos | Descrição |
|---|---|
| Tipo de conteúdo | Obrigatórios. Defina-o como application/json |
| chave de API | Opcional se você estiver usando funções do Azure e um token de portador for fornecido na solicitação, caso contrário, uma chave será necessária. Uma chave de api é uma cadeia de caracteres exclusiva gerada pelo sistema que autentica a solicitação para o serviço de pesquisa. Obter solicitações para uma definição de objeto deve incluir um campo api-key definido como sua chave de administrador (em vez de uma chave de consulta). Confira Conectar-se ao Azure AI Search usando a autenticação de chave para obter detalhes. |
Corpo da solicitação
Nenhum.
Resposta
Código de status: "200 OK" é retornado para uma resposta bem-sucedida.
Exemplos
{
"value": [
{
"name": "Books",
"fields": [
{"name": "ISBN", ...},
...
]
},
{
"name": "Games",
...
},
...
]
}
Você pode filtrar a resposta apenas para as propriedades em que está interessado. Por exemplo, se você quiser apenas uma lista de nomes de índice, use a opção de consulta OData $select :
GET /indexes?api-version=2020-06-30&$select=name
Nesse caso, a resposta do exemplo anterior seria exibida da seguinte maneira:
{
"value": [
{"name": "Books"},
{"name": "Games"},
...
]
}
Essa é uma técnica útil para economizar largura de banda se você tiver muitos índices em seu serviço Search.