เว็บฮุคช่วยให้ Gemini API ส่งการแจ้งเตือนแบบเรียลไทม์ไปยังเซิร์ฟเวอร์ของคุณเมื่อการดำเนินการแบบไม่พร้อมกันหรือการดำเนินการที่ใช้เวลานาน (LRO) เสร็จสมบูรณ์ ซึ่งจะมาแทนที่ความจำเป็นในการโพล API เพื่อดูข้อมูลอัปเดตสถานะ จึงช่วยลดเวลาในการตอบสนองและค่าใช้จ่าย
เว็บฮุคพร้อมใช้งานสำหรับการดำเนินการต่างๆ เช่น งานแบบกลุ่ม การโต้ตอบ และ การสร้างวิดีโอ
วิธีการทำงาน
แทนที่จะโพล GET /operations ซ้ำๆ เพื่อตรวจสอบว่างานเสร็จแล้วหรือไม่ คุณสามารถกำหนดค่าเว็บฮุคของ Gemini API ให้ส่งคำขอ HTTP POST ไปยัง URL ของ Listener ทันทีเมื่อมีการทริกเกอร์เหตุการณ์
Gemini API รองรับการกำหนดค่าเว็บฮุค 2 วิธีดังนี้
- เว็บฮุคแบบคงที่: ปลายทางระดับโปรเจ็กต์ที่กำหนดค่า ด้วย Gemini WebhookService API เหมาะสำหรับการผสานรวมทั่วโลก (เช่น การแจ้งเตือน Slack, การซิงค์ฐานข้อมูล ฯลฯ)
- เว็บฮุคแบบไดนามิก: การลบล้างระดับคำขอโดยส่ง URL ของเว็บฮุคในเพย์โหลดการกำหนดค่าของการเรียกงานที่เฉพาะเจาะจง เหมาะสำหรับการกำหนดเส้นทางงานที่เฉพาะเจาะจงไปยังปลายทางเฉพาะ
เว็บฮุคแบบคงที่
เว็บฮุคแบบคงที่จะลงทะเบียนสำหรับทั้ง โปรเจ็กต์ และทริกเกอร์สำหรับเหตุการณ์ที่ตรงกัน
สร้างเว็บฮุค
คุณสร้างปลายทางได้โดยใช้ SDK หรือ REST API
สำคัญ: เมื่อสร้างเว็บฮุค API จะแสดงข้อมูลลับในการลงนาม เพียงครั้งเดียว คุณต้องจัดเก็บข้อมูลนี้อย่างปลอดภัย (เช่น ในตัวแปรสภาพแวดล้อม) เพื่อยืนยันลายเซ็นในภายหลัง หากลืมข้อมูลลับในการลงนาม คุณจะต้อง หมุนเวียนข้อมูลลับดังกล่าว