Discovery - Auto Complete

Référence

Service:: Purview

Version d'API:: 2023-09-01

Obtenir les options de saisie semi-automatique.

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

Paramètres URI

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

Corps de la demande

Nom	Type	Description
filter		Filtre de la demande de saisie semi-automatique.
keywords	string	Mots clés appliqués à tous les champs qui prennent en charge l’opération de saisie semi-automatique. Il doit comporter au moins 1 caractère et pas plus de 100 caractères.
limit	integer	Nombre de résultats d’autocomplétion que nous espérons retourner. La valeur par défaut est 50. La valeur doit être un nombre compris entre 1 et 100.

Réponses

Nom	Type	Description
200 OK	AutoCompleteResult	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_AutoComplete

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
AtlasErrorResponse	Réponse d’erreur du service
AutoCompleteOptions	Charge utile de la demande de saisie semi-automatique.
AutoCompleteResult	Résultat de la demande d’autocomplétion.
AutoCompleteResultValue	Élément de valeur de la suggestion d’autocomplétion.

AtlasErrorResponse

Réponse d’erreur du service

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

AutoCompleteOptions

Charge utile de la demande de saisie semi-automatique.

Nom	Type	Description
filter		Filtre de la demande de saisie semi-automatique.
keywords	string	Mots clés appliqués à tous les champs qui prennent en charge l’opération de saisie semi-automatique. Il doit comporter au moins 1 caractère et pas plus de 100 caractères.
limit	integer	Nombre de résultats d’autocomplétion que nous espérons retourner. La valeur par défaut est 50. La valeur doit être un nombre compris entre 1 et 100.

AutoCompleteResult

Résultat de la demande d’autocomplétion.

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

AutoCompleteResultValue

Élément de valeur de la suggestion d’autocomplétion.

Nom	Type	Description
queryPlusText	string	Texte de la requête de recherche terminée.
text	string	Terme ou expression terminé.

Partager via