Method: answerQuery

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

คำขอ HTTP

POST https://developerknowledge.googleapis.com/v1alpha:answerQuery

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

เนื้อความของคำขอ

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

การแสดง JSON 
{
  "query": string,
  "filter": string
}
ช่อง
query

string

ต้องระบุ คำค้นหาที่ต้องการตอบ
filter

string

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

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

  • contentLengthBytes (INTEGER): ความยาวของช่อง Document.content ในหน่วยไบต์
  • 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

ช่อง 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.AnswerQuery

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

การแสดง JSON 
{
  "answer": {
    object (Answer)
  }
}
ช่อง
answer

object (Answer)

คำตอบสำหรับคำค้นหา

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

ต้องใช้ขอบเขต 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.

คำตอบ

คำตอบสำหรับคำค้นหา

การแสดง JSON 
{
  "answerText": string,
  "citations": [
    {
      object (AnswerCitation)
    }
  ],
  "references": [
    {
      object (AnswerReference)
    }
  ]
}
ช่อง
answerText

string

มีข้อความของคำตอบ
citations[]

object (AnswerCitation)

เอาต์พุตเท่านั้น มีการอ้างอิงสำหรับคำตอบ
references[]

object (AnswerReference)

เอาต์พุตเท่านั้น มีการอ้างอิงสำหรับคำตอบ

AnswerCitation

ข้อมูลการอ้างอิงสำหรับกลุ่ม

การแสดง JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
ช่อง
startIndex

integer

เอาต์พุตเท่านั้น ระบุจุดเริ่มต้นของกลุ่มที่วัดเป็นไบต์ (Unicode UTF-8) ซึ่งรวมถึง หากมีอักขระหลายไบต์ เช่น อักขระที่ไม่ใช่ ASCII การวัดดัชนีจะยาวกว่าความยาวของสตริง
endIndex

integer

เอาต์พุตเท่านั้น ระบุจุดสิ้นสุดของกลุ่มที่วัดเป็นไบต์ (Unicode UTF-8) ซึ่งไม่รวม หากมีอักขระหลายไบต์ เช่น อักขระที่ไม่ใช่ ASCII การวัดดัชนีจะยาวกว่าความยาวของสตริง
sources[]

object (CitationSource)

เอาต์พุตเท่านั้น มีแหล่งที่มาของการอ้างอิงสำหรับกลุ่มที่มีการระบุแหล่งที่มา

CitationSource

แหล่งที่มาของการอ้างอิง

การแสดง JSON 
{
  "referenceIndex": integer
}
ช่อง
referenceIndex

integer

เอาต์พุตเท่านั้น มีดัชนีของ Answer.AnswerReference ในช่อง references ที่ซ้ำได้

AnswerReference

แสดงการอ้างอิงไปยังแหล่งที่มา

การแสดง JSON 
{

  // Union field content can be only one of the following:
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field content.
}
ช่อง
ฟิลด์ Union content มีเนื้อหาของการอ้างอิง content จะเป็นได้เพียงอย่างใดอย่างหนึ่งต่อไปนี้
documentReference

object (DocumentReference)

เอาต์พุตเท่านั้น เอกสารอ้างอิง

DocumentReference

แสดงการอ้างอิงไปยังเอกสาร

การแสดง JSON 
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
ช่อง
documentChunk

object (DocumentChunk)

เอาต์พุตเท่านั้น มีส่วนของเอกสาร ระบบไม่ได้ตั้งค่าช่อง documentChunk.id และช่องนี้จะเป็นค่าว่าง