Code Search Results - Fetch Code Search Results

Başvuru

Service:: Search

API Version:: 7.1-preview.1

Arama metni için bir sonuç kümesi sağlar.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
organization	path	True	string	Azure DevOps kuruluşunun adı.
project	path		string	Proje Kimliği veya proje adı
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '7.1-preview.1' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
$orderBy	SortOption[]	Arama sonuçlarını sıralama seçenekleri. Null olarak ayarlanırsa, sonuçlar ilgi düzeyine göre sıralanmış olarak döndürülür. Birden fazla sıralama seçeneği sağlanırsa, sonuçlar OrderBy'de belirtilen düzende sıralanır.
$skip	integer	Atlanacak sonuç sayısı.
$top	integer	Döndürülecek sonuç sayısı.
filters	object	Uygulanacak filtreler. Uygulanacak filtre yoksa null olarak ayarlayın.
includeFacets	boolean	Sonuçta model almayı tercih etmek için bayrak. Varsayılan davranış false'tur.
includeSnippet	boolean	Sonuç olarak eşleşen kod parçacığını eklemeyi tercih etmek için bayrak. Varsayılan davranış false'tur.
searchText	string	Arama metni.

Yanıtlar

Name	Tür	Description
200 OK	CodeSearchResponse	başarılı işlem

Güvenlik

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

Name	Description
vso.code	İşlemeler, değişiklik kümeleri, dallar ve diğer sürüm denetimi yapıtları hakkında kaynak kodu ve meta verileri okuma yeteneği verir. Ayrıca kod arama ve hizmet kancaları aracılığıyla sürüm denetimi olayları hakkında bildirim alma olanağı verir.

Örnekler

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

Tanımlar

Name	Description
CodeResult	Arama yapılan dosyaların ve meta verilerinin bilgilerini içeren kod sonucunu tanımlar.
CodeSearchRequest	Bir kod arama isteği tanımlar.
CodeSearchResponse	Kod arama yanıt öğesini tanımlar.
Collection	Koleksiyonun ayrıntılarını tanımlar.
Project	Projenin ayrıntılarını tanımlar.
Repository	Deponun ayrıntılarını tanımlar.
SortOption	Sonucun nasıl sıralanacağını tanımlar.
Version	Sonuç dosyasının bir sürümüyle ilgili ayrıntıları açıklar.
VersionControlType	Sonuç dosyasının sürüm denetimi türü.

CodeResult

Arama yapılan dosyaların ve meta verilerinin bilgilerini içeren kod sonucunu tanımlar.

Name	Tür	Description
collection	Collection	Sonuç dosyasının koleksiyonu.
contentId	string	Sonuç dosyasının ContentId değeri.
fileName	string	Sonuç dosyasının adı.
matches	object	Sonuç dosyasındaki uzaklıklara isabet etmek için alanın sözlüğü. Key, isabetlerin bulunduğu alanı tanımlar, örneğin: dosya içeriği/dosya adı vb.
path	string	Sonuç dosyasının bulunduğu yol.
project	Project	Sonuç dosyasının projesi.
repository	Repository	Sonuç dosyasının deposu.
versions	Version[]	Sonuç dosyasının sürümleri.

CodeSearchRequest

Bir kod arama isteği tanımlar.

Name	Tür	Description
$orderBy	SortOption[]	Arama sonuçlarını sıralama seçenekleri. Null olarak ayarlanırsa, sonuçlar ilgi düzeyine göre sıralanmış olarak döndürülür. Birden fazla sıralama seçeneği sağlanırsa, sonuçlar OrderBy'de belirtilen düzende sıralanır.
$skip	integer	Atlanacak sonuç sayısı.
$top	integer	Döndürülecek sonuç sayısı.
filters	object	Uygulanacak filtreler. Uygulanacak filtre yoksa null olarak ayarlayın.
includeFacets	boolean	Sonuçta model almayı tercih etmek için bayrak. Varsayılan davranış false'tur.
includeSnippet	boolean	Sonuç olarak eşleşen kod parçacığını eklemeyi tercih etmek için bayrak. Varsayılan davranış false'tur.
searchText	string	Arama metni.

CodeSearchResponse

Kod arama yanıt öğesini tanımlar.

Name	Tür	Description
count	integer	Eşleşen dosyaların toplam sayısı.
facets	object	Her modelde bir nesne dizisinin `Filter` depolandığı sözlük.
infoCode	integer	Ek bilgileri gösteren sayısal kod: 0 - Tamam, 1 - Hesap yeniden dizinleniyor, 2 - Hesap dizini oluşturma başlatılmadı, 3 - Geçersiz İstek, 4 - Ön ek joker karakter sorgusu desteklenmiyor, 5 - Kod modelli MultiWords desteklenmiyor, 6 - Hesap ekleniyor, 7 - Hesap ekleniyor veya yeniden dizinleniyor, 8 - Maxresult izin verilen en yüksek değer kırpılıyor 9 - Dallar dizine alınıyor, 10 - Model oluşturma etkin değil, 11 - İş öğeleri erişilebilir değil, 19 - Kod türü filtreleri desteklenmeyen tümcecik sorguları, 20 - Kod türü filtreleri desteklenmeyen joker karakter sorguları. Diğer tüm bilgi kodları dahili amaçla kullanılır.
results	CodeResult[]	Eşleşen dosyaların listesi.

Collection

Koleksiyonun ayrıntılarını tanımlar.

Name	Tür	Description
name	string	Koleksiyonun adı.

Project

Projenin ayrıntılarını tanımlar.

Name	Tür	Description
id	string	Projenin kimliği.
name	string	Projenin adı.

Repository

Deponun ayrıntılarını tanımlar.

Name	Tür	Description
id	string	Deponun kimliği.
name	string	Deponun adı.
type	VersionControlType	Sonuç dosyasının sürüm denetimi türü.

SortOption

Sonucun nasıl sıralanacağını tanımlar.

Name	Tür	Description
field	string	Sıralamanın yapılması gereken alan adı.
sortOrder	string	Sonuçların sıralanması gereken düzen (ASC/DESC).

Version

Sonuç dosyasının bir sürümüyle ilgili ayrıntıları açıklar.

Name	Tür	Description
branchName	string	Dalın adı.
changeId	string	Bu eşleşmeyle ilişkili verilen daldaki ChangeId.

VersionControlType

Sonuç dosyasının sürüm denetimi türü.

Name	Tür	Description
custom	string	dahili kullanım için.
git	string
tfvc	string

Aracılığıyla paylaş