Wiki Search Results - Fetch Wiki Search Results

参考

Service:: Search

API Version:: 7.1-preview.1

为搜索请求提供一组结果。

POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/wikisearchresults?api-version=7.1-preview.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1-preview.1”才能使用此版本的 API。

请求正文

名称	类型	说明
$orderBy	SortOption[]	用于对搜索结果进行排序的选项。如果设置为 null，则返回的结果将按相关性排序。如果提供了多个排序选项，则结果将按 OrderBy 中指定的顺序排序。
$skip	integer	要跳过的结果数。
$top	integer	要返回的结果数。
filters	object	要应用的筛选器。如果没有要应用的筛选器，则将其设置为 null。
includeFacets	boolean	在结果中选择分面的标志。默认行为为 false。
searchText	string	搜索文本。

响应

名称	类型	说明
200 OK	WikiSearchResponse	成功的操作

安全性

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

名称	说明
vso.wiki	授予读取 Wiki、Wiki 网页和 Wiki 附件的能力。此外，还授予搜索 Wiki 页面的功能。

示例

Sample Request

HTTP

POST https://almsearch.dev.azure.com/fabrikam/_apis/search/wikisearchresults?api-version=7.1-preview.1

{
  "searchText": "Hello",
  "$skip": 0,
  "$top": 2,
  "filters": {
    "Project": [
      "Search",
      "Release"
    ]
  },
  "$orderBy": null,
  "includeFacets": true
}

Sample Response

Status code:: 200

{
  "count": 1,
  "results": [
    {
      "fileName": "Hello-world.md",
      "path": "/Hello-world.md",
      "collection": {
        "name": "test"
      },
      "project": {
        "id": "9811862e-ec6f-4e94-93bd-91555b51eedd",
        "name": "Release",
        "visibility": null
      },
      "wiki": {
        "id": "9c2aeff2-bab0-43e9-9eaa-bf8283be064b",
        "mappedPath": "/",
        "name": "Release.wiki",
        "version": "wikiMaster"
      },
      "contentId": "70c379b63ffa0795fdbfbc128e5a2818397b7ef8",
      "hits": [
        {
          "fieldReferenceName": "fileNames",
          "highlights": [
            "<highlighthit>Hello</highlighthit>-world.md"
          ]
        },
        {
          "fieldReferenceName": "content",
          "highlights": [
            "<highlighthit>Hello</highlighthit> world"
          ]
        }
      ]
    }
  ],
  "infoCode": 0,
  "facets": {
    "Project": [
      {
        "name": "Search",
        "id": "Search",
        "resultCount": 0
      },
      {
        "name": "Release",
        "id": "Release",
        "resultCount": 1
      }
    ]
  }
}

定义

名称	说明
Collection	定义集合的详细信息。
ProjectReference	定义项目的详细信息。
SortOption	定义如何对结果进行排序。
Wiki	定义 wiki 的详细信息。
WikiHit	在 Wiki 结果的字段中定义匹配的字词。
WikiResult	定义与 Wiki 搜索请求匹配的 Wiki 结果。
WikiSearchRequest	定义 Wiki 搜索请求。
WikiSearchResponse	定义 Wiki 搜索响应项。

Collection

定义集合的详细信息。

名称	类型	说明
name	string	集合的名称。

ProjectReference

定义项目的详细信息。

名称	类型	说明
id	string	项目的 ID。
name	string	项目名称。
visibility	string	项目的可见性。

SortOption

定义如何对结果进行排序。

名称	类型	说明
field	string	应对其执行排序的字段名称。
sortOrder	string	对结果排序 (ASC/DESC) 排序。

Wiki

定义 wiki 的详细信息。

名称	类型	说明
id	string	Wiki 的 ID。
mappedPath	string	Wiki 的映射路径。
name	string	Wiki 的名称。
version	string	Wiki 的版本。

WikiHit

在 Wiki 结果的字段中定义匹配的字词。

名称	类型	说明
fieldReferenceName	string	突出显示的字段的引用名称。
highlights	string[]	字段的匹配/突出显示的代码段。

WikiResult

定义与 Wiki 搜索请求匹配的 Wiki 结果。

名称	类型	说明
collection	Collection	结果文件的集合。
contentId	string	结果文件的 ContentId。
fileName	string	结果文件的名称。
hits	WikiHit[]	突出显示了与搜索请求匹配的字段片段。列表按代码片段的相关性排序。
path	string	结果文件所在的路径。
project	ProjectReference	Wiki 文档的项目详细信息。
wiki	Wiki	结果的 Wiki 信息。

WikiSearchRequest

定义 Wiki 搜索请求。

名称	类型	说明
$orderBy	SortOption[]	用于对搜索结果进行排序的选项。如果设置为 null，则返回的结果将按相关性排序。如果提供了多个排序选项，则结果将按 OrderBy 中指定的顺序排序。
$skip	integer	要跳过的结果数。
$top	integer	要返回的结果数。
filters	object	要应用的筛选器。如果没有要应用的筛选器，则将其设置为 null。
includeFacets	boolean	在结果中选择分面的标志。默认行为为 false。
searchText	string	搜索文本。

WikiSearchResponse

定义 Wiki 搜索响应项。

名称	类型	说明
count	integer	匹配的 Wiki 文档总数。
facets	object	一个字典，该字典针对每个方面存储对象的数组 `Filter` 。
infoCode	integer	指示任何其他信息的数字代码：0 - 正常，1 - 帐户正在重新编制索引，2 - 帐户索引尚未启动，3 - 请求无效，4 - 不支持前缀通配符查询，5 - 不支持代码方面的多字，6 - 正在载入帐户，7 - 正在加入帐户或重新编制索引，8 - 已剪裁为允许的最大值 9 - 正在为分支编制索引， 10 - 未启用分面，11 - 工作项不可访问，19 - 不支持代码类型筛选器的短语查询，20 - 不支持具有代码类型筛选器的通配符查询。任何其他信息代码都用于内部目的。
results	WikiResult[]	最匹配的 Wiki 文档列表。

通过