Adatösszegző API áttekintése (előzetes verzió)

[Ez a cikk egy előzetes kiadási dokumentáció, amely a későbbiekben változhat.]

A készítők az Power Pages összegző API-val adják hozzá az oldaltartalom összegzését generatív AI-val. Ez a funkció lehetővé teszi a webhely felhasználói számára, hogy áttekintést kapjanak az oldal tartalmáról anélkül, hogy elolvasnák a teljes oldalt. Az API a Power Pages Web API-ra épül, amely az oldalakon használt Dataverse táblák adatainak összegzését biztosítja.

Fontos

  • Ez egy előnézeti funkció.
  • Az előzetes funkciókat nem célszerű termelési környezetben használni, és előfordulhat, hogy korlátozott funkcionalitással rendelkeznek. Ezekre a funkciókra kiegészítő használati feltételek vonatkoznak, és a hivatalos kiadás előtt érhetők el, hogy az ügyfelek korai hozzáférést kaphassanak, és visszajelzést adhassanak.

Előfeltételek

Webhelybeállítások

Engedélyezze az oldalakat a webes API-ban, és állítsa be a következő webhelybeállításokat az összegző API funkcióhoz.

Webhelybeállítás neve Leírás
Összegzés/Adatok/Engedélyezés Engedélyezze vagy tiltsa le az összegző funkciót.
alapértelmezett: hamis
Érvényes értékek: igaz,hamis
Összegzés/prompt/{any_identifier}

Ezekkel a beállításokkal adhat utasításokat az összegzéshez.
típus: karakterlánc

Példa:
Név: Összefoglalás/utasítás/ügy_összefoglaló
Érték: Foglalja össze a legfontosabb részleteket és a kritikus információkat
Összegzés/Adatok/TartalomMérethatár Módosítsa az összegző tartalom bemeneti méretkorlátját.
típus: egész szám
Alapértelmezett: 100000 karakter

API-séma

Módszer URI JSON-minta
POST [Site URI]/_api/Summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Tulajdonság neve Leírás
Utasításazonosító Ez a tulajdonság nem kötelező. Ha további utasításokat szeretne átadni az összegzéshez, használja a webhelybeállításokat a parancssor hozzáadásához. Mindig adja meg a webhelybeállítás nevét a korábban definiált módon.
Ajánlás konfigurációja Ez a tulajdonság nem kötelező. Ezzel a tulajdonsággal átadhatja az összegző API által javasolt kérést. Az értéket kivonatolni kell, és változatlannak kell maradnia.

Figyelem

Az API a webes API által támogatott Power Pages szabványos Open Data Protocol (OData) specifikációkat követi. Az összegzés API támogatja a Power Pages webes API-ban elérhető összes olvasási műveletet.

Sample

Foglalja össze az eset típusát, tárgyát, leírását és esettörténetét a legfontosabb részletekre és fontos információkra összpontosítva.

Kérés

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

Válasz

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

Az összegzési válasz ajánlott kéréseket tartalmaz az összegzés finomhangolásához. A javaslatok használatához adja át a konfigurációs értéket a kérelemtörzsben a InstructionIdentifier tulajdonság kihagyásával.

Biztonság

Az összegző API tiszteletben tartja a tábla- és oszlopengedélyekhez konfigurált szerepköralapú biztonságot. Csak azokat a rekordokat veszi figyelembe, amelyekhez a felhasználó hozzáférhet az összegzéshez.

Az összegző API hitelesítése

Nem kell hitelesítési kódot megadnia, mert az alkalmazás-munkamenet kezeli a hitelesítést és az engedélyezést. A webes API összes hívásának tartalmaznia kell a webhelyközi kérések hamisításának (CSRF) tokenjét.

Hibakódok és üzenetek

Az alábbi táblázat az összegző API használatakor előforduló különböző hibakódokat és üzeneteket ismerteti.

Állapotkód Hibakód Hibaüzenet
400 90041001. A generatív AI-funkciók le vannak tiltva
400 90041003. Az adatösszegzés le van tiltva ezen a webhelyen. Engedélyezze a webhelybeállítás használatával.
400 90041004. A tartalom hossza meghaladja a korlátot
400 90041005. Nem találtak összefoglalható rekordokat
400 90041006. Hiba történt a tartalom összegzése közben.

Gyakori kérdések az adatösszegző API-val kapcsolatban

  • Last updated on