Package Search Results - Fetch Package Search Results

Предоставляет набор результатов для текста поиска.

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

Параметры URI

Имя В Обязательно Тип Описание
organization
path True

string

Имя организации Azure DevOps.

api-version
query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".

Текст запроса

Имя Тип Описание
$orderBy

SortOption[]

Параметры сортировки результатов поиска. Если задано значение NULL, результаты будут возвращены по релевантности. Если указано несколько вариантов сортировки, результаты сортируются в порядке, указанном в OrderBy.

$skip

integer (int32)

Количество пропущенных результатов.

$top

integer (int32)

Количество возвращаемых результатов.

filters

object

Примененные фильтры. Задайте для него значение NULL, если не применяются фильтры.

includeFacets

boolean

Флаг, чтобы выбрать аспект в результате. Поведение по умолчанию — false.

searchText

string

Текст поиска.

Ответы

Имя Тип Описание
200 OK

PackageSearchResponseContent

успешная операция

Заголовки

ActivityId: string

Безопасность

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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

Области

Имя Описание
vso.packaging Предоставляет возможность чтения веб-каналов и пакетов. Кроме того, предоставляет возможность поиска пакетов.

Примеры

Образец запроса

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

Пример ответа

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

Определения

Имя Описание
FeedInfo

Определяет сведения о веб-канале.

PackageHit

Определяет соответствующие термины в поле результата пакета.

PackageResult

Определяет результат пакета, соответствующий запросу на поиск пакетов.

PackageSearchRequest

Определяет запрос поиска пакета.

PackageSearchResponseContent

Определяет элемент ответа, возвращаемый для запроса поиска пакета.

SortOption

Определяет, как сортировать результат.

FeedInfo

Определяет сведения о веб-канале.

Имя Тип Описание
collectionId

string

Идентификатор коллекции.

collectionName

string

Имя коллекции.

feedId

string

Идентификатор веб-канала.

feedName

string

Имя веб-канала.

latestMatchedVersion

string

Последняя соответствующая версия пакета в этом веб-канале.

latestVersion

string

Последняя версия пакета в этом веб-канале.

packageUrl

string

URL-адрес пакета в этом веб-канале.

views

string[]

Список представлений, содержащих соответствующий пакет.

PackageHit

Определяет соответствующие термины в поле результата пакета.

Имя Тип Описание
fieldReferenceName

string

Имя выделенного поля.

highlights

string[]

Сопоставленные или выделенные фрагменты поля.

PackageResult

Определяет результат пакета, соответствующий запросу на поиск пакетов.

Имя Тип Описание
description

string

Описание пакета.

feeds

FeedInfo[]

Список веб-каналов, содержащих соответствующий пакет.

hits

PackageHit[]

Список выделенных полей для совпадения.

id

string

Идентификатор пакета.

name

string

Имя пакета.

protocolType

string

Тип пакета.

PackageSearchRequest

Определяет запрос поиска пакета.

Имя Тип Описание
$orderBy

SortOption[]

Параметры сортировки результатов поиска. Если задано значение NULL, результаты будут возвращены по релевантности. Если указано несколько вариантов сортировки, результаты сортируются в порядке, указанном в OrderBy.

$skip

integer (int32)

Количество пропущенных результатов.

$top

integer (int32)

Количество возвращаемых результатов.

filters

object

Примененные фильтры. Задайте для него значение NULL, если не применяются фильтры.

includeFacets

boolean

Флаг, чтобы выбрать аспект в результате. Поведение по умолчанию — false.

searchText

string

Текст поиска.

PackageSearchResponseContent

Определяет элемент ответа, возвращаемый для запроса поиска пакета.

Имя Тип Описание
count

integer (int32)

Общее количество сопоставленных пакетов.

facets

object

Словарь, в котором хранится массив объектов Filter по каждому аспекту.

infoCode

integer (int32)

Числовый код, указывающий любую дополнительную информацию: 0 – ОК, 1 . Учетная запись переиндексирована, 2 - Индексирование учетной записи не запущено, 3 - Недопустимый запрос, 4 - Запрос подстановочного знака префикса не поддерживается, 5 - MultiWords с аспектом кода, 6 - учетная запись подключена, 7 - учетная запись подключена или повторно выполнена повторно, 8 - Максимальное значение, сокращенное до максимально допустимого 9 - Ветви индексируются, 10 . Аспекты не включены, 11 — рабочие элементы недоступны, 19 — запросы фраз с фильтрами типов кода не поддерживаются, 20 — запросы подстановочных знаков с фильтрами типов кода не поддерживаются. Любой другой код информации используется для внутренней цели.

results

PackageResult[]

Список сопоставленных пакетов.

SortOption

Определяет, как сортировать результат.

Имя Тип Описание
field

string

Имя поля, для которого необходимо выполнить сортировку.

sortOrder

string

Порядок (ASC/DESC), в котором должны быть отсортированы результаты.