SearchClient.GetDocument<T> Methode

Referenz

Definition

Namespace:: Azure.Search.Documents

Assembly:: Azure.Search.Documents.dll

Paket:: Azure.Search.Documents v11.5.1

Paket:: Azure.Search.Documents v11.6.0-beta.4

Quelle:: SearchClient.cs

Quelle:: SearchClient.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ruft ein Dokument aus Azure Cognitive Search ab. 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. Mit dem Suchvorgang können Sie mehrere Dokumente in einer Anforderung abfragen. Dokument suchen

public virtual Azure.Response<T> GetDocument<T> (string key, Azure.Search.Documents.GetDocumentOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDocument : string * Azure.Search.Documents.GetDocumentOptions * System.Threading.CancellationToken -> Azure.Response<'T>
override this.GetDocument : string * Azure.Search.Documents.GetDocumentOptions * System.Threading.CancellationToken -> Azure.Response<'T>

Public Overridable Function GetDocument(Of T) (key As String, Optional options As GetDocumentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of T)

Typparameter

T

Der .NET-Typ, der dem Indexschema zugeordnet ist. Instanzen dieses Typs können als Dokumente aus dem Index abgerufen werden.

Parameter

key: String

Erforderlich. Ein Zeichenfolgenwert, der jedes Dokument im Index eindeutig identifiziert. Der Schlüssel wird manchmal als Dokument-ID bezeichnet. Weitere Informationen finden Sie unter Benennungsregeln für die Regeln zum Erstellen gültiger Dokumentschlüssel.

options: GetDocumentOptions

Optionen zum Anpassen des Vorgangsverhaltens.

cancellationToken: CancellationToken

Optional CancellationToken zur Weitergabe von Benachrichtigungen, dass der Vorgang abgebrochen werden soll.

Gibt zurück

Response<T>

Das Dokument, das dem keyentspricht.

Ausnahmen

RequestFailedException

Wird ausgelöst, wenn ein Fehler vom Suchdienst zurückgegeben wird.

Hinweise

Die generischen Überladungen der Methoden und unterstützen die GetDocument<T>(String, GetDocumentOptions, CancellationToken) Zuordnung von Azure Search-Feldtypen zu .NET-Typen über den Typparameter T.GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) Beachten Sie, dass alle Suchfeldtypen mit Ausnahme von Auflistungen NULL-Werte zulassen. Daher wird empfohlen, Nullable-Typen für die Eigenschaften von Tzu verwenden. Weitere Informationen finden Sie unter GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken).

Gilt für: