Time Series Instances - Suggest

Dienst:

Time Series Insights

API-Version:

2020-07-31

Schlägt Schlüsselwörter basierend auf Zeitreihen instance Attributen vor, die später in Suchinstanzen verwendet werden sollen.

POST https://{environmentFqdn}/timeseries/instances/suggest?api-version=2020-07-31

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentFqdn	path	True	string	FQDN pro Umgebung, z. B. 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Sie können diesen Domänennamen aus der Antwort der Get Environments-API, Azure-Portal oder Azure Resource Manager abrufen.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Derzeit wird die Version "2020-07-31" unterstützt.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string	Optionale Clientanforderungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst die dienstübergreifende Ablaufverfolgung des Vorgangs und ermöglicht es dem Kunden, sich bezüglich einer bestimmten Anforderung an den Support zu wenden.
x-ms-client-session-id		string	Optionale Clientsitzungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst das Nachverfolgen einer Gruppe verwandter Vorgänge über Dienste hinweg und ermöglicht es dem Kunden, den Support bezüglich einer bestimmten Gruppe von Anforderungen zu kontaktieren.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
searchString	True	string	Suchzeichenfolge, für die Vorschläge erforderlich sind. Leer ist zulässig, aber nicht NULL.
take		integer	Maximale Anzahl von Vorschlägen, die im Ergebnis erwartet werden. Der Standardwert ist 10, wenn nicht festgelegt.

Antworten

Name	Typ	Beschreibung
200 OK	InstancesSuggestResponse	Erfolgreiche Ausführung Header x-ms-request-id: string
Other Status Codes	TsiError	Unerwarteter Fehler. Header x-ms-request-id: string

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

InstancesSuggest

Beispielanforderung

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/suggest?api-version=2020-07-31

{
  "searchString": "flo",
  "take": 3
}

Beispiel für eine Antwort

Statuscode:

200

{
  "suggestions": [
    {
      "searchString": "floor 100",
      "highlightedSearchString": "<hit>flo</hit>or 100"
    },
    {
      "searchString": "sensor on floor 0",
      "highlightedSearchString": "sensor on <hit>flo</hit>or 0"
    },
    {
      "searchString": "sensor on floor 1",
      "highlightedSearchString": "sensor on <hit>flo</hit>or 1"
    }
  ]
}

Definitionen

Name	Beschreibung
InstancesSearchStringSuggestion	Vorgeschlagene Suchzeichenfolge, die für die weitere Suche nach Zeitreiheninstanzen verwendet werden soll.
InstancesSuggestRequest	Anforderung zum Abrufen von Suchzeichenfolgenvorschlägen für die Suche nach Zeitreiheninstanzen basierend auf Präfixtext.
InstancesSuggestResponse	Antwort auf das Abrufen von Vorschlägen für die Suche nach Zeitreiheninstanzen.
TsiError	Informationen zu einem API-Fehler.
TsiErrorBody	Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.
TsiErrorDetails	Zusätzliche Fehlerinformationen.

InstancesSearchStringSuggestion

Vorgeschlagene Suchzeichenfolge, die für die weitere Suche nach Zeitreiheninstanzen verwendet werden soll.

Name	Typ	Beschreibung
highlightedSearchString	string	Die vorgeschlagene Suchzeichenfolge wurde hervorgehoben, die dem Benutzer angezeigt werden soll. Hervorheben von Einfügungen und Tags in den Textabschnitten, die mit der Suchzeichenfolge übereinstimmen. Verwenden Sie keine hervorgehobene Suchzeichenfolge, um weitere Suchaufrufe auszuführen.
searchString	string	Vorgeschlagene Suchzeichenfolge. Kann für die weitere Suche nach Zeitreiheninstanzen verwendet werden.

InstancesSuggestRequest

Anforderung zum Abrufen von Suchzeichenfolgenvorschlägen für die Suche nach Zeitreiheninstanzen basierend auf Präfixtext.

Name	Typ	Beschreibung
searchString	string	Suchzeichenfolge, für die Vorschläge erforderlich sind. Leer ist zulässig, aber nicht NULL.
take	integer	Maximale Anzahl von Vorschlägen, die im Ergebnis erwartet werden. Der Standardwert ist 10, wenn nicht festgelegt.

InstancesSuggestResponse

Antwort auf das Abrufen von Vorschlägen für die Suche nach Zeitreiheninstanzen.

Name	Typ	Beschreibung
suggestions	InstancesSearchStringSuggestion[]	Liste der instance Vorschläge für die Suche nach Zeitreihenmodellen.

TsiError

Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	TsiErrorBody	Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

Name	Typ	Beschreibung
code	string	Sprachunabhängige, für Menschen lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	TsiErrorDetails[]	Enthält zusätzliche Fehlerinformationen. Ist möglicherweise NULL.
innerError	TsiErrorBody	Enthält einen spezifischeren Fehler, der die Ursache eingrenzt. Ist möglicherweise NULL.
message	string	Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.
target	string	Ziel des bestimmten Fehlers (z. B. der Name der -Eigenschaft im Fehler). Ist möglicherweise NULL.

TsiErrorDetails

Zusätzliche Fehlerinformationen.

Name	Typ	Beschreibung
code	string	Sprachunabhängige, für Menschen lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
message	string	Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.