Přehled rozhraní API souhrnu dat (Preview)

[Tento článek představuje předběžnou dokumentaci a může se změnit.]

Tvůrci používají rozhraní API sumarizace Power Pages k přidání souhrnu obsahu stránky pomocí generativní AI. Tato funkce umožňuje uživatelům webu získat přehled o obsahu stránky, aniž by museli číst celou stránku. Rozhraní API je postavené na webovém rozhraní API Power Pages, které poskytuje sumarizaci dat pro tabulky Dataverse používané na stránkách.

Důležité

  • Toto je funkce Preview.
  • Funkce Preview nejsou určené pro normální používání a mohou mít omezené fungování. Tyto funkce podléhají doplňujícím podmínkám použití a jsou poskytnuty před oficiálním vydáním, aby si je zákazníci mohli co nejdříve vyzkoušet a napsat nám své názory.

Předpoklady

  • Zapněte nastavení webu pro webové rozhraní API.
  • Pro sumarizaci jsou k dispozici pouze tabulky podporované webovým rozhraním API Power Pages. Další informace o API Power Pages najdete v přehledu Web API.

Nastavení webu

Povolte stránkování ve vašem webovém rozhraní API a nastavte následující nastavení webu pro funkci API pro sumarizaci.

Název nastavení webu Popis
Souhrn/data/aktivovat Zapněte nebo vypněte funkci shrnutí.
Výchozí hodnota: false
Platné hodnoty: true, false
Souhrn/výzva/{any_identifier}

Tato nastavení slouží k zadání pokynů pro souhrn.
Typ: řetězec

Příklad:
Název: Summarization/prompt/case_summary
Hodnota: Shrnutí klíčových podrobností a kritických informací
Souhrn/Data/ContentSizeLimit Upravte limit velikosti vstupu pro souhrnný obsah.
Typ: celé číslo
Výchozí hodnota: 100000 znaků

Schéma API

metoda identifikátor URI Ukázka JSON
POST [URI webu]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Název vlastnosti Popis
InstructionIdentifier Tato vlastnost je volitelná. Pokud chcete předat další pokyny pro souhrn, přidejte výzvu pomocí nastavení webu. Vždy zadejte název nastavení webu tak, jak byl definován dříve.
RecommendationConfig Tato vlastnost je volitelná. Tato vlastnost slouží k předání výzvy doporučené rozhraním API pro souhrn. Hodnota musí být hashovaná a zůstat nezměněná.

Poznámka:

Rozhraní API se řídí standardními specifikacemi protokolu OData (Open Data Protocol) podporovanými webovým rozhraním API Power Pages. Rozhraní API pro sumarizaci podporuje všechny operace čtení, které jsou k dispozici ve webovém rozhraním API Power Pages.

Ukázka

Shrňte typ případu, předmět, popis a anamnézu případu tím, že se zaměříte na klíčové detaily a důležité informace.

Žádost

POST [Power Pages URL]/_api/summarization/data/v1.0/incidents(aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb)?$select=description,title&$expand=incident_adx_portalcomments($select=description)
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0
Accept: application/json

Body:
{
"InstructionIdentifier": "Summarization/prompt/case_summary"
}

Odpověď

HTTP/1.1 200 OK
OData-Version: 4.0
{
  "Summary": "The data results provide information…",
  "Recommendations": [
    {
      "Text": "would you like to know about…?",
      "Config": "HSYmaicakjvIwTFYeCIjKOyC7nQ4RTSiDJ+/LBK56r4="
    }
  ]
}

Souhrnná odpověď poskytuje doporučené výzvy k doladění souhrnu. Pokud chcete použít tato doporučení, předejte konfigurační hodnotu v textu požadavku bez vlastnosti InstructionIdentifier.

Zabezpečení

Rozhraní API pro souhrn respektuje zabezpečení založené na rolích nakonfigurované pro oprávnění k tabulkám a sloupcům. Bere v úvahu pouze záznamy, ke kterým má uživatel přístup pro souhrn.

Ověřování rozhraní API pro souhrn

Není nutné zahrnout ověřovací kód, protože ověřování a autorizaci spravuje relace aplikace. Všechna volání webového API musí obsahovat token CSRF.

Chybové kódy a zprávy

Následující tabulka popisuje různé kódy chyb a zprávy, se kterými se můžete setkat při použití rozhraní API pro souhrn.

Stavový kód Kód chyby Zpráva o chybě
400 90041001 Funkce s generativní AI jsou deaktivovány
400 90041003 Souhrn dat je pro tento web zakázán. Povolte pomocí nastavení webu.
400 90041004 Délka obsahu překračuje limit
400 90041005 Nebyly nalezeny žádné záznamy k shrnutí
400 90041006 Při vytváření souhrnu obsahu došlo k chybě.

Nejčastější dotazy pro rozhraní API souhrnu dat

  • Last updated on