Developer Knowledge API

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

ภาพรวม

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

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

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

วิธีใช้ Developer Knowledge

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

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

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

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

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

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

เปิดใช้ API

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

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

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

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

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

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

ขอบเขต OAuth

เมื่อตรวจสอบสิทธิ์ด้วย OAuth 2.0 หรือบัญชีบริการ Developer Knowledge API และเซิร์ฟเวอร์ Developer Knowledge MCP จะยอมรับขอบเขต OAuth ต่อไปนี้

• https://www.googleapis.com/auth/cloud-platform: ขอบเขตเริ่มต้นที่ใช้โดยข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน (ADC), gcloud CLI และไลบรารีของไคลเอ็นต์ Google Cloud อย่างเป็นทางการ
• https://www.googleapis.com/auth/devprofiles.full_control: ขอบเขตที่ใช้สำหรับขั้นตอนการขอความยินยอม OAuth 2.0 ของผู้ใช้และการผสานรวมเซิร์ฟเวอร์ MCP
• https://www.googleapis.com/auth/developerprofiles.readonly: ขอบเขตแบบอ่านอย่างเดียวที่รองรับสำหรับบัญชีบริการและข้อมูลเข้าสู่ระบบที่ไม่ต้องใช้หน้าจอขอความยินยอม OAuth ของผู้ใช้ปลายทาง

การให้สิทธิ์โทเค็นสำหรับผู้ถือ

หากต้องการตรวจสอบสิทธิ์คำขอ REST โดยตรงด้วยบัญชีบริการหรือโทเค็นเพื่อการเข้าถึง OAuth 2.0 ให้ส่งโทเค็นในส่วนหัว Authorization: Bearer และระบุโปรเจ็กต์สำหรับการเรียกเก็บเงินใน X-Goog-User-Project ดังนี้

export ACCESS_TOKEN=$(gcloud auth print-access-token)
curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Goog-User-Project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

แทนที่ PROJECT_ID ด้วยรหัสโปรเจ็กต์ Google Cloud

สำหรับแอปพลิเคชัน Python, Node.js, Go และ Java ไลบรารีของไคลเอ็นต์อย่างเป็นทางการจะจัดการข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน (ADC) และการรีเฟรชโทเค็นโดยอัตโนมัติ ดูตัวอย่างได้ที่ใช้ไลบรารีของไคลเอ็นต์กับ Developer Knowledge API

เอกสารประกอบที่รวมไว้

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

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

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

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