Code Search Results - Fetch Code Search Results

Ссылка

Service:: Search

API Version:: 7.1-preview.1

Предоставляет набор результатов для текста поиска.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path		string	Идентификатор или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.

Текст запроса

Имя	Тип	Описание
$orderBy	SortOption[]	Параметры сортировки результатов поиска. Если задано значение NULL, результаты будут отсортированы по релевантности. Если задано несколько параметров сортировки, результаты сортируются в порядке, указанном в OrderBy.
$skip	integer	Число пропущенных результатов.
$top	integer	Число возвращаемых результатов.
filters	object	Применяемые фильтры. Присвойте ему значение NULL, если нет фильтров для применения.
includeFacets	boolean	Пометка для выбора аспектов в результате. По умолчанию используется значение false.
includeSnippet	boolean	Флаг для включения совпадаемого фрагмента кода в результат. По умолчанию используется значение false.
searchText	string	Текст, поиск которого необходимо выполнить.

Ответы

Имя	Тип	Описание
200 OK	CodeSearchResponse	успешная операция

Безопасность

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

Имя	Описание
vso.code	Предоставляет возможность чтения исходного кода и метаданных о фиксациях, наборах изменений, ветвях и других артефактах управления версиями. Кроме того, предоставляет возможность поиска кода и получения уведомлений о событиях управления версиями с помощью перехватчиков служб.

Имя

Описание

vso.code

Предоставляет возможность чтения исходного кода и метаданных о фиксациях, наборах изменений, ветвях и других артефактах управления версиями. Кроме того, предоставляет возможность поиска кода и получения уведомлений о событиях управления версиями с помощью перехватчиков служб.

Примеры

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

Определения

Имя	Описание
CodeResult	Определяет результат кода, содержащий сведения о искомых файлах и их метаданных.
CodeSearchRequest	Определяет запрос на поиск кода.
CodeSearchResponse	Определяет элемент ответа поиска кода.
Collection	Определяет сведения о коллекции.
Project	Определяет сведения о проекте.
Repository	Определяет сведения о репозитории.
SortOption	Определяет способ сортировки результата.
Version	Описывает сведения, относящиеся к версии файла результатов.
VersionControlType	Тип управления версиями результирующий файл.

CodeResult

Определяет результат кода, содержащий сведения о искомых файлах и их метаданных.

Имя	Тип	Описание
collection	Collection	Коллекция файла результатов.
contentId	string	ContentId результирующий файл.
fileName	string	Имя файла результатов.
matches	object	Словарь поля для смещений в результирующем файле. Ключ определяет область, в которой были найдены попадания, например: содержимое файла, имя файла и т. д.
path	string	Путь к файлу результатов.
project	Project	Проект результирующий файл.
repository	Repository	Репозиторий файла результатов.
versions	Version[]	Версии файла результатов.

CodeSearchRequest

Определяет запрос на поиск кода.

Имя	Тип	Описание
$orderBy	SortOption[]	Параметры сортировки результатов поиска. Если задано значение NULL, результаты будут отсортированы по релевантности. Если задано несколько параметров сортировки, результаты сортируются в порядке, указанном в OrderBy.
$skip	integer	Число пропущенных результатов.
$top	integer	Число возвращаемых результатов.
filters	object	Применяемые фильтры. Присвойте ему значение NULL, если нет фильтров для применения.
includeFacets	boolean	Пометка для выбора аспектов в результате. По умолчанию используется значение false.
includeSnippet	boolean	Флаг для включения совпадаемого фрагмента кода в результат. По умолчанию используется значение false.
searchText	string	Текст, поиск которого необходимо выполнить.

CodeSearchResponse

Определяет элемент ответа поиска кода.

Имя	Тип	Описание
count	integer	Общее количество сопоставленных файлов.
facets	object	Словарь, в котором хранится массив `Filter` объектов для каждого аспекта.
infoCode	integer	Числовой код, указывающий любые дополнительные сведения: 0 — ОК, 1 — учетная запись переиндексирована, 2 — индексирование учетной записи не началось, 3 — недопустимый запрос, 4 — запрос с подстановочными знаками префикса не поддерживается, 5 — MultiWords с аспектом кода не поддерживается, 6 — учетная запись подключена, 7 — учетная запись подключена или переиндексирована, 8 — максимально допустимое значение, 9 — индексируются ветви; 10 — фасетирование не включено, 11 — рабочие элементы недоступны, 19 — запросы фраз с фильтрами типов кода не поддерживаются, 20 — запросы с подстановочными знаками с фильтрами типов кода не поддерживаются. Любой другой информационный код используется для внутренних целей.
results	CodeResult[]	Список сопоставленных файлов.

Collection

Определяет сведения о коллекции.

Имя	Тип	Описание
name	string	Имя коллекции.

Project

Определяет сведения о проекте.

Имя	Тип	Описание
id	string	Идентификатор проекта.
name	string	Имя проекта.

Repository

Определяет сведения о репозитории.

Имя	Тип	Описание
id	string	Идентификатор репозитория.
name	string	Имя репозитория.
type	VersionControlType	Тип управления версиями результирующий файл.

SortOption

Определяет способ сортировки результата.

Имя	Тип	Описание
field	string	Имя поля, в котором должна выполняться сортировка.
sortOrder	string	Порядок (ASC/DESC), в котором следует отсортировать результаты.

Version

Описывает сведения, относящиеся к версии файла результатов.

Имя	Тип	Описание
branchName	string	Имя ветви.
changeId	string	ChangeId в заданной ветви, связанной с этим совпадением.

VersionControlType

Тип управления версиями результирующий файл.

Имя	Тип	Описание
custom	string	Для внутреннего использования.
git	string
tfvc	string