SearchClient.GetDocument<T> Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Recupera un documento de Azure Cognitive Search. Esto resulta útil cuando un usuario hace clic en un resultado de búsqueda específico y desea buscar detalles específicos acerca de ese documento. Solamente se puede obtener un documento de cada vez. Utilice Búsqueda para obtener varios documentos en una única solicitud. Buscar 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
Tipo de .NET que se asigna al esquema de índice. Las instancias de este tipo se pueden recuperar como documentos del índice.
Parámetros
- key
- String
Necesario. Valor de cadena que identifica de forma única cada documento del índice. A veces, la clave se conoce como identificador de documento. Consulte Reglas de nomenclatura de las reglas para construir claves de documento válidas.
- options
- GetDocumentOptions
Opciones para personalizar el comportamiento de la operación.
- cancellationToken
- CancellationToken
Opcional CancellationToken para propagar las notificaciones que se deben cancelar en la operación.
Devoluciones
Documento correspondiente a key
.
Excepciones
Se produce cuando el servicio de búsqueda devuelve un error.
Comentarios
Las sobrecargas genéricas de los métodos y GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) admiten la GetDocument<T>(String, GetDocumentOptions, CancellationToken) asignación de tipos de campo de Azure Search a tipos de .NET a través del parámetro T
de tipo . Tenga en cuenta que todos los tipos de campo de búsqueda excepto las colecciones aceptan valores NULL, por lo que se recomienda usar tipos que aceptan valores NULL para las propiedades de T
. Consulte GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) para obtener más información.
Se aplica a
Azure SDK for .NET