Discovery - Suggest

リファレンス

サービス:: Purview

API バージョン:: 2023-09-01

クエリ条件で検索候補を取得します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
filter		検索のフィルター。
keywords	string	suggest 操作をサポートするすべてのフィールドに適用されるキーワード。 1 文字以上で、100 文字以下にする必要があります。インデックススキーマでは、サポートされているすべてのフィールドを一覧表示し、検索モードを指定する既定の suggester を定義しました。
limit	integer (int32)	返す提案の数。既定値は 5 です。値は、1 ~ 100 の数値である必要があります。

応答

名前	型	説明
200 OK	SuggestResult	要求は成功しました。
Other Status Codes	AtlasErrorResponse	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 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	suggest 要求のペイロード。
SuggestResult	検索の結果項目が提案されます。
SuggestResultValue	検索候補の値項目。
TermSearchResultValue	コンテキスト。

AtlasErrorResponse

Object

サービスからのエラー応答

名前	型	説明
errorCode	string	エラーコード。
errorMessage	string	エラーメッセージ。
requestId	string (uuid)	要求 ID。

ContactSearchResultValue

Object

検索結果と提案結果の連絡先。

名前	型	説明
contactType	string	連絡先の種類。エンティティのエキスパートまたは所有者にすることができます。用語集の用語には、エキスパートまたはスチュワードを指定できます。
id	string	連絡先の GUID。
info	string	連絡先の説明。

SuggestOptions

Object

suggest 要求のペイロード。

名前	型	説明
filter		検索のフィルター。
keywords	string	suggest 操作をサポートするすべてのフィールドに適用されるキーワード。 1 文字以上で、100 文字以下にする必要があります。インデックススキーマでは、サポートされているすべてのフィールドを一覧表示し、検索モードを指定する既定の suggester を定義しました。
limit	integer (int32)	返す提案の数。既定値は 5 です。値は、1 ~ 100 の数値である必要があります。

SuggestResult

Object

検索の結果項目が提案されます。

名前	型	説明
value	SuggestResultValue[]	結果の値

SuggestResultValue

Object

検索候補の値項目。

名前	型	説明
@search.score	number (float)	検索エンジンによって計算される検索スコア。既定では、結果は検索スコアで並べ替えられます。
@search.text	string	プレフィックスとしてキーワードを含むターゲットテキスト。キーワードは強調マークで囲まれています。
assetType	string[]	資産の資産の種類。
classification	string[]	レコードの分類。
contact	ContactSearchResultValue[]	資産の連絡先。
createTime	integer (int64)	レコードの作成時刻。 Unix エポック形式。
description	string	資産の説明。
endorsement	string[]	資産の保証。
entityType	string	資産の型名。
glossary	string	用語の用語集の名前。
glossaryType	string	用語の型名。 Atlas 用語集、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 (int64)	レコードの最終更新時刻。 Unix エポック形式。

TermSearchResultValue

Object

コンテキスト。

名前	型	説明
glossaryName	string	用語を含む用語集の名前。
guid	string	用語の GUID。
name	string	用語の名前。

次の方法で共有

Discovery - Suggest

URI パラメーター

要求本文

応答

セキュリティ

OAuth2Auth

スコープ

例

Discovery_Suggest

要求のサンプル

応答のサンプル

定義

AtlasErrorResponse

ContactSearchResultValue

SuggestOptions

SuggestResult

SuggestResultValue

TermSearchResultValue