Zdieľať cez

Prehľad rozhrania API na súhrn údajov (verzia Preview)

  • Článok

[Tento článok je predbežnou dokumentáciou a môže sa zmeniť.]

Tvorcovia môžu použiť Power Pages summarization API na pridanie sumarizácie obsahu stránky, ktorá využíva generatívnu AI. Používatelia stránky tak môžu získať prehľad o obsahu stránky bez toho, aby museli prejsť celú stránku. Rozhranie API je postavené na Power Pages webovom rozhraní API, ktoré poskytuje sumarizáciu údajov v tabuľkách Dataverse , ktoré sa používajú na stránkach.

Dôležité

  • Toto je ukážková funkcia.
  • Funkcie verzie Preview nie sú určené na produkčné účely a môžu mať obmedzenú funkčnosť. Na tieto funkcie sa vzťahujú dodatočné zmluvné podmienky a sú k dispozícii pred oficiálnym vydaním, aby zákazníci mohli získať skorý prístup a poskytnúť spätnú väzbu.

Požiadavky

  • Musíte povoliť nastavenia lokality pre webové rozhranie API.
  • Na zhrnutie sú dostupné iba tabuľky, ktoré sú podporované pre Power Pages Web API. Viac informácií o Power Pages Web API nájdete v Prehľad Web API.
  • Táto funkcia nie je k dispozícii v regiónoch Government Community Cloud (GCC), Government Community Cloud – High (GCC High) alebo Ministerstva obrany (DoD).

Nastavenia lokality

Povoľte stránky vo svojom webovom rozhraní API a nastavte nasledujúce nastavenia lokality pre funkciu súhrnného rozhrania API.

Názov nastavenia lokality Description
Sumarizácia/Údaje/Povoliť Povoliť alebo zakázať funkciu sumarizácie.
Predvolená hodnota: Nepravda
Platné hodnoty: Pravda, Nepravda
Sumarizácia/výzva/{any_identifier}

Tieto nastavenia použite na poskytnutie akýchkoľvek pokynov na zhrnutie.
Typ: reťazec

Príklad:
Názov: Súhrn/výzva/súhrn_prípadu
Hodnota: Zhrňte kľúčové podrobnosti a dôležité informácie
Sumarizácia/Údaje/ContentSizeLimit Upravte limit vstupnej veľkosti pre obsah súhrnu.
Typ: celé číslo
Predvolená hodnota: 100 000

Schéma API

Method URI Ukážka JSON
POST [URI lokality]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Názov vlastnosti Description
InstructionIdentifier Táto vlastnosť je voliteľná. Ak chcete odovzdať akékoľvek ďalšie pokyny na zhrnutie, pridajte výzvu pomocou nastavení lokality. Vždy by ste mali zadať názov nastavenia lokality tak, ako bol definovaný predtým.
RecommendationConfig Táto vlastnosť je voliteľná. Ak chcete odoslať výzvu, ktorú odporúča súhrnné API, použite túto vlastnosť na jej odovzdanie. Hodnota by mala byť hašovaná a nie modifikovaná.

Poznámka

Rozhranie API sa riadi štandardnými špecifikáciami protokolu OData (Open Data Protocol), ktoré podporuje Power Pages Web API. Sumarizačné API podporuje všetky operácie čítania , ktoré podporuje Power Pages Webové API.

Sample

Zhrňte typ prípadu, predmet, popis a históriu prípadu so zameraním na kľúčové detaily a kritické informácie.

Žiadať

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"
}

Response

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="
    }
  ]
}

Súhrn odpoveď poskytuje odporúčané výzvy na doladenie súhrnu. Ak chcete použiť tieto odporúčania, zadajte konfiguračnú hodnotu do tela požiadavky bez vlastnosti InstructionIdentifier .

Zabezpečenie

Sumarizačné API rešpektuje zabezpečenie založené na rolách, ktoré je nakonfigurované pre oprávnenia tabuľky a stĺpca. Na sumarizáciu sa berú do úvahy iba záznamy, ku ktorým má používateľ prístup.

Overuje sa súhrnné API

Nemusíte zadávať autentifikačný kód, pretože autentifikáciu a autorizáciu riadi relácia aplikácie. Všetky volania webového rozhrania API musia obsahovať token falšovania žiadostí medzi stránkami (CSRF).

Chybové kódy a správy

Nasledujúca tabuľka popisuje rôzne chybové kódy a hlásenia, s ktorými sa môžete stretnúť pri používaní súhrnného API.

Kód stavu Kód chyby Error message
400 90041001 Generatívne funkcie AI sú vypnuté
400 90041003 Súhrn údajov je pre túto stránku zakázaný. Povoliť pomocou nastavenia lokality.
400 90041004 Dĺžka obsahu prekračuje limit
400 90041005 Nenašli sa žiadne záznamy na zhrnutie
400 90041006 Pri sumarizácii obsahu sa vyskytla chyba.

Časté otázky týkajúce sa rozhrania API na súhrn údajov