Code Search Results - Fetch Code Search Results

Referencia

Servicio:: Search

Versión de la API:: 7.1

Proporciona un conjunto de resultados para el texto de búsqueda.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	Nombre de la organización de Azure DevOps.
project	path		string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
$orderBy	SortOption[]	Opciones para ordenar los resultados de búsqueda. Si se establece en NULL, los resultados se devolverán ordenados por relevancia. Si se proporciona más de una opción de ordenación, los resultados se ordenan en el orden especificado en OrderBy.
$skip	integer (int32)	Número de resultados que se van a omitir.
$top	integer (int32)	Número de resultados que se van a devolver.
filters	object	Filtros que se van a aplicar. Establézcalo en NULL si no hay ningún filtro que se va a aplicar.
includeFacets	boolean	Marca para optar por la faceta en el resultado. El comportamiento predeterminado es false.
includeSnippet	boolean	Marca para optar por incluir el fragmento de código coincidente en el resultado. El comportamiento predeterminado es false.
searchText	string	Texto de búsqueda.

Respuestas

Nombre	Tipo	Description
200 OK	CodeSearchResponse	operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token: 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

Ámbitos

Nombre	Description
vso.code	Concede la capacidad de leer código fuente y metadatos sobre confirmaciones, conjuntos de cambios, ramas y otros artefactos de control de versiones. También concede la capacidad de buscar código y recibir notificaciones sobre eventos de control de versiones a través de enlaces de servicio.

Ejemplos

Solicitud de ejemplo

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
}

Respuesta de muestra

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

Definiciones

Nombre	Description
CodeResult	Define el resultado del código que contiene información de los archivos buscados y sus metadatos.
CodeSearchRequest	Define una solicitud de búsqueda de código.
CodeSearchResponse	Define un elemento de respuesta de búsqueda de código.
Collection	Define los detalles de la colección.
Project	Define los detalles del proyecto.
Repository	Define los detalles del repositorio.
SortOption	Define cómo ordenar el resultado.
Version	Describe los detalles relativos a una versión del archivo de resultados.
VersionControlType	Tipo de control de versiones del archivo de resultados.

CodeResult

Object

Define el resultado del código que contiene información de los archivos buscados y sus metadatos.

Nombre	Tipo	Description
collection	Collection	Colección del archivo de resultados.
contentId	string	ContentId del archivo de resultados.
fileName	string	Nombre del archivo de resultados.
matches	object	Diccionario de campo para alcanzar desplazamientos en el archivo de resultados. Clave identifica el área en la que se encontraron los aciertos, por ejemplo: contenido de archivo o nombre de archivo, etc.
path	string	Ruta de acceso en la que está presente el archivo de resultados.
project	Project	Proyecto del archivo de resultados.
repository	Repository	Repositorio del archivo de resultados.
versions	Version[]	Versiones del archivo de resultados.

CodeSearchRequest

Object

Define una solicitud de búsqueda de código.

Nombre	Tipo	Description
$orderBy	SortOption[]	Opciones para ordenar los resultados de búsqueda. Si se establece en NULL, los resultados se devolverán ordenados por relevancia. Si se proporciona más de una opción de ordenación, los resultados se ordenan en el orden especificado en OrderBy.
$skip	integer (int32)	Número de resultados que se van a omitir.
$top	integer (int32)	Número de resultados que se van a devolver.
filters	object	Filtros que se van a aplicar. Establézcalo en NULL si no hay ningún filtro que se va a aplicar.
includeFacets	boolean	Marca para optar por la faceta en el resultado. El comportamiento predeterminado es false.
includeSnippet	boolean	Marca para optar por incluir el fragmento de código coincidente en el resultado. El comportamiento predeterminado es false.
searchText	string	Texto de búsqueda.

CodeSearchResponse

Object

Define un elemento de respuesta de búsqueda de código.

Nombre	Tipo	Description
count	integer (int32)	Número total de archivos coincidentes.
facets	object	Diccionario que almacena una matriz de `Filter` objeto en cada faceta.
infoCode	integer (int32)	Código numérico que indica información adicional: 0 - Ok, 1 - Account is being reindexed, 2 - Account indexing has not started, 3 - Invalid Request, 4 - Prefix wildcard query not supported, 5 - MultiWords with code facet not supported, 6 - Account is being onboarded, 7 - Account is being onboarded or reindexed, 8 - Top value trimed to maxresult allowed 9 - Branches are being indexed, 10 - Facetas no habilitadas, 11 - Elementos de trabajo no accesibles, 19 - Consultas de frases con filtros de tipo de código no compatibles, 20 - Consultas con caracteres comodín con filtros de tipo de código no admitidos. Cualquier otro código de información se usa para fines internos.
results	CodeResult[]	Lista de archivos coincidentes.

Collection

Object

Define los detalles de la colección.

Nombre	Tipo	Description
name	string	Nombre de la colección.

Project

Object

Define los detalles del proyecto.

Nombre	Tipo	Description
id	string (uuid)	Id. del proyecto.
name	string	Nombre del proyecto.

Repository

Object

Define los detalles del repositorio.

Nombre	Tipo	Description
id	string	Identificador del repositorio.
name	string	Nombre del repositorio.
type	VersionControlType	Tipo de control de versiones del archivo de resultados.

SortOption

Object

Define cómo ordenar el resultado.

Nombre	Tipo	Description
field	string	Nombre de campo en el que se debe realizar la ordenación.
sortOrder	string	Orden (ASC/DESC) en el que se deben ordenar los resultados.

Version

Object

Describe los detalles relativos a una versión del archivo de resultados.

Nombre	Tipo	Description
branchName	string	Nombre de la rama.
changeId	string	ChangeId en la rama especificada asociada a esta coincidencia.

VersionControlType

Enumeración

Tipo de control de versiones del archivo de resultados.

Valor	Description
custom	Para uso interno.
git
tfvc

Compartir a través de

Code Search Results - Fetch Code Search Results

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

oauth2

Ámbitos

Ejemplos

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CodeResult

CodeSearchRequest

CodeSearchResponse

Collection

Project

Repository

SortOption

Version

VersionControlType