Gambaran keseluruhan API ringkasan data (pratonton)

[Artikel ini merupakan dokumentasi prakeluaran dan tertakluk pada perubahan.]

Pembuat menggunakan Power Pages API ringkasan untuk menambah ringkasan kandungan halaman dengan AI generatif. Ciri ini membolehkan pengguna laman web mendapatkan gambaran keseluruhan kandungan halaman tanpa membaca keseluruhan halaman. API dibina pada Power Pages API Web, yang menyediakan ringkasan data untuk Dataverse jadual yang digunakan pada halaman.

Penting

  • Ini adalah ciri pratonton.
  • Ciri pratonton bukan untuk kegunaan pengeluaran dan mungkin mempunyai kefungsian yang terbatas. Ciri-ciri ini tertakluk kepada syarat penggunaan tambahan, dan tersedia sebelum keluaran rasmi supaya pelanggan boleh mendapatkan access awal dan memberikan maklum balas.

Prasyarat

  • Dayakan tetapan laman web untuk API Web.
  • Hanya jadual yang disokong oleh Power Pages API Web tersedia untuk ringkasan. Ketahui lebih lanjut tentang Power Pages API Web dalam gambaran keseluruhan API Web.

Tetapan tapak

Dayakan halaman dalam API web anda dan tetapkan tetapan laman berikut untuk ciri API ringkasan.

Nama tetapan tapak Perihalan
Ringkasan/Data/Dayakan Dayakan atau lumpuhkan ciri ringkasan.
Lalai: palsu
Nilai yang sah: benar, palsu
Ringkasan/gesaan/{any_identifier}

Gunakan tetapan ini untuk memberikan arahan untuk meringkaskan.
Jenis: rentetan

Contoh:
Nama: Ringkasan/gesa/case_summary
Nilai: Ringkaskan butiran utama dan maklumat kritikal
Ringkasan/Data/ContentSizeLimit Ubah suai had saiz input untuk kandungan ringkasan.
Jenis: integer
Lalai: 100000 charecters

Skema API

Kaedah URI Sampel JSON
POST [URI Tapak]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Nama sifat Perihalan
Pengecam Arahan Hartanah ini adalah pilihan. Untuk lulus arahan tambahan untuk ringkasan, gunakan tetapan tapak untuk menambah gesaan. Sentiasa berikan nama tetapan tapak seperti yang ditakrifkan sebelum ini.
Konfigurasi Cadangan Hartanah ini adalah pilihan. Gunakan sifat ini untuk menghantar gesaan yang disyorkan oleh API ringkasan. Nilai mesti dicincang dan kekal tidak diubah suai.

Nota

API mengikut spesifikasi Protokol Data Terbuka (OData) standard yang disokong oleh Power Pages API Web. API ringkasan menyokong semua operasi baca yang tersedia dalam Power Pages API Web.

Sampel

Ringkaskan jenis kes, subjek, penerangan dan sejarah kes dengan memfokuskan pada butiran utama dan maklumat penting.

Permintaan

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

Respons

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

Respons ringkasan menyediakan gesaan yang disyorkan untuk memperhalusi ringkasan. Untuk menggunakan cadangan ini, hantar nilai konfigurasi dalam isi permintaan tanpa InstructionIdentifier sifat.

Keselamatan

API ringkasan menghormati keselamatan berasaskan peranan yang dikonfigurasikan untuk keizinan jadual dan lajur. Ia hanya mempertimbangkan rekod yang boleh diakses oleh pengguna untuk ringkasan.

Mengesahkan API ringkasan

Anda tidak perlu menyertakan kod pengesahan kerana sesi aplikasi menguruskan pengesahan dan kebenaran. Semua panggilan API Web mesti termasuk token pemalsuan permintaan merentas tapak (CSRF).

Kod ralat dan mesej

Jadual berikut menerangkan kod ralat dan mesej berbeza yang mungkin anda hadapi apabila anda menggunakan API ringkasan.

Kod status Kod ralat Mesej ralat
400 90041001 Ciri AI generatif dilumpuhkan
400 90041003 Ringkasan data dilumpuhkan untuk laman web ini. Dayakan penggunaan tetapan tapak.
400 90041004 Panjang kandungan melebihi had
400 90041005 Tiada rekod ditemui untuk meringkaskan
400 90041006 Ralat berlaku semasa meringkaskan kandungan.

Soalan Lazim untuk API ringkasan data

  • Last updated on