Sdílet prostřednictvím

Přehled rozhraní API souhrnu dat (Preview)

  • Článek

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

Tvůrci mohou pomocí Power Pages rozhraní API pro shrnutí přidat souhrn obsahu stránky, který využívá generativní umělou inteligenci. Uživatelé webu tak mohou získat přehled o obsahu stránky, aniž by museli procházet celou stránku. Rozhraní API je postaveno Power Pages na webovém rozhraní API, které poskytuje souhrn dat v Dataverse tabulkách, které se používají 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

  • Musíte zapnout nastavení webu pro webové rozhraní API.
  • Pro souhrn jsou k dispozici pouze tabulky, které jsou podporovány Power Pages pro webové rozhraní API. Další informace o Power Pages webovém rozhraní API najdete v tématu Přehled webového rozhraní API.
  • Tato funkce není k dispozici v prostředí Government Community Cloud (GCC), Government Community Cloud - High (GCC High) nebo Department of Defense (DoD).

Nastavení webu

Povolte stránky ve webovém rozhraní API a nastavte následující nastavení webu pro funkci rozhraní API pro souhrn.

Název nastavení webu Description
Souhrn/data/povolit Zapněte nebo vypněte funkci shrnutí.
Výchozí: False
Platné hodnoty: True, False
Souhrn/výzva/{any_identifier}

Tato nastavení slouží k zadání jakýchkoli 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 obsah souhrnu.
Typ: celé číslo
Výchozí: 100 000

Schéma API

metoda Identifikátor URI Ukázka JSON
POST [URI webu]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Název vlastnosti Description
InstructionIdentifier Tato vlastnost je volitelná. Pokud chcete předat jakékoli další pokyny pro souhrn, přidejte výzvu pomocí nastavení webu. Vždy byste měli zadat název nastavení webu tak, jak byl definován dříve.
RecommendationConfig Tato vlastnost je volitelná. Pokud chcete předat výzvu, kterou doporučuje rozhraní API pro souhrn, použijte k jejímu předání tuto vlastnost. Hodnota by měla být hashovaná a neměla by se měnit.

Poznámka:

Rozhraní API se řídí standardními specifikacemi protokolu OData (Open Data Protocol), které Power Pages webové rozhraní API podporuje. Rozhraní API pro souhrn podporuje všechny operace čtení, které webové rozhraní API Power Pages podporuje.

Sample

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.

Požádat

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
{
"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 tato doporučení použít, předejte konfigurační hodnotu v textu požadavku bez InstructionIdentifier vlastnosti.

Zabezpečení

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

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 Error message
400 90041001 Funkce s generativní AI jsou zakázá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