searchRequest 资源类型
命名空间：microsoft.graph
在 JSON Blob 中设置格式的搜索请求。
JSON Blob 包含响应中预期的资源类型、基础源、分页参数、排序选项、请求的聚合和字段以及实际搜索查询。 请参阅针对各种资源搜索请求 的示例 。
注意
请注意在搜索特定实体类型组合以及对搜索结果进行排序或聚合方面的 已知限制 。
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| aggregationFilters | 字符串集合 | 包含一个或多个筛选器，用于获取聚合并筛选为字段的特定值的搜索结果。 可选。 基于以前按同一字段聚合的搜索生成此筛选器。 从先前搜索的响应中，标识将结果筛选为字段的特定值的 searchBucket ，在其 aggregationFilterToken 属性中使用字符串，并生成格式 为“{field}：\”{aggregationFilterToken}\“的聚合筛选器字符串。 如果需要为同一字段提供多个值，请使用其 aggregationFilterToken 属性中的字符串，并生成格式为 “{field}：或 (\”{aggregationFilterToken1}\“，\”{aggregationFilterToken2}\“) ”的聚合筛选器字符串。 例如，按文件类型搜索和聚合驱动器项会返回响应中文件类型 docx的 searchBucket。 可以在后续搜索查询中方便地使用此 searchBucket 返回的 aggregationFilterToken，并向下筛选匹配项以驱动文件类型的docx项。
示例 1 和 示例 2 显示了实际的请求和响应。 |
| 聚合 | aggregationOption 集合 | 指定与搜索结果一起返回的聚合 (也称为精简条件) 。 可选。 |
| collapseProperties | collapseProperty 集合 | 包含对折叠结果的字段和限制的有序集合。 可选。 |
| contentSources | 字符串集合 | 包含要面向的连接。 |
| enableTopResults | 布尔值 | 这会触发消息的混合排序：前 3 条消息最相关。 此属性仅适用于 entityType=message。 可选。 |
| entityTypes | entityType 集合 | 响应中预期的一个或多个资源类型。 可取值为：event、message、driveItem、externalItem、site、list、listItem、drive、chatMessage、person、acronym、bookmark。 请注意，必须使用Prefer: include-unknown-enum-members请求标头来获取以下值， (此可演变枚举中的) ：chatMessage、、person、acronymbookmark。 对于同一搜索请求中支持的两种或更多实体类型的组合，请参阅 已知限制 。 必填。 |
| fields | 字符串集合 | 包含要为 entityTypes 中指定的每个资源对象返回的字段，允许自定义默认返回的字段;否则，包括其他字段，例如 SharePoint 和 OneDrive 中的自定义托管属性，或者从 Microsoft Graph 连接器引入的内容中的 externalItem 中的自定义字段。
fields 属性可以使用应用于属性的语义标签。 例如，如果某个属性标记为标题，则可以使用以下语法检索它： label_title。 可选。 |
| 起始数量 | Int32 | 指定搜索结果的偏移量。 偏移量 0 返回第一个结果。 可选。 |
| 查询 | searchQuery | 包含查询词。 必填。 |
| queryAlterationOptions | searchAlterationOptions | JSON Blob 中格式化的查询更改选项，其中包含与拼写更正相关的两个可选标志。 可选。 |
| 地区 | String | 搜索的地理位置。 对于使用应用程序权限的搜索是必需的。 有关详细信息，请参阅 获取区域值。 |
| resultTemplateOptions | resultTemplateOption 集合 | 提供搜索结果模板选项，用于呈现来自连接器的搜索结果。 |
| sharePointOneDriveOptions | sharePointOneDriveOptions | 指示在使用应用程序权限执行搜索时要搜索的内容的类型。 可选。 |
| size | Int32 | 要检索的页面的大小。 最大值为 500。 可选。 |
| sortProperties | sortProperty 集合 | 包含对结果进行排序的字段和方向的有序集合。 集合中最多可以有 5 个排序属性。 可选。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"aggregationFilters": ["String"],
"aggregations": [{"@odata.type": "microsoft.graph.aggregationOption"}],
"collapseProperties": [{"@odata.type": "microsoft.graph.collapseProperty"}],
"enableTopResults": "Boolean",
"entityTypes": ["String"],
"contentSources": ["String"],
"fields": ["String"],
"from": "Int32",
"query": {"@odata.type": "microsoft.graph.searchQuery"},
"queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
"region": "String",
"resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
"sharePointOneDriveOptions": {"@odata.type": "microsoft.graph.sharePointOneDriveOptions"},
"size": "Int32"
}