Code Search Results - Fetch Code Search Results

Reference

Služba:: Search

Verze rozhraní API:: 7.1

Poskytuje sadu výsledků pro hledaný text.

POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/codesearchresults?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.
includeSnippet	boolean	Příznak, který se má ve výsledku rozhodnout pro zahrnutí odpovídajícího fragmentu kódu. Výchozí chování je false.
searchText	string	Hledaný text.

Odpovědi

Name	Typ	Description
200 OK	CodeSearchResponse	ú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.code	Uděluje možnost číst zdrojový kód a metadata o potvrzeních, sadách změn, větvích a dalších artefaktech správy verzí. Umožňuje také prohledávat kód a dostávat oznámení o událostech správy verzí prostřednictvím háků služby.

Příklady

Ukázkový požadavek

HTTP

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

{
  "searchText": "CodeSearchController",
  "$skip": 0,
  "$top": 1,
  "filters": {
    "Project": [
      "MyFirstProject"
    ],
    "Repository": [
      "MyFirstProject"
    ],
    "Path": [
      "/"
    ],
    "Branch": [
      "master"
    ],
    "CodeElement": [
      "def",
      "class"
    ]
  },
  "$orderBy": [
    {
      "field": "filename",
      "sortOrder": "ASC"
    }
  ],
  "includeFacets": true
}

Ukázková odpověď

Stavový kód:: 200

{
  "count": 1,
  "results": [
    {
      "fileName": "CodeSearchController.cs",
      "path": "/CodeSearchController.cs",
      "matches": {
        "content": [
          {
            "charOffset": 1187,
            "length": 20
          },
          {
            "charOffset": 1395,
            "length": 20
          },
          {
            "charOffset": 1686,
            "length": 20
          }
        ],
        "fileName": [
          {
            "charOffset": 0,
            "length": -1
          }
        ]
      },
      "collection": {
        "name": "DefaultCollection"
      },
      "project": {
        "name": "MyFirstProject",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "repository": {
        "name": "MyFirstProject",
        "id": "c1548045-29f6-4354-8114-55ef058be1a3",
        "type": "git"
      },
      "versions": [
        {
          "branchName": "master",
          "changeId": "47e1cc8877baea4b7bb33af803d6cc697914f88b"
        }
      ],
      "contentId": "004898f1ad91c9c2a0f492f2d1174468bc3c84ef"
    }
  ],
  "infoCode": 0,
  "facets": {
    "Project": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 1
      }
    ],
    "Repository": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 1
      }
    ],
    "CodeElement": [
      {
        "name": "Class",
        "id": "class",
        "resultCount": 1
      },
      {
        "name": "Comment",
        "id": "comment",
        "resultCount": 1
      },
      {
        "name": "Definition",
        "id": "def",
        "resultCount": 1
      }
    ]
  }
}

Definice

Name	Description
CodeResult	Definuje výsledek kódu obsahující informace o prohledáných souborech a jeho metadatech.
CodeSearchRequest	Definuje požadavek na vyhledávání kódu.
CodeSearchResponse	Definuje položku odpovědi vyhledávání kódu.
Collection	Definuje podrobnosti o kolekci.
Project	Definuje podrobnosti projektu.
Repository	Definuje podrobnosti o úložišti.
SortOption	Definuje způsob řazení výsledku.
Version	Popisuje podrobnosti týkající se verze výsledného souboru.
VersionControlType	Typ správy verzí výsledného souboru

CodeResult

Objekt

Definuje výsledek kódu obsahující informace o prohledáných souborech a jeho metadatech.

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
matches	object	Slovník pole pro dosažení posunů ve výsledném souboru Klíč identifikuje oblast, ve které byly nalezeny přístupy, například obsah souboru nebo název souboru atd.
path	string	Cesta, ve které je k dispozici výsledný soubor.
project	Project	Projekt výsledného souboru
repository	Repository	Úložiště výsledného souboru.
versions	Version[]	Verze výsledného souboru.

CodeSearchRequest

Objekt

Definuje požadavek na vyhledávání kódu.

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.
includeSnippet	boolean	Příznak, který se má ve výsledku rozhodnout pro zahrnutí odpovídajícího fragmentu kódu. Výchozí chování je false.
searchText	string	Hledaný text.

CodeSearchResponse

Objekt

Definuje položku odpovědi vyhledávání kódu.

Name	Typ	Description
count	integer (int32)	Celkový počet odpovídajících souborů
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	CodeResult[]	Seznam shodných souborů

Collection

Objekt

Definuje podrobnosti o kolekci.

Name	Typ	Description
name	string	Název kolekce.

Project

Objekt

Definuje podrobnosti projektu.

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

Repository

Objekt

Definuje podrobnosti o úložišti.

Name	Typ	Description
id	string	ID úložiště.
name	string	Název úložiště.
type	VersionControlType	Typ správy verzí výsledného souboru

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.

Version

Objekt

Popisuje podrobnosti týkající se verze výsledného souboru.

Name	Typ	Description
branchName	string	Název větve
changeId	string	ChangeId v dané větvi přidružené k této shodě.

VersionControlType

Výčet

Typ správy verzí výsledného souboru

Hodnota	Description
custom	Pro interní použití.
git
tfvc

Sdílet prostřednictvím

Code Search Results - Fetch Code 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

CodeResult

CodeSearchRequest

CodeSearchResponse

Collection

Project

Repository

SortOption

Version

VersionControlType

Další materiály