Documents - Get

Service:

Search Service

Version d'API:

2023-10-01-Preview

Récupère un document à partir de l’index.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2023-10-01-Preview

Avec des paramètres facultatifs:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2023-10-01-Preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URL du point de terminaison du service de recherche.
indexName	path	True	string	Nom de l’index.
key	path	True	string	Clé du document à récupérer.
api-version	query	True	string	Version de l’API cliente.
$select	query		string[]	Liste des noms de champs à récupérer pour le document ; Tout champ non récupéré sera manquant dans le document retourné.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string uuid	ID de suivi envoyé avec la demande pour faciliter le débogage.

Réponses

Nom	Type	Description
200 OK	LookupDocument	Réponse contenant le document demandé.
Other Status Codes	SearchError	Réponse d’erreur.

Exemples

SearchIndexGetDocument

Exemple de requête

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs('1')?$select=docId,title,description&api-version=2023-10-01-Preview

Exemple de réponse

Code d’état:

200

{
  "description": "Cheapest hotel in town",
  "docId": "1",
  "title": "Nice Hotel"
}

Définitions

SearchError

Décrit une condition d’erreur pour l’API.

Nom	Type	Description
code	string	Un des ensembles de codes d’erreur définis par le serveur.
details	SearchError[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
message	string	Représentation lisible de l’erreur.