Package Search Results - Fetch Package Search Results

Reference

Service:: Search

API Version:: 7.1-preview.1

Poskytuje sadu výsledků pro hledaný text.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.1.

Text požadavku

Name	Typ	Description
$orderBy	SortOption[]	Možnosti řazení výsledků hledání Pokud je nastavená hodnota null, vrátí se výsledky seřazené podle relevance. Pokud je k dispozici více než jedna možnost řazení, výsledky se seřadí v pořadí zadaném v orderBy.
$skip	integer	Počet přeskočených výsledků
$top	integer	Počet vrácených výsledků
filters	object	Filtry, které se mají použít. Pokud neexistují žádné filtry, které by se použily, nastavte hodnotu null.
includeFacets	boolean	Příznakem zvolíte faceting ve výsledku. Výchozí chování je false.
searchText	string	Hledaný text.

Odpovědi

Name	Typ	Description
200 OK	PackageSearchResponseContent	úspěšná operace Headers ActivityId: string

Name

Typ

Description

200 OK

PackageSearchResponseContent

úspěšná operace

Headers

ActivityId: string

Zabezpečení

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.packaging	Uděluje možnost číst informační kanály a balíčky. Umožňuje také vyhledávat v balíčcích.

Příklady

Sample Request

HTTP

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

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

Sample Response

Status code:: 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
      }
    ]
  }
}

Definice

Name	Description
FeedInfo	Definuje podrobnosti informačního kanálu.
PackageHit	Definuje odpovídající termíny v poli výsledku balíčku.
PackageResult	Definuje výsledek balíčku, který odpovídal požadavku hledání balíčku.
PackageSearchRequest	Definuje požadavek na hledání balíčku.
PackageSearchResponseContent	Definuje položku odpovědi, která se vrátí pro požadavek hledání balíčku.
SortOption	Definuje, jak seřadit výsledek.

FeedInfo

Definuje podrobnosti informačního kanálu.

Name	Typ	Description
collectionId	string	ID kolekce.
collectionName	string	Název kolekce.
feedId	string	ID informačního kanálu.
feedName	string	Název informačního kanálu
latestMatchedVersion	string	Nejnovější odpovídající verze balíčku v tomto informačním kanálu.
latestVersion	string	Nejnovější verze balíčku v tomto informačním kanálu.
packageUrl	string	Adresa URL balíčku v tomto informačním kanálu
views	string[]	Seznam zobrazení, která obsahují odpovídající balíček

PackageHit

Definuje odpovídající termíny v poli výsledku balíčku.

Name	Typ	Description
fieldReferenceName	string	Název odkazu zvýrazněného pole.
highlights	string[]	Odpovídající nebo zvýrazněné fragmenty kódu pole

PackageResult

Definuje výsledek balíčku, který odpovídal požadavku hledání balíčku.

Name	Typ	Description
description	string	Popis balíčku.
feeds	FeedInfo[]	Seznam informačních kanálů, které obsahují odpovídající balíček
hits	PackageHit[]	Seznam zvýrazněných polí pro shodu
id	string	ID balíčku.
name	string	Název balíčku.
protocolType	string	Typ balíčku.

PackageSearchRequest

Definuje požadavek na hledání balíčku.

Name	Typ	Description
$orderBy	SortOption[]	Možnosti řazení výsledků hledání Pokud je nastavená hodnota null, vrátí se výsledky seřazené podle relevance. Pokud je k dispozici více než jedna možnost řazení, výsledky se seřadí v pořadí zadaném v orderBy.
$skip	integer	Počet přeskočených výsledků
$top	integer	Počet vrácených výsledků
filters	object	Filtry, které se mají použít. Pokud neexistují žádné filtry, které by se použily, nastavte hodnotu null.
includeFacets	boolean	Příznakem zvolíte faceting ve výsledku. Výchozí chování je false.
searchText	string	Hledaný text.

PackageSearchResponseContent

Definuje položku odpovědi, která se vrátí pro požadavek hledání balíčku.

Name	Typ	Description
count	integer	Celkový počet odpovídajících balíčků.
facets	object	Slovník, který ukládá pole `Filter` objektů pro každou omezující vlastnost.
infoCode	integer	Číselný kód označující jakékoli další informace: 0 – OK, 1 – Účet se přeindexuje, 2 – Indexování účtu se nezačne, 3 – Neplatný požadavek, 4 – Dotaz se zástupnými čísly není podporovaný, 5 – MultiWords s nepodporovanou fazetou kódu, 6 – Probíhá onboarding účtu, 7 – účet se nasazuje nebo přeindexuje, 8 – horní hodnota je oříznutá na maximální povolený počet povolených hodnot 9 – větve se indexují, 10 – Fasety nejsou povoleny, 11 – Pracovní položky nejsou přístupné, 19 – Frázové dotazy s filtry typu kódu nejsou podporované, 20 – Dotazy se zástupnými znakůmimi s filtry typu kódu nejsou podporovány. Jakýkoli jiný informační kód se používá k interním účelům.
results	PackageResult[]	Seznam odpovídajících balíčků

SortOption

Definuje, jak seřadit výsledek.

Name	Typ	Description
field	string	Název pole, podle kterého se má řazení provést.
sortOrder	string	Pořadí (ASC/DESC), ve kterém by měly být výsledky seřazeny.

Sdílet prostřednictvím

Package Search Results - Fetch Package Search Results

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

oauth2

Scopes

Příklady

Sample Request

Sample Response

Definice

FeedInfo

PackageHit

PackageResult

PackageSearchRequest

PackageSearchResponseContent

SortOption

Další materiály