Zdieľať cez

Prehľad rozhrania API na sumarizáciu údajov (ukážka)

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

Tvorcovia používajú rozhranie API na sumarizáciu na pridanie sumarizácie obsahu stránky pomocou generatívnej umelej inteligencie. Power Pages Táto funkcia umožňuje používateľom webu získať prehľad o obsahu stránky bez toho, aby si ju museli prečítať celú. Rozhranie API je postavené na webovom rozhraní API, ktoré poskytuje sumarizáciu údajov pre tabuľky používané na stránkach. Power Pages Dataverse

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ť. Tieto funkcie podliehajú doplnkovým podmienkam používaniaa sú k dispozícii pred oficiálnym vydaním, aby k nim zákazníci mali skorý prístup a mohli poskytnúť spätnú väzbu.

Požiadavky

  • Povoľte nastavenia webového rozhrania API v nastaveniach lokality. ...
  • Na sumarizáciu sú k dispozícii iba tabuľky podporované rozhraním Web API. Power Pages Viac informácií o rozhraní Web API nájdete v časti Prehľad webového API. Power Pages
  • Táto funkcia nie je k dispozícii v regiónoch Government Community Cloud (GCC), Government Community Cloud – High (GCC High) ani Ministerstvo obrany (DoD).

Nastavenia lokality

Povoľte stránky vo svojom webovom rozhraní API a nastavte nasledujúce nastavenia lokality pre funkciu rozhrania API na sumarizáciu.

Názov nastavenia lokality Description
Sumarizácia/Údaje/Povoliť Povoliť alebo zakázať funkciu sumarizácie.
Predvolená hodnota: false
Platné hodnoty: true, false
Zhrnutie/nápoveda/{any_identifier}

Tieto nastavenia použite na poskytnutie pokynov na sumarizáciu.
Typ: reťazec

Príklad:
Názov: Zhrnutie/výzva/súhrn_prípadu
Hodnota: Zhrňte kľúčové detaily a kritické informácie
Sumarizácia/dáta/limit veľkosti obsahu Upravte limit vstupnej veľkosti pre sumarizačný obsah.
Typ: celé číslo
Predvolené: 100000 znakov

Schéma API

Method URI Ukážka JSON
POST [URI lokality]/_api/summarization/data/v1.0/názov_sady_tabuľiek { "InstructionIdentifier":"", "RecommendationConfig":"" }
Názov vlastnosti Description
Identifikátor inštrukcie Táto vlastnosť je voliteľná. Ak chcete odoslať ďalšie pokyny na sumarizáciu, použite nastavenia lokality na pridanie výzvy. Názov nastavenia lokality vždy zadajte tak, ako bol predtým definovaný.
OdporúčanieKonfigurácia Táto vlastnosť je voliteľná. Túto vlastnosť použite na odovzdanie výzvy odporúčanej rozhraním API sumarizácie. Hodnota musí byť hašovaná a zostať nezmenená.

Poznámka

Rozhranie API sa riadi štandardnými špecifikáciami protokolu Open Data Protocol (OData) podporovanými webovým rozhraním API. Power Pages Rozhranie API na sumarizáciu podporuje všetky operácie čítania dostupné vo webovom rozhraní API. Power Pages

Sample

Zhrňte typ prípadu, predmet, popis a históriu prípadu so zameraním na kľúčové detaily a dôležité 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

Body:
{
"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úhrnná odpoveď poskytuje odporúčané pokyny 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 nakonfigurované pre povolenia tabuliek a stĺpcov. Na sumarizáciu berie do úvahy iba záznamy, ku ktorým má používateľ prístup.

Autentifikácia rozhrania API na sumarizáciu

Nemusíte zadávať overovací kód, pretože overovanie a autorizáciu spravuje relácia aplikácie. Všetky volania webového rozhrania API musia obsahovať token CSRF (cross-site request forgery) .

Chybové kódy a hlásenia

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

Kód stavu Kód chyby Chybové hlásenie
400 90041001 Funkcie generatívnej umelej inteligencie sú vypnuté
400 90041003 Sumarizácia ú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.

Často kladené otázky týkajúce sa API na sumarizáciu údajov

  • Last updated on