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 بـ (الطابع الزمني): الطابع الزمني لآخر تعديل مهم تم إجراؤه على المستند. التعديل المهم هو الذي يغيّر محتوى 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: 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 حرف، وإلا سيحدث الخطأ 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 
{

  // Union field content can be only one of the following:
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field content.
}
الحقول
حقل الربط content يحتوي على محتوى المستند المرجعي. يمكن أن يكون التعليق content إحدى القيم التالية فقط:
documentReference

object (DocumentReference)

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

DocumentReference

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

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

object (DocumentChunk)

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