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