Documents - Get

Service:: Search Service

Version d'API:: 2025-11-01-preview

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

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2025-11-01-preview

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL du point de terminaison du service de recherche.
indexName	path	True	string	Nom de l’index.
key	path	True	string	La clé du document à récupérer.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
$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	Type	Description
Accept	Accept	L’en-tête Accept.
x-ms-query-source-authorization	string	Jeton identifiant l’utilisateur pour lequel la requête est exécutée. Ce jeton est utilisé pour appliquer des restrictions de sécurité sur les documents.
x-ms-enable-elevated-read	boolean	Une valeur qui permet une lecture élevée qui contourne l’autorisation au niveau du document vérifie l’opération de requête.
x-ms-client-request-id	string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Réponses

Nom	Type	Description
200 OK	LookupDocument	La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

api-key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom	Description
https://search.azure.com/.default

Exemples

SearchIndexGetDocument

Exemple de requête

HTTP

GET https://previewexampleservice.search.windows.net/indexes('preview-test')/docs('1')?api-version=2025-11-01-preview&$select=id,description,name,category,ownerId

Exemple de réponse

Code d’état:: 200

{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

Définitions

Nom	Description
Accept	L’en-tête Accept.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Accept

Énumération

L’en-tête Accept.

Valeur	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Objet

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

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

ErrorDetail

Objet

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

Objet

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.