ภาพรวม API การสรุปข้อมูล (พรีวิว)

[บทความนี้เป็นคู่มือรุ่นก่อนวางจำหน่าย และอาจจะมีการเปลี่ยนแปลงในอนาคต]

ผู้สร้างใช้ API การสรุป Power Pages เพื่อเพิ่มการสรุปเนื้อหาของหน้าด้วย AI สร้างสรรค์ คุณลักษณะ นี้ช่วยให้ผู้ใช้ไซต์ได้รับภาพรวมของเนื้อหาของหน้าโดยไม่ต้องอ่านทั้งหน้า API สร้างขึ้นด้วย API เว็บสำหรับ Power Pages ซึ่งให้สรุปข้อมูลสำหรับตาราง Dataverse ที่ใช้ในหน้าเว็บ

สำคัญ

• นี่คือคุณลักษณะพรีวิว
• คุณลักษณะพรีวิวไม่ได้มีไว้สำหรับการนำไปใช้งานจริง และอาจมีการจำกัดฟังก์ชันการทำงาน คุณลักษณะเหล่านี้อยู่ภายใต้ ข้อกำหนดการใช้งานเพิ่มเติม และสามารถใช้ได้ก่อนการเผยแพร่อย่างเป็นทางการเพื่อให้ลูกค้าสามารถเข้าถึงล่วงหน้าและแสดงความคิดเห็น

ข้อกำหนดเบื้องต้น

• เปิดใช้งาน การตั้งค่าไซต์ สำหรับ API เว็บ
• เฉพาะตารางที่ได้รับการสนับสนุนจาก API เว็บสำหรับ Power Pages เท่านั้นที่สามารถใช้สำหรับการสรุป เรียนรู้เพิ่มเติมเกี่ยวกับ API เว็บสำหรับ Power Pages ใน ภาพรวมของ API เว็บ
• คุณลักษณะนี้ไม่สามารถใช้งานในภูมิภาค Government Community Cloud (GCC), Government Community Cloud - High (GCC High) หรือกระทรวงกลาโหม (DoD)

การตั้งค่าไซต์

เปิดใช้งานหน้าเว็บใน API เว็บของคุณและตั้งค่าไซต์ต่อไปนี้สำหรับคุณลักษณะ API การสรุป

ชื่อการตั้งค่าไซต์	Description
การสรุป/ข้อมูล/เปิดใช้งาน	เปิดใช้งานหรือปิดใช้งานคุณลักษณะการสรุป ค่าเริ่มต้น: เท็จ ค่าที่ถูกต้อง: จริง, เท็จ
การสรุป/พร้อมท์/{any_identifier}	ใช้การตั้งค่าเหล่านี้เพื่อให้คำแนะนำในการสรุป ชนิด: สตริง ตัวอย่าง: ชื่อ: Summarization/prompt/case_summary ค่า: สรุปรายละเอียดที่สำคัญและข้อมูลสำคัญ
การสรุป/ข้อมูล/ContentSizeLimit	แก้ไขขีดจำกัดขนาดอินพุตสำหรับเนื้อหาสรุป ชนิด: จำนวนเต็ม ค่าเริ่มต้น: อักขระ 100000 ตัว

เค้าร่าง API

เมธอด	URI	ตัวอย่าง JSON
โพสต์	[URI ของไซต์]/_api/summarization/data/v1.0/tablesetname	{ "InstructionIdentifier":"", "RecommendationConfig":"" }

ชื่อคุณสมบัติ	Description
InstructionIdentifier	คุณสมบัตินี้เป็นทางเลือก หากต้องการส่งคำแนะนำเพิ่มเติมสำหรับการสรุป ให้ใช้การตั้งค่าไซต์เพื่อเพิ่มพร้อมท์ ระบุชื่อการตั้งค่าไซต์ตามที่กำหนดไว้ก่อนหน้านี้เสมอ
RecommendationConfig	คุณสมบัตินี้เป็นทางเลือก ใช้คุณสมบัตินี้เพื่อส่งผ่านพร้อมท์ที่แนะนำโดย API การสรุป ค่าจะต้องถูกแฮชและยังคงไม่แก้ไข

หมายเหตุ

API เป็นไปตามข้อกำหนด Open Data Protocol (OData) มาตรฐานที่ API เว็บสำหรับ Power Pages รองรับ API การสรุปรองรับ การดำเนินการอ่านทั้งหมดที่มีอยู่ใน API เว็บสำหรับ Power Pages

ตัวอย่าง

สรุปประเภทกรณี หัวเรื่อง คำอธิบาย และประวัติกรณีโดยเน้นที่รายละเอียดที่สำคัญและข้อมูลสำคัญ

ส่งคำขอ

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

การตอบสนอง

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	เกิดข้อผิดพลาดขณะสรุปเนื้อหา

ข้อมูลที่เกี่ยวข้อง

คำถามที่ถามบ่อยเกี่ยวกับ API การสรุปข้อมูล