Time Series Instances - Suggest

Usługa:

Time Series Insights

Wersja interfejsu API:

2020-07-31

Sugeruje słowa kluczowe na podstawie atrybutów wystąpienia szeregów czasowych do późniejszego użycia w wystąpieniach wyszukiwania.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
environmentFqdn	path	True	string	Na nazwę FQDN środowiska, na przykład 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Tę nazwę domeny można uzyskać z odpowiedzi interfejsu API pobierania środowisk, Azure Portal lub usługi Azure Resource Manager.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Obecnie obsługiwana wersja to "2020-07-31".

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string	Opcjonalny identyfikator żądania klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie operacji między usługami i umożliwia klientowi skontaktowanie się z pomocą techniczną dotyczącą konkretnego żądania.
x-ms-client-session-id		string	Opcjonalny identyfikator sesji klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie grupy powiązanych operacji między usługami i umożliwia klientowi kontaktowanie się z pomocą techniczną dotyczącą określonej grupy żądań.

Treść żądania

Nazwa	Wymagane	Typ	Opis
searchString	True	string	Wyszukaj ciąg, dla którego są wymagane sugestie. Wartość Pusta jest dozwolona, ale nie ma wartości null.
take		integer	Maksymalna liczba sugestii oczekiwana w wyniku. Wartość domyślna to 10, jeśli nie zostanie ustawiona.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	InstancesSuggestResponse	Operacja zakończona pomyślnie. Nagłówki x-ms-request-id: string
Other Status Codes	TsiError	Nieoczekiwany błąd. Nagłówki x-ms-request-id: string

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

InstancesSuggest

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
InstancesSearchStringSuggestion	Sugerowany ciąg wyszukiwania, który ma być używany do dalszego wyszukiwania wystąpień szeregów czasowych.
InstancesSuggestRequest	Żądanie pobrania sugestii ciągów wyszukiwania dla wystąpień szeregów czasowych wyszukiwania na podstawie tekstu prefiksu.
InstancesSuggestResponse	Odpowiedź na sugestie dotyczące wyszukiwania wystąpień szeregów czasowych.
TsiError	Informacje o błędzie interfejsu API.
TsiErrorBody	Określony błąd interfejsu API z kodem błędu i komunikatem.
TsiErrorDetails	Dodatkowe informacje o błędzie.

InstancesSearchStringSuggestion

Sugerowany ciąg wyszukiwania, który ma być używany do dalszego wyszukiwania wystąpień szeregów czasowych.

Nazwa	Typ	Opis
highlightedSearchString	string	Wyróżniono sugerowany ciąg wyszukiwania, który ma być wyświetlany użytkownikowi. Wyróżnianie wstawień i tagów w fragmentach tekstu pasujących do ciągu wyszukiwania. Nie używaj wyróżnionego ciągu wyszukiwania do wykonywania dalszych wywołań wyszukiwania.
searchString	string	Sugerowany ciąg wyszukiwania. Można użyć do dalszego wyszukiwania wystąpień szeregów czasowych.

InstancesSuggestRequest

Żądanie pobrania sugestii ciągów wyszukiwania dla wystąpień szeregów czasowych wyszukiwania na podstawie tekstu prefiksu.

Nazwa	Typ	Opis
searchString	string	Wyszukaj ciąg, dla którego są wymagane sugestie. Wartość Pusta jest dozwolona, ale nie ma wartości null.
take	integer	Maksymalna liczba sugestii oczekiwana w wyniku. Wartość domyślna to 10, jeśli nie zostanie ustawiona.

InstancesSuggestResponse

Odpowiedź na sugestie dotyczące wyszukiwania wystąpień szeregów czasowych.

Nazwa	Typ	Opis
suggestions	InstancesSearchStringSuggestion[]	Lista sugestii wystąpień dotyczących wyszukiwania modeli szeregów czasowych.

TsiError

Informacje o błędzie interfejsu API.

Nazwa	Typ	Opis
error	TsiErrorBody	Określony błąd interfejsu API z kodem błędu i komunikatem.

TsiErrorBody

Określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa	Typ	Opis
code	string	Niezależny od języka ciąg czytelny dla człowieka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
details	TsiErrorDetails[]	Zawiera dodatkowe informacje o błędzie. Może mieć wartość null.
innerError	TsiErrorBody	Zawiera bardziej szczegółowy błąd, który zawęża przyczynę. Może mieć wartość null.
message	string	Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie nadaje się do ujawnienia użytkownikom końcowym.
target	string	Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie). Może mieć wartość null.

TsiErrorDetails

Dodatkowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Niezależny od języka ciąg czytelny dla człowieka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
message	string	Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie nadaje się do ujawnienia użytkownikom końcowym.