Wiki Search Results - Fetch Wiki Search Results

Reference

Service:: Search

API Version:: 7.1-preview.1

Poskytuje sadu výsledků pro požadavek hledání.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
project	path		string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 7.1-preview.1.

Text požadavku

Name	Typ	Description
$orderBy	SortOption[]	Možnosti řazení výsledků hledání Pokud je nastavená hodnota null, vrátí se výsledky seřazené podle relevance. Pokud je k dispozici více než jedna možnost řazení, výsledky se seřadí v pořadí zadaném v orderBy.
$skip	integer	Počet přeskočených výsledků
$top	integer	Počet vrácených výsledků
filters	object	Filtry, které se mají použít. Pokud neexistují žádné filtry, které by se použily, nastavte hodnotu null.
includeFacets	boolean	Příznak, který ve výsledku zvolí fazetu. Výchozí chování je false.
searchText	string	Hledaný text

Odpovědi

Name	Typ	Description
200 OK	WikiSearchResponse	úspěšná operace

Zabezpečení

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

Name	Description
vso.wiki	Umožňuje číst wikiweby, stránky wikiwebu a přílohy wikiwebu. Uděluje také možnost prohledávat stránky wikiwebu.

Příklady

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

Definice

Name	Description
Collection	Definuje podrobnosti kolekce.
ProjectReference	Definuje podrobnosti projektu.
SortOption	Definuje, jak seřadit výsledek.
Wiki	Definuje podrobnosti wikiwebu.
WikiHit	Definuje odpovídající termíny v poli výsledku wikiwebu.
WikiResult	Definuje výsledek wikiwebu, který odpovídal požadavku wiki vyhledávání.
WikiSearchRequest	Definuje požadavek na vyhledávání wikiwebu.
WikiSearchResponse	Definuje položku odpovědi na hledání wikiwebu.

Collection

Definuje podrobnosti kolekce.

Name	Typ	Description
name	string	Název kolekce.

ProjectReference

Definuje podrobnosti projektu.

Name	Typ	Description
id	string	ID projektu.
name	string	Název projektu
visibility	string	Viditelnost projektu

SortOption

Definuje, jak seřadit výsledek.

Name	Typ	Description
field	string	Název pole, podle kterého se má řazení provést.
sortOrder	string	Pořadí (ASC/DESC), ve kterém by měly být výsledky seřazeny.

Wiki

Definuje podrobnosti wikiwebu.

Name	Typ	Description
id	string	ID wikiwebu
mappedPath	string	Namapovaná cesta pro wikiweb.
name	string	Název wikiwebu
version	string	Verze wikiwebu.

WikiHit

Definuje odpovídající termíny v poli výsledku wikiwebu.

Name	Typ	Description
fieldReferenceName	string	Název odkazu zvýrazněného pole.
highlights	string[]	Odpovídající nebo zvýrazněné fragmenty kódu pole

WikiResult

Definuje výsledek wikiwebu, který odpovídal požadavku wiki vyhledávání.

Name	Typ	Description
collection	Collection	Kolekce výsledného souboru.
contentId	string	ContentId výsledného souboru.
fileName	string	Název výsledného souboru.
hits	WikiHit[]	Zvýrazněné fragmenty polí, které odpovídají požadavku vyhledávání. Seznam je seřazený podle relevance fragmentů kódu.
path	string	Cesta, na které je k dispozici výsledný soubor.
project	ProjectReference	Project details of the wiki document.
wiki	Wiki	Informace o výsledku na wikiwebu

WikiSearchRequest

Definuje požadavek na vyhledávání wikiwebu.

Name	Typ	Description
$orderBy	SortOption[]	Možnosti řazení výsledků hledání Pokud je nastavená hodnota null, vrátí se výsledky seřazené podle relevance. Pokud je k dispozici více než jedna možnost řazení, výsledky se seřadí v pořadí zadaném v orderBy.
$skip	integer	Počet přeskočených výsledků
$top	integer	Počet vrácených výsledků
filters	object	Filtry, které se mají použít. Pokud neexistují žádné filtry, které by se použily, nastavte hodnotu null.
includeFacets	boolean	Příznak, který ve výsledku zvolí fazetu. Výchozí chování je false.
searchText	string	Hledaný text

WikiSearchResponse

Definuje položku odpovědi na hledání wikiwebu.

Name	Typ	Description
count	integer	Celkový počet odpovídajících wiki dokumentů
facets	object	Slovník, který ukládá pole objektu `Filter` pro každou omezující vlastnost.
infoCode	integer	Číselný kód označující jakékoli další informace: 0 – OK, 1 – Probíhá přeindexování účtu, 2 – indexování účtu se nezačne, 3 – neplatný požadavek, 4 – nepodporovaný dotaz se zástupnými čísly, 5 – vícewords s nepodporovanou omezující vlastností kódu, 6 – onboarding účtu, 7 – onboarding nebo přeindexování účtu, 8 – horní hodnota oříznutá na maximální povolený limit 9 – větve se indexují, 10 – Fasetování není povoleno, 11 – Pracovní položky nejsou přístupné, 19 – Dotazy frází s filtry typu kódu nejsou podporovány, 20 – Dotazy se zástupnými znakůýmimi kódy s filtry typu kódu nejsou podporovány. Jakýkoli jiný informační kód se používá pro interní účely.
results	WikiResult[]	Seznam dokumentů wikiwebu s nejvyšším shodným

Sdílet prostřednictvím