Package google.developers.knowledge.v1alpha

الفهرس

• DeveloperKnowledge (واجهة)
• Answer (رسالة)
• Answer.AnswerCitation (رسالة)
• Answer.AnswerReference (رسالة)
• Answer.CitationSource (رسالة)
• Answer.DocumentReference (رسالة)
• AnswerQueryRequest (رسالة)
• AnswerQueryResponse (رسالة)
• BatchGetDocumentsRequest (رسالة)
• BatchGetDocumentsResponse (رسالة)
• Document (رسالة)
• DocumentChunk (رسالة)
• DocumentView (تعداد)
• GetDocumentRequest (رسالة)
• SearchDocumentChunksRequest (رسالة)
• SearchDocumentChunksResponse (رسالة)

DeveloperKnowledge

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

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

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

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

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse) يجيب عن طلب باستخدام ميزة "الإنشاء المستند إلى بيانات واقعية". نطاقات الأذونات يجب توفير أحد نطاقات 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.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse) يستردّ هذا الإجراء مستندات متعددة، يحتوي كل منها على محتوى Markdown الكامل. نطاقات الأذونات يجب توفير أحد نطاقات 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.

GetDocument
rpc GetDocument(GetDocumentRequest) returns (Document) يستردّ مستندًا واحدًا يتضمّن محتوى Markdown الكامل. نطاقات الأذونات يجب توفير أحد نطاقات 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.

SearchDocumentChunks

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse) يبحث عن معلومات للمطوّرين في مستندات المطوّرين من Google. تعرض هذه الدالة DocumentChunk استنادًا إلى طلب المستخدم. قد تكون هناك عدة أجزاء من Document نفسه. لاسترداد المستندات الكاملة، استخدِم DeveloperKnowledge.GetDocument أو DeveloperKnowledge.BatchGetDocuments مع DocumentChunk.parent الذي تم عرضه في SearchDocumentChunksResponse.results. نطاقات الأذونات يجب توفير أحد نطاقات 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.

الإجابة

تمثّل هذه السمة إجابة عن طلب بحث.

الحقول
answer_text	string تحتوي هذه السمة على نص الإجابة.
citations[]	AnswerCitation النتائج فقط. تحتوي على اقتباسات للإجابة.
references[]	AnswerReference النتائج فقط. تحتوي على مراجع للإجابة.

AnswerCitation

تمثّل هذه السمة معلومات الاقتباس الخاصة بمقطع.

الحقول
start_index	int32 النتائج فقط. تشير إلى بداية المقطع، ويتم قياسها بالبايت (يونيكود UTF-8)، وهي قيمة شاملة. إذا كانت هناك أحرف متعددة البايت، مثل الأحرف غير ASCII، يكون قياس الفهرس أطول من طول السلسلة.
end_index	int32 النتائج فقط. تشير إلى نهاية المقطع، ويتم قياسها بالبايت (يونيكود UTF-8)، وهي قيمة حصرية. إذا كانت هناك أحرف متعددة البايت، مثل الأحرف غير ASCII، يكون قياس الفهرس أطول من طول السلسلة.
sources[]	CitationSource النتائج فقط. تحتوي على مصادر التوثيق الخاصة بالجزء المنسوب.

AnswerReference

تمثّل هذه السمة مرجعًا إلى مستند مصدر.

الحقول
حقل الربط content يحتوي على محتوى المستند المرجعي. يمكن أن يكون التعليق content إحدى القيم التالية فقط:
document_reference	DocumentReference النتائج فقط. المستند المرجعي

CitationSource

مصدر التوثيق

الحقول
reference_index	int32 النتائج فقط. يحتوي على فهرس Answer.AnswerReference في الحقل المتكرّر references.

DocumentReference

تمثّل هذه السمة مرجعًا إلى مستند.

الحقول
document_chunk	DocumentChunk النتائج فقط. يحتوي على جزء المستند. لم يتم ضبط الحقل document_chunk.id وسيكون فارغًا.

AnswerQueryRequest

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

الحقول
query	string الحقل مطلوب. تمثّل هذه السمة طلب البحث الذي يجب الإجابة عنه.
filter	string اختياريّ. تطبيق فلتر صارم على نتائج البحث المستخدَمة لتحديد أساس الإجابة يتوافق التعبير مع مجموعة فرعية من البنية الموضّحة في https://google.aip.dev/160. الحقول المتاحة للفلترة: استبدِل content_length_bytes بـ (INTEGER): طول الحقل 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". يمكنك دمج التعبيرات باستخدام عوامل التشغيل المنطقية 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.

AnswerQueryResponse

رسالة الردّ على DeveloperKnowledge.AnswerQuery

الحقول
answer	Answer تمثّل هذه السمة الإجابة عن طلب البحث.

BatchGetDocumentsRequest

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

الحقول
names[]	string الحقل مطلوب. تحدّد هذه السمة أسماء المستندات المطلوب استردادها. يمكن استرداد 20 مستندًا كحد أقصى في دفعة واحدة. يتم عرض المستندات بالترتيب نفسه الذي يظهر به names في الطلب. التنسيق: documents/{uri_without_scheme} مثال: documents/docs.cloud.google.com/storage/docs/creating-buckets يجب ألا يتجاوز كل اسم 500 حرف، وإلا سيظهر الخطأ INVALID_ARGUMENT.
view	DocumentView اختياريّ. تحدّد هذه السمة DocumentView المستند. إذا لم يتم تحديدها، تكون القيمة التلقائية لـ DeveloperKnowledge.BatchGetDocuments هي DOCUMENT_VIEW_CONTENT.

BatchGetDocumentsResponse

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

الحقول
documents[]	Document يحتوي على المستندات المطلوبة.

مستند

يمثّل المستند صفحة من مستندات مجموعة Developer Knowledge، مثل الصفحة على https://docs.cloud.google.com/storage/docs/creating-buckets.

الحقول
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 النتائج فقط. تقدّم وصفًا للمستند.
data_source	string النتائج فقط. تحدّد هذه السمة مصدر بيانات المستند. مثال على مصدر البيانات: firebase.google.com
title	string النتائج فقط. تعرض هذه السمة عنوان المستند.
update_time	Timestamp النتائج فقط. يمثّل هذا الحقل الطابع الزمني لآخر تعديل على محتوى المستند أو بياناته الوصفية.
view	DocumentView النتائج فقط. تحدّد هذه السمة DocumentView المستند.
content_length_bytes	int32 النتائج فقط. طول الحقل content بالبايت.

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 النتائج فقط. تحتوي على محتوى جزء المستند.
document	Document النتائج فقط. تمثّل هذه السمة البيانات الوصفية حول Document الذي تنتمي إليه هذه القطعة. سيتم ضبط DocumentView رسالة Document هذه على DOCUMENT_VIEW_BASIC. تم تضمينها هنا لتوفير الراحة حتى لا يحتاج العملاء إلى طلب DeveloperKnowledge.GetDocument أو DeveloperKnowledge.BatchGetDocuments إذا كانوا يحتاجون فقط إلى حقول البيانات الوصفية. بخلاف ذلك، يجب أن يستخدم العملاء DeveloperKnowledge.GetDocument أو DeveloperKnowledge.BatchGetDocuments لجلب محتوى المستند الكامل.
relevance_score	double النتائج فقط. تمثّل هذه السمة درجة ملاءمة الجزء لطلب البحث. تشير النتيجة الأعلى إلى مدى صلة الجزء بالموضوع. تندرج النتيجة ضمن النطاق [0.0, 1.0].

DocumentView

تحدّد هذه السمة الحقول التي يتم تضمينها في Document.

عمليات التعداد
DOCUMENT_VIEW_UNSPECIFIED	القيمة التلقائية أو غير المضبوطة راجِع كل طريقة من طرق واجهة برمجة التطبيقات لمعرفة القيمة التلقائية إذا لم يتم تحديد DocumentView.
DOCUMENT_VIEW_BASIC	يتضمّن حقول البيانات الوصفية الأساسية فقط: name uri data_source title description update_time view content_length_bytes هذا هو العرض التلقائي لـ DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL	تتضمّن جميع حقول Document.
DOCUMENT_VIEW_CONTENT	يتضمّن حقول DOCUMENT_VIEW_BASIC وحقل content. هذا هو العرض التلقائي لـ DeveloperKnowledge.GetDocument وDeveloperKnowledge.BatchGetDocuments.

GetDocumentRequest

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

الحقول
name	string الحقل مطلوب. تحدّد هذه السمة اسم المستند المطلوب استرداده. التنسيق: documents/{uri_without_scheme} مثال: documents/docs.cloud.google.com/storage/docs/creating-buckets يجب ألا يتجاوز الاسم 500 حرف، وإلا سيظهر الخطأ INVALID_ARGUMENT.
view	DocumentView اختياريّ. تحدّد هذه السمة DocumentView المستند. إذا لم يتم تحديدها، تكون القيمة التلقائية لـ DeveloperKnowledge.GetDocument هي DOCUMENT_VIEW_CONTENT.

SearchDocumentChunksRequest

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

الحقول
query	string الحقل مطلوب. تعرض هذه السمة سلسلة طلب البحث الأوّلية التي يقدّمها المستخدم، مثل "كيفية إنشاء حزمة Cloud Storage". يجب ألا يتجاوز طلب البحث 500 حرف، وإلا سيظهر الخطأ INVALID_ARGUMENT.
page_size	int32 اختياريّ. تحدّد هذه السمة الحد الأقصى لعدد النتائج المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 5 نتائج كحد أقصى. الحد الأقصى للقيمة هو 100، وسيتم فرض القيمة 100 على القيم التي تزيد عن 100.
page_token	string اختياريّ. يحتوي على رمز مميز للصفحة تم تلقّيه من طلب SearchDocumentChunks سابق. يجب تقديم هذا الرمز لاسترداد الصفحة التالية.
filter	string اختياريّ. تطبيق فلتر صارم على نتائج البحث يتوافق التعبير مع مجموعة فرعية من البنية الموضّحة في https://google.aip.dev/160. في حين أنّ SearchDocumentChunks تعرض DocumentChunk، يتم تطبيق الفلتر على حقول DocumentChunk.document. الحقول المتاحة للفلترة: استبدِل content_length_bytes بـ (INTEGER): طول الحقل 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". يمكنك دمج التعبيرات باستخدام عوامل التشغيل المنطقية 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.

SearchDocumentChunksResponse

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

الحقول
results[]	DocumentChunk يحتوي على نتائج البحث عن طلب البحث المحدّد. يتضمّن كل DocumentChunk في هذه القائمة مقتطفًا من المحتوى ذي الصلة بطلب البحث. استخدِم الحقل DocumentChunk.parent لكل نتيجة مع DeveloperKnowledge.GetDocument أو DeveloperKnowledge.BatchGetDocuments لاسترداد محتوى المستند الكامل.
next_page_token	string توفّر هذه السمة رمزًا مميزًا يمكن إرساله كـ page_token لاسترداد الصفحة التالية. في حال حذف هذا الحقل، لن تكون هناك صفحات لاحقة.