Wiki Search Results - Fetch Wiki Search Results

Reference

Služba:: Search

Verze rozhraní API:: 7.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

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. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.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 zadáno více možností řazení, výsledky se seřadí v pořadí uvedeném v orderBy.
$skip	integer (int32)	Počet výsledků, které se mají přeskočit
$top	integer (int32)	Počet vrácených výsledků
filters	object	Filtry, které se mají použít. Pokud nejsou použity žádné filtry, nastavte ho na hodnotu null.
includeFacets	boolean	Příznak, který se má ve výsledku rozhodnout pro 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

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

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

Příklady

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:: 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 o kolekci.
ProjectReference	Definuje podrobnosti projektu.
SortOption	Definuje způsob řazení výsledku.
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 hledání wikiwebu.
WikiSearchRequest	Definuje žádost o vyhledávání wikiwebu.
WikiSearchResponse	Definuje položku odpovědi hledání wikiwebu.

Collection

Objekt

Definuje podrobnosti o kolekci.

Name	Typ	Description
name	string	Název kolekce.

ProjectReference

Objekt

Definuje podrobnosti projektu.

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

SortOption

Objekt

Definuje způsob řazení výsledku.

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 se mají výsledky řadit.

Wiki

Objekt

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

Objekt

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

Objekt

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

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í odpovídajících hledanému požadavku Seznam se seřadí podle relevance fragmentů kódu.
path	string	Cesta, ve které je k dispozici výsledný soubor.
project	ProjectReference	Podrobnosti o projektu dokumentu wikiwebu
wiki	Wiki	Informace wikiwebu pro výsledek

WikiSearchRequest

Objekt

Definuje žádost o 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 zadáno více možností řazení, výsledky se seřadí v pořadí uvedeném v orderBy.
$skip	integer (int32)	Počet výsledků, které se mají přeskočit
$top	integer (int32)	Počet vrácených výsledků
filters	object	Filtry, které se mají použít. Pokud nejsou použity žádné filtry, nastavte ho na hodnotu null.
includeFacets	boolean	Příznak, který se má ve výsledku rozhodnout pro fazetu. Výchozí chování je false.
searchText	string	Hledaný text.

WikiSearchResponse

Objekt

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

Name	Typ	Description
count	integer (int32)	Celkový počet odpovídajících dokumentů wikiwebu
facets	object	Slovník, který ukládá pole `Filter` objektu proti jednotlivým omezujícím vlastnostem.
infoCode	integer (int32)	Číselný kód označující všechny další informace: 0 – OK, 1 – Účet se přeindexuje, 2 – Indexování účtů se nespustilo, 3 – Neplatný požadavek, 4 – Nepodporovaný dotaz se zástupnými znamény předponou, 5 – MultiWords s nepodporovanou omezující vlastností kódu, 6 – Účet je onboardovaný, 7 – Účet se připojuje nebo přeindexuje, 8 – Horní hodnota se ořízla na maximální povolenou hodnotu 9 – Větve se indexují, 10 – Fazeta není povolená, 11 – Pracovní položky nejsou přístupné, 19 – Dotazy frází s nepodporovanými filtry typu kódu, 20 – Dotazy se zástupnými cardy s filtry typu kódu se nepodporují. Jakýkoli jiný informační kód se používá pro interní účely.
results	WikiResult[]	Seznam dokumentů wikiwebu s nejvyššími shodami

Sdílet prostřednictvím

Wiki Search Results - Fetch Wiki Search Results

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

oauth2

Rozsahy

Příklady

Ukázkový požadavek

Ukázková odpověď

Definice

Collection

ProjectReference

SortOption

Wiki

WikiHit

WikiResult

WikiSearchRequest

WikiSearchResponse