Dela via


API:er för Azure Time Series Insights Gen2-modell

Översikt

Var och en av de tre komponenterna som utgör en Time Series-modell (instanser, hierarkier och typer) har motsvarande REST-API:er som stöder åtgärderna CREATE, READ,UPDATE och DELETE, sidnumrering och/eller batch.

  • Instans-API:et stöder sidnumrerade GET-åtgärder, batch-CREATE, READ, UPDATE och DELETE-åtgärder, sökning och nyckelordsförslag för sökåtgärder.
  • Hierarki-API:et stöder sidnumrerade GET-åtgärder och batch-åtgärder för att skapa,läsa, uppdatera och ta bort.
  • Typ-API:et stöder sidnumrerade GET-åtgärder och batch-åtgärder för att skapa,läsa, uppdatera och ta bort.

Ett fjärde API ger REST-stöd för inställningar för Time Series Model:

  • API:et för modellinställningar stöder HTTP-, GET- och UPDATE-åtgärder för konfigurationsinställningar för Time Series Model. Läs Time Series Model för detaljerad information om Time Series Model och instans-, hierarki- och typdefinitioner .

API för instanser

Med instans-API:et kan CREATE, READ, UPDATE och DELETE åtgärder utföras på Time Series Instances:

  • API:et Get Instances returnerar alla Time Series-instanser som matchar begäran.

  • API:et för att hantera instanser möjliggör batchåtgärder på instanser. Alla åtgärder mot det här API:et är HTTP POST-åtgärder . Varje åtgärd accepterar en nyttolast. Nyttolasten är ett JSON-objekt. Det här objektet definierar en enskild egenskap. Egenskapsnyckeln är namnet på en åtgärd som tillåts av API:et. Åtgärder som stöds är PUT,UPDATE och DELETE.

  • Dessa API:er möjliggör identifiering av Time Series-instanser:

    • Föreslå aktiverar scenarier för automatisk komplettering när du söker efter en instans.
    • Sökningen hjälper till att identifiera instanserna baserat på de angivna nyckelorden.

    Tips/Råd

    Läs mer om sökfrågefunktioner nedan.

API för hierarkier

API:et för hierarkier gör det möjligt att skapa,läsa, uppdatera och ta bort i tidsseriehierarkier.

API Beskrivning
Hämta API för hierarkier Returnerar alla Time Series-hierarkier som matchar begäran.
Hantera API:er för hierarkier Aktiverar batchåtgärder i hierarkier. Alla åtgärder mot det här API:et är HTTP POST-åtgärder . Varje åtgärd accepterar en nyttolast. Nyttolasten är ett JSON-objekt. Det här objektet definierar en enskild egenskap. Egenskapsnyckeln är namnet på en åtgärd som API:et tillåter. Åtgärder som stöds är PUT,UPDATE och DELETE.

API för typer

API:et för typer gör det möjligt att skapa,läsa, uppdatera och ta bort tidsserietyper och deras associerade variabler.

API Beskrivning
API för att hämta typer Returnerar alla tidsserietyper och deras associerade variabler.
API för inläggstyper Aktiverar batchåtgärder för typer. Alla åtgärder mot det här API:et är HTTP POST-åtgärder . Varje åtgärd accepterar en nyttolast. Nyttolasten är ett JSON-objekt. Det här objektet definierar en enskild egenskap. Egenskapsnyckeln är namnet på en åtgärd som API:et tillåter. Åtgärder som stöds är PUT,UPDATE och DELETE.

API för modellinställningar

API:et för modellinställningar gör det möjligt att skapa,läsa, uppdatera och ta bort automatiskt skapade modeller i miljön av TimeSeriesIds.

API Beskrivning
Hämta API för modellinställningar Returnerar den automatiskt skapade modellen i miljön för TimeSeriesIds.
API för uppdateringsmodellinställningar Uppdaterar modellen i miljön för TimeSeriesIds med de nya värden som anges i begäran.

Sökfunktioner

Jokerteckensökningar

Vi stöder sökningar med jokertecken med ett eller flera tecken inom enskilda termer (inte inom frassökningar).

Enkelt tecken

Om du vill utföra en sökning med jokertecken med ett tecken använder du symbolen ? . Jokerteckensökningen med ett tecken söker efter termer som matchar strängen med det enda tecknet som ersätts.

Om du vill söka efter antingen text eller testsöker du: te?t.

Flera tecken

Om du vill utföra en sökning med flera tecken med jokertecken använder du symbolen * . Sökningar med jokertecken med flera tecken söker efter noll eller flera tecken.

Om du vill söka efter test, , eller testeranvänder du sökningen: test*tests.

Du kan också använda sökningar med jokertecken mitt i en term. Om du vill söka efter dryerkan du använda sökningen: dr*r.

Booleska operatorer

Booleska operatorer gör det möjligt att kombinera termer med hjälp av logiska operatorer. Vi stöder AND, OR,+ , -och NOT som booleska operatorer.

Viktigt!

  • Booleska operatorer måste vara i ALLA VERSALER.
  • Booleska operatorer måste separeras från söksatser med hjälp av blanksteg.
  • dryer AND washer är giltig men inte dryer ANDwasher.

OCH-operatorn

Operatorn AND matchar dokument där båda termerna finns var som helst i texten i ett enda dokument.

Så här söker du efter dokument som innehåller dryer washer och foo bar använder sökningen: dryer washer AND foo bar.

Anmärkning

Symbolen && kan användas i stället för operatorn AND.

OR-operatorn

Operatorn OR länkar två termer och hittar ett matchande dokument om någon av termerna finns i ett dokument. Operatorn OR är standardoperatorn för konjunktion. Det innebär att om det inte finns någon boolesk operator mellan två termer används operatorn OR .

Om du vill söka efter dokument som innehåller någon dryer washer av eller bara dryer använder någon av följande sökningar:

  1. 'dryer washer' dryer
  2. 'dryer washer' OR dryer

Anmärkning

Symbolen || kan användas i stället för operatorn OR.

+ Operatör

Operatorn + eller required kräver att termen efter symbolen + finns någonstans i ett fält i ett enda dokument.

Om du vill söka efter dokument som måste innehålla dryer och kan innehålla washer använder du sökningen: +dryer washer.

-Operatör

Operatorn - or prohibit utesluter dokument som innehåller termen efter - tecknet.

Så här söker du efter dokument som innehåller dryer washer men inte foo bar använder sökningen: dryer washer -foo bar.

INTE

Operatorn NOT utesluter dokument som innehåller termen efter NOT.

Så här söker du efter dokument som innehåller dryer washer men inte foo bar använder sökningen: dryer washer NOT foo bar.

Operatorn NOT kan inte användas med bara en term.

Följande sökning ger inga resultat: NOT dryer washer.

Anmärkning

Symbolen ! kan användas i stället för operatorn NOT.

  • Den måste omedelbart föregå den uteslutna söktermen.
  • dryer !washer är giltig men inte dryer ! washer.

Se även

  • Mer information om programregistrering och Azure Active Directory-programmeringsmodellen finns i Azure Active Directory för utvecklare.

  • Mer information om parametrar för begäran och autentisering finns i Autentisering och auktorisering.

  • Verktyg som hjälper dig att testa HTTP-begäranden och svar är:

  • Spelman. Den här kostnadsfria webbfelsökningsproxyn kan fånga upp dina REST-begäranden, så att du kan diagnostisera HTTP-begäran och svarsmeddelanden.

  • JWT.io. Du kan använda det här verktyget för att snabbt dumpa anspråken i din ägartoken och sedan verifiera deras innehåll.

  • Brevbärare. Det här är ett kostnadsfritt testverktyg för HTTP-begäran och svar för felsökning av REST-API:er.

  • Läs mer om Azure Time Series Insights Gen2 genom att läsa Gen2-dokumentationen.