Obtenir l’index (API REST Azure AI Search)
L’opération Obtenir l’index obtient la définition d’index à partir d’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]
Paramètres URI
| Paramètre | Description |
|---|---|
| nom du service | Obligatoire. Définissez cette valeur sur le nom unique défini par l’utilisateur de votre service de recherche. |
| nom de l'index | Obligatoire. L’URI de requête spécifie le nom de l’index à retourner. |
| api-version | Obligatoire. Pour obtenir la liste des versions prises en charge, consultez Versions d’API . |
En-têtes de requête
Le tableau suivant décrit les en-têtes de demande obligatoires et facultatifs.
| Champs | Description |
|---|---|
| Content-Type | Obligatoire. À définir avec la valeur application/json |
| api-key | Facultatif si vous utilisez des rôles Azure et qu’un jeton de porteur est fourni sur la demande, sinon une clé est requise. Si vous utilisez des clés API, spécifiez une clé d’administration (par opposition à une clé de requête) pour renvoyer des informations d’objet à partir du service de recherche. Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé . |
Corps de la demande
Aucun.
response
Code d’état : « 200 OK » est retourné pour une réponse réussie. Pour obtenir un exemple de charge utile de réponse, consultez l’exemple JSON de requête dans Créer un index (API REST Recherche Azure AI). Le corps de réponse Get Index et les corps de réponse Créer un index et de réponse sont tous au même format.