Package Search Results - Fetch Package Search Results

Layanan:
Search
Versi API:
7.1

Menyediakan serangkaian hasil untuk teks pencarian.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
organization
 path True

string

Nama organisasi Azure DevOps.
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.
searchText

string

Teks pencarian.

Respons

Nama Jenis Deskripsi
200 OK

PackageSearchResponseContent

operasi berhasil

Header

ActivityId: string

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.packaging Memberikan kemampuan untuk membaca umpan dan paket. Juga memberikan kemampuan untuk mencari paket.

Contoh

Permintaan sampel

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

{
  "$skip": 0,
  "$top": 50,
  "$orderBy": null,
  "includeFacets": true,
  "searchText": "microsoft applicationinsight package",
  "filters": {
    "Feeds": [
      "ApplicationInsights-Team"
    ],
    "View": [
      "local"
    ],
    "ProtocolType": [
      "Nuget",
      "Npm"
    ]
  }
}

Respon sampel

Kode status:
200 
{
  "count": 3,
  "results": [
    {
      "name": "@microsoft/applicationinsights-mezzurite",
      "id": "0adc5b40-8b48-4a42-ac5e-93da78206d27",
      "description": "Logging Extention for Mezzurtie Timing Package",
      "protocolType": "Npm",
      "feeds": [
        {
          "collectionId": "0efb4611-d565-4cd1-9a64-7d6cb6d7d5f0",
          "collectionName": "mseng",
          "feedId": "cd3f7228-b239-4ef5-8d3b-ee9c3bc79bc2",
          "feedName": "ApplicationInsights-Team",
          "packageUrl": "https://dev.azure.com/mseng/_packaging?feed=ApplicationInsights-Team&_a=package&package=@microsoft/applicationinsights-mezzurite&version=1.0.0&protocolType=Npm",
          "latestVersion": "1.0.0",
          "latestMatchedVersion": "1.0.0",
          "views": [
            "local"
          ]
        }
      ],
      "hits": [
        {
          "fieldReferenceName": "name",
          "highlights": [
            "@<highlighthit>microsoft</highlighthit>/<highlighthit>applicationinsights</highlighthit>-mezzurite"
          ]
        },
        {
          "fieldReferenceName": "description",
          "highlights": [
            "Logging Extention for Mezzurtie Timing <highlighthit>Package</highlighthit>"
          ]
        }
      ]
    },
    {
      "name": "Microsoft.ApplicationInsights.Masi.Tracing",
      "id": "5b709505-a14f-4d2c-b172-21f1e6fc0562",
      "description": "The MASI tracing package allowing you to send log messages with activity context to Application Insights and to Windows Azure Diagnostics easily",
      "protocolType": "NuGet",
      "feeds": [
        {
          "collectionId": "0efb4611-d565-4cd1-9a64-7d6cb6d7d5f0",
          "collectionName": "mseng",
          "feedId": "cd3f7228-b239-4ef5-8d3b-ee9c3bc79bc2",
          "feedName": "ApplicationInsights-Team",
          "packageUrl": "https://dev.azure.com/mseng/_packaging?feed=ApplicationInsights-Team&_a=package&package=Microsoft.ApplicationInsights.Masi.Tracing&version=1.0.13.2-build00132-2&protocolType=NuGet",
          "latestVersion": "1.0.13.2-build00132-2",
          "latestMatchedVersion": "1.0.13.2-build00132-2",
          "views": [
            "local"
          ]
        }
      ],
      "hits": [
        {
          "fieldReferenceName": "name",
          "highlights": [
            "<highlighthit>Microsoft</highlighthit>.<highlighthit>ApplicationInsights</highlighthit>.Masi.Tracing"
          ]
        },
        {
          "fieldReferenceName": "description",
          "highlights": [
            "The MASI tracing <highlighthit>package</highlighthit> allowing you to send log messages with activity context to Application"
          ]
        }
      ]
    },
    {
      "name": "Microsoft.ApplicationInsights.Agent.StartupTask",
      "id": "60c357c1-69bf-4c9b-8fe0-a8ad7e50a5f9",
      "description": "Application Insights Agent startup task. This package adds a startup task for installing Application Insights Agent to enable additional Application Insights Telemetry.",
      "protocolType": "NuGet",
      "feeds": [
        {
          "collectionId": "0efb4611-d565-4cd1-9a64-7d6cb6d7d5f0",
          "collectionName": "mseng",
          "feedId": "cd3f7228-b239-4ef5-8d3b-ee9c3bc79bc2",
          "feedName": "ApplicationInsights-Team",
          "packageUrl": "https://dev.azure.com/mseng/_packaging?feed=ApplicationInsights-Team&_a=package&package=Microsoft.ApplicationInsights.Agent.StartupTask&version=1.0.5&protocolType=NuGet",
          "latestVersion": "1.0.5",
          "latestMatchedVersion": "1.0.5",
          "views": [
            "local"
          ]
        }
      ],
      "hits": [
        {
          "fieldReferenceName": "name",
          "highlights": [
            "<highlighthit>Microsoft</highlighthit>.<highlighthit>ApplicationInsights</highlighthit>.Agent.StartupTask"
          ]
        },
        {
          "fieldReferenceName": "description",
          "highlights": [
            "This <highlighthit>package</highlighthit> adds a startup task for installing Application Insights Agent to enable additional"
          ]
        }
      ]
    }
  ],
  "infoCode": 0,
  "facets": {
    "ProtocolType": [
      {
        "name": "Npm",
        "id": "Npm",
        "resultCount": 1
      },
      {
        "name": "NuGet",
        "id": "NuGet",
        "resultCount": 2
      }
    ],
    "Feeds": [
      {
        "name": "ApexPreRelease",
        "id": "ApexPreRelease",
        "resultCount": 4
      },
      {
        "name": "ApplicationInsights-dotnet-develop",
        "id": "ApplicationInsights-dotnet-develop",
        "resultCount": 3
      },
      {
        "name": "ApplicationInsights-Team",
        "id": "ApplicationInsights-Team",
        "resultCount": 3
      },
      {
        "name": "ArtifactTool",
        "id": "ArtifactTool",
        "resultCount": 1
      },
      {
        "name": "Axon.Dependencies",
        "id": "Axon.Dependencies",
        "resultCount": 4
      },
      {
        "name": "CloudBuild",
        "id": "CloudBuild",
        "resultCount": 1
      },
      {
        "name": "CloudBuildTest",
        "id": "CloudBuildTest",
        "resultCount": 1
      },
      {
        "name": "CodeFlow",
        "id": "CodeFlow",
        "resultCount": 3
      },
      {
        "name": "Codex-Deps",
        "id": "Codex-Deps",
        "resultCount": 4
      },
      {
        "name": "Kusto-Internal",
        "id": "Kusto-Internal",
        "resultCount": 4
      },
      {
        "name": "MSCredProvider",
        "id": "MSCredProvider",
        "resultCount": 2
      },
      {
        "name": "VS",
        "id": "VS",
        "resultCount": 7
      },
      {
        "name": "VsoMicrosoftExternals",
        "id": "VsoMicrosoftExternals",
        "resultCount": 3
      }
    ],
    "View": [
      {
        "name": "Local",
        "id": "Local",
        "resultCount": 3
      }
    ]
  }
}

Definisi

Nama Deskripsi
FeedInfo

Menentukan detail umpan.
PackageHit

Menentukan istilah yang cocok di bidang hasil paket.
PackageResult

Menentukan hasil paket yang cocok dengan permintaan pencarian paket.
PackageSearchRequest

Menentukan permintaan pencarian paket.
PackageSearchResponseContent

Menentukan item respons yang dikembalikan untuk permintaan pencarian paket.
SortOption

Menentukan cara mengurutkan hasilnya.

FeedInfo

Objek

Menentukan detail umpan.

Nama Jenis Deskripsi
collectionId

string

Id koleksi.
collectionName

string

Nama koleksi.
feedId

string

Id umpan.
feedName

string

Nama umpan.
latestMatchedVersion

string

Versi paket terbaru yang cocok di Umpan ini.
latestVersion

string

Versi terbaru paket dalam Umpan ini.
packageUrl

string

Url paket dalam Umpan ini.
views

string[]

Daftar tampilan yang berisi paket yang cocok.

PackageHit

Objek

Menentukan istilah yang cocok di bidang hasil paket.

Nama Jenis Deskripsi
fieldReferenceName

string

Nama referensi bidang yang disorot.
highlights

string[]

Cuplikan bidang yang cocok/disorot.

PackageResult

Objek

Menentukan hasil paket yang cocok dengan permintaan pencarian paket.

Nama Jenis Deskripsi
description

string

Deskripsi paket.
feeds

FeedInfo[]

Daftar umpan yang berisi paket yang cocok.
hits

PackageHit[]

Daftar bidang yang disorot untuk kecocokan.
id

string

Id paket.
name

string

Nama paket.
protocolType

string

Jenis paket.

PackageSearchRequest

Objek

Menentukan permintaan pencarian paket.

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.
searchText

string

Teks pencarian.

PackageSearchResponseContent

Objek

Menentukan item respons yang dikembalikan untuk permintaan pencarian paket.

Nama Jenis Deskripsi
count

integer (int32)

Jumlah total paket 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

PackageResult[]

Daftar paket yang cocok.

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.