SearchClient.GetDocument<T> Méthode

Définition

Espace de noms:

Azure.Search.Documents

Assembly:

Azure.Search.Documents.dll

Paquet:

Azure.Search.Documents v11.5.1

Source:

SearchClient.cs

Récupère un document à partir de Recherche cognitive Azure. Cela est utile quand un utilisateur clique sur un résultat de recherche en particulier et que vous voulez rechercher des détails spécifiques sur ce document. Vous ne pouvez obtenir qu'un seul document à la fois. Utilisez Search pour obtenir plusieurs documents dans une requête unique. Recherche de document

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)

Paramètres de type

T

Type .NET mappé au schéma d’index. Les instances de ce type peuvent être récupérées en tant que documents à partir de l’index.

Paramètres

key

String

Obligatoire. Valeur de chaîne qui identifie de manière unique chaque document dans l’index. La clé est parfois appelée ID de document. Consultez Règles de nommage pour connaître les règles de construction de clés de document valides.

options

GetDocumentOptions

Options permettant de personnaliser le comportement de l’opération.

cancellationToken

CancellationToken

Facultatif CancellationToken pour propager des notifications indiquant que l’opération doit être annulée.

Retours

Response<T>

Document correspondant à .key

Exceptions

RequestFailedException

Levée lorsqu’un échec est retourné par le service de recherche.

Remarques

Les surcharges génériques des méthodes et GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) prennent en charge le GetDocument<T>(String, GetDocumentOptions, CancellationToken) mappage des types de champs Recherche Azure aux types .NET via le paramètre Ttype . Notez que tous les types de champs de recherche à l’exception des collections sont nullables. Nous vous recommandons donc d’utiliser des types nullables pour les propriétés de T. Consultez la rubrique GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) (éventuellement en anglais) pour plus d'informations.