Package Search Results - Fetch Package Search Results

Referência

Service:: Search

API Version:: 7.1-preview.1

Fornece um conjunto de resultados para o texto da pesquisa.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
$orderBy	SortOption[]	Opções para classificar os resultados da pesquisa. Se definido como nulo, os resultados serão retornados classificados por relevância. Se mais de uma opção de classificação for fornecida, os resultados serão classificados na ordem especificada em OrderBy.
$skip	integer	Número de resultados a serem ignorados.
$top	integer	Número de resultados a serem retornados.
filters	object	Filtros a serem aplicados. Defina-o como nulo se não houver filtros a serem aplicados.
includeFacets	boolean	Sinalizador para optar pela faceta no resultado. O comportamento padrão é false.
searchText	string	O texto de pesquisa.

Respostas

Nome	Tipo	Description
200 OK	PackageSearchResponseContent	operação bem-sucedida Headers ActivityId: string

Nome

Tipo

Description

200 OK

PackageSearchResponseContent

operação bem-sucedida

Headers

ActivityId: string

Segurança

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

Nome	Description
vso.packaging	Concede a capacidade de ler feeds e pacotes. Também concede a capacidade de pesquisar pacotes.

Exemplos

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

Definições

Nome	Description
FeedInfo	Define os detalhes de um feed.
PackageHit	Define os termos correspondentes no campo do resultado do pacote.
PackageResult	Define o resultado do pacote que correspondeu a uma solicitação de pesquisa de pacote.
PackageSearchRequest	Define uma solicitação de pesquisa de pacote.
PackageSearchResponseContent	Define um item de resposta retornado para uma solicitação de pesquisa de pacote.
SortOption	Define como classificar o resultado.

FeedInfo

Define os detalhes de um feed.

Nome	Tipo	Description
collectionId	string	Id da coleção.
collectionName	string	Nome da coleção.
feedId	string	Id do feed.
feedName	string	Nome do feed.
latestMatchedVersion	string	Versão mais recente correspondente do pacote neste Feed.
latestVersion	string	Versão mais recente do pacote neste Feed.
packageUrl	string	URL do pacote neste Feed.
views	string[]	Lista de exibições que contêm o pacote correspondente.

PackageHit

Define os termos correspondentes no campo do resultado do pacote.

Nome	Tipo	Description
fieldReferenceName	string	Nome de referência do campo realçado.
highlights	string[]	Snippets correspondentes/realçados do campo.

PackageResult

Define o resultado do pacote que correspondeu a uma solicitação de pesquisa de pacote.

Nome	Tipo	Description
description	string	Descrição do pacote.
feeds	FeedInfo[]	Lista de feeds que contêm o pacote correspondente.
hits	PackageHit[]	Lista de campos realçados para a correspondência.
id	string	Id do pacote.
name	string	Nome do pacote.
protocolType	string	Tipo do pacote.

PackageSearchRequest

Define uma solicitação de pesquisa de pacote.

Nome	Tipo	Description
$orderBy	SortOption[]	Opções para classificar os resultados da pesquisa. Se definido como nulo, os resultados serão retornados classificados por relevância. Se mais de uma opção de classificação for fornecida, os resultados serão classificados na ordem especificada em OrderBy.
$skip	integer	Número de resultados a serem ignorados.
$top	integer	Número de resultados a serem retornados.
filters	object	Filtros a serem aplicados. Defina-o como nulo se não houver filtros a serem aplicados.
includeFacets	boolean	Sinalizador para optar pela faceta no resultado. O comportamento padrão é false.
searchText	string	O texto de pesquisa.

PackageSearchResponseContent

Define um item de resposta retornado para uma solicitação de pesquisa de pacote.

Nome	Tipo	Description
count	integer	Número total de pacotes correspondentes.
facets	object	Um dicionário que armazena uma matriz de `Filter` objeto em cada faceta.
infoCode	integer	Código numérico que indica qualquer informação adicional: 0 – Ok, 1 – A conta está sendo reindexada, 2 – A indexação de conta não foi iniciada, 3 – Solicitação Inválida, 4 – Não há suporte para consulta curinga de prefixo, 5 – MultiWords com faceta de código sem suporte, 6 – a conta está sendo integrada, 7 – a conta está sendo integrada ou reindexada, 8 – Valor superior cortado para maxresult permitido 9 – Branches estão sendo indexados, 10 – Faceta não habilitada, 11 – Itens de trabalho não acessíveis, 19 – Consultas de frase com filtros de tipo de código sem suporte, 20 – Consultas curinga com filtros de tipo de código sem suporte. Qualquer outro código de informações é usado para fins internos.
results	PackageResult[]	Lista de pacotes correspondentes.

SortOption

Define como classificar o resultado.

Nome	Tipo	Description
field	string	Nome do campo no qual a classificação deve ser feita.
sortOrder	string	Ordem (ASC/DESC) na qual os resultados devem ser classificados.

Compartilhar via

Package Search Results - Fetch Package Search Results

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

oauth2

Scopes

Exemplos

Sample Request

Sample Response

Definições

FeedInfo

PackageHit

PackageResult

PackageSearchRequest

PackageSearchResponseContent

SortOption

Comentários

Recursos adicionais