searchRequest 资源类型
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
警告
Microsoft Search API 请求和响应中使用的资源已重命名或删除了属性或者已被弃用。 查找有关过时的更多详细信息。 相应更新任何早期应用中的搜索 API 查询。
在 JSON Blob 中设置格式的搜索请求。
JSON Blob 包含响应中预期的资源类型、基础源、分页参数、排序选项、请求的聚合和字段以及实际搜索查询。 请参阅针对各种资源搜索请求 的示例 。
注意
请注意在搜索特定实体类型组合以及对搜索结果进行排序或聚合方面的 已知限制 。
属性
属性 | 类型 | 说明 |
---|---|---|
聚合 | aggregationOption 集合 | 指定与搜索结果一起返回的聚合 (也称为精简条件) 。 可选。 |
aggregationFilters | 字符串集合 | 包含一个或多个筛选器,用于获取聚合并筛选为字段的特定值的搜索结果。 可选。 基于以前按同一字段聚合的搜索生成此筛选器。 从先前搜索的响应中,标识将结果筛选为字段的特定值的 searchBucket ,在其 aggregationFilterToken 属性中使用字符串,并生成格式 为“{field}:\”{aggregationFilterToken}\“的聚合筛选器字符串。 如果需要为同一字段提供多个值,请使用其 aggregationFilterToken 属性中的字符串,并生成格式为 “{field}:或 (\”{aggregationFilterToken1}\“,\”{aggregationFilterToken2}\“) ”的聚合筛选器字符串。 例如,按文件类型搜索和聚合驱动器项会返回响应中文件类型 docx 的 searchBucket。 可以在后续搜索查询中方便地使用此 searchBucket 返回的 aggregationFilterToken,并向下筛选匹配项以驱动文件类型的docx 项。
示例 1 和 示例 2 显示了实际的请求和响应。 |
collapseProperties | collapseProperty 集合 | 包含对折叠结果的字段和限制的有序集合。 可选。 |
contentSources | 字符串集合 | 包含要面向的连接。 遵循以下格式: /external/connections/connectionid 其中 connectionid 是连接器管理中定义的 ConnectionId。 注意:contentSource 仅适用于 entityType= externalItem 。 可选。 |
enableTopResults | 布尔值 | 这会触发消息的混合排序:前 3 条消息最相关。 此属性仅适用于 entityType=message 。 可选。 |
entityTypes | entityType 集合 | 响应中预期的一个或多个资源类型。 可取值为:list 、site 、listItem 、message 、event 、drive 、driveItem 、person 、externalItem 、acronym 、bookmark 、chatMessage 。 有关同一搜索请求中支持的两种或更多实体类型的组合的详细信息,请参阅 已知限制。 必填。 |
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 个排序属性。 可选。 |
trimDuplicates | 布尔值 | 指示是否从搜索结果中剪裁重复的 SharePoint 文件。 默认值为 false 。 可选。 |
已弃用stored_fields () | 字符串集合 | 现在,它已替换为 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"},
"region": "63128164-cbbf-4db4-896c-a7038417019c",
"resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
"sharePointOneDriveOptions": {"@odata.type": "microsoft.graph.sharePointOneDriveOptions"},
"size": 1024,
"sortProperties": [{"@odata.type": "microsoft.graph.sortProperty"}],
"collapseProperties": [{"@odata.type": "microsoft.graph.collapseProperty"}],
"trimDuplicates": false
}
相关内容
- 使用查询模板
- 搜索邮件
- 搜索日历事件
- 搜索人员
- 在 SharePoint 和 OneDrive 中搜索内容 (文件、列表和网站)
- 使用连接器搜索导入的自定义类型
- 排序搜索结果
- 折叠搜索结果
- 剪裁重复搜索结果
- 使用聚合 优化搜索结果
- 使用显示布局
- 在搜索结果中启用拼写更正
- 使用应用程序权限搜索 SharePoint 内容