Method: documents.searchDocumentChunks

يبحث هذا الطلب عن معلومات المطوّرين في مستندات المطوّرين من Google. ويعرض DocumentChunk استنادًا إلى طلب بحث المستخدم. قد يكون هناك العديد من الأجزاء من 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.

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

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

تتوفّر عوامل التشغيل = و< و<= و> و>= لحقول الأعداد الصحيحة.

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

تتوفّر عوامل التشغيل = و< و<= و> و>= لحقول الطوابع الزمنية. يجب أن تكون الطوابع الزمنية بتنسيق 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.