Nachschlagedokument (Azure AI Search-REST-API)

  • Artikel

Mit dem Vorgang Dokument suchen wird ein Dokument aus Azure AI Search abgerufen. Dies ist nützlich, wenn ein Benutzer auf ein bestimmtes Suchergebnis klickt und Sie spezifische Details zu diesem Dokument prüfen möchten. Sie können jeweils nur ein Dokument abrufen. Verwenden Sie Dokumente durchsuchen , um mehrere Dokumente in einer einzigen Anforderung abzurufen.

GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]  
  Content-Type: application/json   
  api-key: [admin or query key]

Alternativ können Sie für die Schlüsselsuche die herkömmliche OData-Syntax verwenden:

GET /indexes/[index name]/docs('[key]')?[query parameters]

URI-Parameter

Parameter BESCHREIBUNG
Dienstname Erforderlich. Legen Sie dies auf den eindeutigen, benutzerdefinierten Namen Ihres Suchdiensts fest.
Indexname Erforderlich. Der Anforderungs-URI gibt den Namen des abzufragenden Index an. Abfrageparameter werden in der Abfragezeichenfolge für GET-Anforderungen und im Anforderungstext für POST-Anforderungen angegeben.
Schlüssel Erforderlich. Ein Edm.String Wert, der jedes Dokument im Index eindeutig identifiziert. Der Schlüssel wird manchmal als Dokument-ID bezeichnet. Beim Wert des Schlüssels wird die Groß-/Kleinschreibung beachtet. Ein Dokument mit dem Schlüssel "abc" unterscheidet sich beispielsweise von einem Dokument mit dem Schlüssel "ABC".
Abfrageparameter (query parameters) Eine mehrteilige Konstruktion, die ein $select (optional) und api-version=2020-06-30 (erforderlich) enthält. Für diesen Vorgang wird die API-Version als Abfrageparameter angegeben.
$select=[string] ist eine Liste von durch Trennzeichen getrennten Feldern, die abgerufen werden sollen. Nur Felder, die als abrufbar gekennzeichnet sind, können in diese Klausel aufgenommen werden. Wenn nicht anders angegeben oder auf *gesetzt, werden alle im Schema als abrufbar gekennzeichnete Felder in die Projektion einbezogen.

Anforderungsheader

Die folgende Tabelle beschreibt die erforderlichen und optionalen Anforderungsheader.

Felder BESCHREIBUNG
Content-Type Erforderlich. Auf application/json
api-key Optional, wenn Sie Azure-Rollen verwenden und ein Bearertoken für die Anforderung bereitgestellt wird, andernfalls ist ein Schlüssel erforderlich. Ein API-Schlüssel ist eine eindeutige, vom System generierte Zeichenfolge, die die Anforderung bei Ihrem Suchdienst authentifiziert. Abrufen von Anforderungen für eine Objektdefinition muss ein API-Schlüsselfeld enthalten, das auf Ihren Administratorschlüssel festgelegt ist (im Gegensatz zu einem Abfrageschlüssel). Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Azure AI Search mithilfe der Schlüsselauthentifizierung .

Anforderungstext

Keine.

Antwort

Statuscode: "200 OK" wird für eine erfolgreiche Antwort zurückgegeben.

{   
   field_name: field_value (fields matching the default or specified projection)   
}

Beispiele

Suchen Sie das Dokument mit dem Schlüssel "2":

GET /indexes/hotels/docs/2?api-version=2020-06-30

Suchen Sie das Dokument mit dem Schlüssel "3" mithilfe der OData-Syntax:

GET /indexes/hotels/docs('3')?api-version=2020-06-30

Weitere Informationen