Method: documents.searchDocumentChunks

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

คำขอ HTTP

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

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

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

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

string

ต้องระบุ ระบุสตริงการค้นหาดิบที่ผู้ใช้ระบุ เช่น "วิธีสร้างที่เก็บข้อมูล Cloud Storage"
pageSize

integer

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

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

ค่าสูงสุดคือ 20 ค่าที่สูงกว่า 20 จะทำให้เกิดข้อผิดพลาด INVALID_ARGUMENT
pageToken

string

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

string

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

ขณะที่ documents.searchDocumentChunks แสดงผล DocumentChunk รายการ ระบบจะใช้ตัวกรองกับฟิลด์ DocumentChunk.document

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

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

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

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

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

ตัวอย่าง

  • 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/cloud-platform

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

DocumentChunk

DocumentChunk แสดงถึงเนื้อหาส่วนหนึ่งจาก Document ในคลังความรู้ของนักพัฒนาซอฟต์แวร์ หากต้องการดึงเนื้อหาเอกสารทั้งหมด ให้ส่ง parent ไปยัง DeveloperKnowledge.GetDocument หรือ DeveloperKnowledge.BatchGetDocuments

การแสดง JSON 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
ช่อง
parent

string

เอาต์พุตเท่านั้น มีชื่อทรัพยากรของเอกสารที่มาจากก้อนข้อมูลนี้ รูปแบบ: documents/{uri_without_scheme} ตัวอย่าง: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

เอาต์พุตเท่านั้น ระบุรหัสของก้อนข้อมูลนี้ภายในเอกสาร รหัสก้อนข้อมูลจะไม่ซ้ำกันภายในเอกสาร แต่จะไม่ซ้ำกันทั่วโลกในเอกสารต่างๆ รหัสกลุ่มไม่คงที่และอาจเปลี่ยนแปลงเมื่อเวลาผ่านไป
content

string

เอาต์พุตเท่านั้น มีเนื้อหาของก้อนเอกสาร
document

object (Document)

เอาต์พุตเท่านั้น แสดงข้อมูลเมตาเกี่ยวกับ Document ที่ได้จากก้อนข้อมูลนี้ ระบบจะตั้งค่า DocumentView ของข้อความ Document นี้เป็น DOCUMENT_VIEW_BASIC เราได้รวมไว้ที่นี่เพื่อความสะดวก เพื่อให้ลูกค้าไม่ต้องเรียกใช้ DeveloperKnowledge.GetDocument หรือ DeveloperKnowledge.BatchGetDocuments หากต้องการเฉพาะฟิลด์ข้อมูลเมตา มิฉะนั้น ลูกค้าควรใช้ DeveloperKnowledge.GetDocument หรือ DeveloperKnowledge.BatchGetDocuments เพื่อดึงเนื้อหาเอกสารทั้งหมด