Wiki Search Results - Fetch Wiki Search Results

リファレンス

Service:: Search

API Version:: 5.0-preview.1

検索要求の結果のセットを提供します。

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

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '5.0-preview.1' に設定する必要があります。

要求本文

名前	型	説明
$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=5.0-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 - OK、1 - アカウントのインデックス再作成中、2 - アカウントのインデックス作成が開始されていません、3 - 無効な要求、4 - プレフィックスワイルドカードクエリがサポートされていません、5 - コードファセットがサポートされていないマルチワード、6 - アカウントがオンボード中、7 - アカウントがオンボードまたはインデックス再作成中、8 - maxresult にトリミングされた最上位値が 9 - ブランチがインデックス付けされています、 10 - ファセットが有効になっていない、11 - 作業項目にアクセスできない、19 - コード型フィルターがサポートされていないフレーズクエリ、20 - コード型フィルターがサポートされていないワイルドカードクエリ。その他の情報コードは、内部目的で使用されます。
results	WikiResult[]	一致した上位 Wiki ドキュメントの一覧。