Code Search Results - Fetch Code Search Results

Referência

Service:: Search

API Version:: 7.1-preview.1

Fornece um conjunto de resultados para o texto da pesquisa.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
project	path		string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
$orderBy	SortOption[]	Opções para classificar os resultados da pesquisa. Se definido como nulo, os resultados serão retornados classificados por relevância. Se mais de uma opção de classificação for fornecida, os resultados serão classificados na ordem especificada em OrderBy.
$skip	integer	Número de resultados a serem ignorados.
$top	integer	Número de resultados a serem retornados.
filters	object	Filtros a serem aplicados. Defina-o como nulo se não houver filtros a serem aplicados.
includeFacets	boolean	Sinalizador para optar pela faceta no resultado. O comportamento padrão é false.
includeSnippet	boolean	Sinalizador para optar por incluir snippet de código correspondente no resultado. O comportamento padrão é false.
searchText	string	O texto de pesquisa.

Respostas

Nome	Tipo	Description
200 OK	CodeSearchResponse	operação bem-sucedida

Segurança

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

Nome	Description
vso.code	Concede a capacidade de ler código-fonte e metadados sobre commits, conjuntos de alterações, branches e outros artefatos de controle de versão. Também concede a capacidade de pesquisar código e ser notificado sobre eventos de controle de versão por meio de ganchos de serviço.

Exemplos

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

Definições

Nome	Description
CodeResult	Define o resultado do código que contém informações dos arquivos pesquisados e seus metadados.
CodeSearchRequest	Define uma solicitação de pesquisa de código.
CodeSearchResponse	Define um item de resposta de pesquisa de código.
Collection	Define os detalhes da coleção.
Project	Define os detalhes do projeto.
Repository	Define os detalhes do repositório.
SortOption	Define como classificar o resultado.
Version	Descreve os detalhes relativos a uma versão do arquivo de resultado.
VersionControlType	Tipo de controle de versão do arquivo de resultado.

CodeResult

Define o resultado do código que contém informações dos arquivos pesquisados e seus metadados.

Nome	Tipo	Description
collection	Collection	Coleção do arquivo de resultado.
contentId	string	ContentId do arquivo de resultado.
fileName	string	Nome do arquivo de resultado.
matches	object	Dicionário de campo para atingir deslocamentos no arquivo de resultado. Key identifica a área na qual foram encontradas ocorrências, por exemplo: conteúdo do arquivo/nome do arquivo etc.
path	string	Caminho no qual o arquivo de resultado está presente.
project	Project	Projeto do arquivo de resultado.
repository	Repository	Repositório do arquivo de resultado.
versions	Version[]	Versões do arquivo de resultado.

CodeSearchRequest

Define uma solicitação de pesquisa de código.

Nome	Tipo	Description
$orderBy	SortOption[]	Opções para classificar os resultados da pesquisa. Se definido como nulo, os resultados serão retornados classificados por relevância. Se mais de uma opção de classificação for fornecida, os resultados serão classificados na ordem especificada em OrderBy.
$skip	integer	Número de resultados a serem ignorados.
$top	integer	Número de resultados a serem retornados.
filters	object	Filtros a serem aplicados. Defina-o como nulo se não houver filtros a serem aplicados.
includeFacets	boolean	Sinalizador para optar pela faceta no resultado. O comportamento padrão é false.
includeSnippet	boolean	Sinalizador para optar por incluir snippet de código correspondente no resultado. O comportamento padrão é false.
searchText	string	O texto de pesquisa.

CodeSearchResponse

Define um item de resposta de pesquisa de código.

Nome	Tipo	Description
count	integer	Número total de arquivos correspondentes.
facets	object	Um dicionário que armazena uma matriz de `Filter` objeto em cada faceta.
infoCode	integer	Código numérico que indica qualquer informação adicional: 0 – Ok, 1 – A conta está sendo reindexada, 2 – A indexação de conta não foi iniciada, 3 – Solicitação Inválida, 4 – Não há suporte para consulta curinga de prefixo, 5 – MultiWords com faceta de código sem suporte, 6 – a conta está sendo integrada, 7 – a conta está sendo integrada ou reindexada, 8 – Valor superior cortado para maxresult permitido 9 – Branches estão sendo indexados, 10 – Faceta não habilitada, 11 – Itens de trabalho não acessíveis, 19 – Consultas de frase com filtros de tipo de código sem suporte, 20 – Consultas curinga com filtros de tipo de código sem suporte. Qualquer outro código de informações é usado para fins internos.
results	CodeResult[]	Lista de arquivos correspondentes.

Collection

Define os detalhes da coleção.

Nome	Tipo	Description
name	string	Nome da coleção.

Project

Define os detalhes do projeto.

Nome	Tipo	Description
id	string	Id do projeto.
name	string	Nome do projeto.

Repository

Define os detalhes do repositório.

Nome	Tipo	Description
id	string	Id do repositório.
name	string	Nome do repositório.
type	VersionControlType	Tipo de controle de versão do arquivo de resultado.

SortOption

Define como classificar o resultado.

Nome	Tipo	Description
field	string	Nome do campo no qual a classificação deve ser feita.
sortOrder	string	Ordem (ASC/DESC) na qual os resultados devem ser classificados.

Version

Descreve os detalhes relativos a uma versão do arquivo de resultado.

Nome	Tipo	Description
branchName	string	Nome do branch.
changeId	string	ChangeId no branch especificado associado a essa correspondência.

VersionControlType

Tipo de controle de versão do arquivo de resultado.

Nome	Tipo	Description
custom	string	Para uso interno.
git	string
tfvc	string

Compartilhar via