Time Series Instances - Suggest
Suggerisce parole chiave basate sugli attributi dell'istanza della serie temporale da usare in un secondo momento nelle istanze di ricerca.
POST https://{environmentFqdn}/timeseries/instances/suggest?api-version=2020-07-31
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
environment
|
path | True |
string |
FQDN per ambiente, ad esempio 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. È possibile ottenere questo nome di dominio dalla risposta dell'API Get Environments, portale di Azure o azure Resource Manager. |
api-version
|
query | True |
string |
Versione dell'API da usare con la richiesta client. La versione attualmente supportata è "2020-07-31". |
Intestazione della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
x-ms-client-request-id |
string |
ID richiesta client facoltativo. Il servizio registra questo valore. Consente al servizio di tenere traccia dell'operazione tra i servizi e consente al cliente di contattare il supporto tecnico relativo a una richiesta specifica. |
|
x-ms-client-session-id |
string |
ID sessione client facoltativo. Il servizio registra questo valore. Consente al servizio di tracciare un gruppo di operazioni correlate tra i servizi e consente al cliente di contattare il supporto tecnico relativo a un determinato gruppo di richieste. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
searchString | True |
string |
Stringa di ricerca per cui sono necessari suggerimenti. Vuoto è consentito, ma non Null. |
take |
integer |
Numero massimo di suggerimenti previsti nel risultato. Il valore predefinito è 10 se non impostato. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Operazione riuscita. Intestazioni x-ms-request-id: string |
|
Other Status Codes |
Errore imprevisto. Intestazioni x-ms-request-id: string |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
InstancesSuggest
Esempio di richiesta
POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/suggest?api-version=2020-07-31
{
"searchString": "flo",
"take": 3
}
Risposta di esempio
{
"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"
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Instances |
Stringa di ricerca suggerita da usare per ulteriori ricerche per le istanze di serie temporali. |
Instances |
Richiesta per ottenere suggerimenti per le stringhe di ricerca per la ricerca di istanze di serie temporali in base al testo del prefisso. |
Instances |
Risposta del recupero di suggerimenti per la ricerca di istanze di serie temporali. |
Tsi |
Informazioni su un errore dell'API. |
Tsi |
Errore dell'API specifico con un codice di errore e un messaggio. |
Tsi |
Informazioni aggiuntive sull'errore. |
InstancesSearchStringSuggestion
Stringa di ricerca suggerita da usare per ulteriori ricerche per le istanze di serie temporali.
Nome | Tipo | Descrizione |
---|---|---|
highlightedSearchString |
string |
Stringa di ricerca suggerita evidenziata da visualizzare all'utente. Evidenziazione degli inserimenti e dei tag nelle parti di testo corrispondenti alla stringa di ricerca. Non usare la stringa di ricerca evidenziata per eseguire altre chiamate di ricerca. |
searchString |
string |
Stringa di ricerca suggerita. Può essere usato per cercare altre istanze di serie temporali. |
InstancesSuggestRequest
Richiesta per ottenere suggerimenti per le stringhe di ricerca per la ricerca di istanze di serie temporali in base al testo del prefisso.
Nome | Tipo | Descrizione |
---|---|---|
searchString |
string |
Stringa di ricerca per cui sono necessari suggerimenti. Vuoto è consentito, ma non Null. |
take |
integer |
Numero massimo di suggerimenti previsti nel risultato. Il valore predefinito è 10 se non impostato. |
InstancesSuggestResponse
Risposta del recupero di suggerimenti per la ricerca di istanze di serie temporali.
Nome | Tipo | Descrizione |
---|---|---|
suggestions |
Elenco di suggerimenti per l'istanza per la ricerca di modelli time series. |
TsiError
Informazioni su un errore dell'API.
Nome | Tipo | Descrizione |
---|---|---|
error |
Errore dell'API specifico con un codice di errore e un messaggio. |
TsiErrorBody
Errore dell'API specifico con un codice di errore e un messaggio.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Stringa leggibile indipendente dal linguaggio che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice. |
details |
Contiene informazioni aggiuntive sull'errore. Può essere Null. |
|
innerError |
Contiene un errore più specifico che restringe la causa. Può essere Null. |
|
message |
string |
Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali. |
target |
string |
Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore. Può essere Null. |
TsiErrorDetails
Informazioni aggiuntive sull'errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Stringa leggibile indipendente dal linguaggio che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice. |
message |
string |
Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali. |