Wiki Search Results - Fetch Wiki Search Results

Referensi

Service:: Search

API Version:: 7.1-preview.1

Menyediakan serangkaian hasil untuk permintaan pencarian.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
project	path		string	ID proyek atau nama proyek
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.1' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
$orderBy	SortOption[]	Opsi untuk mengurutkan hasil pencarian. Jika diatur ke null, hasilnya akan dikembalikan diurutkan menurut relevansi. Jika lebih dari satu opsi pengurutan disediakan, hasilnya diurutkan dalam urutan yang ditentukan dalam OrderBy.
$skip	integer	Jumlah hasil yang akan dilewati.
$top	integer	Jumlah hasil yang akan dikembalikan.
filters	object	Filter yang akan diterapkan. Atur ke null jika tidak ada filter yang akan diterapkan.
includeFacets	boolean	Bendera untuk memilih faset dalam hasil. Perilaku default adalah false.
searchText	string	Teks pencarian.

Respons

Nama	Jenis	Deskripsi
200 OK	WikiSearchResponse	operasi berhasil

Keamanan

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

Nama	Deskripsi
vso.wiki	Memberikan kemampuan untuk membaca wiki, halaman wiki, dan lampiran wiki. Juga memberikan kemampuan untuk mencari halaman wiki.

Contoh

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
      }
    ]
  }
}

Definisi

Nama	Deskripsi
Collection	Menentukan detail koleksi.
ProjectReference	Menentukan detail proyek.
SortOption	Menentukan cara mengurutkan hasilnya.
Wiki	Mendefinisikan detail wiki.
WikiHit	Menentukan istilah yang cocok di bidang hasil wiki.
WikiResult	Menentukan hasil wiki yang cocok dengan permintaan pencarian wiki.
WikiSearchRequest	Menentukan permintaan pencarian wiki.
WikiSearchResponse	Menentukan item respons pencarian wiki.

Collection

Menentukan detail koleksi.

Nama	Jenis	Deskripsi
name	string	Nama koleksi.

ProjectReference

Menentukan detail proyek.

Nama	Jenis	Deskripsi
id	string	ID proyek.
name	string	Nama proyek.
visibility	string	Visibilitas proyek.

SortOption

Menentukan cara mengurutkan hasilnya.

Nama	Jenis	Deskripsi
field	string	Nama bidang tempat pengurutan harus dilakukan.
sortOrder	string	Urutan (ASC/DESC) di mana hasilnya harus diurutkan.

Wiki

Mendefinisikan detail wiki.

Nama	Jenis	Deskripsi
id	string	Id wiki.
mappedPath	string	Jalur yang dipetakan untuk wiki.
name	string	Nama wiki.
version	string	Versi untuk wiki.

WikiHit

Menentukan istilah yang cocok di bidang hasil wiki.

Nama	Jenis	Deskripsi
fieldReferenceName	string	Nama referensi bidang yang disorot.
highlights	string[]	Cuplikan bidang yang cocok/disorot.

WikiResult

Menentukan hasil wiki yang cocok dengan permintaan pencarian wiki.

Nama	Jenis	Deskripsi
collection	Collection	Kumpulan file hasil.
contentId	string	ContentId dari file hasil.
fileName	string	Nama file hasil.
hits	WikiHit[]	Cuplikan bidang yang disorot yang cocok dengan permintaan pencarian. Daftar diurutkan menurut relevansi cuplikan.
path	string	Jalur di mana file hasil ada.
project	ProjectReference	Detail proyek dokumen wiki.
wiki	Wiki	Informasi Wiki untuk hasilnya.

WikiSearchRequest

Menentukan permintaan pencarian wiki.

Nama	Jenis	Deskripsi
$orderBy	SortOption[]	Opsi untuk mengurutkan hasil pencarian. Jika diatur ke null, hasilnya akan dikembalikan diurutkan menurut relevansi. Jika lebih dari satu opsi pengurutan disediakan, hasilnya diurutkan dalam urutan yang ditentukan dalam OrderBy.
$skip	integer	Jumlah hasil yang akan dilewati.
$top	integer	Jumlah hasil yang akan dikembalikan.
filters	object	Filter yang akan diterapkan. Atur ke null jika tidak ada filter yang akan diterapkan.
includeFacets	boolean	Bendera untuk memilih faset dalam hasil. Perilaku default adalah false.
searchText	string	Teks pencarian.

WikiSearchResponse

Menentukan item respons pencarian wiki.

Nama	Jenis	Deskripsi
count	integer	Jumlah total dokumen wiki yang cocok.
facets	object	Kamus yang menyimpan array `Filter` objek terhadap setiap faset.
infoCode	integer	Kode numerik yang menunjukkan informasi tambahan: 0 - Ok, 1 - Akun sedang diindeks ulang, 2 - Pengindeksan akun belum dimulai, 3 - Permintaan Tidak Valid, 4 - Kueri wildcard awalan tidak didukung, 5 - MultiWords dengan faset kode tidak didukung, 6 - Akun sedang di-onboarding, 7 - Akun sedang di-onboarding atau diindeks ulang, 8 - Nilai teratas dipangkas ke maxresult yang diizinkan 9 - Cabang sedang diindeks, 10 - Faset tidak diaktifkan, 11 - Item kerja tidak dapat diakses, 19 - Kueri frasa dengan filter jenis kode tidak didukung, 20 - Kueri wildcard dengan filter jenis kode tidak didukung. Kode info lainnya digunakan untuk tujuan internal.
results	WikiResult[]	Daftar dokumen wiki yang paling cocok.

Bagikan melalui