Documents - Get
Récupère un document à partir de l’index.
GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2024-07-01
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2024-07-01
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
URL du point de terminaison du service de recherche. |
index
|
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é. |
Nom | Obligatoire | Type | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
ID de suivi envoyé avec la demande pour faciliter le débogage. |
Nom | Type | Description |
---|---|---|
200 OK |
Lookup |
Réponse contenant le document demandé. |
Other Status Codes |
Réponse d’erreur. |
Exemple de requête
GET https://exampleservice.search.windows.net/indexes('getdocumentexample')/docs('1')?$select=docId,title,description&api-version=2024-07-01
Exemple de réponse
{
"docId": "1",
"title": "Nice Hotel",
"description": "Cheapest hotel in town"
}
Nom | Description |
---|---|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
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. |
Détail de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d’erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur. |