Package google.developers.knowledge.v1alpha

الفهرس

DeveloperKnowledge

توفّر واجهة برمجة التطبيقات Developer Knowledge API إمكانية الوصول الآلي إلى مستندات المطوّرين المتاحة للجميع من Google، ما يتيح لك دمج قاعدة المعلومات هذه في تطبيقاتك وسير عملك.

تم تصميم واجهة برمجة التطبيقات لتكون المصدر الأساسي للوصول إلى مستندات المطوّرين من Google بتنسيق يمكن للآلة قراءته.

تتمثّل إحدى حالات الاستخدام النموذجية في استخدام DeveloperKnowledge.SearchDocumentChunks أولاً للعثور على معرّفات URI ذات الصلة بالصفحات استنادًا إلى طلب بحث، ثم استخدام DeveloperKnowledge.GetDocument أو DeveloperKnowledge.BatchGetDocuments لجلب المحتوى الكامل لأهم النتائج.

يتم توفير كل محتوى المستند بتنسيق Markdown.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

يستردّ هذا الإجراء مستندات متعددة، يحتوي كل منها على محتوى Markdown الكامل.

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

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

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

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

rpc GetDocument(GetDocumentRequest) returns (Document)

يستردّ مستندًا واحدًا يتضمّن محتوى Markdown الكامل.

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

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

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

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

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

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

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

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

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

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

BatchGetDocumentsRequest

طلب رسالة من DeveloperKnowledge.BatchGetDocuments

الحقول
names[]

string

الحقل مطلوب. تحدّد هذه السمة أسماء المستندات المطلوب استردادها. يمكن استرداد 20 مستندًا كحد أقصى في دفعة واحدة. يتم عرض المستندات بالترتيب نفسه الذي يظهر به names في الطلب.

التنسيق: documents/{uri_without_scheme} مثال: documents/docs.cloud.google.com/storage/docs/creating-buckets

BatchGetDocumentsResponse

رسالة الردّ على السؤال DeveloperKnowledge.BatchGetDocuments

الحقول
documents[]

Document

يحتوي على المستندات المطلوبة

مستند

يمثّل المستند جزءًا من المحتوى من مجموعة Developer Knowledge.

الحقول
name

string

المعرّف. يحتوي على اسم المورد الخاص بالمستند. التنسيق: documents/{uri_without_scheme} مثال: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

النتائج فقط. توفّر هذه السمة معرّف URI للمحتوى، مثل docs.cloud.google.com/storage/docs/creating-buckets.
content

string

النتائج فقط. تحتوي على المحتوى الكامل للمستند بتنسيق Markdown.
description

string

النتائج فقط. تقدّم وصفًا للمستند.
title

string

النتائج فقط. تعرض هذه السمة عنوان المستند.

DocumentChunk

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

الحقول
parent

string

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

string

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

string

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

GetDocumentRequest

طلب رسالة من DeveloperKnowledge.GetDocument

الحقول
name

string

الحقل مطلوب. تحدّد هذه السمة اسم المستند المطلوب استرداده. التنسيق: documents/{uri_without_scheme} مثال: documents/docs.cloud.google.com/storage/docs/creating-buckets

SearchDocumentChunksRequest

طلب رسالة من DeveloperKnowledge.SearchDocumentChunks

الحقول
query

string

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

int32

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

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

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

string

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

SearchDocumentChunksResponse

رسالة الردّ على السؤال DeveloperKnowledge.SearchDocumentChunks

الحقول
results[]

DocumentChunk

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

string

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