Document de recherche (API REST Azure AI Search)

Article
11/13/2023

L’opération De recherche de document récupère un document à partir d’Azure AI Search. Cela est utile quand un utilisateur clique sur un résultat de recherche en particulier et que vous voulez rechercher des détails spécifiques sur ce document. Vous ne pouvez obtenir qu'un seul document à la fois. Utilisez Rechercher des documents pour obtenir plusieurs documents dans une même requête.

GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]  
  Content-Type: application/json   
  api-key: [admin or query key]

Vous pouvez aussi utiliser la syntaxe traditionnelle OData pour la recherche de clé :

GET /indexes/[index name]/docs('[key]')?[query parameters]

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 la requête spécifie le nom de l'index à interroger. Les paramètres de requête sont spécifiés sur la chaîne de requête pour les requêtes GET et dans le corps de la requête pour les requêtes POST.
key	Obligatoire. Valeur `Edm.String` qui identifie de manière unique chaque document dans l’index. La clé est parfois appelée ID de document. La valeur de la clé respecte la casse. Par exemple, un document avec la clé « abc » est distinct d’un document avec la clé « ABC ».
paramètres de requête	Construction en plusieurs parties qui comprend un `$select` (facultatif) et `api-version=2020-06-30` (obligatoire). Pour cette opération, la version de l'api est spécifiée en tant que paramètre de requête. `$select=[string]` est une liste de champs séparés par des virgules à récupérer. Seuls les champs marqués comme récupérables peuvent être inclus dans cette clause. Si la valeur n'est pas spécifiée ou est `*`, tous les champs marqués comme récupérables dans le schéma sont inclus dans la projection.

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. Une clé API est une chaîne unique générée par le système qui authentifie la demande auprès de votre service de recherche. Les demandes d’obtention d’une définition d’objet doivent inclure un champ api-key défini sur votre clé d’administration (par opposition à une clé de requête). Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé .

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. Une clé API est une chaîne unique générée par le système qui authentifie la demande auprès de votre service de recherche. Les demandes d’obtention d’une définition d’objet doivent inclure un champ api-key défini sur votre clé d’administration (par opposition à une clé de requête). 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.

{   
   field_name: field_value (fields matching the default or specified projection)   
}

Exemples

Rechercher le document qui contient la clé « 2 » :

GET /indexes/hotels/docs/2?api-version=2020-06-30

Rechercher le document qui contient la clé « 3 » à l'aide de la syntaxe OData :

GET /indexes/hotels/docs('3')?api-version=2020-06-30

Partager via