Obter Índice (API REST da Pesquisa de IA do Azure)
A operação Obter Índice obtém a definição de índice da Pesquisa de IA do Azure.
GET https://[service name].search.windows.net/indexes/[index name]?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 e definido pelo utilizador do seu serviço de pesquisa. |
| nome do índice | Obrigatório. O URI do pedido especifica o nome do índice a devolver. |
| api-version | Obrigatório. Veja Versões da API para obter uma lista de versões suportadas. |
Cabeçalhos do 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. Se estiver a utilizar chaves de API, especifique uma chave de administrador (em oposição a uma chave de consulta) para devolver informações do objeto do serviço de pesquisa. Veja 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 obter uma resposta bem-sucedida. Veja o pedido de exemplo JSON em Create Index (API REST da Pesquisa de IA do Azure) para obter um exemplo do payload de resposta. O corpo de resposta Obter Índice e os corpos de resposta e resposta Criar Índice são todos do mesmo formato.