Developer Knowledge API ให้สิทธิ์เข้าถึงเอกสารประกอบสำหรับนักพัฒนาแอปแบบสาธารณะของ Google แบบเป็นโปรแกรม ซึ่งช่วยให้คุณผสานรวมฐานความรู้นี้เข้ากับแอปพลิเคชันและเวิร์กโฟลว์ของคุณเองได้
ภาพรวม
Developer Knowledge API ได้รับการออกแบบมาให้เป็นแหล่งข้อมูลที่เชื่อถือได้สำหรับการเข้าถึงเอกสารประกอบสำหรับนักพัฒนาแอปของ Google ในรูปแบบที่เครื่องอ่านได้ โดยมีฟังก์ชันสำหรับการค้นหาและดึงข้อมูลเอกสาร รวมถึงตอบคำถาม ดังนี้
SearchDocumentChunksเพื่อค้นหา URI ของหน้าที่เกี่ยวข้องและข้อมูลสรุปเนื้อหาตามการค้นหาGetDocumentหรือBatchGetDocumentsเพื่อดึงข้อมูลเนื้อหาทั้งหมดของผลการค้นหาAnswerQueryเพื่อรับคำตอบสำหรับคำถามที่อิงตามคลังข้อมูลเอกสาร
หากต้องการเริ่มต้นใช้งานอย่างรวดเร็ว ให้ทำตามคู่มือเริ่มใช้งานฉบับย่อ
คลังข้อมูลเนื้อหาที่ค้นหาได้จะแสดงอยู่ใน ข้อมูลอ้างอิงคลังข้อมูล
Developer Knowledge API รองรับการค้นหาและดึงข้อมูลหน้าเอกสารประกอบเป็นเนื้อหา Markdown ที่ไม่มีโครงสร้าง
เปิดใช้ API
หากต้องการใช้ Developer Knowledge API คุณต้องเปิดใช้ API ดังกล่าวก่อนสำหรับโปรเจ็กต์ที่อยู่ในระบบคลาวด์ของ Google
- เปิดหน้า Developer Knowledge API ในไลบรารี Google API
- ตรวจสอบว่าคุณได้เลือกโปรเจ็กต์ที่ถูกต้องซึ่งคุณต้องการใช้ API
- คลิกเปิดใช้ คุณไม่จำเป็นต้องมีบทบาท IAM ที่เฉพาะเจาะจงเพื่อเปิดใช้หรือใช้ API
การตรวจสอบสิทธิ์
คุณต้องมีคีย์ Developer Knowledge API จึงจะใช้ Developer Knowledge API ได้ วิธีสร้างคีย์
- ในคอนโซล Google Cloud สำหรับโปรเจ็กต์ที่คุณเปิดใช้ API ให้ไปที่ หน้าข้อมูลเข้าสู่ระบบ
- คลิกสร้างข้อมูลเข้าสู่ระบบ แล้วเลือกคีย์ API จากเมนู
- ป้อนชื่อคีย์ในช่องชื่อ
-
คลิกเมนูแบบเลื่อนลงเลือกการจำกัด API แล้วพิมพ์ Developer Knowledge API คลิกผลลัพธ์ แล้วคลิก ตกลง
หมายเหตุ
- หากเพิ่งเปิดใช้ Developer Knowledge API ระบบอาจใช้เวลาสักครู่ ก่อนที่ API จะปรากฏในรายการ โปรดรอสักครู่แล้วลองอีกครั้ง
-
หากวางแผนที่จะใช้คีย์เดียวกันนี้สำหรับการเรียกโมเดลทั่วไปของไคลเอ็นต์ AI (เช่น
GEMINI_API_KEY) คุณต้องเลือก Generative Language API ด้วย มิฉะนั้นระบบจะบล็อกการเรียกเหล่านั้น
- คลิกสร้าง
ใส่คีย์ Developer Knowledge API นี้ในคำขอ เช่น การเรียก REST ควรใส่คีย์โดยใช้พารามิเตอร์การค้นหา key ดูตัวอย่างได้ใน
คู่มือเริ่มใช้งานฉบับย่อ
เอกสารประกอบที่รวมไว้
ดูข้อมูลเกี่ยวกับเอกสารที่ API ค้นหาได้ในข้อมูลอ้างอิงคลังข้อมูลสำหรับ ข้อมูล
Developer Knowledge API มีเป้าหมายที่จะให้สิทธิ์เข้าถึงเอกสารประกอบสำหรับนักพัฒนาแอปของ Google เวอร์ชันล่าสุด เป้าหมายของเราคือการจัดทำดัชนีเนื้อหาใหม่ภายใน 48 ชั่วโมงนับจากเวลาที่เผยแพร่ เพื่อให้เอกสารประกอบใหม่หรือที่อัปเดตพร้อมใช้งานภายใน 2 วันทำการข้อจำกัดที่ทราบ
- คุณภาพของ Markdown: ระบบสร้าง Markdown จาก HTML ต้นฉบับ จึงอาจมีความคลาดเคลื่อนหรือปัญหาเกี่ยวกับการจัดรูปแบบ
- ขอบเขตเนื้อหา: ระบบจะรวมเฉพาะหน้าสาธารณะใน ข้อมูลอ้างอิงคลังข้อมูล โดยไม่รวมเนื้อหาจากแหล่งที่มาอื่นๆ เช่น GitHub, เว็บไซต์ OSS, บล็อก หรือ YouTube