Discovery - Auto Complete

Referenz

Dienst:: Purview

API-Version:: 2023-09-01

Automatische Vervollständigungsoptionen abrufen.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
filter		Der Filter für die Autovervollständigen-Anforderung.
keywords	string	Die Schlüsselwörter, die auf alle Felder angewendet werden, die autovervollständigen-Vorgänge unterstützen. Es muss mindestens ein Zeichen und nicht mehr als 100 Zeichen sein.
limit	integer	Die Anzahl der Ergebnisse der automatischen Vervollständigung, die wir zurückgeben möchten. Der Standardwert lautet "50". Der Wert muss eine Zahl zwischen 1 und 100 sein.

Antworten

Name	Typ	Beschreibung
200 OK	AutoCompleteResult	Die Anforderung wurde erfolgreich durchgeführt.
Other Status Codes	AtlasErrorResponse	Eine unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://purview.azure.net/.default

Beispiele

Discovery_AutoComplete

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
AtlasErrorResponse	Eine Fehlerantwort des Diensts
AutoCompleteOptions	Die Nutzlast der Anforderung für die automatische Vervollständigung.
AutoCompleteResult	Das Ergebnis der Anforderung zur automatischen Vervollständigung.
AutoCompleteResultValue	Das Wertelement des Vorschlags für die automatische Vervollständigung.

AtlasErrorResponse

Eine Fehlerantwort des Diensts

Name	Typ	Beschreibung
errorCode	string	Der Fehlercode.
errorMessage	string	Die Fehlermeldung.
requestId	string	Die Anforderungs-ID.

AutoCompleteOptions

Die Nutzlast der Anforderung für die automatische Vervollständigung.

Name	Typ	Beschreibung
filter		Der Filter für die Autovervollständigen-Anforderung.
keywords	string	Die Schlüsselwörter, die auf alle Felder angewendet werden, die autovervollständigen-Vorgänge unterstützen. Es muss mindestens ein Zeichen und nicht mehr als 100 Zeichen sein.
limit	integer	Die Anzahl der Ergebnisse der automatischen Vervollständigung, die wir zurückgeben möchten. Der Standardwert lautet "50". Der Wert muss eine Zahl zwischen 1 und 100 sein.

AutoCompleteResult

Das Ergebnis der Anforderung zur automatischen Vervollständigung.

Name	Typ	Beschreibung
value	AutoCompleteResultValue[]	Der Ergebniswert

AutoCompleteResultValue

Das Wertelement des Vorschlags für die automatische Vervollständigung.

Name	Typ	Beschreibung
queryPlusText	string	Der vollständige Suchabfragetext.
text	string	Der abgeschlossene Begriff oder Ausdruck.

Freigeben über