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