SearchClient.GetDocument<T> Método

Definição

Namespace:

Azure.Search.Documents

Assembly:

Azure.Search.Documents.dll

Pacote:

Azure.Search.Documents v11.5.1

Origem:

SearchClient.cs

Recupera um documento de Azure Cognitive Search. Isso é útil quando um usuário clica em um resultado de pesquisa específico e você deseja pesquisar detalhes específicos sobre esse documento. Você pode obter apenas um documento por vez. Use Pesquisar para obter vários documentos em uma única solicitação. Procurar documento

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)

Parâmetros de tipo

T

O tipo .NET que mapeia para o esquema de índice. Instâncias desse tipo podem ser recuperadas como documentos do índice.

Parâmetros

key

String

Obrigatórios. Um valor de cadeia de caracteres que identifica exclusivamente cada documento no índice. Às vezes, a chave é chamada de ID de documento. Consulte Regras de nomenclatura para as regras para construir chaves de documento válidas.

options

GetDocumentOptions

Opções para personalizar o comportamento da operação.

cancellationToken

CancellationToken

Opcional CancellationToken para propagar notificações de que a operação deve ser cancelada.

Retornos

Response<T>

O documento correspondente ao key.

Exceções

RequestFailedException

Gerada quando uma falha é retornada pelo Serviço de Pesquisa.

Comentários

As sobrecargas genéricas dos métodos e GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) dão suporte ao GetDocument<T>(String, GetDocumentOptions, CancellationToken) mapeamento de tipos de campo do Azure Search para tipos .NET por meio do parâmetro Tde tipo . Observe que todos os tipos de campo de pesquisa, exceto coleções, são anuláveis, portanto, é recomendável usar tipos anuláveis para as propriedades de T. Consulte GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) para obter mais informações.