Documents - Get
Ruft ein Dokument aus dem Index ab.
GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2023-11-01
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2023-11-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
endpoint
|
path | True |
string |
Die Endpunkt-URL des Suchdiensts. |
index
|
path | True |
string |
Der Name des Index. |
key
|
path | True |
string |
Der Schlüssel des abzurufenden Dokuments. |
api-version
|
query | True |
string |
Client-API-Version. |
$select
|
query |
string[] |
Liste der Feldnamen, die für das Dokument abgerufen werden sollen; Alle nicht abgerufenen Felder fehlen im zurückgegebenen Dokument. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Die Verfolgungs-ID, die mit der Anforderung gesendet wurde, um beim Debuggen zu helfen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Lookup |
Antwort mit dem angeforderten Dokument. |
Other Status Codes |
Fehlerantwort. |
Beispiele
SearchIndexGetDocument
Sample Request
GET https://myservice.search.windows.net/indexes('myindex')/docs('1')?$select=docId,title,description&api-version=2023-11-01
Sample Response
{
"description": "Cheapest hotel in town",
"docId": "1",
"title": "Nice Hotel"
}
Definitionen
SearchError
Beschreibt eine Fehlerbedingung für die API.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Einer von einem serverdefiniertem Satz von Fehlercodes. |
details |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
|
message |
string |
Eine lesbare Darstellung des Fehlers. |