Jaa

Tietojen yhteenvedon ohjelmointirajapinnan yleiskatsaus (esiversio)

  • Artikkeli

[Tämä artikkeli sisältää julkaisua edeltävää materiaalia ja voi muuttua.]

Tekijät voivat Power Pages käyttää yhteenvedon ohjelmointirajapintaa lisätäkseen sivun sisällön yhteenvedon, joka käyttää generatiivista tekoälyä. Tällä tavalla sivuston käyttäjät voivat saada yleiskuvan sivun sisällöstä ilman, että heidän tarvitsee käydä läpi koko sivua. Ohjelmointirajapinta perustuu Power Pages verkko-ohjelmointirajapintaan, joka tarjoaa yhteenvedon sivuilla käytettävien taulukoiden Dataverse tiedoista.

Tärkeää

  • Tämä on esiversiotoiminto.
  • Esiversiotoimintoja ei ole tarkoitettu tuotantokäyttöön, ja niiden toiminnot voivat olla rajoitettuja. Näihin toimintoihin sovelletaan lisäkäyttöehtoja ja ne ovat käytettävissä ennen virallista julkaisua, jotta asiakkaat voivat käyttää niitä aikaisessa vaiheessa ja antaa palautetta.

edellytykset

  • Verkko-ohjelmointirajapinnan sivustoasetukset on otettava käyttöön.
  • Vain taulukot, Power Pages joita verkko-ohjelmointirajapinta tukee, ovat käytettävissä yhteenvetoa varten. Lisätietoja Power Pagesin verkko-ohjelmointirajapinnasta on verkko-ohjelmointirajapinnan yleiskatsauksessa.
  • Tämä ominaisuus ei ole käytettävissä Government Community Cloud (GCC)-, Government Community Cloud – High (GCC High)- tai Department of Defense (DoD) -alueilla.

Sivuston asetukset

Ota sivut käyttöön verkko-ohjelmointirajapinnassa ja määritä seuraavat sivustoasetukset yhteenvedon ohjelmointirajapinnan ominaisuudelle.

Sivuston asetuksen nimi Description
Yhteenveto/Tiedot/Käyttöönotto Ota yhteenveto-ominaisuus käyttöön tai poista se käytöstä.
Oletus: Epätosi
Kelvolliset arvot: Tosi, Epätosi
Yhteenveto/kehote/{any_identifier}

Näiden asetusten avulla voit antaa ohjeita yhteenvedon tekemiseen.
Tyyppi: Merkkijono

Esimerkki:
Nimi: Yhteenveto/kehote/case_summary
Arvo: Tee yhteenveto tärkeimmistä yksityiskohdista ja tärkeistä tiedoista
Yhteenveto/Tiedot/ContentSizeLimit Muokkaa yhteenvedon sisällön syötteen kokorajoitusta.
Tyyppi: kokonaisluku
Oletus: 100 000

API-rakenne

Metodi URI JSON-näyte
POST [Sivuston URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Ominaisuuden nimi Description
InstructionIdentifier Tämä ominaisuus on valinnainen. Jos haluat välittää muita yhteenvetoa koskevia ohjeita, lisää kehote sivuston asetusten avulla. Anna aina sivuston asetuksen nimi siinä muodossa kuin se on aiemmin määritetty.
RecommendationConfig Tämä ominaisuus on valinnainen. Jos haluat välittää yhteenvedon ohjelmointirajapinnan suositteleman kehotteen, välitä se tämän ominaisuuden avulla. Arvo on hajautettava eikä sitä saa muokata.

Muistiinpano

Ohjelmointirajapinta noudattaa OData (Open Data Protocol) -vakiomäärityksiä, joita Power Pages verkko-ohjelmointirajapinta tukee. Yhteenveto-ohjelmointirajapinta tukee kaikkia lukutoimintoja, joita Power Pagesin verkko-ohjelmointirajapinta tukee.

Sample

Tee yhteenveto tapauksen tyypistä, aiheesta, kuvauksesta ja tapaushistoriasta keskittymällä tärkeisiin yksityiskohtiin ja tärkeisiin tietoihin.

Pyydä

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

Yhteenvetovastaus sisältää suositeltuja kehotteita yhteenvedon hienosäätöön. Jos haluat käyttää näitä suosituksia, välitä määritysarvo pyynnön tekstiosassa ilman InstructionIdentifier ominaisuutta.

Suojaus

Yhteenvedon ohjelmointirajapinta noudattaa roolipohjaista suojausta, joka on määritetty taulukon ja sarakkeen käyttöoikeuksille. Vain tietueet, joihin käyttäjällä on käyttöoikeus, otetaan huomioon yhteenvedossa.

Yhteenvedon ohjelmointirajapinnan todentaminen

Todennuskoodia ei tarvitse sisällyttää, sillä sovellusistunto hallitsee todennusta ja valtuutusta. Kaikissa verkko-ohjelmointirajapintakutsuissa on oltava CSRF (jaetun julkaisuoikeuspyynnön väärentäminen) -tunnus.

Virhekoodit ja viestit

Seuraavassa taulukossa kuvataan erilaiset virhekoodit ja sanomat, joita voi ilmetä yhteenveto-ohjelmointirajapintaa käytettäessä.

Tilakoodi Virhekoodi Error message
400 90041001 Generatiivisen tekoälyn ominaisuudet on poistettu käytöstä
400 90041003 Tietojen yhteenveto on poistettu käytöstä tässä sivustossa. Ota käyttöön sivuston asetuksen avulla.
400 90041004 Sisällön pituus ylittää rajan
400 90041005 Tietueita ei löytynyt yhteenvetoa varten
400 90041006 Virhe sisällön yhteenvetoa muodostettaessa.

Tietojen yhteenvedon ohjelmointirajapinnan usein kysytyt kysymykset