Method: documents.searchDocumentChunks

يبحث هذا المكوّن الإضافي عن معلومات للمطوّرين في مستندات Google الخاصة بالمطوّرين. تعرض DocumentChunks استنادًا إلى طلب بحث المستخدم. قد يكون هناك العديد من الأجزاء من Document نفسه. لاسترداد المستندات الكاملة، استخدِم DeveloperKnowledge.GetDocument أو DeveloperKnowledge.BatchGetDocuments مع DocumentChunk.parent التي تم عرضها في SearchDocumentChunksResponse.results.

طلب HTTP

GET https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks

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

مَعلمات طلب البحث

المَعلمات
query

string

الحقل مطلوب. تقدّم هذه السمة سلسلة طلب البحث الأوّلية التي يقدّمها المستخدم، مثل "كيفية إنشاء حزمة Cloud Storage".
pageSize

integer

اختياريّ. تحدّد هذه السمة الحد الأقصى لعدد النتائج المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة.

إذا لم يتم تحديدها، سيتم عرض 5 نتائج على الأكثر.

الحد الأقصى للقيمة هو 20، وستؤدي القيم الأكبر من 20 إلى حدوث خطأ INVALID_ARGUMENT.
pageToken

string

اختياريّ. يحتوي على رمز مميز للصفحة تم تلقّيه من طلب documents.searchDocumentChunks سابق. يجب تقديم هذا الرمز لاسترداد الصفحة التالية.
filter

string

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

على الرغم من أنّ documents.searchDocumentChunks تعرض DocumentChunk، يتم تطبيق الفلتر على حقول DocumentChunk.document.

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

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

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

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

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

أمثلة:

  • 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.SearchDocumentChunks

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
الحقول
results[]

object (DocumentChunk)

يحتوي على نتائج البحث عن طلب البحث المحدّد. يحتوي كل DocumentChunk في هذه القائمة على مقتطف من المحتوى ذي الصلة بطلب البحث. استخدِم الحقل DocumentChunk.parent لكل نتيجة مع DeveloperKnowledge.GetDocument أو DeveloperKnowledge.BatchGetDocuments لاسترداد محتوى المستند الكامل.
nextPageToken

string

اختياريّ. توفّر هذه السمة رمزًا مميزًا يمكن إرساله كـ pageToken لاسترداد الصفحة التالية. في حال حذف هذا الحقل، لن تكون هناك صفحات لاحقة.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.

DocumentChunk

يمثّل DocumentChunk جزءًا من المحتوى من Document في مجموعة DeveloperKnowledge. لاسترداد محتوى المستند بأكمله، مرِّر parent إلى DeveloperKnowledge.GetDocument أو DeveloperKnowledge.BatchGetDocuments.

تمثيل JSON 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
الحقول
parent

string

النتائج فقط. تحتوي على اسم المورد للمستند الذي تم استخراج هذه الفقرة منه. التنسيق: documents/{uri_without_scheme} مثال: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

النتائج فقط. تحدّد هذه السمة رقم تعريف هذا الجزء ضمن المستند. يكون رقم تعريف الجزء فريدًا داخل المستند، ولكن ليس فريدًا على مستوى جميع المستندات. معرّف الجزء غير ثابت وقد يتغيّر بمرور الوقت.
content

string

النتائج فقط. تحتوي على محتوى جزء المستند.
document

object (Document)

النتائج فقط. تمثّل هذه السمة البيانات الوصفية الخاصة بـ Document التي تنتمي إليها هذه القطعة. سيتم ضبط DocumentView رسالة Document هذه على DOCUMENT_VIEW_BASIC. تم تضمينها هنا لتوفير الراحة حتى لا يحتاج العملاء إلى طلب DeveloperKnowledge.GetDocument أو DeveloperKnowledge.BatchGetDocuments إذا كانوا يحتاجون فقط إلى حقول البيانات الوصفية. بخلاف ذلك، يجب أن يستخدم العملاء DeveloperKnowledge.GetDocument أو DeveloperKnowledge.BatchGetDocuments لجلب محتوى المستند الكامل.