Деректерді қорытындылау API шолуы (алдын ала қарау нұсқасы)
[Бұл мақала — шығарылым алдындағы құжаттама және ол өзгеруі мүмкін.]
Жасаушылар генеративті AI қолданатын бет мазмұнының қорытындылауын қосу үшін Power Pages қорытындылау API пайдалана алады. Осылайша, сайт пайдаланушылары бүкіл бетті араламай-ақ, бет мазмұнына шолу жасай алады. API беттерде қолданылатын Power Pages кестелердегі деректерді қорытындылауды қамтамасыз ететін Dataverse Web API-дің үстіне құрастырылған.
Маңызды
- Бұл алдын ала қарау мүмкіндігі болып табылады.
- Алдын ала қарау нұсқасының мүмкіндіктері өндірісті пайдалану үшін арналмаған және функционалдық шектеулі болуы мүмкін. Бұл мүмкіндіктер қосымша пайдалану шарттарына бағынады және тұтынушылар ертерек қол жеткізіп, кері байланыс бере алуы үшін ресми шығарылымға дейін қолжетімді болады.
Алғышарттар
- Веб API үшін сайт параметрлерін қосу керек.
- Қорытындылау үшін Power Pages Web API үшін қолдау көрсетілетін кестелер ғана қолжетімді. Power Pages Web API шолуынанWeb API туралы қосымша ақпарат алыңыз.
- Бұл мүмкіндік үкіметтік қауымдастық бұлты (GCC), үкіметтік қауымдастық бұлты - жоғары (GCC High) немесе қорғаныс министрлігі (DoD) аймақтарында қолжетімді емес.
Сайт параметрлері
Веб API ішіндегі беттерді қосыңыз және қорытындылау API мүмкіндігі үшін келесі торап параметрлерін орнатыңыз.
Сайт параметрі аты | Сипаттама |
---|---|
Қорытындылау/Деректер/Қосу | Қорытындылау мүмкіндігін қосыңыз немесе өшіріңіз. Әдепкі: Өтірік Жарамды мәндер: True, False |
Қорытындылау/сұрақ/{any_identifier} | Қорытындылау үшін кез келген нұсқауларды қамтамасыз ету үшін осы параметрлерді пайдаланыңыз. Мысал: |
Қорытындылау/Деректер/ContentSizeLimit | Қорытындылау мазмұны үшін енгізу өлшемі шегін өзгертіңіз. түрі: бүтін сан Әдепкі: 100 000 |
API схемасы
Әдіс | URI | JSON үлгісі |
---|---|---|
POST | [Сайт URI]/_api/summarization/data/v1.0/tablesetname | { "InstructionIdentifier":"", "RecommendationConfig":"" } |
Сипат атауы | Сипаттама |
---|---|
Нұсқау идентификаторы | Бұл сипат міндетті емес. Қорытындылау үшін кез келген басқа нұсқауларды жібергіңіз келсе, сұрауды қосу үшін сайт параметрлерін пайдаланыңыз. Сіз әрқашан сайт параметрінің атауын бұрын анықталғандай беруіңіз керек. |
RecommendationConfig | Бұл сипат міндетті емес. Қорытындылау API ұсынатын сұрауды өткізгіңіз келсе, оны өту үшін осы сипатты пайдаланыңыз. Мән хэштеліп, өзгертілмеуі керек. |
Ескертпе
API Power Pages Web API қолдайтын стандартты Open Data Protocol (OData) спецификацияларына сәйкес келеді. Қорытындылау API интерфейсі Web API қолдайтын оқу операцияларының Power Pages барлығын қолдайды.
Үлгі
Негізгі мәліметтер мен маңызды ақпаратқа назар аудару арқылы іс түрін, тақырыбын, сипаттамасын және іс тарихын қорытындылаңыз.
Request
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="
}
]
}
жауап қорытындылауы қорытындыны дәл баптау үшін ұсынылған кеңестерді береді. Осы ұсыныстарды пайдаланғыңыз келсе, конфигурация мәнін сұрау мәтінінде InstructionIdentifier
сипатынсыз өткізіңіз.
Қауіпсіздік
Қорытындылау API кесте және баған рұқсаттары үшін теңшелген рөлге негізделген қауіпсіздікті құрметтейді. Қорытындылау үшін пайдаланушы қол жеткізе алатын жазбалар ғана қарастырылады.
Қорытындылау API түпнұсқалығын растау
Түпнұсқалық растама кодын қосудың қажеті жоқ, себебі қолданба сеансы аутентификация мен авторизацияны басқарады. Барлық Web API қоңыраулары сайтаралық сұрауды жалған жасау (CSRF) таңбалауышын қамтуы керек.
Қате кодтары және хабарлар
Келесі кесте қорытындылау API интерфейсін пайдаланған кезде кездесуі мүмкін әртүрлі қате кодтары мен хабарларды сипаттайды.
Күй коды | Қате коды | Қате туралы хабар |
---|---|---|
400 | 90041001-көше | Генеративті AI мүмкіндіктері өшірілген |
400 | 90041003-көше | Бұл сайт үшін деректерді қорытындылау өшірілген. Сайт параметрін пайдалану арқылы қосыңыз. |
400 | 90041004-көше | Мазмұн ұзындығы шектен асып кетті |
400 | 90041005-көше | Қорытындылайтын жазбалар табылмады |
400 | 90041006-көше | Мазмұнды қорытындылау кезінде қате орын алды. |