Time Series Instances - Suggest
Stelt trefwoorden voor op basis van kenmerken van time series-exemplaren die later moeten worden gebruikt in zoekexemplaren.
POST https://{environmentFqdn}/timeseries/instances/suggest?api-version=2020-07-31
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
environment
|
path | True |
string |
FQDN per omgeving, bijvoorbeeld 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. U kunt deze domeinnaam verkrijgen uit het antwoord van de API Omgevingen ophalen, Azure Portal of Azure Resource Manager. |
api-version
|
query | True |
string |
Versie van de API die moet worden gebruikt met de clientaanvraag. De momenteel ondersteunde versie is 2020-07-31. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
x-ms-client-request-id |
string |
Optionele clientaanvraag-id. Service registreert deze waarde. Hiermee kan de service de bewerking tussen services traceren en kan de klant contact opnemen met ondersteuning met betrekking tot een bepaalde aanvraag. |
|
x-ms-client-session-id |
string |
Optionele clientsessie-id. Service registreert deze waarde. Hiermee kan de service een groep gerelateerde bewerkingen in verschillende services traceren en kan de klant contact opnemen met de ondersteuning voor een bepaalde groep aanvragen. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
searchString | True |
string |
Zoektekenreeks waarvoor suggesties zijn vereist. Leeg is toegestaan, maar niet null. |
take |
integer |
Het maximum aantal suggesties dat in het resultaat wordt verwacht. De standaardwaarde is 10 als dit niet is ingesteld. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De bewerking is voltooid. Kopteksten x-ms-request-id: string |
|
Other Status Codes |
Onverwachte fout. Kopteksten x-ms-request-id: string |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
InstancesSuggest
Voorbeeldaanvraag
POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/suggest?api-version=2020-07-31
{
"searchString": "flo",
"take": 3
}
Voorbeeldrespons
{
"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"
}
]
}
Definities
Name | Description |
---|---|
Instances |
Voorgestelde zoekreeks die moet worden gebruikt voor verdere zoekopdrachten naar tijdreeksexemplaren. |
Instances |
Aanvraag om zoekreekssuggesties voor tijdreeksexemplaren op te halen op basis van voorvoegseltekst. |
Instances |
Antwoord van het verkrijgen van suggesties voor het zoeken naar tijdreeksexemplaren. |
Tsi |
Informatie over een API-fout. |
Tsi |
Een bepaalde API-fout met een foutcode en een bericht. |
Tsi |
Aanvullende foutinformatie. |
InstancesSearchStringSuggestion
Voorgestelde zoekreeks die moet worden gebruikt voor verdere zoekopdrachten naar tijdreeksexemplaren.
Name | Type | Description |
---|---|---|
highlightedSearchString |
string |
Gemarkeerde voorgestelde zoekreeks die moet worden weergegeven voor de gebruiker. Als u invoegingen en tags markeert in de tekstgedeelten die overeenkomen met de zoekreeks. Gebruik geen gemarkeerde zoekreeks om verdere zoekoproepen uit te voeren. |
searchString |
string |
Voorgestelde zoekreeks. Kan worden gebruikt voor verder zoeken naar tijdreeksexemplaren. |
InstancesSuggestRequest
Aanvraag om zoekreekssuggesties voor tijdreeksexemplaren op te halen op basis van voorvoegseltekst.
Name | Type | Description |
---|---|---|
searchString |
string |
Zoektekenreeks waarvoor suggesties zijn vereist. Leeg is toegestaan, maar niet null. |
take |
integer |
Het maximum aantal suggesties dat in het resultaat wordt verwacht. De standaardwaarde is 10 als dit niet is ingesteld. |
InstancesSuggestResponse
Antwoord van het verkrijgen van suggesties voor het zoeken naar tijdreeksexemplaren.
Name | Type | Description |
---|---|---|
suggestions |
Lijst met instantiesuggesties voor het zoeken naar tijdreeksmodellen. |
TsiError
Informatie over een API-fout.
Name | Type | Description |
---|---|---|
error |
Een bepaalde API-fout met een foutcode en een bericht. |
TsiErrorBody
Een bepaalde API-fout met een foutcode en een bericht.
Name | Type | Description |
---|---|---|
code |
string |
Taalonafhankelijke, door mensen leesbare tekenreeks die een servicespecifieke foutcode definieert. Deze code fungeert als een specifiekere indicator voor de HTTP-foutcode die is opgegeven in het antwoord. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen. |
details |
Bevat aanvullende foutinformatie. Kan null zijn. |
|
innerError |
Bevat een specifiekere fout die de oorzaak beperkt. Kan null zijn. |
|
message |
string |
Door mensen leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers. |
target |
string |
Doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap fout). Kan null zijn. |
TsiErrorDetails
Aanvullende foutinformatie.
Name | Type | Description |
---|---|---|
code |
string |
Taalonafhankelijke, door mensen leesbare tekenreeks die een servicespecifieke foutcode definieert. Deze code fungeert als een specifiekere indicator voor de HTTP-foutcode die is opgegeven in het antwoord. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen. |
message |
string |
Door mensen leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers. |