การเริ่มต้นอย่างรวดเร็ว: เริ่มต้นใช้งาน 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. คลิกสร้าง

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

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

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

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

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

  2. ใช้ curl เพื่อโทรไปยังปลายทาง AnswerQuery

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

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

ค้นหาเอกสารแบบเป็นกลุ่ม

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

ใช้ 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 ทั้งหมดของเอกสารที่ระบุ

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