การเริ่มต้นอย่างรวดเร็ว: เริ่มต้นใช้งาน Developer Knowledge API

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

ก่อนเริ่มต้น

โปรดทำตามขั้นตอนต่อไปนี้ก่อนเริ่มใช้ Developer Knowledge API

เปิดใช้ API

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

สร้างและรักษาความปลอดภัยคีย์ API

  1. ในคอนโซล Google Cloud สำหรับโปรเจ็กต์ที่คุณเปิดใช้ API ให้ไปที่ หน้าข้อมูลเข้าสู่ระบบ
  2. คลิกสร้างข้อมูลเข้าสู่ระบบ แล้วเลือกคีย์ API จากเมนู
  3. ป้อนชื่อคีย์ในช่องชื่อ

  4. คลิกเมนูแบบเลื่อนลงเลือกข้อจำกัดของ API แล้วพิมพ์ Developer Knowledge API คลิกผลลัพธ์ แล้วคลิก ตกลง

    หมายเหตุ

    • หากเพิ่งเปิดใช้ Developer Knowledge API ระบบอาจใช้เวลาสักครู่ ก่อนที่ API จะปรากฏในรายการ โปรดรอสักครู่แล้วลองอีกครั้ง
    • หากคุณวางแผนที่จะใช้คีย์เดียวกันนี้สำหรับการเรียกโมเดลทั่วไปของไคลเอ็นต์ AI (เช่น GEMINI_API_KEY) คุณต้องเลือก Generative Language API ด้วย มิเช่นนั้นระบบจะบล็อกการเรียกเหล่านั้น
  5. คลิกสร้าง

สร้างคำตอบจากเอกสารประกอบ

เมื่อมีคีย์ Developer Knowledge API แล้ว คุณก็เริ่มใช้ API ได้ ตัวอย่างต่อไปนี้แสดงวิธีถามคำถามและสร้างคำตอบจากเอกสารประกอบ

  1. บันทึกคีย์ API ของ Developer Knowledge API ลงในตัวแปรสภาพแวดล้อมโดยทำดังนี้

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    แทนที่ YOUR_API_KEY ด้วยคีย์ API ที่คุณสร้างขึ้น

  2. ใช้ curl เพื่อเรียกปลายทาง AnswerQuery โดยทำดังนี้

    curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

คำสั่งนี้จะแสดงคำตอบสำหรับคำถามของคุณโดยอิงตามเอกสารประกอบ

ค้นหาข้อมูลเอกสาร

หากต้องการค้นหาสนับสนุนย่อยของเอกสารประกอบที่เฉพาะเจาะจงแทนที่จะเป็นคำตอบที่สร้างขึ้น คุณสามารถค้นหาข้อมูลเอกสารได้โดยตรง

ใช้ curl เพื่อเรียกปลายทาง SearchDocumentChunks โดยทำดังนี้

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

การตอบกลับจะมีข้อมูลเนื้อหาที่ตรงกันจากเอกสารประกอบและการอ้างอิงไปยังเอกสารหลัก

ดึงข้อมูลเอกสาร

การตอบกลับจาก searchDocumentChunks จะมีรายการข้อมูลเอกสาร ข้อมูลเอกสารแต่ละรายการจะมีช่อง parent ที่มีชื่อทรัพยากรของเอกสาร ซึ่งคุณสามารถใช้กับ GetDocument เพื่อดึงข้อมูลเนื้อหาทั้งหมดของเอกสารได้

หากต้องการดึงข้อมูลเอกสาร ให้คัดลอกช่อง parent จากข้อมูลเอกสารรายการใดรายการหนึ่งที่แสดงผลโดย searchDocumentChunks แล้วบันทึกลงในตัวแปรสภาพแวดล้อม จากนั้นใช้ curl เพื่อเรียกปลายทาง GetDocument โดยทำดังนี้

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

คำสั่งนี้จะแสดงเนื้อหา Markdown ทั้งหมดของเอกสารที่ระบุ

ขั้นตอนถัดไป