با استفاده از تولید زمین به یک پرس و جو پاسخ میدهد.
درخواست HTTP
POST https://developerknowledge.googleapis.com/v1alpha:answerQuery
این URL از سینتکس Transcoding در gRPC استفاده میکند.
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{ "query": string } |
| فیلدها | |
|---|---|
query | الزامی. پرسشی که باید به آن پاسخ داده شود. |
بدنه پاسخ
پیام پاسخ برای DeveloperKnowledge.AnswerQuery .
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{
"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 ( |
| فیلدها | |
|---|---|
answerText | شامل متن پاسخ است. |
citations[] | فقط خروجی. شامل استنادهایی برای پاسخ است. |
references[] | فقط خروجی. شامل ارجاعات برای پاسخ است. |
پاسخ استناد
اطلاعات استناد برای یک بخش.
| نمایش JSON |
|---|
{
"startIndex": integer,
"endIndex": integer,
"sources": [
{
object ( |
| فیلدها | |
|---|---|
startIndex | فقط خروجی. شروع بخش را نشان میدهد که بر حسب بایت (یونیکد UTF-8) اندازهگیری میشود، شامل. اگر کاراکترهای چند بایتی مانند کاراکترهای غیر ASCII وجود داشته باشد، اندازهگیری شاخص طولانیتر از طول رشته است. |
endIndex | فقط خروجی. انتهای بخش را نشان میدهد که منحصراً با واحد بایت (یونیکد UTF-8) اندازهگیری میشود. اگر کاراکترهای چند بایتی مانند کاراکترهای غیر ASCII وجود داشته باشد، اندازه شاخص از طول رشته طولانیتر است. |
sources[] | فقط خروجی. شامل منابع استناد برای بخش نسبت داده شده است. |
منبع استناد
منبع استناد.
| نمایش JSON |
|---|
{ "referenceIndex": integer } |
| فیلدها | |
|---|---|
referenceIndex | فقط خروجی. شامل اندیس |
مرجع پاسخ
نشان دهنده ارجاع به یک منبع است.
| نمایش JSON |
|---|
{ // Union field |
| فیلدها | |
|---|---|
content فیلد Union. شامل محتوای مرجع است. content میتواند فقط یکی از موارد زیر باشد: | |
documentReference | فقط خروجی. سند مرجع. |
مرجع سند
نشان دهنده ارجاع به یک سند است.
| نمایش JSON |
|---|
{
"documentChunk": {
object ( |
| فیلدها | |
|---|---|
documentChunk | فقط خروجی. شامل بخش سند است. فیلد |