Method: answerQuery

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

คำขอ HTTP

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

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

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

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

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

string

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

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

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

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

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

object (Answer)

คำตอบของคำค้นหา

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

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

  • https://www.googleapis.com/auth/devprofiles.full_control
  • 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 และจะปล่อยให้ว่างไว้