Method: answerQuery

يجيب عن طلب باستخدام ميزة "الإنشاء المستند إلى بيانات واقعية".

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل الترميز إلى gRPC.

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "query": string,
  "filter": string
}
الحقول
query

string

الحقل مطلوب. تمثّل هذه السمة طلب البحث الذي يجب الإجابة عنه.
filter

string

اختيارية: تطبيق فلتر صارم على نتائج البحث المستخدَمة لتحديد الإجابة يتوافق التعبير مع مجموعة فرعية من بنية الجملة الموضّحة في https://google.aip.dev/160.

الحقول المتاحة للفلترة:

  • ‫content_length_bytes (عدد صحيح): طول الحقل Document.content بالبايت
  • ‫data_source (STRING): مصدر المستند، مثل docs.cloud.google.com يمكنك الاطّلاع على https://developers.google.com/knowledge/reference/corpus-reference للحصول على القائمة الكاملة بمصادر البيانات في مجموعة المستندات.
  • update_time (الطابع الزمني): الطابع الزمني لآخر مرة تم فيها تعديل المستند بشكل كبير. التعديل المهم هو الذي يغيّر محتوى مستند Markdown أو البيانات الوصفية.
  • ‫uri (STRING): معرّف الموارد المنتظم للمستند، مثل https://docs.cloud.google.com/bigquery/docs/tables

تتوافق حقول INTEGER مع عوامل التشغيل = و< و<= و> و>=.

تتيح حقول STRING عوامل التشغيل = (يساوي) و!= (لا يساوي) لإجراء مطابقة تامة للسلسلة بأكملها. لا تتوفّر المطابقة الجزئية والمطابقة مع البادئة والمطابقة مع التعبير العادي.

تتوافق حقول الطوابع الزمنية مع عوامل التشغيل = و< و<= و> و>=. يجب أن تكون الطوابع الزمنية بالتنسيق RFC-3339، مثل "2025-01-01T00:00:00Z".

يمكنك دمج التعبيرات باستخدام عوامل التشغيل المنطقية AND وOR وNOT (أو -). تكون OR ذات أولوية أعلى من AND. استخدِم الأقواس للتجميع حسب الأولوية.

أمثلة:

  • الفلترة حسب Document.content_length_bytes: content_length_bytes < 50000
  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

يجب ألا تتجاوز السلسلة filter 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

النتائج فقط. تشير إلى بداية المقطع، ويتم قياسها بالبايت (يونيكود UTF-8)، وهي قيمة شاملة. في حال توفّر أحرف متعددة البايتات، مثل الأحرف غير ASCII، يكون قياس الفهرس أطول من طول السلسلة.
endIndex

integer

النتائج فقط. تشير إلى نهاية المقطع، ويتم قياسها بالبايت (يونيكود UTF-8)، وهي قيمة حصرية. في حال توفّر أحرف متعددة البايتات، مثل الأحرف غير ASCII، يكون قياس الفهرس أطول من طول السلسلة.
sources[]

object (CitationSource)

النتائج فقط. تحتوي على مصادر التوثيق الخاصة بالشريحة المحدّدة المصدر.

CitationSource

مصدر الاقتباس

تمثيل JSON 
{
  "referenceIndex": integer
}
الحقول
referenceIndex

integer

النتائج فقط. يحتوي على فهرس Answer.AnswerReference في الحقل المتكرّر references.

AnswerReference

تمثّل هذه السمة مرجعًا إلى مصدر.

تمثيل JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "documentReference": {
    object (DocumentReference)
  }
  // End of mutually exclusive fields.
}
الحقول
يحتوي على محتوى المستند المرجعي. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
documentReference

object (DocumentReference)

النتائج فقط. المستند المرجعي
نهاية الحقول المتنافية

DocumentReference

تمثّل هذه السمة مرجعًا إلى مستند.

تمثيل JSON 
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
الحقول
documentChunk

object (DocumentChunk)

النتائج فقط. يحتوي على جزء المستند. لم يتم ضبط الحقل documentChunk.id وسيكون فارغًا.