Method: documents.searchDocumentChunks

ค้นหาความรู้ของนักพัฒนาแอปในเอกสารประกอบสำหรับนักพัฒนาแอปของ Google แสดงผล DocumentChunk ตามคำค้นหาของผู้ใช้ โดยอาจมีหลาย Chunk จาก Document เดียวกัน หากต้องการดึงข้อมูลเอกสารฉบับเต็ม ให้ใช้ DeveloperKnowledge.GetDocument หรือ DeveloperKnowledge.BatchGetDocuments กับ DocumentChunk.parent ที่แสดงผลใน SearchDocumentChunksResponse.results

คำขอ HTTP

GET https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks

URL ใช้ ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
query

string

ต้องระบุ ระบุสตริงคำค้นหาดิบที่ผู้ใช้ป้อน เช่น "วิธีสร้างบัคเก็ต Cloud Storage" คำค้นหาต้องมีความยาวไม่เกิน 500 อักขระ หากยาวเกิน 500 อักขระ ระบบจะแสดงข้อผิดพลาด INVALID_ARGUMENT
pageSize

integer

ไม่บังคับ ระบุจำนวนผลลัพธ์สูงสุดที่จะแสดง บริการอาจแสดงผลลัพธ์น้อยกว่าค่านี้

หากไม่ได้ระบุ ระบบจะแสดงผลลัพธ์ไม่เกิน 5 รายการ

ค่าสูงสุดคือ 100 หากค่าสูงกว่า 100 ระบบจะบังคับให้เป็น 100
pageToken

string

ไม่บังคับ มีโทเค็นหน้าเว็บที่ได้รับจากการเรียก documents.searchDocumentChunks ครั้งก่อน ระบุโทเค็นนี้เพื่อดึงข้อมูลหน้าถัดไป
filter

string

ไม่บังคับ ใช้ตัวกรองที่เข้มงวดกับผลการค้นหา นิพจน์รองรับไวยากรณ์บางส่วนที่อธิบายไว้ที่ https://google.aip.dev/160

แม้ว่า documents.searchDocumentChunks จะแสดงผล DocumentChunks แต่ระบบจะใช้ตัวกรองกับช่อง DocumentChunk.document

ช่องที่รองรับสำหรับการกรองมีดังนี้

  • contentLengthBytes (INTEGER): ความยาวของช่อง Document.content ในหน่วยไบต์
  • dataSource (STRING): แหล่งที่มาของเอกสาร เช่น docs.cloud.google.com ดูรายการแหล่งข้อมูลทั้งหมดใน Corpus ได้ที่ https://developers.google.com/knowledge/reference/corpus-reference
  • updateTime (TIMESTAMP): การประทับเวลาของการอัปเดตที่มีความหมายครั้งล่าสุดของเอกสาร การอัปเดตที่มีความหมายคือการอัปเดตที่เปลี่ยนเนื้อหา Markdown หรือข้อมูลเมตาของเอกสาร
  • uri (STRING): URI ของเอกสาร เช่น https://docs.cloud.google.com/bigquery/docs/tables

ช่อง INTEGER รองรับตัวดำเนินการ =, <, <=, >, และ >=

ช่อง STRING รองรับตัวดำเนินการ = (เท่ากับ) และ != (ไม่เท่ากับ) สำหรับการค้นหาที่ตรงกันทุกประการ ในสตริงทั้งหมด ไม่รองรับการค้นหาที่ตรงกันบางส่วน การค้นหาที่ตรงกันกับคำนำหน้า และการค้นหาที่ตรงกันกับนิพจน์ทั่วไป

ช่อง TIMESTAMP รองรับตัวดำเนินการ =, <, <=, >, และ >= การประทับเวลาต้องอยู่ในรูปแบบ RFC-3339 เช่น "2025-01-01T00:00:00Z"

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

ตัวอย่าง

  • กรองตาม Document.content_length_bytes: contentLengthBytes < 50000
  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

สตริง filter ต้องมีความยาวไม่เกิน 500 อักขระ หากยาวเกิน 500 อักขระ ระบบจะแสดงข้อผิดพลาด INVALID_ARGUMENT

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

ข้อความตอบกลับสำหรับ DeveloperKnowledge.SearchDocumentChunks

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
ช่อง
results[]

object (DocumentChunk)

มีผลการค้นหาสำหรับคำค้นหาที่ระบุ DocumentChunk แต่ละรายการในรายการนี้มีข้อมูลโค้ดเนื้อหาที่เกี่ยวข้องกับคำค้นหา ใช้ช่อง DocumentChunk.parent ของผลลัพธ์แต่ละรายการกับ DeveloperKnowledge.GetDocument หรือ DeveloperKnowledge.BatchGetDocuments เพื่อดึงข้อมูลเนื้อหาเอกสารฉบับเต็ม
nextPageToken

string

ระบุโทเค็นที่สามารถส่งเป็น pageToken เพื่อดึงข้อมูลหน้าถัดไป หากไม่ระบุช่องนี้ แสดงว่าไม่มีหน้าถัดไป

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview.