Code Search Results - Fetch Code Search Results

Odwołanie

Usługa:: Search

Wersja interfejsu API:: 7.1

Zawiera zestaw wyników dla tekstu wyszukiwania.

POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/codesearchresults?api-version=7.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. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
$orderBy	SortOption[]	Opcje sortowania wyników wyszukiwania. Jeśli zostanie ustawiona wartość 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 (int32)	Liczba wyników do pominięcia.
$top	integer (int32)	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ć aspektowanie w wyniku. Domyślne zachowanie to fałsz.
includeSnippet	boolean	Flaga, aby wybrać 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

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

Zakresy

Nazwa	Opis
vso.code	Przyznaje możliwość odczytywania 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

Przykładowe żądanie

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
}

Przykładowa odpowiedź

Kod stanu:: 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

Objekt

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 wyników.
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

Objekt

Definiuje żądanie wyszukiwania kodu.

Nazwa	Typ	Opis
$orderBy	SortOption[]	Opcje sortowania wyników wyszukiwania. Jeśli zostanie ustawiona wartość 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 (int32)	Liczba wyników do pominięcia.
$top	integer (int32)	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ć aspektowanie w wyniku. Domyślne zachowanie to fałsz.
includeSnippet	boolean	Flaga, aby wybrać dołączenie pasowanego fragmentu kodu w wyniku. Domyślne zachowanie to fałsz.
searchText	string	Tekst wyszukiwania.

CodeSearchResponse

Objekt

Definiuje element odpowiedzi wyszukiwania kodu.

Nazwa	Typ	Opis
count	integer (int32)	Łączna liczba dopasowanych plików.
facets	object	Słownik przechowującą tablicę obiektów `Filter` względem każdego aspektu.
infoCode	integer (int32)	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 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 wieloznaczne z filtrami typu kodu nieobsługiwane. Każdy inny kod informacyjny jest używany do celów wewnętrznych.
results	CodeResult[]	Lista pasowanych plików.

Collection

Objekt

Definiuje szczegóły kolekcji.

Nazwa	Typ	Opis
name	string	Nazwa kolekcji.

Project

Objekt

Definiuje szczegóły projektu.

Nazwa	Typ	Opis
id	string (uuid)	Identyfikator projektu.
name	string	Nazwa projektu.

Repository

Objekt

Definiuje szczegóły repozytorium.

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

SortOption

Objekt

Definiuje sposób sortowania wyniku.

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

Version

Objekt

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

Wyliczanie

Typ kontroli wersji pliku wynikowego.

Wartość	Opis
custom	Do użytku wewnętrznego.
git
tfvc

Udostępnij przez

Code Search Results - Fetch Code Search Results

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CodeResult

CodeSearchRequest

CodeSearchResponse

Collection

Project

Repository

SortOption

Version

VersionControlType