你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Discovery - Suggest

按查询条件获取搜索建议。

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
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
https://purview.azure.net/.default

示例

Discovery_Suggest

示例请求

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

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

示例响应

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

请求 ID。

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

包含关键字 (keyword) 作为前缀的目标文本。 关键字 (keyword) 用强调标记包装。

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

术语的名称。