Developer Knowledge API

Developer Knowledge API ให้สิทธิ์เข้าถึงเอกสารประกอบสำหรับนักพัฒนาแอปแบบสาธารณะของ Google แบบเป็นโปรแกรม ซึ่งช่วยให้คุณผสานรวมฐานความรู้นี้เข้ากับแอปพลิเคชันและเวิร์กโฟลว์ของคุณเองได้

ภาพรวม

Developer Knowledge API ออกแบบมาให้เป็นแหล่งข้อมูลที่เชื่อถือได้สำหรับการเข้าถึงเอกสารประกอบสำหรับนักพัฒนาซอฟต์แวร์ของ Google ในรูปแบบที่เครื่องอ่านได้ โดยมีฟังก์ชัน ในการค้นหาและดึงข้อมูลเอกสาร รวมถึงตอบคำค้นหา ดังนี้

• SearchDocumentChunks เพื่อค้นหา URI ของหน้าเว็บและ ข้อมูลโค้ดเนื้อหาที่เกี่ยวข้องตามคำค้นหา
• GetDocument หรือ BatchGetDocuments เพื่อดึงเนื้อหาทั้งหมดของผลการค้นหา
• AnswerQuery เพื่อ สร้างคำตอบสำหรับคำถามที่ดึงมาจากคลังเอกสาร

Developer Knowledge API รองรับการค้นหาและดึงข้อมูลหน้าเอกสารประกอบเป็นเนื้อหามาร์กดาวน์ที่ไม่มีโครงสร้าง คลังข้อมูลของเนื้อหาที่ค้นหาได้แสดงอยู่ในการอ้างอิงคลังข้อมูล

วิธีใช้ความรู้สำหรับนักพัฒนาซอฟต์แวร์

คุณเข้าถึงความรู้สำหรับนักพัฒนาแอปได้ผ่านแพลตฟอร์มต่อไปนี้ ทั้งนี้ขึ้นอยู่กับเวิร์กโฟลว์ของคุณ

• REST API และ RPC API: เรียกปลายทาง HTTP หรือ gRPC โดยตรง ดูข้อกำหนดของเมธอดได้ในข้อมูลอ้างอิง REST และข้อมูลอ้างอิง RPC
• ไลบรารีของไคลเอ็นต์: ผสานรวม Developer Knowledge API เข้ากับแอปพลิเคชันของคุณโดยใช้ไลบรารีของไคลเอ็นต์อย่างเป็นทางการสำหรับ Python, Node.js และ TypeScript, Go, Java, PHP และ Ruby
• Google Cloud CLI (gcloud): เรียกใช้gcloud developer-knowledge คำสั่งจากเทอร์มินัลเพื่อค้นหา กลุ่มเอกสาร ดึงข้อมูลเนื้อหามาร์กดาวน์ และสร้างคำตอบ
• เซิร์ฟเวอร์ MCP ความรู้สำหรับนักพัฒนาแอป: เชื่อมต่อผู้ช่วยหรือเอเจนต์การเขียนโค้ด AI กับเอกสารประกอบของ Google โดยใช้เครื่องมือ Model Context Protocol (MCP) (search_documents, get_documents และ answer_query) โปรดดูข้อมูลอ้างอิง MCP

เคล็ดลับ: หากคุณใช้ผู้ช่วยการเขียนโค้ด AI ให้ติดตั้ง retrieving-developer-knowledgeทักษะของ Agent โดยเรียกใช้ npx skills add google/skills --skill retrieving-developer-knowledge ความสามารถนี้ จะให้คำสั่งในตัวแก่ผู้ช่วยเกี่ยวกับเครื่องมือเซิร์ฟเวอร์ MCP ของ Developer Knowledge ที่จะ เลือก วิธีจัดการข้อผิดพลาด และวิธีเรียก REST API ด้วย curl หากเซิร์ฟเวอร์ MCP ไม่พร้อมใช้งาน ดูข้อมูลเพิ่มเติมได้ที่ ใช้ทักษะเอเจนต์ความรู้สำหรับนักพัฒนาแอป

เลือกระหว่าง API กับเซิร์ฟเวอร์ MCP

Developer Knowledge API และเซิร์ฟเวอร์ MCP ของ Developer Knowledge ออกแบบมาเพื่อความต้องการในการผสานรวมที่แตกต่างกัน ดังนี้

• ใช้ Developer Knowledge API, ไลบรารีของไคลเอ็นต์ หรือ gcloud CLI เมื่อมีกรณีต่อไปนี้
  • โปรเจ็กต์ของคุณไม่ได้ใช้ AI Agent
  • คุณต้องการกำหนดเครื่องมือหรือชุดเครื่องมือที่กำหนดเองสำหรับเอเจนต์
  • คุณต้องการประมวลผลหรือรวมผลลัพธ์ก่อนส่งไปยังโมเดล (เช่น ตรวจสอบความยาวของไบต์ของเอกสารก่อนที่จะดึงเนื้อหาทั้งหมด )
  • คุณต้องกรองผลการค้นหา (เช่น ตาม data_source หรือ update_time) หรือใช้ ฟิลด์มาสก์
• ใช้เซิร์ฟเวอร์ MCP และทักษะเอเจนต์ของ Developer Knowledge เมื่อ
  • คุณต้องการเชื่อมต่อผู้ช่วยหรือเอเจนต์การเขียนโค้ด AI โดยไม่ต้องเขียน คำจำกัดความและคำอธิบายเครื่องมือที่กำหนดเอง
  • คุณต้องการการอัปเดตอัตโนมัติเมื่อเซิร์ฟเวอร์ MCP ความรู้สำหรับนักพัฒนาแอปเพิ่มความสามารถใหม่ๆ
  • คุณไม่จำเป็นต้องกรองข้อมูลเมตาที่กำหนดเองในผลการค้นหา

เปิดใช้ API

หากต้องการใช้ Developer Knowledge API คุณต้องเปิดใช้ API ดังกล่าวก่อนสำหรับโปรเจ็กต์ที่อยู่ในระบบคลาวด์ของ Google

เคล็ดลับ: หากไม่มีโปรเจ็กต์ที่อยู่ในระบบคลาวด์ของ Google ให้สร้างโปรเจ็กต์โดยใช้คำสั่งของ Google Cloud หรือ Firebase

1. เปิดหน้า Developer Knowledge API ในคลัง Google APIs
2. ตรวจสอบว่าคุณได้เลือกโปรเจ็กต์ที่ถูกต้องซึ่งคุณต้องการ ใช้ API
3. คลิกเปิดใช้ คุณไม่จำเป็นต้องมีบทบาท IAM ที่เฉพาะเจาะจงเพื่อเปิดใช้หรือใช้ API

การตรวจสอบสิทธิ์

คุณสามารถตรวจสอบสิทธิ์คำขอไปยัง Developer Knowledge API ได้โดยใช้วิธีใดวิธีหนึ่งต่อไปนี้

• คีย์ API: ตรวจสอบสิทธิ์คำขอ REST โดยตรงหรือเซิร์ฟเวอร์ MCP ของ Developer Knowledge โดยใช้พารามิเตอร์การค้นหา key หรือส่วนหัว X-Goog-Api-Key
• ข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน (ADC), OAuth 2.0 หรือบัญชีบริการ: ตรวจสอบสิทธิ์คำขอเมื่อใช้ ไลบรารีของไคลเอ็นต์อย่างเป็นทางการหรือเวิร์กโฟลว์เวอร์ชันที่ใช้งานจริง ดูข้อมูลเพิ่มเติมเกี่ยวกับการตั้งค่าข้อมูลเข้าสู่ระบบได้ที่เอกสารประกอบเกี่ยวกับข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน
• ข้อมูลเข้าสู่ระบบของผู้ใช้ (gcloud CLI): ตรวจสอบสิทธิ์คำขอ CLI โดย ลงชื่อเข้าใช้บัญชี Google Cloud ด้วย gcloud auth login ดูวิธีการตั้งค่าได้ที่คู่มือเริ่มใช้งานฉบับย่อของ gcloud CLI

เอกสารที่รวมอยู่ด้วย

ดูข้อมูลเกี่ยวกับเอกสารที่ API ค้นหาได้ที่ข้อมูลอ้างอิงของคลัง

Developer Knowledge API มีเป้าหมายที่จะให้สิทธิ์เข้าถึงเอกสารประกอบล่าสุดของ Google สำหรับนักพัฒนาซอฟต์แวร์ เป้าหมายของเราคือการจัดทำดัชนีเนื้อหาอีกครั้งภายใน 48 ชั่วโมงหลังจากเผยแพร่ เพื่อให้เอกสารประกอบใหม่หรือที่อัปเดตพร้อมใช้งานภายใน 2 วันทำการ

ข้อจำกัดที่ทราบ

• คุณภาพของมาร์กดาวน์: มาร์กดาวน์สร้างขึ้นจาก HTML ต้นฉบับ อาจมีความคลาดเคลื่อนหรือปัญหาการจัดรูปแบบ
• ขอบเขตเนื้อหา: ระบบจะรวมเฉพาะหน้าสาธารณะในการอ้างอิงคลังข้อความ เนื้อหาจากแหล่งที่มาอื่นๆ เช่น GitHub, เว็บไซต์ OSS, บล็อก หรือ YouTube จะไม่รวมอยู่ด้วย