แชร์ผ่าน

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

  • บทความ

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

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

สำคัญ

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

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

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

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

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

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

ใช้การตั้งค่าเหล่านี้เพื่อให้คำแนะนำในการสรุป
ชนิด: สตริง

ตัวอย่าง:
ชื่อ: Summarization/prompt/case_summary
ค่า: สรุปรายละเอียดที่สำคัญและข้อมูลสำคัญ
การสรุป/ข้อมูล/ContentSizeLimit แก้ไขขีดจำกัดขนาดอินพุตสำหรับเนื้อหาสรุป
ชนิด: จำนวนเต็ม
ค่าเริ่มต้น: 100,000

เค้าร่าง API

เมธอด URI ตัวอย่าง JSON
โพสต์ [URI ของไซต์]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
ชื่อคุณสมบัติ Description
InstructionIdentifier คุณสมบัตินี้เป็นทางเลือก หากคุณต้องการส่งคำแนะนำอื่นๆ สำหรับการสรุป ให้ใช้การตั้งค่าไซต์เพื่อเพิ่มพร้อมท์ คุณควรระบุชื่อการตั้งค่าไซต์ตามที่กำหนดไว้ก่อนหน้านี้เสมอ
RecommendationConfig คุณสมบัตินี้เป็นทางเลือก หากคุณต้องการส่งผ่านพร้อมท์ที่ API การสรุป แนะนำ ให้ใช้คุณสมบัตินี้เพื่อส่งผ่าน ค่าควรถูกแฮชและไม่มีการแก้ไข

หมายเหตุ

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

ตัวอย่าง

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

ส่งคำขอ

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

การตอบสนอง

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 การสรุปข้อมูล