Code Search Results - Fetch Code Search Results

Layanan:: Search

Versi API:: 7.1

Menyediakan serangkaian hasil untuk teks pencarian.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
project	path		string	ID proyek atau nama proyek
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
$orderBy	SortOption[]	Opsi untuk mengurutkan hasil pencarian. Jika diatur ke null, hasilnya akan dikembalikan diurutkan berdasarkan relevansi. Jika tersedia lebih dari satu opsi pengurutan, hasilnya diurutkan dalam urutan yang ditentukan dalam OrderBy.
$skip	integer (int32)	Jumlah hasil yang akan dilewati.
$top	integer (int32)	Jumlah hasil yang akan dikembalikan.
filters	object	Filter yang akan diterapkan. Atur ke null jika tidak ada filter yang akan diterapkan.
includeFacets	boolean	Bendera untuk memilih faset dalam hasil. Perilaku default adalah false.
includeSnippet	boolean	Bendera untuk memilih menyertakan cuplikan kode yang cocok dalam hasilnya. Perilaku default adalah false.
searchText	string	Teks pencarian.

Respons

Nama	Jenis	Deskripsi
200 OK	CodeSearchResponse	operasi berhasil

Keamanan

oauth2

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL 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

Cakupan

Nama	Deskripsi
vso.code	Memberikan kemampuan untuk membaca kode sumber dan metadata tentang penerapan, set perubahan, cabang, dan artefak kontrol versi lainnya. Juga memberikan kemampuan untuk mencari kode dan mendapatkan pemberitahuan tentang peristiwa kontrol versi melalui kait layanan.

Contoh

Permintaan sampel

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
}

Respon sampel

Kode status:: 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
      }
    ]
  }
}

Definisi

Nama	Deskripsi
CodeResult	Menentukan hasil kode yang berisi informasi file yang dicari dan metadatanya.
CodeSearchRequest	Menentukan permintaan pencarian kode.
CodeSearchResponse	Menentukan item respons pencarian kode.
Collection	Menentukan detail koleksi.
Project	Menentukan detail proyek.
Repository	Menentukan detail repositori.
SortOption	Menentukan cara mengurutkan hasilnya.
Version	Menjelaskan detail yang berkaitan dengan versi file hasil.
VersionControlType	Jenis kontrol versi file hasil.

CodeResult

Objek

Menentukan hasil kode yang berisi informasi file yang dicari dan metadatanya.

Nama	Jenis	Deskripsi
collection	Collection	Kumpulan file hasil.
contentId	string	ContentId dari file hasil.
fileName	string	Nama file hasil.
matches	object	Kamus bidang untuk mencapai offset dalam file hasil. Kunci mengidentifikasi area tempat temuan ditemukan, misalnya: konten file/nama file dll.
path	string	Jalur di mana file hasil ada.
project	Project	Proyek file hasil.
repository	Repository	Repositori file hasil.
versions	Version[]	Versi file hasil.

CodeSearchRequest

Objek

Menentukan permintaan pencarian kode.

Nama	Jenis	Deskripsi
$orderBy	SortOption[]	Opsi untuk mengurutkan hasil pencarian. Jika diatur ke null, hasilnya akan dikembalikan diurutkan berdasarkan relevansi. Jika tersedia lebih dari satu opsi pengurutan, hasilnya diurutkan dalam urutan yang ditentukan dalam OrderBy.
$skip	integer (int32)	Jumlah hasil yang akan dilewati.
$top	integer (int32)	Jumlah hasil yang akan dikembalikan.
filters	object	Filter yang akan diterapkan. Atur ke null jika tidak ada filter yang akan diterapkan.
includeFacets	boolean	Bendera untuk memilih faset dalam hasil. Perilaku default adalah false.
includeSnippet	boolean	Bendera untuk memilih menyertakan cuplikan kode yang cocok dalam hasilnya. Perilaku default adalah false.
searchText	string	Teks pencarian.

CodeSearchResponse

Objek

Menentukan item respons pencarian kode.

Nama	Jenis	Deskripsi
count	integer (int32)	Jumlah total file yang cocok.
facets	object	Kamus yang menyimpan array objek `Filter` terhadap setiap faset.
infoCode	integer (int32)	Kode numerik yang menunjukkan informasi tambahan apa pun: 0 - Ok, 1 - Akun sedang diindeks ulang, 2 - Pengindeksan akun belum dimulai, 3 - Permintaan Tidak Valid, 4 - Kueri wildcard awalan tidak didukung, 5 - MultiWords dengan faset kode tidak didukung, 6 - Akun sedang di-onboarding, 7 - Akun sedang di-onboarding atau diindeks ulang, 8 - Nilai teratas dipangkas ke maxresult yang diizinkan 9 - Cabang sedang diindeks, 10 - Faset tidak diaktifkan, 11 - Item kerja tidak dapat diakses, 19 - Kueri frasa dengan filter jenis kode tidak didukung, 20 - Kueri wildcard dengan filter jenis kode tidak didukung. Kode info lainnya digunakan untuk tujuan internal.
results	CodeResult[]	Daftar file yang cocok.

Collection

Objek

Menentukan detail koleksi.

Nama	Jenis	Deskripsi
name	string	Nama koleksi.

Project

Objek

Menentukan detail proyek.

Nama	Jenis	Deskripsi
id	string (uuid)	Id proyek.
name	string	Nama proyek.

Repository

Objek

Menentukan detail repositori.

Nama	Jenis	Deskripsi
id	string	Id repositori.
name	string	Nama repositori.
type	VersionControlType	Jenis kontrol versi file hasil.

SortOption

Objek

Menentukan cara mengurutkan hasilnya.

Nama	Jenis	Deskripsi
field	string	Nama bidang tempat pengurutan harus dilakukan.
sortOrder	string	Urutan (ASC/DESC) di mana hasilnya harus diurutkan.

Version

Objek

Menjelaskan detail yang berkaitan dengan versi file hasil.

Nama	Jenis	Deskripsi
branchName	string	Nama cabang.
changeId	string	ChangeId di cabang yang diberikan yang terkait dengan kecocokan ini.

VersionControlType

Enumerasi

Jenis kontrol versi file hasil.

Nilai	Deskripsi
git
tfvc
custom	Untuk penggunaan internal.

Saran dan Komentar

Apakah halaman ini membantu?