Method: documents.searchDocumentChunks

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

طلب HTTP

GET https://developerknowledge.googleapis.com/v1alpha/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.

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

  • استبدِل 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.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.