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". يجب ألا يتجاوز طلب البحث 500 حرف، وإلا سيؤدي إلى ظهور الخطأ INVALID_ARGUMENT.
pageSize

integer

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

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

الحدّ الأقصى للقيمة هو 100، وسيتم فرض القيمة 100 على القيم التي تزيد عن 100.
pageToken

string

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

string

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

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

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

  • ‫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".

ملاحظة: يجب أن تكون أسماء الحقول بين علامتَي snake_case (مثلاً، data_source). يجب أن تكون القيم على الجانب الأيسر من عبارات الفلترة عبارة عن سلاسل حرفية محاطة بعلامتَي اقتباس مزدوجتَين (مثلاً، "docs.cloud.google.com").

يمكنك دمج التعبيرات باستخدام عوامل التشغيل المنطقية 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.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/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

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