Code Search Results - Fetch Code Search Results

Reference

Service:: Search

API Version:: 7.1-preview.1

Poskytuje sadu výsledků pro hledaný text.

POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/codesearchresults?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. Aby se tato verze rozhraní API používala, měla by 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říznakem zvolíte faceting ve výsledku. Výchozí chování je false.
includeSnippet	boolean	Příznakem se rozhodnete zahrnout do výsledku odpovídající fragment 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

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.code	Umožňuje čí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 služby Hooks.

Příklady

Sample Request

HTTP

POST https://almsearch.dev.azure.com/fabrikam/_apis/search/codesearchresults?api-version=7.1-preview.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
}

Sample Response

Status code:: 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 hledaných souborech a jejich metadatech.
CodeSearchRequest	Definuje žádost o vyhledávání kódu.
CodeSearchResponse	Definuje položku odpovědi pro vyhledávání kódu.
Collection	Definuje podrobnosti o kolekci.
Project	Definuje podrobnosti projektu.
Repository	Definuje podrobnosti o úložišti.
SortOption	Definuje, jak seřadit výsledek.
Version	Popisuje podrobnosti týkající se verze výsledného souboru.
VersionControlType	Typ správy verzí výsledného souboru.

CodeResult

Definuje výsledek kódu obsahující informace o hledaných souborech a jejich 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, 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

Definuje žádost o 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 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říznakem zvolíte faceting ve výsledku. Výchozí chování je false.
includeSnippet	boolean	Příznakem se rozhodnete zahrnout do výsledku odpovídající fragment kódu. Výchozí chování je false.
searchText	string	Hledaný text.

CodeSearchResponse

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

Name	Typ	Description
count	integer	Celkový počet odpovídajících souborů.
facets	object	Slovník, který ukládá pole `Filter` objektů pro každou omezující vlastnost.
infoCode	integer	Číselný kód označující jakékoli další informace: 0 – OK, 1 – Účet se přeindexuje, 2 – Indexování účtu se nezačne, 3 – Neplatný požadavek, 4 – Dotaz se zástupnými čísly není podporovaný, 5 – MultiWords s nepodporovanou fazetou kódu, 6 – Probíhá onboarding účtu, 7 – účet se nasazuje nebo přeindexuje, 8 – horní hodnota je oříznutá na maximální povolený počet povolených hodnot 9 – větve se indexují, 10 – Fasety nejsou povoleny, 11 – Pracovní položky nejsou přístupné, 19 – Frázové dotazy s filtry typu kódu nejsou podporované, 20 – Dotazy se zástupnými znakůmimi s filtry typu kódu nejsou podporovány. Jakýkoli jiný informační kód se používá k interním účelům.
results	CodeResult[]	Seznam odpovídajících souborů

Collection

Definuje podrobnosti o kolekci.

Name	Typ	Description
name	string	Název kolekce.

Project

Definuje podrobnosti projektu.

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

Repository

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

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.

Version

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

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

Name	Typ	Description
custom	string	Pro interní použití.
git	string
tfvc	string

Sdílet prostřednictvím