Code Search Results - Fetch Code Search Results

Référence

Service:: Search

API Version:: 7.1-preview.1

Fournit un ensemble de résultats pour le texte de recherche.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path		string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
$orderBy	SortOption[]	Options de tri des résultats de recherche. Si la valeur est null, les résultats sont retournés triés par pertinence. Si plusieurs options de tri sont fournies, les résultats sont triés dans l’ordre spécifié dans OrderBy.
$skip	integer	Nombre de résultats à ignorer.
$top	integer	Nombre de résultats à retourner.
filters	object	Filtres à appliquer. Définissez-la sur null s’il n’y a aucun filtre à appliquer.
includeFacets	boolean	Indicateur permettant d’opter pour la facette dans le résultat. Le comportement par défaut est false.
includeSnippet	boolean	Indicateur permettant d’opter pour l’inclusion d’un extrait de code correspondant dans le résultat. Le comportement par défaut est false.
searchText	string	Texte de la recherche.

Réponses

Nom	Type	Description
200 OK	CodeSearchResponse	opération réussie

Sécurité

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

Nom	Description
vso.code	Accorde la possibilité de lire le code source et les métadonnées sur les commits, les ensembles de modifications, les branches et d’autres artefacts de contrôle de version. Accorde également la possibilité de rechercher du code et d’être informé des événements de contrôle de version via des hooks de service.

Exemples

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

Définitions

Nom	Description
CodeResult	Définit le résultat du code contenant des informations sur les fichiers recherchés et leurs métadonnées.
CodeSearchRequest	Définit une demande de recherche de code.
CodeSearchResponse	Définit un élément de réponse de recherche de code.
Collection	Définit les détails de la collection.
Project	Définit les détails du projet.
Repository	Définit les détails du dépôt.
SortOption	Définit comment trier le résultat.
Version	Décrit les détails relatifs à une version du fichier de résultats.
VersionControlType	Type de contrôle de version du fichier de résultat.

CodeResult

Définit le résultat du code contenant des informations sur les fichiers recherchés et leurs métadonnées.

Nom	Type	Description
collection	Collection	Collection du fichier de résultats.
contentId	string	ContentId du fichier de résultats.
fileName	string	Nom du fichier de résultats.
matches	object	Dictionnaire de champ pour atteindre les décalages dans le fichier de résultats. La clé identifie la zone dans laquelle les accès ont été trouvés, par exemple le contenu du fichier/nom de fichier, etc.
path	string	Chemin d’accès auquel le fichier de résultat est présent.
project	Project	Projet du fichier de résultats.
repository	Repository	Dépôt du fichier de résultats.
versions	Version[]	Versions du fichier de résultats.

CodeSearchRequest

Définit une demande de recherche de code.

Nom	Type	Description
$orderBy	SortOption[]	Options de tri des résultats de recherche. Si la valeur est null, les résultats sont retournés triés par pertinence. Si plusieurs options de tri sont fournies, les résultats sont triés dans l’ordre spécifié dans OrderBy.
$skip	integer	Nombre de résultats à ignorer.
$top	integer	Nombre de résultats à retourner.
filters	object	Filtres à appliquer. Définissez-la sur null s’il n’y a aucun filtre à appliquer.
includeFacets	boolean	Indicateur permettant d’opter pour la facette dans le résultat. Le comportement par défaut est false.
includeSnippet	boolean	Indicateur permettant d’opter pour l’inclusion d’un extrait de code correspondant dans le résultat. Le comportement par défaut est false.
searchText	string	Texte de la recherche.

CodeSearchResponse

Définit un élément de réponse de recherche de code.

Nom	Type	Description
count	integer	Nombre total de fichiers correspondants.
facets	object	Dictionnaire stockant un tableau d’objet `Filter` sur chaque facette.
infoCode	integer	Code numérique indiquant des informations supplémentaires : 0 - Ok, 1 - Le compte est réindexé, 2 - L’indexation du compte n’a pas démarré, 3 - Requête non valide, 4 - Requête générique de préfixe non prise en charge, 5 - MultiWords avec la facette de code non prise en charge, 6 - Compte en cours d’intégration, 7 - Compte en cours d’intégration ou de réindexation, 8 - Valeur supérieure réduite à maxresult autorisé 9 - Branches sont indexées, 10 - Facettes non activées, 11 - Éléments de travail non accessibles, 19 - Requêtes d’expressions avec des filtres de type de code non pris en charge, 20 - Requêtes génériques avec des filtres de type de code non pris en charge. Tout autre code d’informations est utilisé à des fins internes.
results	CodeResult[]	Liste des fichiers correspondants.

Collection

Définit les détails de la collection.

Nom	Type	Description
name	string	Nom de la collection.

Project

Définit les détails du projet.

Nom	Type	Description
id	string	ID du projet.
name	string	Nom du projet.

Repository

Définit les détails du dépôt.

Nom	Type	Description
id	string	ID du dépôt.
name	string	Nom du dépôt.
type	VersionControlType	Type de contrôle de version du fichier de résultat.

SortOption

Définit comment trier le résultat.

Nom	Type	Description
field	string	Nom du champ sur lequel le tri doit être effectué.
sortOrder	string	Ordre (ASC/DESC) dans lequel les résultats doivent être triés.

Version

Décrit les détails relatifs à une version du fichier de résultats.

Nom	Type	Description
branchName	string	Nom de la branche.
changeId	string	ChangeId dans la branche donnée associée à cette correspondance.

VersionControlType

Type de contrôle de version du fichier de résultat.

Nom	Type	Description
custom	string	À usage interne uniquement.
git	string
tfvc	string

Partager via