Documents - Get

Dienst:

Search Service

API-Version:

2023-10-01-Preview

Ruft ein Dokument aus dem Index ab.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
indexName	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 Tracking-ID, die mit der Anforderung gesendet wurde, beim Debuggen zu helfen.

Antworten

Name	Typ	Beschreibung
200 OK	LookupDocument	Antwort, die das angeforderte Dokument enthält.
Other Status Codes	SearchError	Fehlerantwort.

Beispiele

SearchIndexGetDocument

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "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 der vom Server definierten Fehlercodes.
details	SearchError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.