tipo de recurso searchRequestsearchRequest resource type

Espacio de nombres: microsoft.graphNamespace: microsoft.graph

Importante

Las API de la /beta versión de Microsoft Graph están sujetas a cambios.APIs under the /beta version in Microsoft Graph are subject to change. No se admite el uso de estas API en aplicaciones de producción.Use of these APIs in production applications is not supported. Para determinar si una API está disponible en v 1.0, use el selector de versiones .To determine whether an API is available in v1.0, use the Version selector.

Precaución

Se han cambiado o eliminado, o están en desuso, los nombres de algunas de las propiedades del recurso que se usa para la solicitud y respuesta de la API de Búsqueda de Microsoft.Resources used in a Microsoft Search API request and response have had properties renamed or removed, or are being deprecated. Obtenga más información sobre el desuso.Find more details about the deprecation. Actualice las consultas de las API de búsqueda en las aplicaciones anteriores correspondientes.Update search API queries in any earlier apps accordingly.

Una solicitud de búsqueda con formato en un BLOB JSON.A search request formatted in a JSON blob.

El objeto binario JSON contiene los tipos de recursos esperados en la respuesta, los orígenes subyacentes, los parámetros de paginación, las opciones de ordenación, las agregaciones y los campos solicitados y la consulta de búsqueda real.The JSON blob contains the types of resources expected in the response, the underlying sources, paging parameters, sort options, requested aggregations and fields, and actual search query. Vea ejemplos de solicitudes de búsqueda en varios recursos.See examples of search requests on various resources.

Nota

Tenga en cuenta las limitaciones conocidas de la búsqueda de combinaciones específicas de tipos de entidades y la ordenación o adición de los resultados de la búsqueda.Be aware of known limitations on searching specific combinations of entity types, and sorting or aggregating search results.

PropiedadesProperties

PropiedadProperty TipoType DescripciónDescription
agregacionesaggregations colección aggregationOptionaggregationOption collection Especifica las agregaciones (también conocidas como refinadores) que se van a devolver junto con los resultados de la búsqueda.Specifies aggregations (also known as refiners) to be returned alongside search results. Opcional.Optional.
aggregationFiltersaggregationFilters Colección de cadenasString collection Contiene uno o más filtros para obtener los resultados de la búsqueda agregados y filtrados a un valor específico de un campo.Contains one or more filters to obtain search results aggregated and filtered to a specific value of a field. Opcional.Optional.
Cree este filtro a partir de una búsqueda anterior que agregue por el mismo campo.Build this filter based on a prior search that aggregates by the same field. A partir de la respuesta de la búsqueda anterior, identifique el searchBucket que filtra los resultados por el valor específico del campo, use la cadena en su propiedad aggregationFilterToken y cree una cadena de filtro de agregación con el formato "{Field}: \ " {aggregationFilterToken} \ "".From the response of the prior search, identify the searchBucket that filters results to the specific value of the field, use the string in its aggregationFilterToken property, and build an aggregation filter string in the format "{field}:\"{aggregationFilterToken}\"".
Por ejemplo, la búsqueda y adición de elementos de unidad por tipo de archivo devuelve una searchBucket para el tipo docx de archivo en la respuesta.For example, searching and aggregating drive items by file type returns a searchBucket for the file type docx in the response. Puede usar de forma cómoda el aggregationFilterToken devuelto para este searchBucket en una consulta de búsqueda posterior y las coincidencias de filtro para controlar los elementos del docx tipo de archivo.You can conveniently use the aggregationFilterToken returned for this searchBucket in a subsequent search query and filter matches down to drive items of the docx file type. El ejemplo 1 y el ejemplo 2 muestran las solicitudes y respuestas reales.Example 1 and example 2 show the actual requests and responses.
contentSourcescontentSources Colección de cadenasString collection Contiene la conexión que se va a usar como destino.Contains the connection to be targeted.
Respeta el siguiente formato: /external/connections/connectionid donde connectionid es la ConnectionId definida en la administración de conectores.Respects the following format : /external/connections/connectionid where connectionid is the ConnectionId defined in the Connectors Administration.
Nota: contentSource solo es aplicable cuando entityType = externalItem .Note : contentSource is only applicable when entityType=externalItem. Opcional.Optional.
enableTopResultsenableTopResults BooleanBoolean Esto desencadena la ordenación híbrida para los mensajes: los 3 primeros mensajes son los más relevantes.This triggers hybrid sort for messages : the first 3 messages are the most relevant. Esta propiedad solo se aplica a entityType = message .This property is only applicable to entityType=message. Opcional.Optional.
entityTypesentityTypes colección entityTypeentityType collection Uno o más tipos de recursos que se esperaban en la respuesta.One or more types of resources expected in the response. Los valores posibles son: list, site, listItem, message, event, drive, driveItem y externalItem.Possible values are: list, site, listItem, message, event, drive, driveItem, externalItem. Vea las limitaciones conocidas para las combinaciones de dos o más tipos de entidad que se admiten en la misma solicitud de búsqueda.See known limitations for those combinations of two or more entity types that are supported in the same search request. Necesario.Required.
fieldsfields Colección de cadenasString collection Contiene los campos que se van a devolver para cada objeto Resource especificado en entityTypes, lo que permite personalizar los campos devueltos de forma predeterminada, incluidos campos adicionales como propiedades administradas personalizadas de SharePoint y OneDrive, o campos personalizados de externalItem del contenido recopilados por los conectores de Graph.Contains the fields to be returned for each resource object specified in entityTypes, allowing customization of the fields returned by default otherwise, including additional fields such as custom managed properties from SharePoint and OneDrive, or custom fields in externalItem from content ingested by Graph connectors. Opcional.Optional.
fromfrom Int32Int32 Especifica el desplazamiento para los resultados de la búsqueda.Specifies the offset for the search results. El desplazamiento 0 devuelve el primer resultado.Offset 0 returns the very first result. Opcional.Optional.
consultaquery searchQuerysearchQuery Contiene los términos de la consulta.Contains the query terms. Necesario.Required.
sizesize Int32Int32 Tamaño de la página que se va a recuperar.The size of the page to be retrieved. Opcional.Optional.
sortPropertiessortProperties colección SortPropertysortProperty collection Contiene la colección ordenada de campos y dirección para ordenar los resultados.Contains the ordered collection of fields and direction to sort results. Puede haber como máximo 5 propiedades de ordenación en la colección.There can be at most 5 sort properties in the collection. Opcional.Optional.
stored_fields (en desuso)stored_fields (deprecated) Colección de cadenasString collection Ahora se ha reemplazado por la propiedad Fields .This is now replaced by the fields property.

Representación JSONJSON representation

Esta es una representación JSON del recurso.The following is a JSON representation of the resource.

{
  "entityTypes": ["String"],
  "contentSources": ["String"],
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "from": 1024,
  "size": 1024,
  "fields": ["String"],
  "sortProperties": [{"@odata.type": "microsoft.graph.sortProperty"}],
  "aggregations": [{"@odata.type": "microsoft.graph.aggregationOption"}],
  "aggregationFilters": ["String"],
  "enableTopResults": true  
}

Vea tambiénSee also