Package Search Results - Fetch Package Search Results

Ссылка

Service:: Search

API Version:: 7.1-preview.1

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.

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

Имя	Тип	Описание
$orderBy	SortOption[]	Параметры сортировки результатов поиска. Если задано значение NULL, результаты будут отсортированы по релевантности. Если указано несколько параметров сортировки, результаты сортируются в порядке, указанном в OrderBy.
$skip	integer	Число пропущенных результатов.
$top	integer	Число возвращаемых результатов.
filters	object	Применяемые фильтры. Присвойте ему значение NULL, если фильтры не применяются.
includeFacets	boolean	Пометка, чтобы выбрать фасет в результате. По умолчанию используется значение false.
searchText	string	Текст, поиск которого необходимо выполнить.

Ответы

Имя	Тип	Описание
200 OK	PackageSearchResponseContent	успешная операция Headers ActivityId: string

Имя

Тип

Описание

200 OK

PackageSearchResponseContent

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

Headers

ActivityId: string

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

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

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

Примеры

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

Определения

Имя	Описание
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	Число пропущенных результатов.
$top	integer	Число возвращаемых результатов.
filters	object	Применяемые фильтры. Присвойте ему значение NULL, если фильтры не применяются.
includeFacets	boolean	Пометка, чтобы выбрать фасет в результате. По умолчанию используется значение false.
searchText	string	Текст, поиск которого необходимо выполнить.

PackageSearchResponseContent

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

Имя	Тип	Описание
count	integer	Общее количество сопоставленных пакетов.
facets	object	Словарь, в котором хранится массив `Filter` объектов для каждого аспекта.
infoCode	integer	Числовой код, указывающий дополнительные сведения: 0 – ОК, 1 — учетная запись переиндексирована, 2 — индексирование учетных записей не началось, 3 — недопустимый запрос, 4 — запрос с подстановочными знаками префикса не поддерживается, 5 — многослойные слова с аспектом кода не поддерживается, 6 — учетная запись подключена, 7 — учетная запись подключена или повторно индексируется, 8 — максимально допустимое значение, 9 — индексируются ветви; 10 — фасетирование не включено, 11 — рабочие элементы недоступны, 19 — запросы фраз с фильтрами типов кода не поддерживаются, 20 — запросы с подстановочными знаками с фильтрами типов кода не поддерживаются. Любой другой информационный код используется для внутренних целей.
results	PackageResult[]	Список сопоставленных пакетов.

SortOption

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

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

Поделиться через

Package Search Results - Fetch Package Search Results

Параметры URI

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

Ответы

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

oauth2

Scopes

Примеры

Sample Request

Sample Response

Определения

FeedInfo

PackageHit

PackageResult

PackageSearchRequest

PackageSearchResponseContent

SortOption

Дополнительные ресурсы