Discovery - Suggest

服務:

Purview

API 版本:

2023-09-01

依查詢準則取得搜尋建議。

POST {endpoint}/datamap/api/search/suggest?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	我們希望傳回的建議數目。 預設值為 5。 值必須是 1 到 100 之間的數字。

回應

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

安全性

OAuth2Auth

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

範圍

名稱	Description
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"
        }
      ]
    }
  ]
}

定義

名稱	Description
AtlasErrorResponse	來自服務的錯誤回應
ContactSearchResultValue	搜尋中的聯繫人和建議結果。
SuggestOptions	建議要求的承載。
SuggestResult	搜尋建議的結果專案。
SuggestResultValue	搜尋建議的值專案。
TermSearchResultValue	內容。

AtlasErrorResponse

來自服務的錯誤回應

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

ContactSearchResultValue

搜尋中的聯繫人和建議結果。

名稱	類型	Description
contactType	string	聯繫人的類型。 它可以是實體專家或擁有者。 它可以是專家或監管人，適用於詞彙。
id	string	聯繫人的 GUID。
info	string	聯繫人的描述。

SuggestOptions

建議要求的承載。

名稱	類型	Description
filter		搜尋的篩選。
keywords	string	套用至支持建議作業之所有欄位的關鍵詞。 它至少必須是 1 個字元，且不超過 100 個字元。 在索引架構中，我們定義了預設建議工具，其中會列出所有支援的欄位，並指定搜尋模式。
limit	integer	我們希望傳回的建議數目。 預設值為 5。 值必須是 1 到 100 之間的數字。

SuggestResult

搜尋建議的結果專案。

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

SuggestResultValue

搜尋建議的值專案。

名稱	類型	Description
@search.score	number	搜尋引擎所計算的搜尋分數。 結果預設會依搜尋分數排序。
@search.text	string	包含關鍵詞做為前置詞的目標文字。 關鍵詞會以強調標記包裝。
assetType	string[]	資產的資產類型。
classification	string[]	記錄的分類。
contact	ContactSearchResultValue[]	資產的聯繫人。
createTime	integer	記錄的建立時間。 Unix epoch 格式。
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 epoch 格式。

TermSearchResultValue

內容。

名稱	類型	Description
glossaryName	string	包含詞彙的詞彙名稱。
guid	string	詞彙的 GUID。
name	string	字詞的名稱。