Obter Índice (API REST do Azure AI Search)
A operação Obter Índice obtém a definição de índice do Azure AI Search.
GET https://[service name].search.windows.net/indexes/[index name]?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. |
| nome do índice | Obrigatórios. O URI de solicitação especifica o nome do índice a ser retornado. |
| api-version | Obrigatórios. Consulte versões de API para obter uma lista de versões com suporte. |
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. Se você estiver usando chaves de API, especifique uma chave de administrador (em vez de uma chave de consulta) para retornar informações de objeto do serviço de pesquisa. 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. Consulte o exemplo de solicitação JSON em Criar Índice (API REST de Pesquisa de IA do Azure) para obter um exemplo do conteúdo da resposta. O corpo da resposta Obter Índice e os corpos de resposta e resposta Criar Índice são todos do mesmo formato.