Jaa

Tietojen yhteenvedon ohjelmointirajapinnan yleiskatsaus (esiversio)

  • Artikkeli

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

Power Pagesin yhteenvedon ohjelmointirajapinnan avulla tekijät voivat lisätä sivun sisältöyhteenvedon generatiivisen tekoälyn avulla, mikä auttaa sivuston käyttäjiä saamaan yleiskatsauksen käymättä läpi koko sivua. Ohjelmointirajapinta perustuu Power Pagesin verkko-ohjelmointirajapintaan, joka tarjoaa tietojen yhteenvedon sivuilla käytetyistä Dataverse-taulukoista.

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-ohjelmointirajapinnalle on otettava käyttöön sivustoasetukset.

  • Vain taulukot, joita Pagesin verkko-ohjelmointirajapinta tukee, ovat käytettävissä yhteenvetoa varten. Lisätietoja Pagesin verkko-ohjelmointirajapinnasta on kohdassa Verkko-ohjelmointirajapinnan yleiskatsaus.

  • 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 Pages käyttöön verkko-ohjelmointirajapinnassa ja määritä sivustoasetukset yhteenvedon ohjelmointirajapinnan ominaisuudelle.

Sivustoasetuksen nimi Description
Yhteenveto/Tiedot/Käyttöönotto Ottaa yhteenvetotoiminnon käyttöön tai poistaa sen käytöstä.
Oletus: Epätosi
Kelvolliset arvot: Tosi, Epätosi
Yhteenveto/kehote/{any_identifier} Näiden asetusten avulla voit antaa minkä tahansa ohjeen yhteenvetoa varten
Tyyppi: merkkijono
Esimerkki:
Nimi: Yhteenveto/kehote/case_summary
Arvo: Tee yhteenveto tärkeimmistä tiedoista ja kriittisistä tiedoista
Yhteenveto/Tiedot/ContentSizeLimit Muokkaa yhteenvedon sisällön syötteen kokorajoitusta
Tyyppi: kokonaisluku
Oletus: 100 k

API-rakenne

Method URI
POST [Site URI]/_api/summarization/data/v1.0/tablename{ "InstructionIdentifier":"", "RecommendationConfig":"" }
Nimi Description
InstructionIdentifier Tämä ominaisuus on valinnainen. Jos haluat välittää jonkin muun ohjeen yhteenvedolle, lisää kehote sivuston asetusten avulla.
Anna aina sivustoasetuksen nimi aiemmin määritetyllä tavalla.
RecommendationConfig Tämä ominaisuus on valinnainen. Jos välität yhteenvedon ohjelmointirajapinnan antaman suositellun kehotteen, käytä tätä parametria sen välittämiseen. Arvo on hajautettava eikä sitä saa muokata.

Muistiinpano

Ohjelmointirajapinta noudattaa Power Pagesin verkko-ohjelmointirajapinnan tukemia OData-vakiomäärityksiä. Yhteenveto-ohjelmointirajapinta tukee kaikkia lukutoimintoja, joita Power Pagesin verkko-ohjelmointirajapinta tukee.

Näyte

Tee yhteenveto tapaustyypistä, aiheesta, kuvauksesta ja tapaushistoriasta keskittymällä tärkeisiin ja kriittisiin 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-tunnistetta.

Suojaus

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

Yhteenvedon ohjelmointirajapinnan todennus

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 on eri virhekoodit ja viestit, joita saatat nähdä, kun käytät yhteenvedon ohjelmointirajapintaa:

Tilakoodi Virhekoodi Virhesanoma
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