Discovery - Suggest

Ссылка

Служба:: Purview

Версия API:: 2023-09-01

Получение предложений поиска по критериям запроса.

POST {endpoint}/datamap/api/search/suggest?api-version=2023-09-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string
api-version	query	True	string	Версия API, используемая для данной операции.

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

Имя	Тип	Описание
filter		Фильтр для поиска.
keywords	string	Ключевые слова, применяемые ко всем полям, поддерживающим операцию предложения. Он должен содержать не менее 1 символа и не более 100 символов. В схеме индекса мы определили средство подбора по умолчанию, которое перечисляет все поддерживаемые поля и задает режим поиска.
limit	integer	Количество предложений, которые мы надеемся вернуть. Значение по умолчанию — 5. Значение должно быть числом от 1 до 100.

Ответы

Имя	Тип	Описание
200 OK	SuggestResult	Запрос выполнен успешно.
Other Status Codes	AtlasErrorResponse	Непредвиденное сообщение об ошибке.

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

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://purview.azure.net/.default

Примеры

Discovery_Suggest

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

HTTP

POST {endpoint}/datamap/api/search/suggest?api-version=2023-09-01

{
  "keywords": "exampledata",
  "filter": {
    "and": [
      {
        "entityType": "azure_blob_path",
        "includeSubTypes": false
      }
    ]
  },
  "limit": 10
}

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

Код состояния:: 200

{
  "value": [
    {
      "@search.text": "<em>exampledata.csv</em>",
      "@search.score": 9.81402,
      "description": "Example Description",
      "id": "af7a01b0-1b14-4ab6-83a5-12cb11a717ed",
      "name": "exampledata.csv",
      "owner": "$superuser",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.csv",
      "entityType": "azure_blob_path",
      "assetType": [
        "Azure Blob Storage"
      ],
      "classification": [
        "MICROSOFT.GOVERNMENT.US.PASSPORT_NUMBER"
      ],
      "contact": [
        {
          "id": "8a597ffc-6993-4772-ac25-86b7251e1234",
          "info": "Example Info",
          "contactType": "Expert"
        }
      ],
      "label": [
        "Example.Label"
      ],
      "term": [
        {
          "name": "Example Term",
          "glossaryName": "Glossary"
        }
      ]
    }
  ]
}

Определения

Имя	Описание
AtlasErrorResponse	Ответ об ошибке от службы
ContactSearchResultValue	Контакт в результатах поиска и предложения.
SuggestOptions	Полезные данные запроса предложения.
SuggestResult	Элемент результата предложения поиска.
SuggestResultValue	Элемент значения предложения поиска.
TermSearchResultValue	Контекст.

AtlasErrorResponse

Ответ об ошибке от службы

Имя	Тип	Описание
errorCode	string	Код ошибки.
errorMessage	string	Сообщение об ошибке.
requestId	string	Идентификатор запроса.

ContactSearchResultValue

Контакт в результатах поиска и предложения.

Имя	Тип	Описание
contactType	string	Тип контакта. Он может быть экспертом или владельцем для сущности. Это может быть эксперт или стюард для термина глоссария.
id	string	GUID контакта.
info	string	Описание контакта.

SuggestOptions

Полезные данные запроса предложения.

Имя	Тип	Описание
filter		Фильтр для поиска.
keywords	string	Ключевые слова, применяемые ко всем полям, поддерживающим операцию предложения. Он должен содержать не менее 1 символа и не более 100 символов. В схеме индекса мы определили средство подбора по умолчанию, которое перечисляет все поддерживаемые поля и задает режим поиска.
limit	integer	Количество предложений, которые мы надеемся вернуть. Значение по умолчанию — 5. Значение должно быть числом от 1 до 100.

SuggestResult

Элемент результата предложения поиска.

Имя	Тип	Описание
value	SuggestResultValue[]	Результирующий результат

SuggestResultValue

Элемент значения предложения поиска.

Имя	Тип	Описание
@search.score	number	Оценка поиска, вычисленная поисковой системой. Результаты по умолчанию упорядочены по оценке поиска.
@search.text	string	Целевой текст, содержащий ключевое слово в качестве префикса. Ключевое слово заключен в знак подчеркивания.
assetType	string[]	Типы ресурсов ресурса.
classification	string[]	Классификации записи.
contact	ContactSearchResultValue[]	Контакты ресурса.
createTime	integer	Время создания записи. Формат эпохи Unix.
description	string	Описание ресурса.
endorsement	string	Подтверждение актива.
entityType	string	Имя типа ресурса.
glossary	string	Имя глоссария термина.
glossaryType	string	Имя типа термина. Может иметь значение AtlasGlossary, AtlasGlossaryTerm или AtlasGlossaryCategory.
id	string	GUID записи.
label	string[]	Метки ресурса.
longDescription	string	Определение термина.
name	string	Имя записи.
objectType	string	Тип объекта записи. Тип объекта — это свойство верхнего уровня, которое позволяет определить, является ли запись ресурсом или термином.
owner	string	Владелец записи.
qualifiedName	string	Полное имя записи.
term	TermSearchResultValue[]	Термины, назначенные ресурсу.
termStatus	string	Состояние термина.
termTemplate	string[]	Имена терминов шаблонов, используемые термином .
updateTime	integer	Время последнего обновления записи. Формат эпохи Unix.

TermSearchResultValue

Контекст.

Имя	Тип	Описание
glossaryName	string	Имя глоссария, содержащего термин.
guid	string	Идентификатор GUID термина.
name	string	имя условия;

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