Code Search Results - Fetch Code Search Results

Odwołanie

Service:: Search

API Version:: 7.1-preview.1

Zawiera zestaw wyników dla tekstu wyszukiwania.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path		string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "7.1-preview.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
$orderBy	SortOption[]	Opcje sortowania wyników wyszukiwania. W przypadku ustawienia wartości null wyniki zostaną zwrócone posortowane według istotności. Jeśli podano więcej niż jedną opcję sortowania, wyniki są sortowane w kolejności określonej w kolumnie OrderBy.
$skip	integer	Liczba wyników, które mają zostać pominięte.
$top	integer	Liczba wyników do zwrócenia.
filters	object	Filtry do zastosowania. Ustaw wartość null, jeśli nie ma żadnych filtrów do zastosowania.
includeFacets	boolean	Flaga, aby wybrać aspekty w wyniku. Domyślne zachowanie to fałsz.
includeSnippet	boolean	Flaga, która ma zdecydować się na dołączenie pasowanego fragmentu kodu w wyniku. Domyślne zachowanie to fałsz.
searchText	string	Tekst wyszukiwania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CodeSearchResponse	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.code	Umożliwia odczytywanie kodu źródłowego i metadanych dotyczących zatwierdzeń, zestawów zmian, gałęzi i innych artefaktów kontroli wersji. Umożliwia również wyszukiwanie kodu i otrzymywanie powiadomień o zdarzeniach kontroli wersji za pośrednictwem punktów zaczepienia usługi.

Przykłady

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

Definicje

Nazwa	Opis
CodeResult	Definiuje wynik kodu zawierający informacje o przeszukanych plikach i jego metadanych.
CodeSearchRequest	Definiuje żądanie wyszukiwania kodu.
CodeSearchResponse	Definiuje element odpowiedzi wyszukiwania kodu.
Collection	Definiuje szczegóły kolekcji.
Project	Definiuje szczegóły projektu.
Repository	Definiuje szczegóły repozytorium.
SortOption	Definiuje sposób sortowania wyniku.
Version	Opisuje szczegóły dotyczące wersji pliku wynikowego.
VersionControlType	Typ kontroli wersji pliku wynikowego.

CodeResult

Definiuje wynik kodu zawierający informacje o przeszukanych plikach i jego metadanych.

Nazwa	Typ	Opis
collection	Collection	Kolekcja pliku wyników.
contentId	string	ContentId pliku wyników.
fileName	string	Nazwa pliku wynikowego.
matches	object	Słownik pól do trafienia przesunięcia w pliku wynikowym. Klucz identyfikuje obszar, w którym znaleziono trafienia, na przykład: zawartość pliku/nazwa pliku itp.
path	string	Ścieżka, w której znajduje się plik wyników.
project	Project	Projekt pliku wyników.
repository	Repository	Repozytorium pliku wyników.
versions	Version[]	Wersje pliku wyników.

CodeSearchRequest

Definiuje żądanie wyszukiwania kodu.

Nazwa	Typ	Opis
$orderBy	SortOption[]	Opcje sortowania wyników wyszukiwania. W przypadku ustawienia wartości null wyniki zostaną zwrócone posortowane według istotności. Jeśli podano więcej niż jedną opcję sortowania, wyniki są sortowane w kolejności określonej w kolumnie OrderBy.
$skip	integer	Liczba wyników, które mają zostać pominięte.
$top	integer	Liczba wyników do zwrócenia.
filters	object	Filtry do zastosowania. Ustaw wartość null, jeśli nie ma żadnych filtrów do zastosowania.
includeFacets	boolean	Flaga, aby wybrać aspekty w wyniku. Domyślne zachowanie to fałsz.
includeSnippet	boolean	Flaga, która ma zdecydować się na dołączenie pasowanego fragmentu kodu w wyniku. Domyślne zachowanie to fałsz.
searchText	string	Tekst wyszukiwania.

CodeSearchResponse

Definiuje element odpowiedzi wyszukiwania kodu.

Nazwa	Typ	Opis
count	integer	Łączna liczba pasowanych plików.
facets	object	Słownik przechowując tablicę obiektów względem każdego aspektu `Filter` .
infoCode	integer	Kod liczbowy wskazujący dodatkowe informacje: 0 — Ok, 1 — Konto jest ponownie indeksowane, 2 — Indeksowanie konta nie zostało uruchomione, 3 — Nieprawidłowe żądanie, 4 — Kwerenda wieloznaczna prefiksu nie jest obsługiwana, 5 — MultiWords z nieobsługiwanym aspektem kodu, 6 — Konto jest dołączane, 7 — Konto jest dołączane lub ponownie indeksowane, 8 — Maksymalna wartość przycinana do maksymalnego limitresultu dozwolonego 9 — Gałęzie są indeksowane, 10 — Nie włączono tworzenia aspektów, 11 — elementy robocze nie są dostępne, 19 — zapytania fraz z filtrami typów kodu nieobsługiwane, 20 — zapytania z symbolami wieloznacznymi z filtrami typów kodu nieobsługiwane. Każdy inny kod informacyjny jest używany do użytku wewnętrznego.
results	CodeResult[]	Lista pasowanych plików.

Collection

Definiuje szczegóły kolekcji.

Nazwa	Typ	Opis
name	string	Nazwa kolekcji.

Project

Definiuje szczegóły projektu.

Nazwa	Typ	Opis
id	string	Identyfikator projektu.
name	string	Nazwa projektu.

Repository

Definiuje szczegóły repozytorium.

Nazwa	Typ	Opis
id	string	Identyfikator repozytorium.
name	string	Nazwa repozytorium.
type	VersionControlType	Typ kontroli wersji pliku wynikowego.

SortOption

Definiuje sposób sortowania wyniku.

Nazwa	Typ	Opis
field	string	Nazwa pola, dla którego należy przeprowadzić sortowanie.
sortOrder	string	Kolejność (ASC/DESC), w której wyniki powinny być sortowane.

Version

Opisuje szczegóły dotyczące wersji pliku wynikowego.

Nazwa	Typ	Opis
branchName	string	Nazwa gałęzi.
changeId	string	ChangeId w danej gałęzi skojarzonej z tym dopasowaniem.

VersionControlType

Typ kontroli wersji pliku wynikowego.

Nazwa	Typ	Opis
custom	string	Do użytku wewnętrznego.
git	string
tfvc	string

Udostępnij za pośrednictwem