Method: answerQuery

با استفاده از تولید زمین به یک پرس و جو پاسخ می‌دهد.

درخواست HTTP

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

این URL از سینتکس Transcoding در 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 (رشته): آدرس اینترنتی سند، مثلاً https://docs.cloud.google.com/bigquery/docs/tables .

فیلدهای عدد صحیح از عملگرهای = ، < ، <= ، > و >= پشتیبانی می‌کنند.

فیلدهای 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 نباید بیش از ۵۰۰ کاراکتر باشد؛ مقادیر بیش از ۵۰۰ کاراکتر منجر به خطای 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 )

فقط خروجی. شامل ارجاعات برای پاسخ است.

پاسخ استناد

اطلاعات استناد برای یک بخش.

نمایش JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
فیلدها
startIndex

integer

فقط خروجی. شروع بخش را نشان می‌دهد که بر حسب بایت (یونیکد UTF-8) اندازه‌گیری می‌شود، شامل. اگر کاراکترهای چند بایتی مانند کاراکترهای غیر ASCII وجود داشته باشد، اندازه‌گیری شاخص طولانی‌تر از طول رشته است.

endIndex

integer

فقط خروجی. انتهای بخش را نشان می‌دهد که منحصراً با واحد بایت (یونیکد UTF-8) اندازه‌گیری می‌شود. اگر کاراکترهای چند بایتی مانند کاراکترهای غیر ASCII وجود داشته باشد، اندازه شاخص از طول رشته طولانی‌تر است.

sources[]

object ( CitationSource )

فقط خروجی. شامل منابع استناد برای بخش نسبت داده شده است.

منبع استناد

منبع استناد.

نمایش JSON 
{
  "referenceIndex": integer
}
فیلدها
referenceIndex

integer

فقط خروجی. شامل اندیس Answer.AnswerReference در فیلد references repeated است.

مرجع پاسخ

نشان دهنده ارجاع به یک منبع است.

نمایش JSON 
{

  // Union field content can be only one of the following:
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field content.
}
فیلدها
content فیلد Union. شامل محتوای مرجع است. content می‌تواند فقط یکی از موارد زیر باشد:
documentReference

object ( DocumentReference )

فقط خروجی. سند مرجع.

مرجع سند

نشان دهنده ارجاع به یک سند است.

نمایش JSON 
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
فیلدها
documentChunk

object ( DocumentChunk )

فقط خروجی. شامل بخش سند است. فیلد documentChunk.id تنظیم نشده و خالی خواهد بود.