Discovery - Suggest

Service:

Purview

Version d'API:

2023-09-01

Obtenez des suggestions de recherche par critères de requête.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
filter		Filtre de la recherche.
keywords	string	Mots clés appliqués à tous les champs qui prennent en charge l’opération de suggestion. Il doit comporter au moins 1 caractère et pas plus de 100 caractères. Dans le schéma d’index, nous avons défini un suggesteur par défaut qui répertorie tous les champs pris en charge et spécifie un mode de recherche.
limit	integer (int32)	Nombre de suggestions que nous espérons retourner. La valeur par défaut est 5. La valeur doit être un nombre compris entre 1 et 100.

Réponses

Nom	Type	Description
200 OK	SuggestResult	La demande a réussi.
Other Status Codes	AtlasErrorResponse	Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://purview.azure.net/.default

Exemples

Discovery_Suggest

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:

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"
        }
      ]
    }
  ]
}

Définitions

Nom	Description
AtlasErrorResponse	Réponse d’erreur du service
ContactSearchResultValue	Contact dans la recherche et suggérer le résultat.
SuggestOptions	Charge utile de la demande de suggestion.
SuggestResult	Élément de résultat de la suggestion de recherche.
SuggestResultValue	Élément de valeur de la suggestion de recherche.
TermSearchResultValue	Contexte.

AtlasErrorResponse

Object

Réponse d’erreur du service

Nom	Type	Description
errorCode	string	Code d’erreur.
errorMessage	string	Message d’erreur.
requestId	string (uuid)	ID de demande.

ContactSearchResultValue

Object

Contact dans la recherche et suggérer le résultat.

Nom	Type	Description
contactType	string	Type du contact. Il peut s’agir d’un expert ou d’un propriétaire pour une entité. Il peut s’agir d’expert ou de gestionnaire pour un terme de glossaire.
id	string	GUID du contact.
info	string	Description du contact.

SuggestOptions

Object

Charge utile de la demande de suggestion.

Nom	Type	Description
filter		Filtre de la recherche.
keywords	string	Mots clés appliqués à tous les champs qui prennent en charge l’opération de suggestion. Il doit comporter au moins 1 caractère et pas plus de 100 caractères. Dans le schéma d’index, nous avons défini un suggesteur par défaut qui répertorie tous les champs pris en charge et spécifie un mode de recherche.
limit	integer (int32)	Nombre de suggestions que nous espérons retourner. La valeur par défaut est 5. La valeur doit être un nombre compris entre 1 et 100.

SuggestResult

Object

Élément de résultat de la suggestion de recherche.

Nom	Type	Description
value	SuggestResultValue[]	Valeur de résultat

SuggestResultValue

Object

Élément de valeur de la suggestion de recherche.

Nom	Type	Description
@search.score	number (float)	Score de recherche calculé par le moteur de recherche. Les résultats sont classés par score de recherche par défaut.
@search.text	string	Texte cible qui contient le mot clé comme préfixe. Le mot clé est encapsulé avec une marque d’accentuation.
assetType	string[]	Types de ressources de la ressource.
classification	string[]	Classifications de l’enregistrement.
contact	ContactSearchResultValue[]	Contacts de la ressource.
createTime	integer (int64)	Heure de création de l’enregistrement. Format d’époque Unix.
description	string	Description de la ressource.
endorsement	string[]	Approbation de la ressource.
entityType	string	Nom de type de la ressource.
glossary	string	Nom du glossaire du terme.
glossaryType	string	Nom de type du terme. Peut être AtlasGlossary, AtlasGlossaryTerm ou AtlasGlossaryCategory.
id	string	GUID de l’enregistrement.
label	string[]	Étiquettes de la ressource.
longDescription	string	Définition du terme.
name	string	Nom de l’enregistrement.
objectType	string	Type d’objet de l’enregistrement. Le type d’objet est la propriété de niveau supérieur pour distinguer si un enregistrement est un élément multimédia ou un terme.
owner	string	Propriétaire de l’enregistrement.
qualifiedName	string	Nom qualifié de l’enregistrement.
term	TermSearchResultValue[]	Termes attribués à la ressource.
termStatus	string	État du terme.
termTemplate	string[]	Noms de modèles de termes utilisés par le terme.
updateTime	integer (int64)	Heure de la dernière mise à jour de l’enregistrement. Format d’époque Unix.

TermSearchResultValue

Object

Contexte.

Nom	Type	Description
glossaryName	string	Nom du glossaire qui contient le terme.
guid	string	GUID du terme.
name	string	Nom du terme.