Documents - Get

Service:

Search Service

Version d'API:

2024-07-01

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

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2024-07-01

Avec des paramètres facultatifs:

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

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é est 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	ErrorResponse	Réponse d’erreur.

Exemples

SearchIndexGetDocument

Exemple de requête

HTTP

GET https://exampleservice.search.windows.net/indexes('getdocumentexample')/docs('1')?$select=docId,title,description&api-version=2024-07-01

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.