searchRequest 资源类型

项目
04/06/2022

命名空间：microsoft.graph

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。不支持在生产应用程序中使用这些 API。若要确定 API 是否在 v1.0 中可用，请使用版本选择器。

注意

Microsoft Search API 请求和响应中使用的资源已重命名或删除了属性或者已被弃用。查找有关过时的更多详细信息。相应更新任何早期应用中的搜索 API 查询。

JSON blob 中格式化的搜索请求。

JSON blob 包含响应中预期的资源类型、基础源、分页参数、排序选项、请求的聚合和字段以及实际搜索查询。请参阅各种资源上的搜索请求示例。

备注

请注意搜索实体类型的特定组合以及排序或聚合搜索结果的已知限制。

属性

属性	类型	说明
聚合	aggregationOption 集合	指定聚合 (也称为) 搜索结果一起返回的精简条件。可选。
aggregationFilters	String collection	包含一个或多个筛选器，用于获取聚合的搜索结果并按字段的特定值进行筛选。可选。基于之前按同一字段聚合的搜索生成此筛选器。从之前搜索的响应中，确定将结果筛选为字段的特定值的 searchBucket ，在其 aggregationFilterToken 属性中使用该字符串，并生成格式为 "{field}：\"{aggregationFilterToken}\" 的聚合筛选器字符串。如果需要为同一字段提供多个值，请使用其 aggregationFilterToken 属性中的字符串，并生成格式为 "{field}：或 (\"{aggregationFilterToken1}\"，\"{aggregationFilterToken2}\") "的聚合筛选器字符串。例如，按文件类型搜索和聚合驱动器项在响应中返回文件类型的 searchBucket`docx`。可以在后续搜索查询中方便地使用此 searchBucket `docx` 返回的 aggregationFilterToken，筛选器向下筛选文件类型的驱动器项。示例 1 和示例 2 显示实际请求和响应。
contentSources	String collection	包含要定向的连接。遵循以下格式： `/external/connections/connectionid` 其中 `connectionid` 是连接器管理中定义的 ConnectionId。注意：contentSource 仅在 entityType=时适用`externalItem`。可选。
enableTopResults	Boolean	这将触发邮件的混合排序：前 3 个邮件最相关。此属性仅适用于 entityType=`message`。可选。
entityTypes	entityType 集合	响应中预期的一种或多种资源类型。可取值为：`list`、`site`、`listItem`、`message`、`event`、`drive`、`driveItem`、`person`、`externalItem`。有关同一搜索请求中支持的两个或多个实体类型的组合，请参阅已知限制。必需项。
fields	String collection	包含为 entityTypes 中指定的每个资源对象返回的字段，从而允许自定义默认情况下返回的字段，包括其他字段（如 SharePoint 和 OneDrive 中的自定义托管属性）或 microsoft Graph 连接器引入的内容中的 externalItem 中的自定义字段。 fields 属性可以使用应用于属性的语义标签。例如，如果属性标记为 title，可以使用以下语法检索它：label_title。可选。
起始数量	Int32	指定搜索结果的偏移量。偏移量 0 返回第一个结果。可选。
查询	searchQuery	包含查询词。必需项。
queryAlterationOptions	searchAlterationOptions	提供格式设置为 JSON blob 的查询更改选项，其中包含与拼写更正相关的两个可选标志。可选。
resultTemplateOptions	resultTemplateOption 集合	提供用于呈现连接器搜索结果的搜索结果模板选项。
size	Int32	要检索的页面的大小。可选。
sortProperties	sortProperty 集合	包含排序的字段集合和用于对结果进行排序的方向。集合中最多只能有 5 个排序属性。可选。
trimDuplicates	Boolean	指示是否从搜索结果中SharePoint重复的文件。默认值为 `false`。可选。
stored_fields (弃)	String collection	现在，这将由 fields 属性替换。

JSON 表示形式

下面是资源的 JSON 表示形式。

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

searchRequest 资源类型

属性

JSON 表示形式

另请参阅

反馈