Discovery - Auto Complete

服務:

Purview

API 版本:

2023-09-01

取得自動完成選項。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	類型	Description
filter		自動完成要求的篩選。
keywords	string	套用至支持自動完成作業之所有欄位的關鍵詞。 它至少必須是 1 個字元，且不超過 100 個字元。
limit	integer	我們希望傳回的自動完成結果數目。 預設值為 50。 值必須是 1 到 100 之間的數字。

回應

名稱	類型	Description
200 OK	AutoCompleteResult	要求已成功。
Other Status Codes	AtlasErrorResponse	未預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://purview.azure.net/.default

範例

Discovery_AutoComplete

範例要求

HTTP

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

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

範例回覆

狀態碼:

200

{
  "value": [
    {
      "text": "example",
      "queryPlusText": "example"
    },
    {
      "text": "exampleconfiguration",
      "queryPlusText": "exampleconfiguration"
    },
    {
      "text": "exampleresources",
      "queryPlusText": "exampleresources"
    }
  ]
}

定義

名稱	Description
AtlasErrorResponse	來自服務的錯誤回應
AutoCompleteOptions	自動完成要求的承載。
AutoCompleteResult	自動完成要求的結果。
AutoCompleteResultValue	自動完成建議的值專案。

AtlasErrorResponse

來自服務的錯誤回應

名稱	類型	Description
errorCode	string	錯誤碼。
errorMessage	string	錯誤訊息。
requestId	string	要求識別碼。

AutoCompleteOptions

自動完成要求的承載。

名稱	類型	Description
filter		自動完成要求的篩選。
keywords	string	套用至支持自動完成作業之所有欄位的關鍵詞。 它至少必須是 1 個字元，且不超過 100 個字元。
limit	integer	我們希望傳回的自動完成結果數目。 預設值為 50。 值必須是 1 到 100 之間的數字。

AutoCompleteResult

自動完成要求的結果。

名稱	類型	Description
value	AutoCompleteResultValue[]	結果值

AutoCompleteResultValue

自動完成建議的值專案。

名稱	類型	Description
queryPlusText	string	已完成的搜尋查詢文字。
text	string	完成的字詞或片語。