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 generatív AI-t használó oldaltartalom-összegzést adhatnak hozzá. Ily módon a webhely felhasználói áttekintést kaphatnak az oldal tartalmáról anélkül, hogy végig kellene menniük az egész oldalon. Az API a Power Pages webes API-ra épül, amely adatösszegzést biztosít az Dataverse oldalakon használt táblákon.
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 kapjanak, és visszajelzést adhassanak.
Előfeltételek
- Engedélyeznie kell a webes API webhelybeállításait .
- Csak a Power Pages webes API által támogatott táblák érhetők el összegzésre. További információ a webes API-ról: Power Pages Webes API áttekintése.
- A funkció nem érhető el a Government Community Cloud (GCC), a Government Community Cloud – High (GCC High) vagy a Department of Defense (DoD) régiókban.
Webhelybeállítások
Engedélyezze a lapokat a webes API-ban, és adja meg a következő webhelybeállításokat az összegző API funkcióhoz.
Webhelybeállítás neve | Description |
---|---|
Összegzés/Adatok/Engedélyezés | Az összegzési funkció engedélyezése vagy letiltása. Alapértelmezett: Hamis Érvényes értékek: True,False |
Összegzés/kérdés/{any_identifier} | Ezekkel a beállításokkal megadhatja az összegzésre vonatkozó utasításokat. Példa: |
Összegzés/Data/ContentSizeLimit | Módosítsa az összegző tartalom bemeneti méretkorlátját. Típus: egész szám Alapértelmezés: 100 000 |
API-séma
Method | URI | JSON-minta |
---|---|---|
POST | [Webhely URI-ja]/_api/összegzés/data/v1.0/tablesetname | { "InstructionIdentifier":"", "RecommendationConfig":"" } |
Tulajdonság neve | Description |
---|---|
Utasításazonosító | Ez a tulajdonság nem kötelező. Ha bármilyen más összegzési utasítást szeretne átadni, használja a webhely beállításait a kérdés hozzáadásához. A webhelybeállítás nevét mindig a korábban definiált formában adja meg. |
JavaslatConfig | Ez a tulajdonság nem kötelező. Ha át szeretné adni az összegző API által javasolt parancssort, ezzel a tulajdonsággal adhatja át. Az értéket kivonatolni kell, és nem szabad módosítani. |
Feljegyzés
Az API a webes API által támogatott szabványos Open Data Protocol (OData) specifikációkat Power Pages követi. Az összegző API a webes API által támogatott összes olvasási műveletet Power Pages támogatja.
Sample
Foglalja össze az eset típusát, tárgyát, leírását és előzményeit a legfontosabb részletekre és kritikus 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
{
"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="
}
]
}
Az összegző válasz ajánlott kérdéseket tartalmaz az összegzés finomhangolásához. Ha ezeket a javaslatokat szeretné használni, adja át a konfigurációs értéket a kérelem törzsében, a InstructionIdentifier
tulajdonság nélkül.
Biztonsági
Az összegző API tiszteletben tartja a tábla- és oszlopengedélyekhez konfigurált szerepköralapú biztonságot. A rendszer csak azokat a rekordokat veszi figyelembe összegzésre, amelyekhez a felhasználónak hozzáférése van.
Az összegző API hitelesítése
Nem kell hitelesítési kódot tartalmaznia, mert az alkalmazás-munkamenet kezeli a hitelesítést és az engedélyezést. Minden webes API-hívásnak tartalmaznia kell egy webhelyek közötti kéréshamisítási (CSRF) jogkivonatot.
Hibakódok és üzenetek
Az alábbi táblázat ismerteti azokat a különböző hibakódokat és üzeneteket, amelyekkel az összegző API használata során találkozhat.
Állapotkód | Hibakód | Error message |
---|---|---|
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álható összegző rekord |
400 | 90041006. | Hiba történt a tartalom összegzése során. |