ค้นหาและดึงข้อมูลเอกสาร

คู่มือนี้มีตัวอย่างวิธีใช้ฟังก์ชันของ Developer Knowledge API ได้แก่ การค้นหาเอกสาร การดึงข้อมูลเอกสารเดียว และการดึงข้อมูลเอกสารหลายรายการในกลุ่ม

ก่อนเริ่มต้น โปรดตรวจสอบว่าคุณได้เปิดใช้ API และสร้างคีย์ Developer Knowledge API แล้ว และบันทึกคีย์ลงในตัวแปรสภาพแวดล้อม 

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

ค้นหาเอกสารด้วย SearchDocumentChunks

ใช้เมธอด documents.searchDocumentChunks เพื่อค้นหาเอกสารที่ตรงกับสตริงการค้นหา ผลลัพธ์ประกอบด้วย เนื้อหาจากเอกสารและparentการอ้างอิงที่คุณใช้ เพื่อดึงเนื้อหาเอกสารทั้งหมดได้

ตัวอย่างต่อไปนี้จะค้นหาเอกสารที่ตรงกับ "BigQuery"

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

คุณปรับผลการค้นหาได้โดยใช้พารามิเตอร์ เช่น pageSize เพื่อจำกัดจำนวนผลการค้นหาต่อหน้า และ pageToken เพื่อดึงข้อมูลหน้าถัดไป

กรองผลการค้นหา

ใช้พารามิเตอร์ filter เพื่อใช้ตัวกรองที่เข้มงวดกับผลการค้นหา ระบบจะใช้ ตัวกรองกับข้อมูลเมตาของเอกสารที่เชื่อมโยงกับกลุ่มผลการค้นหา

ช่องที่รองรับสำหรับการกรอง

  • data_source (STRING): แหล่งที่มาของเอกสาร เช่น docs.cloud.google.com
  • update_time (TIMESTAMP): การประทับเวลาเมื่อมีการอัปเดตเอกสารครั้งล่าสุด
  • uri (STRING): URI ของเอกสาร เช่น https://docs.cloud.google.com/bigquery/docs/tables

โอเปอเรเตอร์ที่รองรับมีดังนี้

  • ฟิลด์ STRING รองรับ = (เท่ากับ) และ != (ไม่เท่ากับ) สำหรับการจับคู่ที่ตรงกันทุกประการในสตริงทั้งหมด
  • ฟิลด์การประทับเวลารองรับ =, <, <=, > และ >= การประทับเวลาต้องอยู่ในรูปแบบ RFC-3339 (เช่น "2025-01-01T00:00:00Z")

คุณสามารถรวมนิพจน์โดยใช้โอเปอเรเตอร์เชิงตรรกะ AND, OR และ NOT (หรือ -) โปรดทราบว่า OR มีลำดับความสำคัญสูงกว่า AND

ตัวอย่างต่อไปนี้ค้นหาเอกสารที่ตรงกับ "BigQuery" และจำกัด ผลลัพธ์ให้มาจาก docs.cloud.google.com

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&filter=data_source%3D%22docs.cloud.google.com%22&key=$DEVELOPERKNOWLEDGE_API_KEY"

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

ใช้เมธอด documents.get เพื่อดึงเนื้อหาทั้งหมดของเอกสารเดียว

ตัวอย่างต่อไปนี้จะดึงข้อมูลเอกสารที่มีชื่อ documents/DOCUMENT_ID

curl "https://developerknowledge.googleapis.com/v1/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"

การตอบกลับคือทรัพยากรแบบเต็ม Document รวมถึงฟิลด์ content

ดึงข้อมูลเอกสารหลายฉบับด้วย BatchGetDocuments

ใช้เมธอด documents.batchGet เพื่อดึงข้อมูลเอกสารได้สูงสุด 100 รายการตามชื่อในการเรียก API ครั้งเดียว ซึ่งมีประสิทธิภาพมากกว่าการส่งคำขอ GetDocument หลายรายการ

ตัวอย่างต่อไปนี้จะดึงข้อมูลเอกสาร 2 รายการตามชื่อ

curl "https://developerknowledge.googleapis.com/v1/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"

การตอบกลับจะมีรายการของทรัพยากรที่ขอ Document