تتيح Gemini API إنشاء المحتوى باستخدام الصور والملفات الصوتية والرموز البرمجية والأدوات وغير ذلك. للاطّلاع على تفاصيل حول كل ميزة من هذه الميزات، واصِل القراءة واطّلِع على نموذج الرمز البرمجي الذي يركّز على المهام، أو اقرأ الأدلة الشاملة.
- إنشاء النصوص
- النظر
- الصوت
- التضمينات
- السياق الطويل
- تنفيذ الرموز البرمجية
- وضع JSON
- استدعاء الدوال
- تعليمات النظام
الطريقة: models.generateContent
ينشئ ردًا من النموذج بناءً على الإدخال GenerateContentRequest. راجِع دليل إنشاء النصوص للحصول على معلومات مفصّلة حول الاستخدام. تختلف إمكانات الإدخال بين النماذج، بما في ذلك النماذج المضبوطة. يُرجى الرجوع إلى دليل النماذج ودليل الضبط للاطّلاع على التفاصيل.
نقطة نهاية
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
مَعلمات المسار
model
string
الحقل مطلوب. اسم Model المطلوب استخدامه لإنشاء الإكمال.
التنسيق: models/{model} ويكون بالتنسيق التالي: models/{model}.
نص الطلب
يتضمن نص الطلب بيانات بالبنية التالية:
contents[]
object (Content)
الحقل مطلوب. محتوى المحادثة الحالية مع النموذج
بالنسبة إلى طلبات البحث ذات الدورات الفردية، يكون هذا مثيلاً واحدًا. بالنسبة إلى الاستعلامات المتعددة الأدوار، مثل المحادثة، هذا حقل متكرّر يحتوي على سجلّ المحادثات وآخر طلب.
tools[]
object (Tool)
اختياريّ. قائمة Tools يمكن Model استخدامها لإنشاء الرد التالي
Tool هي جزء من الرمز البرمجي يتيح للنظام التفاعل مع الأنظمة الخارجية لتنفيذ إجراء أو مجموعة من الإجراءات خارج نطاق معرفة Model. Tools المتوافقة هي Function وcodeExecution. لمزيد من المعلومات، يُرجى الرجوع إلى دليلَي استدعاء الدالة وتطبيق الرموز البرمجية.
toolConfig
object (ToolConfig)
اختياريّ. إعدادات الأداة لأي Tool محدّدة في الطلب راجِع دليل استخدام ميزة "طلب تنفيذ وظيفة" للاطّلاع على مثال على الاستخدام.
safetySettings[]
object (SafetySetting)
اختياريّ. قائمة بحالات SafetySetting الفريدة لحظر المحتوى غير الآمن
سيتم فرض ذلك على GenerateContentRequest.contents وGenerateContentResponse.candidates. يجب ألا يكون هناك أكثر من إعداد واحد لكل نوع SafetyCategory. ستحظر واجهة برمجة التطبيقات أي محتوى وردود لا تستوفي الحدود التي تحدّدها هذه الإعدادات. تلغي هذه القائمة الإعدادات التلقائية لكل SafetyCategory محدّد في safetySettings. إذا لم يكن هناك SafetySetting لفئة SafetyCategory معيّنة مقدَّمة في القائمة، ستستخدِم واجهة برمجة التطبيقات إعداد الأمان التلقائي لهذه الفئة. تتوفّر فئات الضرر التالية: HARM_CATEGORY_HATE_SPEECH وHARM_CATEGORY_SEXUALLY_EXPLICIT وHARM_CATEGORY_DANGEROUS_CONTENT وHARM_CATEGORY_HARASSMENT وHARM_CATEGORY_CIVIC_INTEGRITY وHARM_CATEGORY_JAILBREAK. راجِع الدليل للحصول على معلومات مفصّلة حول إعدادات الأمان المتاحة. يمكنك أيضًا الرجوع إلى إرشادات الأمان للتعرّف على كيفية تضمين اعتبارات الأمان في تطبيقات الذكاء الاصطناعي.
systemInstruction
object (Content)
اختياريّ. وضع المطوّر تعليمات النظام. في الوقت الحالي، يمكن معالجة النصوص فقط.
generationConfig
object (GenerationConfig)
اختياريّ. خيارات الإعداد لإنشاء النماذج والمخرجات
cachedContent
string
اختياريّ. اسم المحتوى المخزَّن مؤقتًا لاستخدامه كسياق لعرض التوقّع التنسيق: cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
اختياريّ. فئة الخدمة للطلب
store
boolean
اختياريّ. تضبط هذه السمة سلوك التسجيل لطلب معيّن. في حال ضبطها، تكون لها الأولوية على إعدادات تسجيل البيانات على مستوى المشروع.
مثال على الطلب
نص
Python
Node.js
Go
محارة
جافا
صورة
Python
Node.js
Go
محارة
جافا
الصوت
Python
Node.js
Go
محارة
فيديو
Python
Node.js
Go
محارة
Python
Go
محارة
محادثة
Python
Node.js
Go
محارة
جافا
ذاكرة التخزين المؤقت
Python
Node.js
Go
النموذج المعدَّل
Python
وضع JSON
Python
Node.js
Go
محارة
جافا
تنفيذ الرموز البرمجية
Python
Go
جافا
استدعاء الدالة
Python
Go
Node.js
محارة
جافا
إعدادات الإنشاء
Python
Node.js
Go
محارة
جافا
إعدادات الأمان
Python
Node.js
Go
محارة
جافا
تعليمات النظام
Python
Node.js
Go
محارة
جافا
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال GenerateContentResponse.
الطريقة: models.streamGenerateContent
ينشئ ردًا متسلسلاً من النموذج بناءً على الإدخال GenerateContentRequest.
نقطة نهاية
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
مَعلمات المسار
model
string
الحقل مطلوب. اسم Model المطلوب استخدامه لإنشاء الإكمال.
التنسيق: models/{model} ويكون بالتنسيق التالي: models/{model}.
نص الطلب
يتضمن نص الطلب بيانات بالبنية التالية:
contents[]
object (Content)
الحقل مطلوب. محتوى المحادثة الحالية مع النموذج
بالنسبة إلى طلبات البحث ذات الدورات الفردية، يكون هذا مثيلاً واحدًا. بالنسبة إلى الاستعلامات المتعددة الأدوار، مثل المحادثة، هذا حقل متكرّر يحتوي على سجلّ المحادثات وآخر طلب.
tools[]
object (Tool)
اختياريّ. قائمة Tools يمكن Model استخدامها لإنشاء الرد التالي
Tool هي جزء من الرمز البرمجي يتيح للنظام التفاعل مع الأنظمة الخارجية لتنفيذ إجراء أو مجموعة من الإجراءات خارج نطاق معرفة Model. Tools المتوافقة هي Function وcodeExecution. لمزيد من المعلومات، يُرجى الرجوع إلى دليلَي استدعاء الدالة وتطبيق الرموز البرمجية.
toolConfig
object (ToolConfig)
اختياريّ. إعدادات الأداة لأي Tool محدّدة في الطلب راجِع دليل استخدام ميزة "طلب تنفيذ وظيفة" للاطّلاع على مثال على الاستخدام.
safetySettings[]
object (SafetySetting)
اختياريّ. قائمة بحالات SafetySetting الفريدة لحظر المحتوى غير الآمن
سيتم فرض ذلك على GenerateContentRequest.contents وGenerateContentResponse.candidates. يجب ألا يكون هناك أكثر من إعداد واحد لكل نوع SafetyCategory. ستحظر واجهة برمجة التطبيقات أي محتوى وردود لا تستوفي الحدود التي تحدّدها هذه الإعدادات. تلغي هذه القائمة الإعدادات التلقائية لكل SafetyCategory محدّد في safetySettings. إذا لم يكن هناك SafetySetting لـ SafetyCategory معيّن مُقدَّم في القائمة، ستستخدم واجهة برمجة التطبيقات إعداد الأمان التلقائي لهذه الفئة. تتوفّر فئات الضرر التالية: HARM_CATEGORY_HATE_SPEECH وHARM_CATEGORY_SEXUALLY_EXPLICIT وHARM_CATEGORY_DANGEROUS_CONTENT وHARM_CATEGORY_HARASSMENT وHARM_CATEGORY_CIVIC_INTEGRITY وHARM_CATEGORY_JAILBREAK. راجِع الدليل للحصول على معلومات مفصّلة حول إعدادات الأمان المتاحة. يمكنك أيضًا الرجوع إلى إرشادات الأمان للتعرّف على كيفية تضمين اعتبارات الأمان في تطبيقات الذكاء الاصطناعي.
systemInstruction
object (Content)
اختياريّ. وضع المطوّر تعليمات النظام. في الوقت الحالي، يمكن معالجة النصوص فقط.
generationConfig
object (GenerationConfig)
اختياريّ. خيارات الإعداد لإنشاء النماذج والمخرجات
cachedContent
string
اختياريّ. اسم المحتوى المخزَّن مؤقتًا لاستخدامه كسياق لعرض التوقّع التنسيق: cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
اختياريّ. فئة الخدمة للطلب
store
boolean
اختياريّ. تضبط هذه السمة سلوك التسجيل لطلب معيّن. في حال ضبطها، تكون لها الأولوية على إعدادات تسجيل البيانات على مستوى المشروع.
مثال على الطلب
نص
Python
Node.js
Go
محارة
جافا
صورة
Python
Node.js
Go
محارة
جافا
الصوت
Python
Go
محارة
فيديو
Python
Node.js
Go
محارة
Python
Go
محارة
محادثة
Python
Node.js
Go
محارة
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على سلسلة من أمثلة GenerateContentResponse.
GenerateContentResponse
ردّ من النموذج يتضمّن عدة ردود مرشّحة
يتم عرض تقييمات الأمان وفلترة المحتوى لكل من الطلب في GenerateContentResponse.prompt_feedback ولكل مرشّح في finishReason وsafetyRatings. تعمل واجهة برمجة التطبيقات على: - عرض جميع المرشحين المطلوبين أو عدم عرض أي منهم - عدم عرض أي مرشحين على الإطلاق فقط إذا كان هناك خطأ في الطلب (راجِع promptFeedback) - تسجيل الملاحظات حول كل مرشح في finishReason وsafetyRatings
candidates[]
object (Candidate)
ردود المرشحين من النموذج
promptFeedback
object (PromptFeedback)
تعرض هذه السمة الملاحظات حول طلبك المرتبطة بفلاتر المحتوى.
usageMetadata
object (UsageMetadata)
النتائج فقط. البيانات الوصفية المتعلقة باستخدام الرموز المميزة لطلبات الإنشاء
modelVersion
string
النتائج فقط. إصدار النموذج المستخدَم لإنشاء الردّ.
responseId
string
حقل إخراج فقط، ويُستخدم responseId لتحديد كل رد.
modelStatus
object (ModelStatus)
النتائج فقط. تعرض هذه السمة حالة النموذج الحالية.
| تمثيل JSON |
|---|
{ "candidates": [ { object ( |
PromptFeedback
مجموعة من البيانات الوصفية للملاحظات التي حدّدها الطلب في GenerateContentRequest.content
blockReason
enum (BlockReason)
اختياريّ. في حال ضبطها، تم حظر الطلب ولم يتم عرض أي نتائج محتملة. أعِد صياغة الطلب.
safetyRatings[]
object (SafetyRating)
تقييمات أمان الطلب يمكن إضافة تقييم واحد كحدّ أقصى لكل فئة.
| تمثيل JSON |
|---|
{ "blockReason": enum ( |
BlockReason
تحدّد هذه السمة سبب حظر الطلب.
| عمليات التعداد | |
|---|---|
BLOCK_REASON_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
SAFETY |
تم حظر الطلب لأسباب تتعلق بالأمان. افحص safetyRatings لمعرفة فئة الأمان التي حظرته. |
OTHER |
تم حظر الطلب لأسباب غير معروفة. |
BLOCKLIST |
تم حظر الطلب بسبب العبارات المدرَجة في قائمة الحظر الخاصة بالمصطلحات. |
PROHIBITED_CONTENT |
تم حظر الطلب بسبب المحتوى المحظور. |
IMAGE_SAFETY |
تم حظر المرشّحين بسبب المحتوى غير الآمن الذي تم إنشاؤه من الصور. |
UsageMetadata
البيانات الوصفية المتعلقة باستخدام الرموز المميزة لطلب الإنشاء
promptTokenCount
integer
عدد الرموز المميزة في الطلب عند ضبط cachedContent، يظلّ هذا هو إجمالي حجم الطلب الفعّال، ما يعني أنّه يشمل عدد الرموز المميزة في المحتوى المخزّن مؤقتًا.
cachedContentTokenCount
integer
عدد الرموز المميّزة في الجزء المخزّن مؤقتًا من الطلب (المحتوى المخزّن مؤقتًا)
candidatesTokenCount
integer
إجمالي عدد الرموز المميزة في جميع الردود المقترَحة التي تم إنشاؤها
toolUsePromptTokenCount
integer
النتائج فقط. عدد الرموز المميزة المتوفّرة في طلبات استخدام الأدوات
thoughtsTokenCount
integer
النتائج فقط. عدد الرموز المميّزة للأفكار في نماذج التفكير
totalTokenCount
integer
إجمالي عدد الرموز المميّزة لطلب الإنشاء (الطلب + الأفكار + الردود المحتملة)
promptTokensDetails[]
object (ModalityTokenCount)
النتائج فقط. قائمة بالوسائط التي تمت معالجتها في بيانات الإدخال الخاصة بالطلب
cacheTokensDetails[]
object (ModalityTokenCount)
النتائج فقط. قائمة بأنواع المحتوى المخزّن مؤقتًا في بيانات طلب البحث.
candidatesTokensDetails[]
object (ModalityTokenCount)
النتائج فقط. قائمة بالوسائط التي تم عرضها في الردّ.
toolUsePromptTokensDetails[]
object (ModalityTokenCount)
النتائج فقط. قائمة بالوسائط التي تمت معالجتها لإدخالات طلب استخدام الأدوات
serviceTier
enum (ServiceTier)
النتائج فقط. فئة الخدمة للطلب
| تمثيل JSON |
|---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
ModelStatus
حالة النموذج الأساسي. يُستخدَم هذا الحقل للإشارة إلى مرحلة النموذج الأساسي ووقت إيقافه نهائيًا، إذا كان ذلك منطبقًا.
modelStage
enum (ModelStage)
مرحلة النموذج الأساسي
retirementTime
string (Timestamp format)
الوقت الذي سيتم فيه إيقاف النموذج نهائيًا.
يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".
message
string
رسالة تشرح حالة النموذج
| تمثيل JSON |
|---|
{
"modelStage": enum ( |
ModelStage
تحدّد هذه السمة مرحلة النموذج الأساسي.
| عمليات التعداد | |
|---|---|
MODEL_STAGE_UNSPECIFIED |
مرحلة النموذج غير محدَّدة. |
UNSTABLE_EXPERIMENTAL |
يخضع النموذج الأساسي للكثير من عمليات الضبط. |
EXPERIMENTAL |
النماذج في هذه المرحلة مخصّصة لأغراض تجريبية فقط. |
PREVIEW |
تكون النماذج في هذه المرحلة أكثر تطورًا من النماذج التجريبية. |
STABLE |
تُعدّ النماذج في هذه المرحلة ثابتة وجاهزة للاستخدام في بيئة إنتاجية. |
LEGACY |
إذا كان النموذج في هذه المرحلة، يعني ذلك أنّه سيتم إيقافه نهائيًا في المستقبل القريب. يمكن للعملاء الحاليين فقط استخدام هذا النموذج. |
DEPRECATED |
تم إيقاف النماذج في هذه المرحلة نهائيًا. لا يمكن استخدام هذه النماذج. |
RETIRED |
يتم إيقاف النماذج في هذه المرحلة. لا يمكن استخدام هذه النماذج. |
مرشح
- تمثيل JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- الويب
- الصورة
- RetrievedContext
- CustomMetadata
- StringList
- خرائط Google
- PlaceAnswerSources
- ReviewSnippet
- GroundingSupport
- الشريحة
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- المرشّح
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
مرشّح ردّ تم إنشاؤه من النموذج
content
object (Content)
النتائج فقط. المحتوى الذي تم إنشاؤه والذي تم إرجاعه من النموذج
finishReason
enum (FinishReason)
اختياريّ. النتائج فقط. سبب توقّف النموذج عن إنشاء الرموز المميزة.
إذا كان الحقل فارغًا، يعني ذلك أنّ النموذج لم يتوقف عن إنشاء الرموز المميزة.
safetyRatings[]
object (SafetyRating)
قائمة بتقييمات أمان الردّ المقترَح.
يمكن إضافة تقييم واحد كحدّ أقصى لكل فئة.
citationMetadata
object (CitationMetadata)
النتائج فقط. معلومات الاقتباس الخاصة بالمرشح الذي تم إنشاؤه بواسطة النموذج
قد تتم تعبئة هذا الحقل بمعلومات التلاوة لأي نص مضمّن في content. وهي عبارة عن مقاطع "مقتبسة" من مواد محمية بحقوق الطبع والنشر في بيانات التدريب الخاصة بنموذج اللغة الكبير الأساسي.
tokenCount
integer
النتائج فقط. عدد الرموز المميّزة لهذا المرشّح.
groundingAttributions[]
object (GroundingAttribution)
النتائج فقط. تمثّل هذه السمة معلومات تحديد المصدر للمصادر التي ساهمت في تقديم إجابة مستندة إلى مصادر.
يتم ملء هذا الحقل لطلبات GenerateAnswer.
groundingMetadata
object (GroundingMetadata)
النتائج فقط. البيانات الوصفية الأساسية للمرشّح
يتم ملء هذا الحقل لطلبات GenerateContent.
avgLogprobs
number
النتائج فقط. متوسط نتيجة الاحتمالية اللوغاريتمية للمرشّح
logprobsResult
object (LogprobsResult)
النتائج فقط. نتائج احتمالية اللوغاريتم لرموز الردّ المميزة وأهم الرموز المميزة
urlContextMetadata
object (UrlContextMetadata)
النتائج فقط. بيانات وصفية مرتبطة بأداة استرجاع سياق عنوان URL
index
integer
النتائج فقط. فهرس المرشّح في قائمة المرشّحين للردّ
finishMessage
string
اختياريّ. النتائج فقط. تعرض هذه السمة سبب توقّف النموذج عن إنشاء الرموز المميزة. لا تتم تعبئة هذا الحقل إلا عند ضبط finishReason.
| تمثيل JSON |
|---|
{ "content": { object ( |
FinishReason
تحدّد هذه السمة سبب توقّف النموذج عن إنشاء الرموز المميزة.
| عمليات التعداد | |
|---|---|
FINISH_REASON_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
STOP |
نقطة التوقّف الطبيعية للنموذج أو تسلسل التوقّف المقدَّم |
MAX_TOKENS |
تم بلوغ الحد الأقصى لعدد الرموز المميّزة المحدّد في الطلب. |
SAFETY |
تم الإبلاغ عن المحتوى المرشّح للردّ لأسباب تتعلّق بالأمان. |
RECITATION |
تم الإبلاغ عن محتوى الردّ المرشّح لأسباب تتعلّق بالتلاوة. |
LANGUAGE |
تم الإبلاغ عن المحتوى المرشّح للردّ بسبب استخدام لغة غير متاحة. |
OTHER |
السبب غير معروف. |
BLOCKLIST |
توقّف إنشاء الرموز المميزة لأنّ المحتوى يتضمّن عبارات محظورة. |
PROHIBITED_CONTENT |
تم إيقاف إنشاء الرموز المميزة لاحتمال احتوائها على محتوى محظور. |
SPII |
تم إيقاف إنشاء الرموز المميزة لأنّ المحتوى قد يتضمّن معلومات حسّاسة تكشف عن الهويّة (SPII). |
MALFORMED_FUNCTION_CALL |
طلب الدالة الذي أنشأه النموذج غير صالح. |
IMAGE_SAFETY |
توقّفت عملية إنشاء الرموز المميزة لأنّ الصور التي تم إنشاؤها تتضمّن انتهاكات متعلّقة بالأمان. |
IMAGE_PROHIBITED_CONTENT |
توقّفت عملية إنشاء الصور لأنّ الصور التي تم إنشاؤها تتضمّن محتوًى محظورًا آخر. |
IMAGE_OTHER |
تم إيقاف عملية إنشاء الصورة بسبب مشكلة أخرى متنوّعة. |
NO_IMAGE |
كان من المتوقّع أن ينشئ النموذج صورة، ولكن لم يتم إنشاء أي صورة. |
IMAGE_RECITATION |
تم إيقاف عملية إنشاء الصورة بسبب التلاوة. |
UNEXPECTED_TOOL_CALL |
أنشأ النموذج طلبًا لاستخدام أداة، ولكن لم يتم تفعيل أي أدوات في الطلب. |
TOO_MANY_TOOL_CALLS |
استدعى النموذج عددًا كبيرًا جدًا من الأدوات بشكل متتابع، وبالتالي أوقف النظام التنفيذ. |
MISSING_THOUGHT_SIGNATURE |
يتضمّن الطلب توقيع فكرة واحدًا على الأقل غير متوفّر. |
MALFORMED_RESPONSE |
تم إنهاء المحادثة بسبب ردّ مكتوب بشكل غير صحيح. |
ESCALATION |
تمت فلترة الطلب حسب قاعدة تصعيد. |
GroundingAttribution
معلومات تحديد المصدر الذي ساهم في تقديم إجابة
sourceId
object (AttributionSourceId)
النتائج فقط. معرّف المصدر الذي يساهم في تحديد مصدر الإحالة هذا.
content
object (Content)
المحتوى المصدر الأساسي الذي يتضمّنه هذا البيان
| تمثيل JSON |
|---|
{ "sourceId": { object ( |
AttributionSourceId
معرّف المصدر الذي يساهم في تحديد مصدر الإحالة هذا.
source
Union type
source إحدى القيم التالية فقط:groundingPassage
object (GroundingPassageId)
تمثّل هذه السمة معرّفًا لمقطع مضمّن.
semanticRetrieverChunk
object (SemanticRetrieverChunk)
معرّف Chunk تم استرجاعه من خلال Semantic Retriever
| تمثيل JSON |
|---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
معرّف لجزء ضمن GroundingPassage
passageId
string
النتائج فقط. معرّف المقطع المطابق لـ GroundingPassage.id في GenerateAnswerRequest
partIndex
integer
النتائج فقط. فهرس الجزء ضمن GroundingPassage.content من GenerateAnswerRequest
| تمثيل JSON |
|---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
معرّف Chunk تم استرداده من خلال Semantic Retriever المحدّد في GenerateAnswerRequest باستخدام SemanticRetrieverConfig.
source
string
النتائج فقط. اسم المصدر الذي يتطابق مع SemanticRetrieverConfig.source في الطلب مثال: corpora/123 أو corpora/123/documents/abc
chunk
string
النتائج فقط. اسم Chunk الذي يحتوي على النص المنسوب. مثال: corpora/123/documents/abc/chunks/xyz
| تمثيل JSON |
|---|
{ "source": string, "chunk": string } |
GroundingMetadata
البيانات الوصفية التي يتم عرضها للعميل عند تفعيل ميزة "الاستناد إلى مصادر خارجية"
groundingChunks[]
object (GroundingChunk)
قائمة بالمراجع الداعمة التي تم استرجاعها من مصدر المعلومات الأساسية المحدّد عند البث، لا يحتوي هذا الحقل إلا على أجزاء التأسيس التي لم يتم تضمينها في البيانات الوصفية للتأسيس في الردود السابقة.
groundingSupports[]
object (GroundingSupport)
قائمة بميزات التأسيس المتوافقة
webSearchQueries[]
string
طلبات البحث على الويب التي يتم إجراؤها لمتابعة البحث على الويب
imageSearchQueries[]
string
طلبات البحث بالصور المستخدَمة في عملية التأسيس
searchEntryPoint
object (SearchEntryPoint)
اختياريّ. نقطة دخول "بحث Google" لعمليات البحث اللاحقة على الويب
retrievalMetadata
object (RetrievalMetadata)
البيانات الوصفية المرتبطة باسترجاع المعلومات في مسار تحديد المصدر
googleMapsWidgetContextToken
string
اختياريّ. اسم المورد لرمز مميّز سياقي لأداة خرائط Google الذي يمكن استخدامه مع أداة PlacesContextElement لعرض البيانات السياقية. لا تتم تعبئة هذا الحقل إلا في حال تفعيل ميزة "استخدام خرائط Google كمصدر".
| تمثيل JSON |
|---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
نقطة الدخول إلى "بحث Google"
renderedContent
string
اختياريّ. مقتطف من محتوى الويب يمكن تضمينه في صفحة ويب أو WebView في تطبيق
sdkBlob
string (bytes format)
اختياريّ. تمثّل هذه السمة JSON مرمّزًا بتنسيق Base64 يتضمّن مصفوفة من مجموعة <عبارة البحث، عنوان URL الخاص بالبحث>.
سلسلة مرمّزة باستخدام Base64
| تمثيل JSON |
|---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
يمثّل GroundingChunk جزءًا من الأدلة الداعمة التي تستند إليها استجابة النموذج. يمكن أن تكون هذه المعلومات مقتطفًا من الويب أو سياقًا تم استرجاعه من ملف أو معلومات من "خرائط Google".
chunk_type
Union type
chunk_type إحدى القيم التالية فقط:web
object (Web)
مقتطف تحديد المصدر من الويب
image
object (Image)
اختياريّ. مقتطف تحديد المصدر من "بحث الصور"
retrievedContext
object (RetrievedContext)
اختياريّ. جزء مستند إلى السياق تم استرداده من خلال أداة البحث عن الملفات
maps
object (Maps)
اختياريّ. مقتطف مستند إلى "خرائط Google"
| تمثيل JSON |
|---|
{ // chunk_type "web": { object ( |
الويب
مقتطف من الويب
uri
string
النتائج فقط. يشير إلى معرّف الموارد المنتظم (URI) الخاص بالجزء.
title
string
النتائج فقط. تمثّل هذه السمة عنوان الجزء.
| تمثيل JSON |
|---|
{ "uri": string, "title": string } |
صورة
مقتطف من بحث الصور
sourceUri
string
معرّف الموارد المنتظم (URI) لصفحة الويب الخاصة بتحديد المصدر
imageUri
string
عنوان URL لمادة عرض الصورة
title
string
تمثّل عنوان صفحة الويب التي تمّت استعارة الصورة منها.
domain
string
النطاق الجذر لصفحة الويب التي تأتي منها الصورة، مثل "example.com".
| تمثيل JSON |
|---|
{ "sourceUri": string, "imageUri": string, "title": string, "domain": string } |
RetrievedContext
مقتطف من السياق الذي تم استرداده باستخدام أداة البحث عن الملفات
customMetadata[]
object (CustomMetadata)
اختياريّ. بيانات وصفية مقدَّمة من المستخدم حول السياق الذي تم استرجاعه
uri
string
اختياريّ. مرجع معرّف الموارد المنتظم (URI) لمستند الاسترجاع الدلالي
title
string
اختياريّ. تمثّل هذه السمة عنوان المستند.
text
string
اختياريّ. نص الجزء
fileSearchStore
string
اختياريّ. اسم FileSearchStore الذي يحتوي على المستند مثال: fileSearchStores/123
pageNumber
integer
اختياريّ. تمثّل هذه السمة رقم صفحة السياق الذي تم استرجاعه، إذا كان ذلك منطبقًا.
mediaId
string
اختياريّ. اسم مورد كائن البيانات الثنائي الكبير للوسائط لنتائج البحث عن الملفات المتعدّدة الوسائط التنسيق: fileSearchStores/{file_search_store_id}/media/{blobId}
| تمثيل JSON |
|---|
{
"customMetadata": [
{
object ( |
CustomMetadata
بيانات وصفية مقدَّمة من المستخدم حول GroundingFact
key
string
مفتاح البيانات الوصفية
value
Union type
value إحدى القيم التالية فقط:stringValue
string
اختياريّ. قيمة السلسلة للبيانات الوصفية
stringListValue
object (StringList)
اختياريّ. قائمة بقيم السلسلة للبيانات الوصفية
numericValue
number
اختياريّ. القيمة الرقمية للبيانات الوصفية يعتمد النطاق المتوقّع لهذه القيمة على key المحدّد المستخدَم.
| تمثيل JSON |
|---|
{
"key": string,
// value
"stringValue": string,
"stringListValue": {
object ( |
StringList
قائمة بقيم السلسلة
values[]
string
قيم السلسلة في القائمة
| تمثيل JSON |
|---|
{ "values": [ string ] } |
الخرائط
مقتطف من "خرائط Google" يتوافق جزء "خرائط Google" مع مكان واحد.
uri
string
يشير إلى معرّف الموارد المنتظم (URI) للمكان.
title
string
تمثّل هذه السمة عنوان المكان.
text
string
الوصف النصي لإجابة المكان
placeId
string
معرّف المكان بالتنسيق places/{placeId} يمكن للمستخدم استخدام هذا المعرّف للبحث عن هذا المكان.
placeAnswerSources
object (PlaceAnswerSources)
المصادر التي تقدّم إجابات عن ميزات مكان معيّن في "خرائط Google"
| تمثيل JSON |
|---|
{
"uri": string,
"title": string,
"text": string,
"placeId": string,
"placeAnswerSources": {
object ( |
PlaceAnswerSources
مجموعة من المصادر التي تقدّم إجابات عن ميزات مكان معيّن في "خرائط Google" تتطابق كل رسالة PlaceAnswerSources مع مكان محدّد في "خرائط Google". استخدمت أداة "خرائط Google" هذه المصادر للإجابة عن أسئلة حول ميزات المكان (مثلاً: "هل يوفّر مقهى Foo خدمة Wi-Fi؟" أو "هل يمكن الوصول إلى مقهى Foo باستخدام كرسي متحرك؟"). في الوقت الحالي، لا نتيح سوى مقتطفات المراجعات كمصادر.
reviewSnippets[]
object (ReviewSnippet)
مقتطفات من المراجعات تُستخدَم لإنشاء إجابات حول ميزات مكان معيّن في "خرائط Google"
| تمثيل JSON |
|---|
{
"reviewSnippets": [
{
object ( |
ReviewSnippet
تتضمّن مقتطفًا من مراجعة مستخدم تجيب عن سؤال حول ميزات مكان معيّن في "خرائط Google".
reviewId
string
رقم تعريف مقتطف من المراجعة.
googleMapsUri
string
رابط يتوافق مع مراجعة المستخدم على "خرائط Google".
title
string
تمثّل هذه السمة عنوان المراجعة.
| تمثيل JSON |
|---|
{ "reviewId": string, "googleMapsUri": string, "title": string } |
GroundingSupport
دعم التأسيس
groundingChunkIndices[]
integer
اختياريّ. قائمة بالفهارس (في grounding_chunk في response.candidate.grounding_metadata) تحدّد الاقتباسات المرتبطة بالمطالبة. على سبيل المثال، [1,3,4] تعني أنّ grounding_chunk[1] وgrounding_chunk[3] وgrounding_chunk[4] هي المحتوى الذي تم استرجاعه والمستند إلى الادعاء. إذا كانت الاستجابة يتم بثها، تشير groundingChunkIndices إلى الفهارس في جميع الاستجابات. يتحمّل العميل مسؤولية تجميع أجزاء المستندات الأساسية من جميع الردود (مع الحفاظ على الترتيب نفسه).
confidenceScores[]
number
اختياريّ. درجة المطابقة للمراجع الداعمة تتراوح القيم بين 0 و1. الرقم 1 يشير إلى أعلى مستوى من الثقة. يجب أن يكون حجم هذه القائمة مماثلاً لحجم groundingChunkIndices.
renderedParts[]
integer
النتائج فقط. فهارس في الحقل parts الخاص بمحتوى المرشّح تحدّد هذه الفهارس الأجزاء المعروضة المرتبطة بمصدر الدعم هذا.
segment
object (Segment)
شريحة المحتوى التي ينتمي إليها هذا الدعم
| تمثيل JSON |
|---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"renderedParts": [
integer
],
"segment": {
object ( |
تقسيم
شريحة من المحتوى
partIndex
integer
فهرس كائن "الجزء" ضِمن كائن "المحتوى" الرئيسي
startIndex
integer
فهرس البداية في الجزء المحدّد، ويتم قياسه بالبايت. الإزاحة من بداية الجزء، شاملة، بدءًا من الصفر
endIndex
integer
فهرس النهاية في الجزء المحدّد، ويُقاس بالبايت. الإزاحة من بداية الجزء، باستثناء الجزء نفسه، بدءًا من الصفر
text
string
تمثّل هذه السمة النص الذي يتطابق مع المقطع من الردّ.
| تمثيل JSON |
|---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
البيانات الوصفية المرتبطة باسترجاع المعلومات في مسار تحديد المصدر
googleSearchDynamicRetrievalScore
number
اختياريّ. نتيجة تشير إلى مدى احتمال أن تساعد المعلومات من "بحث Google" في الإجابة عن الطلب. تندرج النتيجة ضمن النطاق [0, 1]، حيث يشير 0 إلى الاحتمال الأقل ويشير 1 إلى الاحتمال الأكبر. لا تتم تعبئة هذه النتيجة إلا عند تفعيل ميزة "الاستناد إلى البحث على Google" و"الاسترجاع الديناميكي". ستتم مقارنته بالحدّ الأدنى لتحديد ما إذا كان سيتم تفعيل البحث على Google.
| تمثيل JSON |
|---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
نتيجة Logprobs
topCandidates[]
object (TopCandidates)
الطول = إجمالي عدد خطوات فك الترميز.
chosenCandidates[]
object (Candidate)
الطول = إجمالي عدد خطوات فك الترميز. قد يكون المرشّحون المختارون ضمن topCandidates أو لا يكونون.
logProbabilitySum
number
مجموع احتمالات اللوغاريتمات لجميع الرموز المميزة
| تمثيل JSON |
|---|
{ "topCandidates": [ { object ( |
TopCandidates
المرشّحون الذين لديهم أعلى احتمالات السجلّ في كل خطوة من خطوات فك الترميز
candidates[]
object (Candidate)
مرتّبة تنازليًا حسب احتمالية اللوغاريتم.
| تمثيل JSON |
|---|
{
"candidates": [
{
object ( |
مرشح
المرشّح للرمز المميّز الخاص بـ logprobs والنتيجة
token
string
قيمة سلسلة الرمز المميّز للمرشّح.
tokenId
integer
تمثّل هذه السمة قيمة المعرّف المميز للمرشح.
logProbability
number
تمثّل هذه السمة احتمالية السجلّ للمرشّح.
| تمثيل JSON |
|---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
بيانات وصفية مرتبطة بأداة استرجاع سياق عنوان URL
urlMetadata[]
object (UrlMetadata)
قائمة بسياق عناوين URL
| تمثيل JSON |
|---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
سياق استرداد عنوان URL واحد
retrievedUrl
string
عنوان URL الذي استردته الأداة
urlRetrievalStatus
enum (UrlRetrievalStatus)
حالة استرداد عنوان URL
| تمثيل JSON |
|---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
حالة استرداد عنوان URL
| عمليات التعداد | |
|---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
URL_RETRIEVAL_STATUS_SUCCESS |
تم استرداد عنوان URL بنجاح. |
URL_RETRIEVAL_STATUS_ERROR |
تعذّر استرداد عنوان URL بسبب حدوث خطأ. |
URL_RETRIEVAL_STATUS_PAYWALL |
تعذّر استرداد عنوان URL لأنّ المحتوى محمي بنظام حظر الاشتراك غير المدفوع. |
URL_RETRIEVAL_STATUS_UNSAFE |
تعذّر استرداد عنوان URL لأنّ المحتوى غير آمن. |
CitationMetadata
مجموعة من بيانات تحديد المصدر الخاصة بجزء من المحتوى
citationSources[]
object (CitationSource)
اقتباسات من مصادر لردّ معيّن
| تمثيل JSON |
|---|
{
"citationSources": [
{
object ( |
CitationSource
اقتباس من مصدر لجزء من ردّ معيّن
startIndex
integer
اختياريّ. بداية جزء الردّ الذي يعود مصدره إلى هذا المستند
يشير الفهرس إلى بداية المقطع، ويتم قياسه بالبايت.
endIndex
integer
اختياريّ. تمثّل نهاية المقطع المنسوب، وهي غير مشمولة.
uri
string
اختياريّ. معرّف الموارد المنتظم (URI) الذي يتم تحديده كمصدر لجزء من النص
license
string
اختياريّ. ترخيص مشروع GitHub الذي تم تحديده كمصدر للجزء.
يجب توفير معلومات الترخيص عند تضمين اقتباسات من الرمز البرمجي.
| تمثيل JSON |
|---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
HarmCategory
فئات المحتوى الضار التي يمكن رصدها في بيانات أدخلها المستخدم وردود النماذج
| عمليات التعداد | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
HARM_CATEGORY_HATE_SPEECH |
المحتوى الذي يروّج للعنف أو يحضّ على الكراهية ضدّ أفراد أو مجموعات على أساس سمات معيّنة |
HARM_CATEGORY_DANGEROUS_CONTENT |
المحتوى الذي يروّج لأنشطة خطيرة أو يسهّل تنفيذها أو يمكّن منها |
HARM_CATEGORY_HARASSMENT |
المحتوى المسيء أو الذي يتضمّن تهديدات أو يهدف إلى التنمّر أو التعذيب أو السخرية |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
المحتوى الذي يشتمل على مواد جنسية فاضحة |
HARM_CATEGORY_CIVIC_INTEGRITY |
تم إيقاف فلتر "الانتخابات" نهائيًا. فئة الضرر هي النزاهة المدنية. |
HARM_CATEGORY_IMAGE_HATE |
الصور التي تتضمّن كلامًا يحض على الكراهية |
HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT |
الصور التي تتضمّن محتوًى خطيرًا |
HARM_CATEGORY_IMAGE_HARASSMENT |
الصور التي تتضمّن مضايقة |
HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT |
الصور التي تتضمّن محتوًى جنسيًا فاضحًا |
HARM_CATEGORY_JAILBREAK |
طلبات مصمّمة لتجاوز فلاتر الأمان |
ModalityTokenCount
تمثّل هذه السمة معلومات حول عدد الرموز المميزة لوسيط واحد.
modality
enum (Modality)
تمثّل هذه السمة نوع الوسائط المرتبط بعدد الرموز المميزة هذا.
tokenCount
integer
عدد الرموز المميّزة
| تمثيل JSON |
|---|
{
"modality": enum ( |
نمط البيانات
طريقة عرض جزء المحتوى
| عمليات التعداد | |
|---|---|
MODALITY_UNSPECIFIED |
طريقة غير محدّدة |
TEXT |
نص عادي |
IMAGE |
صورة: |
VIDEO |
الفيديو |
AUDIO |
ملف صوتي: |
DOCUMENT |
مستند، مثل PDF |
SafetyRating
تمثّل هذه السمة تقييم السلامة لجزء من المحتوى.
يتضمّن تقييم الأمان فئة الضرر ومستوى احتمالية الضرر في تلك الفئة لقطعة من المحتوى. يتم تصنيف المحتوى من حيث الأمان ضمن عدد من فئات الضرر، ويتم تضمين احتمالية تصنيف الضرر هنا.
category
enum (HarmCategory)
الحقل مطلوب. تمثّل هذه السمة فئة التقييم.
probability
enum (HarmProbability)
الحقل مطلوب. تمثّل هذه السمة احتمال الضرر من هذا المحتوى.
blocked
boolean
هل تم حظر هذا المحتوى بسبب هذا التقييم؟
| تمثيل JSON |
|---|
{ "category": enum ( |
HarmProbability
تمثّل هذه السمة احتمال أن يكون المحتوى ضارًا.
يقدّم نظام التصنيف احتمال أن يكون المحتوى غير آمن. ولا يشير ذلك إلى مدى خطورة الضرر الذي قد يسبّبه المحتوى.
| عمليات التعداد | |
|---|---|
HARM_PROBABILITY_UNSPECIFIED |
لم يتم تحديد الاحتمالية. |
NEGLIGIBLE |
فرصة ضئيلة جدًا لأن يكون المحتوى غير آمن |
LOW |
المحتوى لديه فرصة منخفضة لأن يكون غير آمن. |
MEDIUM |
هناك احتمال متوسط بأن يكون المحتوى غير آمن. |
HIGH |
من المحتمل جدًا أن يكون المحتوى غير آمن. |
SafetySetting
إعدادات الأمان التي تؤثر في سلوك الحظر المتعلق بالأمان
يؤدي اجتياز إعداد أمان لفئة معيّنة إلى تغيير الاحتمالية المسموح بها لحظر المحتوى.
category
enum (HarmCategory)
الحقل مطلوب. فئة هذا الإعداد
threshold
enum (HarmBlockThreshold)
الحقل مطلوب. تتحكّم هذه السمة في الحد الأدنى لاحتمال الضرر الذي يتم عنده الحظر.
| تمثيل JSON |
|---|
{ "category": enum ( |
HarmBlockThreshold
الحظر عند مستوى احتمال ضرر محدّد أو أعلى
| عمليات التعداد | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
لم يتم تحديد الحدّ. |
BLOCK_LOW_AND_ABOVE |
سيتم السماح بالمحتوى الذي يتضمّن مستوى "ضئيل". |
BLOCK_MEDIUM_AND_ABOVE |
سيُسمح بالمحتوى الذي يتضمّن مستوى تأثير NEGLIGIBLE وLOW. |
BLOCK_ONLY_HIGH |
سيُسمح بالمحتوى الذي يتضمّن مستويات "ضئيل" و"منخفض" و"متوسط". |
BLOCK_NONE |
سيتم السماح بكل المحتوى. |
OFF |
أوقِف فلتر الأمان. |
ServiceTier
فئة الخدمة للتفاعل
| عمليات التعداد | |
|---|---|
SERVICE_TIER_UNSPECIFIED |
فئة الخدمة التلقائية، وهي الفئة العادية |
SERVICE_TIER_FLEX |
فئة خدمة Flex |
SERVICE_TIER_STANDARD |
فئة الخدمة العادية |
SERVICE_TIER_PRIORITY |
فئة الخدمة ذات الأولوية |
AllowedTools
إعدادات الأدوات المسموح بها
mode
enum (ToolChoiceType)
وضع اختيار الأداة
tools[]
string
تمثّل هذه السمة أسماء الأدوات المسموح بها.
| تمثيل JSON |
|---|
{
"mode": enum ( |
تعليق توضيحي
تمثّل هذه السمة معلومات الاقتباس للمحتوى من إنشاء النموذج.
startIndex
integer
بداية جزء الردّ الذي يعود مصدره إلى هذا المستند
يشير الفهرس إلى بداية المقطع، ويتم قياسه بالبايت.
endIndex
integer
تمثّل نهاية المقطع المنسوب، وهي غير مشمولة.
type
Union type
type إحدى القيم التالية فقط:urlCitation
object (UrlCitation)
تعليق توضيحي لاقتباس من عنوان URL
fileCitation
object (FileCitation)
تعليق توضيحي لاقتباس من ملف
placeCitation
object (PlaceCitation)
تعليق توضيحي بشأن اقتباس من مكان
| تمثيل JSON |
|---|
{ "startIndex": integer, "endIndex": integer, // type "urlCitation": { object ( |
UrlCitation
تعليق توضيحي لاقتباس من عنوان URL
url
string
تمثّل هذه السمة عنوان URL.
title
string
تمثّل هذه السمة عنوان URL.
| تمثيل JSON |
|---|
{ "url": string, "title": string } |
FileCitation
تعليق توضيحي لاقتباس من ملف
documentUri
string
معرّف الموارد المنتظم (URI) للملف
fileName
string
اسم الملف
source
string
المصدر الذي تم الاستناد إليه في جزء من النص
customMetadata
object (Struct)
بيانات التعريف التي يقدّمها المستخدم حول السياق الذي تم استرجاعه
pageNumber
integer
تمثّل هذه السمة رقم صفحة المستند المُشار إليه، إذا كان ذلك منطبقًا.
mediaId
string
تمثّل هذه السمة معرّف الوسائط في حال الاقتباس من الصور، إذا كان ذلك منطبقًا.
| تمثيل JSON |
|---|
{
"documentUri": string,
"fileName": string,
"source": string,
"customMetadata": {
object ( |
PlaceCitation
تعليق توضيحي بشأن اقتباس من مكان
placeId
string
معرّف المكان بالتنسيق places/{placeId}
name
string
تمثّل هذه السمة عنوان المكان.
url
string
يشير إلى معرّف الموارد المنتظم (URI) للمكان.
reviewSnippets[]
object (ReviewSnippet)
مقتطفات من المراجعات تُستخدَم لإنشاء إجابات حول ميزات مكان معيّن في "خرائط Google"
| تمثيل JSON |
|---|
{
"placeId": string,
"name": string,
"url": string,
"reviewSnippets": [
{
object ( |
AspectRatio
نِسب العرض إلى الارتفاع المتاحة لإخراج الصور
| عمليات التعداد | |
|---|---|
ASPECT_RATIO_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
ASPECT_RATIO_ONE_BY_ONE |
نسبة العرض إلى الارتفاع 1:1 |
ASPECT_RATIO_TWO_BY_THREE |
نسبة العرض إلى الارتفاع 2:3 |
ASPECT_RATIO_THREE_BY_TWO |
نسبة العرض إلى الارتفاع 3:2 |
ASPECT_RATIO_THREE_BY_FOUR |
نسبة العرض إلى الارتفاع 3:4 |
ASPECT_RATIO_FOUR_BY_THREE |
نسبة العرض إلى الارتفاع 4:3 |
ASPECT_RATIO_FOUR_BY_FIVE |
نسبة العرض إلى الارتفاع 4:5 |
ASPECT_RATIO_FIVE_BY_FOUR |
نسبة العرض إلى الارتفاع 5:4 |
ASPECT_RATIO_NINE_BY_SIXTEEN |
نسبة العرض إلى الارتفاع 9:16 |
ASPECT_RATIO_SIXTEEN_BY_NINE |
نسبة العرض إلى الارتفاع: 16:9 |
ASPECT_RATIO_TWENTY_ONE_BY_NINE |
نسبة العرض إلى الارتفاع: 21:9 |
ASPECT_RATIO_ONE_BY_EIGHT |
نسبة العرض إلى الارتفاع 1:8 |
ASPECT_RATIO_EIGHT_BY_ONE |
نسبة العرض إلى الارتفاع 8:1 |
ASPECT_RATIO_ONE_BY_FOUR |
نسبة العرض إلى الارتفاع 1:4 |
ASPECT_RATIO_FOUR_BY_ONE |
نسبة العرض إلى الارتفاع 4:1 |
AudioResponseFormat
إعدادات تنسيق إخراج الصوت
mimeType
enum (MimeType)
نوع MIME الخاص بمصدر إخراج الصوت
delivery
enum (Delivery)
طريقة إرسال الصوت
sampleRate
integer
معدّل البيانات في الملف الصوتي بوحدة هرتز
bitRate
integer
معدّل نقل البيانات بالبت في الثانية (bps) ينطبق ذلك فقط على التنسيقات المضغوطة (MP3 وOpus).
| تمثيل JSON |
|---|
{ "mimeType": enum ( |
CodeExecutionCallStep
خطوة طلب تنفيذ الرمز البرمجي
arguments
object (CodeExecutionCallStepArguments)
الحقل مطلوب. الوسيطات التي سيتم تمريرها إلى تنفيذ الرمز البرمجي
| تمثيل JSON |
|---|
{
"arguments": {
object ( |
CodeExecutionCallStepArguments
الوسيطات التي سيتم تمريرها إلى تنفيذ الرمز البرمجي
language
enum (Language)
لغة البرمجة الخاصة بـ code
code
string
الرمز المطلوب تنفيذه
| تمثيل JSON |
|---|
{
"language": enum ( |
CodeExecutionResultStep
خطوة نتيجة تنفيذ الرمز البرمجي
result
string
الحقل مطلوب. ناتج تنفيذ الرمز البرمجي
isError
boolean
تُستخدَم لتحديد ما إذا كان تنفيذ الرمز البرمجي قد أدّى إلى حدوث خطأ.
| تمثيل JSON |
|---|
{ "result": string, "isError": boolean } |
ComputerUse
أداة يمكن أن يستخدمها النموذج للتفاعل مع الكمبيوتر
environment
enum (Environment)
البيئة التي يتم تشغيلها
excludedPredefinedFunctions[]
string
قائمة الدوال المحدّدة مسبقًا والتي تم استبعادها من طلب النموذج
enablePromptInjectionDetection
boolean
تحديد ما إذا كان سيتم تفعيل عملية التحقّق من رصد هجمات حقن الطلبات على طلب استخدام الكمبيوتر
disabledSafetyPolicies[]
enum (SafetyPolicy)
اختياريّ. تم إيقاف سياسات الأمان المتعلقة باستخدام الكمبيوتر.
| تمثيل JSON |
|---|
{ "environment": enum ( |
المحتوى
- تمثيل JSON
- TextContent
- ImageContent
- AudioContent
- DocumentContent
- VideoContent
- ThoughtContent
- ThoughtSummaryContent
- ToolCallContent
- FunctionCallContent
- CodeExecutionCallContent
- CodeExecutionCallArguments
- UrlContextCallContent
- UrlContextCallArguments
- McpServerToolCallContent
- GoogleSearchCallContent
- GoogleSearchCallArguments
- FileSearchCallContent
- GoogleMapsCallContent
- GoogleMapsCallArguments
- ToolResultContent
- FunctionResultContent
- FunctionResultSubcontentList
- FunctionResultSubcontent
- CodeExecutionResultContent
- UrlContextResultContent
- UrlContextResult
- GoogleSearchResultContent
- GoogleSearchResult
- McpServerToolResultContent
- FileSearchResultContent
- FileSearchResult
- GoogleMapsResultContent
- GoogleMapsResult
- الأماكن
تمثّل هذه السمة محتوى الردّ.
type
Union type
type إحدى القيم التالية فقط:text
object (TextContent)
image
object (ImageContent)
audio
object (AudioContent)
document
object (DocumentContent)
video
object (VideoContent)
thought
(deprecated)
object (ThoughtContent)
toolCall
(deprecated)
object (ToolCallContent)
toolResult
(deprecated)
object (ToolResultContent)
| تمثيل JSON |
|---|
{ // type "text": { object ( |
TextContent
مقطع محتوى نصي
text
string
الحقل مطلوب. محتوى النص
annotations[]
object (Annotation)
تمثّل هذه السمة معلومات الاقتباس للمحتوى من إنشاء النموذج.
| تمثيل JSON |
|---|
{
"text": string,
"annotations": [
{
object ( |
ImageContent
كتلة محتوى صورة
mimeType
enum (MimeType)
نوع MIME الخاص بالصورة.
resolution
enum (MediaResolution)
تمثّل هذه السمة درجة دقة الوسائط.
data_or_uri
Union type
data_or_uri إحدى القيم التالية فقط:data
string (bytes format)
محتوى الصورة
سلسلة مرمّزة باستخدام Base64
uri
string
معرّف الموارد المنتظم (URI) للصورة
| تمثيل JSON |
|---|
{ "mimeType": enum ( |
AudioContent
كتلة محتوى صوتي
mimeType
enum (MimeType)
نوع MIME الخاص بالمقطع الصوتي.
channels
integer
تمثّل هذه السمة عدد القنوات الصوتية.
sampleRate
integer
معدّل عيّنة الصوت
data_or_uri
Union type
data_or_uri إحدى القيم التالية فقط:data
string (bytes format)
المحتوى الصوتي
سلسلة مرمّزة باستخدام Base64
uri
string
تمثّل هذه السمة معرّف الموارد المنتظم (URI) الخاص بالملف الصوتي.
| تمثيل JSON |
|---|
{
"mimeType": enum ( |
DocumentContent
وحدة محتوى مستند
mimeType
enum (MimeType)
نوع MIME للمستند.
data_or_uri
Union type
data_or_uri إحدى القيم التالية فقط:data
string (bytes format)
محتوى المستند
سلسلة مرمّزة باستخدام Base64
uri
string
معرّف الموارد المنتظم (URI) للمستند
| تمثيل JSON |
|---|
{
"mimeType": enum ( |
VideoContent
كتلة محتوى فيديو
mimeType
enum (MimeType)
نوع MIME الخاص بالفيديو.
resolution
enum (MediaResolution)
تمثّل هذه السمة درجة دقة الوسائط.
data_or_uri
Union type
data_or_uri إحدى القيم التالية فقط:data
string (bytes format)
محتوى الفيديو
سلسلة مرمّزة باستخدام Base64
uri
string
تمثّل هذه السمة معرّف الموارد المنتظم (URI) الخاص بالفيديو.
| تمثيل JSON |
|---|
{ "mimeType": enum ( |
ThoughtContent
وحدة محتوى خاصة بالأفكار
signature
string (bytes format)
توقيع لمطابقة المصدر الخلفي الذي سيتم تضمينه في عملية الإنشاء
سلسلة مرمّزة باستخدام Base64
summary[]
object (ThoughtSummaryContent)
ملخّص الفكرة
| تمثيل JSON |
|---|
{
"signature": string,
"summary": [
{
object ( |
ThoughtSummaryContent
type
Union type
type إحدى القيم التالية فقط:text
object (TextContent)
image
object (ImageContent)
| تمثيل JSON |
|---|
{ // type "text": { object ( |
ToolCallContent
محتوى طلب استخدام الأداة
id
string
الحقل مطلوب. معرّف فريد لاستدعاء الأداة المحدّد هذا.
signature
string (bytes format)
تجزئة التوقيع للتحقّق من صحة البيانات في الخلفية
سلسلة مرمّزة باستخدام Base64
type
Union type
type إحدى القيم التالية فقط:functionCall
object (FunctionCallContent)
codeExecutionCall
object (CodeExecutionCallContent)
urlContextCall
object (UrlContextCallContent)
mcpServerToolCall
object (McpServerToolCallContent)
googleSearchCall
object (GoogleSearchCallContent)
fileSearchCall
object (FileSearchCallContent)
googleMapsCall
object (GoogleMapsCallContent)
| تمثيل JSON |
|---|
{ "id": string, "signature": string, // type "functionCall": { object ( |
FunctionCallContent
كتلة محتوى لاستدعاء أداة وظيفة
name
string
الحقل مطلوب. تمثّل هذه السمة اسم الأداة المطلوب استدعاؤها.
arguments
object (Struct)
الحقل مطلوب. الوسيطات التي سيتم تمريرها إلى الدالة
| تمثيل JSON |
|---|
{
"name": string,
"arguments": {
object ( |
CodeExecutionCallContent
محتوى تنفيذ الرموز البرمجية
arguments
object (CodeExecutionCallArguments)
الحقل مطلوب. الوسيطات التي سيتم تمريرها إلى تنفيذ الرمز البرمجي
| تمثيل JSON |
|---|
{
"arguments": {
object ( |
CodeExecutionCallArguments
الوسيطات التي سيتم تمريرها إلى تنفيذ الرمز البرمجي
language
enum (Language)
لغة البرمجة الخاصة بـ code
code
string
الرمز المطلوب تنفيذه
| تمثيل JSON |
|---|
{
"language": enum ( |
UrlContextCallContent
محتوى سياق عنوان URL
arguments
object (UrlContextCallArguments)
الحقل مطلوب. الوسيطات التي سيتم تمريرها إلى سياق عنوان URL
| تمثيل JSON |
|---|
{
"arguments": {
object ( |
UrlContextCallArguments
الوسيطات التي سيتم تمريرها إلى سياق عنوان URL
urls[]
string
تمثّل هذه السمة عناوين URL المطلوب استرجاعها.
| تمثيل JSON |
|---|
{ "urls": [ string ] } |
McpServerToolCallContent
محتوى طلب استخدام أداة MCPServer
name
string
الحقل مطلوب. اسم الأداة التي تم استدعاؤها
serverName
string
الحقل مطلوب. تمثّل هذه السمة اسم خادم MCP المستخدَم.
arguments
object (Struct)
الحقل مطلوب. عنصر JSON الخاص بوسيطات الدالة
| تمثيل JSON |
|---|
{
"name": string,
"serverName": string,
"arguments": {
object ( |
GoogleSearchCallContent
محتوى "بحث Google"
arguments
object (GoogleSearchCallArguments)
الحقل مطلوب. الوسيطات التي يجب تمريرها إلى "بحث Google"
searchType
enum (SearchType)
نوع البحث المستند إلى بيانات مفعَّل.
| تمثيل JSON |
|---|
{ "arguments": { object ( |
GoogleSearchCallArguments
الحجج التي يجب تمريرها إلى "بحث Google"
queries[]
string
طلبات البحث على الويب التي يتم إجراؤها لمتابعة البحث على الويب
| تمثيل JSON |
|---|
{ "queries": [ string ] } |
FileSearchCallContent
لا يتضمّن هذا النوع أي حقول.
محتوى "بحث الملفات"
GoogleMapsCallContent
محتوى "خرائط Google"
arguments
object (GoogleMapsCallArguments)
الوسيطات التي سيتم تمريرها إلى أداة "خرائط Google"
| تمثيل JSON |
|---|
{
"arguments": {
object ( |
GoogleMapsCallArguments
الوسيطات التي سيتم تمريرها إلى أداة "خرائط Google"
queries[]
string
طلبات البحث التي سيتم تنفيذها
| تمثيل JSON |
|---|
{ "queries": [ string ] } |
ToolResultContent
محتوى نتيجة الأداة
callId
string
الحقل مطلوب. معرّف يجب أن يتطابق مع المعرّف من مربّع استدعاء الدالة
signature
string (bytes format)
تجزئة التوقيع للتحقّق من صحة البيانات في الخلفية
سلسلة مرمّزة باستخدام Base64
type
Union type
type إحدى القيم التالية فقط:functionResult
object (FunctionResultContent)
codeExecutionResult
object (CodeExecutionResultContent)
urlContextResult
object (UrlContextResultContent)
googleSearchResult
object (GoogleSearchResultContent)
mcpServerToolResult
object (McpServerToolResultContent)
fileSearchResult
object (FileSearchResultContent)
googleMapsResult
object (GoogleMapsResultContent)
| تمثيل JSON |
|---|
{ "callId": string, "signature": string, // type "functionResult": { object ( |
FunctionResultContent
كتلة محتوى لنتيجة أداة دالة
name
string
تمثّل هذه السمة اسم الأداة التي تم استدعاؤها.
isError
boolean
تُستخدَم لتحديد ما إذا كان استدعاء الأداة قد نتج عنه خطأ.
result
Union type
result إحدى القيم التالية فقط:structResult
object (Struct)
contentList
object (FunctionResultSubcontentList)
stringResult
string
| تمثيل JSON |
|---|
{ "name": string, "isError": boolean, // result "structResult": { object ( |
FunctionResultSubcontentList
contents[]
object (FunctionResultSubcontent)
| تمثيل JSON |
|---|
{
"contents": [
{
object ( |
FunctionResultSubcontent
type
Union type
type إحدى القيم التالية فقط:text
object (TextContent)
image
object (ImageContent)
| تمثيل JSON |
|---|
{ // type "text": { object ( |
CodeExecutionResultContent
محتوى نتيجة تنفيذ الرمز البرمجي
result
string
الحقل مطلوب. ناتج تنفيذ الرمز البرمجي
isError
boolean
تُستخدَم لتحديد ما إذا كان تنفيذ الرمز البرمجي قد أدّى إلى حدوث خطأ.
| تمثيل JSON |
|---|
{ "result": string, "isError": boolean } |
UrlContextResultContent
محتوى نتيجة سياق عنوان URL
result[]
object (UrlContextResult)
الحقل مطلوب. نتائج سياق عنوان URL
isError
boolean
تُستخدَم لتحديد ما إذا كان سياق عنوان URL قد أدّى إلى حدوث خطأ.
| تمثيل JSON |
|---|
{
"result": [
{
object ( |
UrlContextResult
نتيجة سياق عنوان URL
url
string
عنوان URL الذي تم استرجاعه.
status
enum (Status)
حالة استرداد عنوان URL.
| تمثيل JSON |
|---|
{
"url": string,
"status": enum ( |
GoogleSearchResultContent
محتوى نتيجة بحث من Google
result[]
object (GoogleSearchResult)
الحقل مطلوب. نتائج بحث Google
isError
boolean
تُستخدَم لتحديد ما إذا كان البحث على Google قد أدّى إلى حدوث خطأ.
| تمثيل JSON |
|---|
{
"result": [
{
object ( |
GoogleSearchResult
نتيجة بحث Google.
searchSuggestions
string
مقتطف من محتوى الويب يمكن تضمينه في صفحة ويب أو WebView في تطبيق
| تمثيل JSON |
|---|
{ "searchSuggestions": string } |
McpServerToolResultContent
محتوى نتيجة أداة MCPServer
name
string
اسم الأداة التي يتم استدعاؤها لتنفيذ طلب استخدام الأداة المحدّد هذا.
serverName
string
تمثّل هذه السمة اسم خادم MCP المستخدَم.
result
Union type
result إحدى القيم التالية فقط:structResult
object (Struct)
contentList
object (FunctionResultSubcontentList)
stringResult
string
| تمثيل JSON |
|---|
{ "name": string, "serverName": string, // result "structResult": { object ( |
FileSearchResultContent
محتوى نتيجة البحث في الملفات
result[]
object (FileSearchResult)
اختياريّ. نتائج البحث عن الملفات
| تمثيل JSON |
|---|
{
"result": [
{
object ( |
FileSearchResult
لا يتضمّن هذا النوع أي حقول.
نتيجة البحث عن الملفات
GoogleMapsResultContent
محتوى نتائج "خرائط Google"
result[]
object (GoogleMapsResult)
الحقل مطلوب. نتائج "خرائط Google"
| تمثيل JSON |
|---|
{
"result": [
{
object ( |
GoogleMapsResult
نتيجة "خرائط Google"
places[]
object (Places)
الأماكن التي تم العثور عليها
widgetContextToken
string
اسم المورد لرمز مميّز سياقي لتطبيق "خرائط Google" المصغّر
| تمثيل JSON |
|---|
{
"places": [
{
object ( |
أماكن
placeId
string
معرّف المكان بالتنسيق places/{placeId}
name
string
تمثّل هذه السمة عنوان المكان.
url
string
يشير إلى معرّف الموارد المنتظم (URI) للمكان.
reviewSnippets[]
object (ReviewSnippet)
مقتطفات من المراجعات تُستخدَم لإنشاء إجابات حول ميزات مكان معيّن في "خرائط Google"
| تمثيل JSON |
|---|
{
"placeId": string,
"name": string,
"url": string,
"reviewSnippets": [
{
object ( |
CreateInteractionRequest
- تمثيل JSON
- التفاعل
- TurnList
- استدارة
- StepList
- الخطوة
- ThoughtStep
- ToolCallStep
- FunctionCallStep
- UrlContextCallStep
- UrlContextCallStepArguments
- McpServerToolCallStep
- GoogleSearchCallStep
- GoogleSearchCallStepArguments
- FileSearchCallStep
- GoogleMapsCallStep
- GoogleMapsCallStepArguments
- ToolResultStep
- FunctionResultStep
- UrlContextResultStep
- UrlContextResultItem
- GoogleSearchResultStep
- GoogleSearchResultItem
- McpServerToolResultStep
- FileSearchResultStep
- GoogleMapsResultStep
- GoogleMapsResultItem
- GoogleMapsResultPlaces
- UserInputStep
- ModelOutputStep
- ResponseFormatList
- ResponseFormat
- TextResponseFormat
- ImageResponseFormat
- VideoResponseFormat
- ModelInteraction
- GenerationConfig
- ToolChoiceConfig
- SpeechConfig
- ImageConfig
- VideoConfig
- EnvironmentConfig
- EnvironmentNetworkEgressAllowlist
- EgressRule
- المصدر
- LocalEnvironmentConfig
- الأداة
- الوظيفة
- UrlContext
- McpServer
- GoogleSearch
- FileSearch
- GoogleMaps
- الاستخدام
- ModalityTokens
- GroundingToolCount
- WebhookConfig
- SafetySetting
مَعلمات الإعداد لإنشاء تفاعل
stream
boolean
الإدخال فقط تُستخدَم لتحديد ما إذا كان سيتم بث التفاعل.
store
boolean
الإدخال فقط تحديد ما إذا كان سيتم تخزين الرد والطلب لاستردادهما لاحقًا
interaction
object (Interaction)
التفاعل المطلوب إنشاؤه
background
boolean
الإدخال فقط تحديد ما إذا كان سيتم تشغيل التفاعل مع النموذج في الخلفية
| تمثيل JSON |
|---|
{
"stream": boolean,
"store": boolean,
"interaction": {
object ( |
التفاعل
الردّ على InteractionService.CreateInteraction
id
string
الحقل مطلوب. النتائج فقط. معرّف فريد لإكمال التفاعل.
status
enum (Status)
الحقل مطلوب. النتائج فقط. تمثّل هذه السمة حالة التفاعل.
created
string
الحقل مطلوب. النتائج فقط. تمثّل هذه السمة الوقت الذي تم فيه إنشاء الردّ بتنسيق ISO 8601 (YYYY-MM-DDThh:mm:ssZ).
updated
string
الحقل مطلوب. النتائج فقط. تمثّل هذه السمة الوقت الذي تم فيه آخر تعديل على الردّ بتنسيق ISO 8601 (YYYY-MM-DDThh:mm:ssZ).
role
(deprecated)
string
النتائج فقط. دور التفاعل
outputs[]
(deprecated)
object (Content)
النتائج فقط. الردود من النموذج
systemInstruction
string
تعليمات النظام للتفاعل
tools[]
object (Tool)
قائمة بتعريفات الأدوات التي قد يستدعيها النموذج أثناء التفاعل
usage
object (Usage)
النتائج فقط. إحصاءات حول استخدام الرمز المميز لطلب التفاعل.
responseModalities[]
(deprecated)
enum (ResponseModality)
أنواع الردود المطلوبة (TEXT أو IMAGE أو AUDIO).
responseMimeType
(deprecated)
string
نوع MIME الخاص بالردّ. هذه السمة مطلوبة في حال ضبط responseFormat.
previousInteractionId
string
رقم تعريف التفاعل السابق، إن وُجد.
environmentId
string
النتائج فقط. رقم تعريف البيئة للتفاعل. لا تتم تعبئة هذا الحقل إلا إذا تم ضبط إعدادات البيئة في الطلب.
serviceTier
enum (ServiceTier)
فئة الخدمة للتفاعل
webhookConfig
object (WebhookConfig)
اختياريّ. إعدادات Webhook لتلقّي الإشعارات عند اكتمال التفاعل
steps[]
object (Step)
الحقل مطلوب. النتائج فقط. تمثّل هذه السمة الخطوات التي يتضمّنها التفاعل.
input
Union type
input إحدى القيم التالية فقط:contentList
(deprecated)
object (ContentList)
مدخلات التفاعل
stringContent
string
تمثّل هذه السمة إدخالاً لسلسلة نصية للتفاعل، وسيتمّ معالجتها كإدخال نصي واحد.
turnList
(deprecated)
object (TurnList)
نوبات التفاعل
stepList
object (StepList)
الإدخال فقط تمثّل هذه السمة خطوات التفاعل.
content
object (Content)
محتوى التفاعل
response_format_config
Union type
response_format_config إحدى القيم التالية فقط:responseFormat
(deprecated)
object (Value)
يفرض أن يكون الردّ الذي يتم إنشاؤه عبارة عن عنصر JSON يتوافق مع مخطط JSON المحدّد في هذا الحقل.
responseFormatList
object (ResponseFormatList)
responseFormatSingleton
object (ResponseFormat)
request_type
Union type
request_type إحدى القيم التالية فقط:modelInteraction
object (ModelInteraction)
التفاعل لإنشاء الإكمال باستخدام النماذج
agentInteraction
object (AgentInteraction)
التفاعل لإنشاء الإكمال باستخدام الوكلاء
environment
Union type
environment إحدى القيم التالية فقط:envId
string
رقم تعريف البيئة للتفاعل. يمكن أن تكون القيمة هي "remote" للبيئة التلقائية.
remoteEnvironment
object (EnvironmentConfig)
localEnvironment
object (LocalEnvironmentConfig)
تتوفّر بيئة الوكيل على اتصال العميل: يتم تسليم عمليات البيئة المضمّنة (عمليات نظام الملفات وتنفيذ الأوامر) إلى العميل لتنفيذها، بدلاً من تنفيذها في بيئة اختبار معزولة يديرها الخادم. لا يمكن استخدامها مع remoteEnvironment. (بشكل مستقل عن أي أدوات وظائف يحدّدها العميل، والتي يتم تنفيذها دائمًا على العميل بغض النظر عن هذا الحقل)
| تمثيل JSON |
|---|
{ "id": string, "status": enum ( |
TurnList
Turn
role
string
مَن بدأ هذا الدور. يجب أن يكون مستخدمًا للإدخال أو نموذجًا لمخرجات النموذج.
content
Union type
content إحدى القيم التالية فقط:contentList
object (ContentList)
محتوى الدور مصفوفة من عناصر المحتوى
contentString
string
محتوى الجولة سلسلة واحدة
| تمثيل JSON |
|---|
{
"role": string,
// content
"contentList": {
object ( |
StepList
قائمة بالخطوات
steps[]
object (Step)
تمثّل هذه السمة خطوات القائمة.
| تمثيل JSON |
|---|
{
"steps": [
{
object ( |
الخطوة
خطوة في التفاعل
type
Union type
type إحدى القيم التالية فقط:thought
object (ThoughtStep)
toolCall
object (ToolCallStep)
toolResult
object (ToolResultStep)
userInput
object (UserInputStep)
لا تستخدم هذه الحقول، فهي مخصّصة لملف JSON الخاص بالجهات الخارجية فقط.
modelOutput
object (ModelOutputStep)
text
(deprecated)
object (LegacyTextContent)
image
(deprecated)
object (LegacyImageContent)
audio
(deprecated)
object (LegacyAudioContent)
document
(deprecated)
object (LegacyDocumentContent)
video
(deprecated)
object (LegacyVideoContent)
| تمثيل JSON |
|---|
{ // type "thought": { object ( |
ThoughtStep
خطوة تفكير
signature
string (bytes format)
تجزئة التوقيع للتحقّق من صحة البيانات في الخلفية
سلسلة مرمّزة باستخدام Base64
summary[]
object (Content)
ملخّص الفكرة
| تمثيل JSON |
|---|
{
"signature": string,
"summary": [
{
object ( |
ToolCallStep
خطوة طلب استخدام الأداة
id
string
الحقل مطلوب. معرّف فريد لاستدعاء الأداة المحدّد هذا.
signature
string (bytes format)
تجزئة التوقيع للتحقّق من صحة البيانات في الخلفية
سلسلة مرمّزة باستخدام Base64
type
Union type
type إحدى القيم التالية فقط:functionCall
object (FunctionCallStep)
codeExecutionCall
object (CodeExecutionCallStep)
urlContextCall
object (UrlContextCallStep)
mcpServerToolCall
object (McpServerToolCallStep)
googleSearchCall
object (GoogleSearchCallStep)
fileSearchCall
object (FileSearchCallStep)
googleMapsCall
object (GoogleMapsCallStep)
retrievalCall
object (RetrievalCallStep)
| تمثيل JSON |
|---|
{ "id": string, "signature": string, // type "functionCall": { object ( |
FunctionCallStep
خطوة استدعاء أداة الدالة
name
string
الحقل مطلوب. تمثّل هذه السمة اسم الأداة المطلوب استدعاؤها.
arguments
object (Struct)
الحقل مطلوب. الوسيطات التي سيتم تمريرها إلى الدالة
| تمثيل JSON |
|---|
{
"name": string,
"arguments": {
object ( |
UrlContextCallStep
خطوة طلب سياق عنوان URL
arguments
object (UrlContextCallStepArguments)
الحقل مطلوب. الوسيطات التي سيتم تمريرها إلى سياق عنوان URL
| تمثيل JSON |
|---|
{
"arguments": {
object ( |
UrlContextCallStepArguments
الوسيطات التي سيتم تمريرها إلى سياق عنوان URL
urls[]
string
تمثّل هذه السمة عناوين URL المطلوب استرجاعها.
| تمثيل JSON |
|---|
{ "urls": [ string ] } |
McpServerToolCallStep
خطوة طلب استخدام أداة MCPServer
name
string
الحقل مطلوب. اسم الأداة التي تم استدعاؤها
serverName
string
الحقل مطلوب. تمثّل هذه السمة اسم خادم MCP المستخدَم.
arguments
object (Struct)
الحقل مطلوب. عنصر JSON الخاص بوسيطات الدالة
| تمثيل JSON |
|---|
{
"name": string,
"serverName": string,
"arguments": {
object ( |
GoogleSearchCallStep
خطوة المكالمة على "بحث Google"
arguments
object (GoogleSearchCallStepArguments)
الحقل مطلوب. الوسيطات التي يجب تمريرها إلى "بحث Google"
searchType
enum (SearchType)
نوع البحث المستند إلى بيانات مفعَّل.
| تمثيل JSON |
|---|
{ "arguments": { object ( |
GoogleSearchCallStepArguments
الوسيطات التي يجب تمريرها إلى "بحث Google"
queries[]
string
طلبات البحث على الويب التي يتم إجراؤها لمتابعة البحث على الويب
| تمثيل JSON |
|---|
{ "queries": [ string ] } |
FileSearchCallStep
لا يتضمّن هذا النوع أي حقول.
خطوة مكالمة "البحث في الملفات"
GoogleMapsCallStep
خطوة الاتصال في "خرائط Google"
arguments
object (GoogleMapsCallStepArguments)
الوسيطات التي سيتم تمريرها إلى أداة "خرائط Google"
| تمثيل JSON |
|---|
{
"arguments": {
object ( |
GoogleMapsCallStepArguments
الوسيطات التي سيتم تمريرها إلى أداة "خرائط Google"
queries[]
string
طلبات البحث التي سيتم تنفيذها
| تمثيل JSON |
|---|
{ "queries": [ string ] } |
ToolResultStep
خطوة نتيجة الأداة
callId
string
الحقل مطلوب. معرّف يجب أن يتطابق مع المعرّف من مربّع استدعاء الدالة
signature
string (bytes format)
تجزئة التوقيع للتحقّق من صحة البيانات في الخلفية
سلسلة مرمّزة باستخدام Base64
type
Union type
type إحدى القيم التالية فقط:functionResult
object (FunctionResultStep)
codeExecutionResult
object (CodeExecutionResultStep)
urlContextResult
object (UrlContextResultStep)
googleSearchResult
object (GoogleSearchResultStep)
mcpServerToolResult
object (McpServerToolResultStep)
fileSearchResult
object (FileSearchResultStep)
googleMapsResult
object (GoogleMapsResultStep)
retrievalResult
object (RetrievalResultStep)
| تمثيل JSON |
|---|
{ "callId": string, "signature": string, // type "functionResult": { object ( |
FunctionResultStep
نتيجة استدعاء أداة دالة
name
string
تمثّل هذه السمة اسم الأداة التي تم استدعاؤها.
isError
boolean
تُستخدَم لتحديد ما إذا كان استدعاء الأداة قد نتج عنه خطأ.
result
object (Value)
الحقل مطلوب. نتيجة استدعاء الأداة.
| تمثيل JSON |
|---|
{
"name": string,
"isError": boolean,
"result": {
object ( |
UrlContextResultStep
خطوة نتيجة سياق عنوان URL
result[]
object (UrlContextResultItem)
الحقل مطلوب. نتائج سياق عنوان URL
isError
boolean
تُستخدَم لتحديد ما إذا كان سياق عنوان URL قد أدّى إلى حدوث خطأ.
| تمثيل JSON |
|---|
{
"result": [
{
object ( |
UrlContextResultItem
نتيجة سياق عنوان URL
url
string
عنوان URL الذي تم جلبه.
status
enum (Status)
حالة استرداد عنوان URL.
| تمثيل JSON |
|---|
{
"url": string,
"status": enum ( |
GoogleSearchResultStep
خطوة نتيجة البحث من Google
result[]
object (GoogleSearchResultItem)
الحقل مطلوب. نتائج بحث Google
isError
boolean
تُستخدَم لتحديد ما إذا كان البحث على Google قد أدّى إلى حدوث خطأ.
| تمثيل JSON |
|---|
{
"result": [
{
object ( |
GoogleSearchResultItem
نتيجة بحث Google.
searchSuggestions
string
مقتطف من محتوى الويب يمكن تضمينه في صفحة ويب أو WebView في تطبيق
| تمثيل JSON |
|---|
{ "searchSuggestions": string } |
McpServerToolResultStep
خطوة نتيجة أداة MCPServer
name
string
اسم الأداة التي يتم استدعاؤها لتنفيذ طلب استخدام الأداة المحدّد هذا.
serverName
string
تمثّل هذه السمة اسم خادم MCP المستخدَم.
result
object (Value)
الحقل مطلوب. الناتج من طلب خادم MCP يمكن أن يكون نصًا بسيطًا أو محتوًى وافيًا.
| تمثيل JSON |
|---|
{
"name": string,
"serverName": string,
"result": {
object ( |
FileSearchResultStep
لا يتضمّن هذا النوع أي حقول.
خطوة نتيجة البحث عن الملفات
GoogleMapsResultStep
خطوة نتيجة "خرائط Google"
result[]
object (GoogleMapsResultItem)
| تمثيل JSON |
|---|
{
"result": [
{
object ( |
GoogleMapsResultItem
نتيجة "خرائط Google"
places[]
object (GoogleMapsResultPlaces)
widgetContextToken
string
| تمثيل JSON |
|---|
{
"places": [
{
object ( |
GoogleMapsResultPlaces
placeId
string
name
string
url
string
reviewSnippets[]
object (ReviewSnippet)
| تمثيل JSON |
|---|
{
"placeId": string,
"name": string,
"url": string,
"reviewSnippets": [
{
object ( |
UserInputStep
الإدخال الذي يقدّمه المستخدم
content
Union type
content إحدى القيم التالية فقط:contentList
object (ContentList)
محتوى الخطوة مصفوفة من عناصر المحتوى
contentString
string
محتوى الخطوة سلسلة واحدة
| تمثيل JSON |
|---|
{
// content
"contentList": {
object ( |
ModelOutputStep
الناتج الذي يصدره النموذج
content[]
object (Content)
| تمثيل JSON |
|---|
{
"content": [
{
object ( |
ResponseFormatList
responseFormats[]
object (ResponseFormat)
| تمثيل JSON |
|---|
{
"responseFormats": [
{
object ( |
ResponseFormat
type
Union type
type إحدى القيم التالية فقط:audio
object (AudioResponseFormat)
text
object (TextResponseFormat)
image
object (ImageResponseFormat)
video
object (VideoResponseFormat)
structValue
object (Struct)
تمّ تفعيل قيم المصنّفات المتعدّدة في GAOS
| تمثيل JSON |
|---|
{ // type "audio": { object ( |
TextResponseFormat
إعدادات تنسيق إخراج النص
mimeType
enum (MimeType)
نوع MIME الخاص بالناتج النصي.
schema
object (Struct)
مخطّط JSON الذي يجب أن يتوافق معه الناتج. ينطبق ذلك فقط عندما يكون mimeType هو application/json.
| تمثيل JSON |
|---|
{ "mimeType": enum ( |
ImageResponseFormat
إعدادات تنسيق إخراج الصورة
mimeType
enum (MimeType)
نوع MIME الخاص بإخراج الصورة.
delivery
enum (Delivery)
طريقة إرسال مخرجات الصورة
aspectRatio
enum (AspectRatio)
نسبة العرض إلى الارتفاع لناتج الصورة
imageSize
enum (ImageSize)
حجم الصورة الناتجة
| تمثيل JSON |
|---|
{ "mimeType": enum ( |
VideoResponseFormat
إعدادات تنسيق إخراج الفيديو
delivery
enum (Delivery)
تحدّد هذه السمة طريقة عرض الفيديو.
aspectRatio
enum (AspectRatio)
نسبة العرض إلى الارتفاع لإخراج الفيديو
duration
string (Duration format)
تمثّل هذه السمة مدة الفيديو الناتج.
مدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ "s". مثال: "3.5s".
| تمثيل JSON |
|---|
{ "delivery": enum ( |
ModelInteraction
التفاعل لإنشاء الإكمال باستخدام النماذج
model
string
اسم Model المستخدَم لإنشاء الإكمال.
generationConfig
object (GenerationConfig)
الإدخال فقط مَعلمات الإعداد للتفاعل مع النموذج
| تمثيل JSON |
|---|
{
"model": string,
"generationConfig": {
object ( |
GenerationConfig
مَعلمات الضبط لتفاعلات النموذج
temperature
number
تتحكّم هذه السمة في عشوائية الناتج.
topP
number
الحد الأقصى للاحتمال التراكمي للرموز المميّزة التي يجب أخذها في الاعتبار عند أخذ العيّنات.
seed
integer
البيانات الأولية المستخدَمة في فك الترميز لضمان إمكانية إعادة الإنتاج
stopSequences[]
string
قائمة بسلاسل الأحرف التي ستوقف التفاعل مع الإخراج
thinkingLevel
enum (ThinkingLevel)
مستوى الرموز المميزة للأفكار التي يجب أن ينشئها النموذج
thinkingSummaries
enum (ThinkingSummaries)
تحديد ما إذا كان سيتم تضمين ملخّصات الأفكار في الردّ.
maxOutputTokens
integer
الحد الأقصى لعدد الرموز المميّزة التي يمكن تضمينها في الرد.
speechConfig[]
object (SpeechConfig)
إعدادات التفاعل مع الكلام
imageConfig
(deprecated)
object (ImageConfig)
إعدادات التفاعل مع الصور
videoConfig
object (VideoConfig)
إعدادات إنشاء الفيديوهات
tool_choice
Union type
tool_choice إحدى القيم التالية فقط:toolChoiceMode
enum (ToolChoiceType)
وضع اختيار الأداة
toolChoiceConfig
object (ToolChoiceConfig)
إعدادات اختيار الأداة
| تمثيل JSON |
|---|
{ "temperature": number, "topP": number, "seed": integer, "stopSequences": [ string ], "thinkingLevel": enum ( |
ToolChoiceConfig
إعدادات اختيار الأداة التي تحتوي على الأدوات المسموح بها
allowedTools
object (AllowedTools)
الأدوات المسموح بها
| تمثيل JSON |
|---|
{
"allowedTools": {
object ( |
SpeechConfig
إعدادات التفاعل الصوتي
voice
string
صوت المتحدث
language
string
لغة الكلام
speaker
string
اسم المتحدث، ويجب أن يتطابق مع اسم المتحدث الوارد في الطلب
| تمثيل JSON |
|---|
{ "voice": string, "language": string, "speaker": string } |
ImageConfig
إعدادات التفاعل مع الصور
aspectRatio
string
نسبة العرض إلى الارتفاع للصورة المطلوب إنشاؤها نسب العرض إلى الارتفاع المتاحة: 1:1 و2:3 و3:2 و3:4 و4:3 و9:16 و16:9 و21:9
في حال عدم تحديد نسبة العرض إلى الارتفاع، سيختار النموذج نسبة تلقائية استنادًا إلى أي صور مرجعية مقدَّمة.
imageSize
string
تحدّد هذه السمة حجم الصور التي يتم إنشاؤها. القيم المسموح بها هي 1K و2K و4K. في حال عدم تحديدها، سيستخدم النموذج القيمة التلقائية 1K.
| تمثيل JSON |
|---|
{ "aspectRatio": string, "imageSize": string } |
VideoConfig
خيارات الإعداد لإنشاء الفيديوهات
task
enum (Task)
وضع المهام الاختياري لإنشاء الفيديوهات في حال عدم تحديد الوضع، يحدّد النموذج تلقائيًا الوضع المناسب استنادًا إلى طلب النص ووسائط الإدخال المقدَّمة.
| تمثيل JSON |
|---|
{
"task": enum ( |
EnvironmentConfig
إعدادات بيئة مخصّصة
sources[]
object (Source)
environmentId
string
اختياريّ. رقم تعريف البيئة للتفاعل. في حال تحديدها، سيعدّل الطلب البيئة الحالية بدلاً من إنشاء بيئة جديدة.
network
Union type
network إحدى القيم التالية فقط:networkAllowlist
object (EnvironmentNetworkEgressAllowlist)
السماح بنطاقات محدّدة فقط
networkMode
enum (NetworkMode)
وضع خروج الشبكة
| تمثيل JSON |
|---|
{ "sources": [ { object ( |
EnvironmentNetworkEgressAllowlist
إعدادات خروج الشبكة للبيئة
allowlist[]
object (EgressRule)
قائمة بالنطاقات المسموح بها وإعداداتها
| تمثيل JSON |
|---|
{
"allowlist": [
{
object ( |
EgressRule
قاعدة خروج من الشبكة تتحكّم في النطاقات الخارجية التي يُسمح للبيئة بالوصول إليها. تحدّد كل قاعدة نطاقًا مستهدفًا، ومجموعة من عناوين HTTP التي سيتم إدخالها في كل طلب صادر مطابق، وذلك بشكل اختياري.
domain
string
نمط النطاق الذي يجب مطابقته لهذه القاعدة استخدِم اسم مضيف مطابقًا تمامًا (مثلاً، github.com) أو بادئة حرف بدل (مثلاً، *.googleapis.com) أو * لمطابقة جميع النطاقات.
transform
map (key: string, value: string)
العناوين المطلوب إدراجها في الطلبات التي تتطابق مع هذه القاعدة المفتاح: اسم العنوان (مثلاً، "Authorization"). القيمة: قيمة العنوان (مثل "Bearer your-token")
عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
| تمثيل JSON |
|---|
{ "domain": string, "transform": { string: string, ... } } |
المصدر
مصدر سيتم تركيبه في البيئة
type
enum (Type)
source
string
مصدر البيئة بالنسبة إلى GCS، هذا هو مسار GCS. بالنسبة إلى GitHub، هذا هو مسار GitHub.
target
string
المكان الذي يجب أن يظهر فيه المصدر في البيئة
content
string
المحتوى المضمّن إذا كانت قيمة type هي INLINE
encoding
string
ترميز اختياري للمحتوى المضمّن (مثل base64)
| تمثيل JSON |
|---|
{
"type": enum ( |
LocalEnvironmentConfig
لا يتضمّن هذا النوع أي حقول.
إعدادات بيئة تعمل على اتصال العميل بدلاً من وضع الحماية الذي يديره الخادم
عند ضبطها (من خلال Interaction.local_environment)، يتم التعامل مع نظام الملفات والصدفة في البرنامج على أنّهما متوفّران على الجهاز: يتم تعليق عمليات البيئة المضمّنة في البرنامج (مثل قراءة الملفات أو إدراجها أو تعديلها أو تنفيذ الأوامر) على الخادم وإعادتها إلى الجهاز لتنفيذها، مع عرض نتائجها في دورة لاحقة. يستبعد ذلك استخدام EnvironmentConfig (remoteEnvironment) يديره الخادم، لأنّ البيئة تكون إما على العميل أو في بيئة الاختبار المعزولة للخادم، وليس كليهما.
لا يتحكّم هذا الإعداد إلا في البيئة المضمّنة للوكيل. يتم دائمًا تنفيذ أدوات الدوال التي يحدّدها العميل على العميل بغض النظر عن هذا الحقل.
الأداة
أداة يمكن أن يستخدمها النموذج.
type
Union type
type إحدى القيم التالية فقط:function
object (Function)
دالة يمكن أن يستخدمها النموذج.
codeExecution
object (CodeExecution)
أداة يمكن أن يستخدمها النموذج لتنفيذ الرمز البرمجي
urlContext
object (UrlContext)
أداة يمكن أن يستخدمها النموذج لجلب سياق عنوان URL.
computerUse
object (ComputerUse)
أداة تتيح للنموذج التفاعل مباشرةً مع الكمبيوتر
mcpServer
object (McpServer)
خادم MCP هو خادم يمكن للنموذج استدعاؤه لتنفيذ إجراءات.
googleSearch
object (GoogleSearch)
أداة يمكن أن يستخدمها النموذج للبحث على Google
fileSearch
object (FileSearch)
أداة يمكن للنموذج استخدامها للبحث في الملفات
googleMaps
object (GoogleMaps)
أداة يمكن للنموذج استخدامها للبحث في "خرائط Google"
retrieval
object (Retrieval)
أداة يمكن للنموذج استخدامها لاسترداد الملفات
| تمثيل JSON |
|---|
{ // type "function": { object ( |
الوظيفة
أداة يمكن أن يستخدمها النموذج.
name
string
اسم الدالة
description
string
تمثّل هذه السمة وصفًا للدالة.
parameters
object (Value)
مخطط JSON الخاص بمعلَمات الدالة.
| تمثيل JSON |
|---|
{
"name": string,
"description": string,
"parameters": {
object ( |
UrlContext
لا يتضمّن هذا النوع أي حقول.
أداة يمكن أن يستخدمها النموذج لجلب سياق عنوان URL.
McpServer
خادم MCP هو خادم يمكن للنموذج استدعاؤه لتنفيذ إجراءات.
name
string
اسم MCPServer
url
string
عنوان URL الكامل لنقطة نهاية MCPServer مثال: "https://api.example.com/mcp"
headers
map (key: string, value: string)
اختياري: حقول لعناوين المصادقة ومهلات الانتظار وما إلى ذلك، إذا لزم الأمر
عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
allowedTools[]
object (AllowedTools)
الأدوات المسموح بها
| تمثيل JSON |
|---|
{
"name": string,
"url": string,
"headers": {
string: string,
...
},
"allowedTools": [
{
object ( |
GoogleSearch
أداة يمكن أن يستخدمها النموذج للبحث على Google
searchTypes[]
enum (SearchType)
أنواع البحث المستند إلى معلومات أساسية التي يجب تفعيلها.
| تمثيل JSON |
|---|
{
"searchTypes": [
enum ( |
FileSearch
أداة يمكن للنموذج استخدامها للبحث في الملفات
fileSearchStoreNames[]
string
أسماء متاجر البحث عن الملفات
topK
integer
عدد أجزاء الاسترجاع الدلالي المطلوب استرجاعها.
metadataFilter
string
فلتر البيانات الوصفية الذي سيتم تطبيقه على المستندات والأجزاء التي يتم استرجاعها دلاليًا.
| تمثيل JSON |
|---|
{ "fileSearchStoreNames": [ string ], "topK": integer, "metadataFilter": string } |
GoogleMaps
أداة يمكن أن يستخدمها النموذج للاتصال بخدمة "خرائط Google"
enableWidget
boolean
تحديد ما إذا كان سيتم عرض رمز مميّز لسياق التطبيق المصغّر في نتيجة استدعاء الأداة ضمن الردّ.
latitude
number
تمثّل هذه السمة خط العرض للموقع الجغرافي للمستخدم.
longitude
number
تمثّل هذه السمة خط الطول للموقع الجغرافي للمستخدم.
| تمثيل JSON |
|---|
{ "enableWidget": boolean, "latitude": number, "longitude": number } |
الاستخدام
إحصاءات حول استخدام الرمز المميز لطلب التفاعل.
totalInputTokens
integer
عدد الرموز المميزة في الطلب (السياق).
inputTokensByModality[]
object (ModalityTokens)
تفصيل لاستخدام الرموز المميزة للإدخال حسب نوع البيانات
totalCachedTokens
integer
عدد الرموز المميّزة في الجزء المخزّن مؤقتًا من الطلب (المحتوى المخزّن مؤقتًا)
cachedTokensByModality[]
object (ModalityTokens)
تفاصيل استخدام الرمز المميز المخزّن مؤقتًا حسب طريقة الدفع
totalOutputTokens
integer
إجمالي عدد الرموز المميزة في جميع الردود التي تم إنشاؤها
outputTokensByModality[]
object (ModalityTokens)
تفاصيل استخدام الرموز المميزة للناتج حسب طريقة العرض
totalToolUseTokens
integer
عدد الرموز المميزة المتوفّرة في طلبات استخدام الأدوات
toolUseTokensByModality[]
object (ModalityTokens)
تفصيل لاستخدام الرموز المميزة الخاصة باستخدام الأدوات حسب نوع البيانات
totalThoughtTokens
integer
عدد الرموز المميّزة للأفكار في نماذج التفكير
totalTokens
integer
إجمالي عدد الرموز المميّزة لطلب التفاعل (الطلب + الردود + الرموز المميّزة الداخلية الأخرى)
groundingToolCount[]
object (GroundingToolCount)
عدد أدوات التأسيس
| تمثيل JSON |
|---|
{ "totalInputTokens": integer, "inputTokensByModality": [ { object ( |
ModalityTokens
عدد الرموز المميزة لنمط استجابة واحد
modality
enum (ResponseModality)
الوسيط المرتبط بعدد الرموز المميزة.
tokens
integer
عدد الرموز المميّزة للوسائط
| تمثيل JSON |
|---|
{
"modality": enum ( |
GroundingToolCount
عدد أدوات التأريض.
type
enum (Type)
نوع أداة التأسيس المرتبطة بالعدد
count
integer
عدد أدوات التأريض.
| تمثيل JSON |
|---|
{
"type": enum ( |
WebhookConfig
رسالة لإعداد أحداث الويب هوك لطلب معيّن
uris[]
string
اختياريّ. في حال ضبطها، سيتم استخدام معرّفات الموارد المنتظمة (URI) الخاصة بخطافات الويب هذه لأحداث خطافات الويب بدلاً من خطافات الويب المسجّلة.
userMetadata
object (Struct format)
اختياريّ. بيانات المستخدم الوصفية التي سيتم عرضها عند كل عملية إرسال حدث إلى خطافات الويب.
| تمثيل JSON |
|---|
{ "uris": [ string ], "userMetadata": { object } } |
SafetySetting
إعداد أمان يؤثر في سلوك الحظر المتعلق بالأمان
يتألف [SafetySetting][google.cloud.aiplatform.master.SafetySetting] من [فئة][google.cloud.aiplatform.master.SafetySetting.category] ضرر و[حدّ][google.cloud.aiplatform.master.SafetySetting.threshold] لتلك الفئة.
type
enum (HarmCategory)
الحقل مطلوب. نوع فئة المحتوى الضار المطلوب حظره.
threshold
enum (HarmBlockThreshold)
الحقل مطلوب. الحدّ الأدنى لحظر المحتوى إذا تجاوز احتمال الضرر هذا الحد، سيتم حظر المحتوى.
method
enum (HarmBlockMethod)
اختياريّ. طريقة حظر المحتوى في حال عدم تحديدها، يكون السلوك التلقائي هو استخدام نتيجة الاحتمالية.
| تمثيل JSON |
|---|
{ "type": enum ( |
إرسال المحتوى
وضع عرض الإعلانات لإخراج الصوت
| عمليات التعداد | |
|---|---|
DELIVERY_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
INLINE |
يتم عرض بيانات الصوت بشكل مضمّن في الردّ. |
URI |
يتم عرض البيانات الصوتية كمعرّف موارد موحّد (URI). |
البيئة
تمثّل هذه السمة البيئة التي يتم تشغيلها، مثل متصفّح الويب.
| عمليات التعداد | |
|---|---|
ENVIRONMENT_UNSPECIFIED |
القيمة التلقائية هي "المتصفّح". |
BROWSER |
يعمل في متصفّح ويب. |
MOBILE |
تعمل في بيئة الأجهزة الجوّالة. |
DESKTOP |
تعمل في بيئة كمبيوتر مكتبي. |
HarmBlockMethod
طريقة حظر المحتوى
| عمليات التعداد | |
|---|---|
HARM_BLOCK_METHOD_UNSPECIFIED |
لم يتم تحديد طريقة حظر المحتوى الضار. |
SEVERITY |
تستخدم طريقة الحظر بسبب الضرر كلاً من نتائج الاحتمالية والخطورة. |
PROBABILITY |
تستخدِم طريقة الحظر بسبب الضرر نتيجة الاحتمالية. |
HarmBlockThreshold
عتبات حظر المحتوى استنادًا إلى احتمال الضرر
| عمليات التعداد | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
لم يتم تحديد الحدّ الأدنى للحظر بسبب الضرر. |
BLOCK_LOW_AND_ABOVE |
حظر المحتوى الذي تبلغ احتمالية ضرره منخفضة أو أعلى |
BLOCK_MEDIUM_AND_ABOVE |
حظر المحتوى الذي تبلغ احتمالية الضرر فيه متوسطة أو أعلى |
BLOCK_ONLY_HIGH |
حظر المحتوى الذي يرجّح أن يتسبّب بضرر كبير |
BLOCK_NONE |
عدم حظر أي محتوى، بغض النظر عن احتمال ضرره |
OFF |
إيقاف فلتر الأمان بالكامل |
ImageSize
أحجام الصور المتوافقة لإخراج الصور
| عمليات التعداد | |
|---|---|
IMAGE_SIZE_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
IMAGE_SIZE_FIVE_TWELVE |
حجم الصورة 512 بكسل |
IMAGE_SIZE_ONE_K |
حجم الصورة 1K |
IMAGE_SIZE_TWO_K |
حجم الصورة 2K |
IMAGE_SIZE_FOUR_K |
حجم الصورة بدقة 4K |
اللغة
لغات البرمجة المتوافقة مع الرمز البرمجي الذي تم إنشاؤه
| عمليات التعداد | |
|---|---|
LANGUAGE_UNSPECIFIED |
لغة غير محدّدة يجب عدم استخدام هذه القيمة. |
PYTHON |
الإصدار 3.10 من Python أو إصدار أحدث، مع توفُّر numpy وsimpy |
MediaResolution
درجة دقة الوسائط التي يتم إدخالها (الصور/الفيديو)
| عمليات التعداد | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
LOW |
درجة الدقة منخفضة. |
MEDIUM |
دقة متوسطة |
HIGH |
دقة عالية |
ULTRA_HIGH |
دقة فائقة |
MimeType
| عمليات التعداد | |
|---|---|
TYPE_UNSPECIFIED |
|
TYPE_WAV |
تنسيق الصوت WAV |
TYPE_MP3 |
تنسيق الصوت MP3 |
TYPE_AIFF |
تنسيق الصوت AIFF |
TYPE_AAC |
تنسيق الصوت AAC |
TYPE_OGG |
تنسيق الصوت OGG |
TYPE_FLAC |
تنسيق الصوت FLAC |
TYPE_MPEG |
تنسيق الصوت MPEG |
TYPE_M4A |
تنسيق الصوت M4A |
TYPE_L16 |
تنسيق الصوت L16 |
TYPE_OPUS |
تنسيق الصوت OPUS |
TYPE_ALAW |
تنسيق الصوت ALAW |
TYPE_MULAW |
تنسيق الصوت MULAW |
الوضع
تحدّد هذه السمة عمق جلسة البحث ومدى شموليتها.
| عمليات التعداد | |
|---|---|
MODE_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
MODE_SCAN |
فحص سريع باستخدام أداة التصنيف الأولية فقط |
MODE_VERIFY |
يتم إجراء التصنيف ثم التحقيق المفصّل. |
NetworkMode
وضع خروج الشبكة لإعدادات غير تلك المُضافة إلى القائمة المسموح بها
| عمليات التعداد | |
|---|---|
NETWORK_MODE_UNSPECIFIED |
القيمة التلقائية غير مستخدَمة |
DISABLED |
يتم حظر جميع عمليات الخروج من الشبكة. |
ResponseModality
تمثّل هذه السمة طريقة عرض الردّ.
| عمليات التعداد | |
|---|---|
RESPONSE_MODALITY_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
TEXT |
تشير إلى أنّ النموذج يجب أن يعرض نصًا. |
IMAGE |
تشير إلى أنّ النموذج يجب أن يعرض صورًا. |
AUDIO |
تشير إلى أنّ النموذج يجب أن يعرض صوتًا. |
VIDEO |
تشير إلى أنّ النموذج يجب أن يعرض فيديو. |
DOCUMENT |
تشير إلى أنّ النموذج يجب أن يعرض المستندات. |
ReviewSnippet
تتضمّن مقتطفًا من مراجعة مستخدم تجيب عن سؤال حول ميزات مكان معيّن في "خرائط Google".
title
string
تمثّل هذه السمة عنوان المراجعة.
url
string
رابط يتوافق مع مراجعة المستخدم على "خرائط Google".
reviewId
string
رقم تعريف مقتطف من المراجعة.
| تمثيل JSON |
|---|
{ "title": string, "url": string, "reviewId": string } |
SafetyPolicy
| عمليات التعداد | |
|---|---|
SAFETY_POLICY_UNSPECIFIED |
سياسة أمان غير محدّدة |
FINANCIAL_TRANSACTIONS |
سياسة الأمان للمعاملات المالية |
SENSITIVE_DATA_MODIFICATION |
سياسة الأمان لتعديل البيانات الحسّاسة |
COMMUNICATION_TOOL |
سياسة الأمان لأدوات التواصل (مثل Gmail وChat وMeet) |
ACCOUNT_CREATION |
سياسة السلامة المتعلّقة بإنشاء الحسابات |
DATA_MODIFICATION |
سياسة الأمان لتعديل البيانات |
USER_CONSENT_MANAGEMENT |
سياسة الأمان المتعلّقة بإدارة موافقة المستخدم |
LEGAL_TERMS_AND_AGREEMENTS |
سياسة الأمان للأحكام والاتفاقيات القانونية |
المخطط
يسمح العنصر Schema بتحديد أنواع بيانات الإدخال والإخراج. يمكن أن تكون هذه الأنواع كائنات، ولكن أيضًا أنواعًا أولية ومصفوفات. يمثّل هذا النوع مجموعة فرعية محدّدة من كائن مخطط OpenAPI 3.0.
type
enum (Type)
الحقل مطلوب. نوع البيانات
format
string
اختياريّ. تنسيق البيانات يُسمح بأي قيمة، ولكنّ معظمها لا يؤدي إلى تشغيل أي وظائف خاصة.
title
string
اختياريّ. تمثّل هذه السمة عنوان المخطط.
description
string
اختياريّ. وصف موجز للمَعلمة يمكن أن يحتوي ذلك على أمثلة على الاستخدام. قد يتم تنسيق وصف المَعلمة على شكل Markdown.
nullable
boolean
اختياريّ. تشير إلى ما إذا كان يمكن أن تكون القيمة فارغة.
enum[]
string
اختياريّ. القيم المحتملة لعنصر Type.STRING بتنسيق enum. على سبيل المثال، يمكننا تحديد تعداد Direction على النحو التالي : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
maxItems
string (int64 format)
اختياريّ. الحدّ الأقصى لعدد العناصر في Type.ARRAY
minItems
string (int64 format)
اختياريّ. الحد الأدنى لعدد العناصر في Type.ARRAY
properties
map (key: string, value: object (Schema))
اختياريّ. خصائص Type.OBJECT
عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]
string
اختياريّ. السمات المطلوبة من النوع Type.OBJECT
minProperties
string (int64 format)
اختياريّ. الحدّ الأدنى لعدد السمات الخاصة بـ Type.OBJECT
maxProperties
string (int64 format)
اختياريّ. الحدّ الأقصى لعدد الخصائص الخاصة بـ Type.OBJECT
minLength
string (int64 format)
اختياريّ. حقول المخطط لنوع STRING الحدّ الأدنى لطول Type.STRING
maxLength
string (int64 format)
اختياريّ. الحد الأقصى لطول Type.STRING
pattern
string
اختياريّ. نمط Type.STRING لحصر سلسلة بتعبير عادي
example
value (Value format)
اختياريّ. مثال على العنصر لن تتم تعبئة هذا الحقل إلا عندما يكون العنصر هو العنصر الجذر.
anyOf[]
object (Schema)
اختياريّ. يجب التحقّق من صحة القيمة مقارنةً بأي من المخططات الفرعية (واحد أو أكثر) في القائمة.
propertyOrdering[]
string
اختياريّ. ترتيب السمات ليس حقلاً عاديًا في مواصفات Open API، ويُستخدم لتحديد ترتيب السمات في الاستجابة.
default
value (Value format)
اختياريّ. القيمة التلقائية للحقل وفقًا لمخطط JSON، هذا الحقل مخصّص لمنشئي المستندات ولا يؤثّر في عملية التحقّق. لذلك، يتم تضمينه هنا وتجاهله حتى لا يتلقّى المطوّرون الذين يرسلون المخططات مع الحقل default أخطاء حقل غير معروف.
items
object (Schema)
اختياريّ. مخطط عناصر Type.ARRAY
minimum
number
اختياريّ. حقول المخطط من النوع INTEGER وNUMBER الحدّ الأدنى لقيمة النوع INTEGER وNUMBER
maximum
number
اختياريّ. الحدّ الأقصى لقيمة Type.INTEGER وType.NUMBER
| تمثيل JSON |
|---|
{ "type": enum ( |
النوع
يحتوي النوع على قائمة بأنواع بيانات OpenAPI كما هو محدّد في https://spec.openapis.org/oas/v3.0.3#data-types
| عمليات التعداد | |
|---|---|
TYPE_UNSPECIFIED |
لم يتم تحديدها، ويجب عدم استخدامها. |
STRING |
نوع السلسلة |
NUMBER |
نوع الرقم |
INTEGER |
نوع العدد الصحيح |
BOOLEAN |
النوع المنطقي |
ARRAY |
نوع المصفوفة |
OBJECT |
نوع العنصر |
NULL |
نوع القيمة الخالية |
نوع البحث
أنواع البحث المستند إلى معلومات أساسية التي يجب تفعيلها.
| عمليات التعداد | |
|---|---|
SEARCH_TYPE_UNSPECIFIED |
نوع البحث غير محدَّد. يجب عدم استخدام هذه القيمة. |
SEARCH_TYPE_WEB_SEARCH |
يؤدي ضبط هذا الحقل إلى تفعيل البحث على الويب. يتم عرض النتائج النصية فقط. |
SEARCH_TYPE_IMAGE_SEARCH |
يؤدي ضبط هذا الحقل إلى تفعيل البحث بالصور. يتم عرض وحدات بايت الصورة. |
بنية
يمثّل Struct قيمة بيانات منظَّمة تتألف من حقول يتم ربطها بقيم ذات أنواع ديناميكية.
fields[]
object (Field)
حقول ذات أنواع ديناميكية قائمة بدلاً من خريطة لأنّ النماذج اللغوية الكبيرة حساسة للترتيب، ونريد أن نمنح المستخدمين إمكانية التحكّم الكامل.
| تمثيل JSON |
|---|
{
"fields": [
{
object ( |
الحقل
المهمة
مهام إنشاء الفيديو المتوافقة
| عمليات التعداد | |
|---|---|
TASK_UNSPECIFIED |
مهمة غير محدّدة يتم استنتاج المهمة من طلب الإدخال والوسائط. |
TEXT_TO_VIDEO |
ينشئ فيديوهات استنادًا إلى طلب نصي فقط. |
IMAGE_TO_VIDEO |
ينشئ فيديوهات من صورة مصدر واحدة أو اثنتين. تحدّد الصورة الأولى الإطار الأوّلي، وتحدّد الصورة الثانية الاختيارية الإطار النهائي. |
REFERENCE_TO_VIDEO |
تُنشئ فيديوهات باستخدام وسائط مرجعية (مثل الصور أو الصوت أو الفيديو). |
EDIT |
تعدّل هذه الطريقة فيديو إدخال حاليًا. |
ThinkingLevel
مستوى الرموز المميزة للأفكار التي يجب أن ينشئها النموذج
| عمليات التعداد | |
|---|---|
THINKING_LEVEL_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
THINKING_LEVEL_MINIMAL |
لا يتطلّب الأمر تفكيرًا كبيرًا. |
THINKING_LEVEL_LOW |
مستوى التفكير منخفض. |
THINKING_LEVEL_MEDIUM |
مستوى التفكير المتوسط |
THINKING_LEVEL_HIGH |
مستوى التفكير العالي |
ThinkingSummaries
تحديد ما إذا كان سيتم تضمين ملخّصات الأفكار في الردّ.
| عمليات التعداد | |
|---|---|
THINKING_SUMMARIES_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
THINKING_SUMMARIES_AUTO |
ملخّصات التفكير التلقائي |
THINKING_SUMMARIES_NONE |
لا تتوفّر ملخّصات التفكير. |
الأداة
- تمثيل JSON
- FunctionDeclaration
- السلوك
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- الوضع
- CodeExecution
- GoogleSearch
- الفاصل الزمني
- SearchTypes
- WebSearch
- ImageSearch
- ComputerUse
- البيئة
- SafetyPolicy
- UrlContext
- FileSearch
- McpServer
- StreamableHttpTransport
- GoogleMaps
تفاصيل الأداة التي قد يستخدمها النموذج لإنشاء الرد
Tool هي جزء من الرمز البرمجي يتيح للنظام التفاعل مع أنظمة خارجية لتنفيذ إجراء أو مجموعة من الإجراءات خارج نطاق معرفة النموذج.
المعرّف التالي: 16
functionDeclarations[]
object (FunctionDeclaration)
اختياريّ. قائمة FunctionDeclarations متاحة للنموذج ويمكن استخدامها في استدعاء الدوال.
لا ينفّذ النموذج أو النظام الوظيفة. بدلاً من ذلك، قد يتم عرض الدالة المحدّدة كـ FunctionCall مع وسيطات من جهة العميل لتنفيذها. قد يقرّر النموذج استدعاء مجموعة فرعية من هذه الدوال عن طريق ملء FunctionCall في الردّ. قد تتضمّن نوبة المحادثة التالية FunctionResponse مع سياق إنشاء Content.role "الوظيفة" لنوبة النموذج التالية.
googleSearchRetrieval
object (GoogleSearchRetrieval)
اختياريّ. أداة استرجاع مدعومة من "بحث Google"
codeExecution
object (CodeExecution)
اختياريّ. تتيح هذه السمة للنموذج تنفيذ الرمز البرمجي كجزء من عملية الإنشاء.
googleSearch
object (GoogleSearch)
اختياريّ. نوع أداة GoogleSearch أداة لدعم "بحث Google" في Model من Google
computerUse
object (ComputerUse)
اختياريّ. أداة تتيح للنموذج التفاعل مباشرةً مع الكمبيوتر في حال تفعيل هذا الخيار، يتم تلقائيًا ملء "تعريفات الدوال" الخاصة باستخدام الكمبيوتر.
urlContext
object (UrlContext)
اختياريّ. أداة للمساعدة في استرداد سياق عنوان URL
fileSearch
object (FileSearch)
اختياريّ. نوع أداة FileSearch أداة لاسترداد المعلومات من مجموعات Semantic Retrieval.
mcpServers[]
object (McpServer)
اختياريّ. خوادم MCP التي سيتم الربط بها
googleMaps
object (GoogleMaps)
اختياريّ. أداة تتيح ربط ردّ النموذج بالسياق الجغرافي المكاني المرتبط بطلب المستخدم
| تمثيل JSON |
|---|
{ "functionDeclarations": [ { object ( |
FunctionDeclaration
تمثيل منظَّم لتعريف دالة كما هو محدَّد في مواصفات OpenAPI 3.03. يتضمّن هذا التعريف اسم الدالة ومعلَماتها. تمثّل FunctionDeclaration مجموعة من الرموز البرمجية التي يمكن استخدامها كـ Tool من قِبل النموذج وتنفيذها من قِبل العميل.
name
string
الحقل مطلوب. اسم الدالة يجب أن يتضمّن أحرفًا من a إلى z أو من A إلى Z أو من 0 إلى 9، أو أن يحتوي على شرطات سفلية ونقطتين رأسيتين ونقاط وشرطات، وبحد أقصى 128 حرفًا.
description
string
الحقل مطلوب. وصف موجز للدالة
behavior
enum (Behavior)
اختياريّ. تحدّد هذه السمة سلوك الدالة. لا تتوافق هذه السمة حاليًا إلا مع الطريقة BidiGenerateContent.
parameters
object (Schema)
اختياريّ. تصف هذه السمة المَعلمات الخاصة بهذه الدالة. تعكس هذه السمة مفتاح السلسلة "عنصر المَعلمة" في Open API 3.03: اسم المَعلمة. أسماء المَعلمات حسّاسة لحالة الأحرف. قيمة المخطط: المخطط الذي يحدّد النوع المستخدَم للمَعلمة.
parametersJsonSchema
value (Value format)
اختياريّ. تصف هذه السمة المَعلمات الخاصة بالدالة بتنسيق JSON Schema. يجب أن يصف المخطط كائنًا تكون خصائصه هي مَعلمات الدالة. على سبيل المثال:
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"additionalProperties": false,
"required": ["name", "age"],
"propertyOrdering": ["name", "age"]
}
لا يمكن استخدام هذا الحقل مع parameters.
response
object (Schema)
اختياريّ. تصف هذه السمة الناتج من هذه الدالة بتنسيق JSON Schema. تعكس هذه السمة "عنصر الرد" في Open API 3.03. يحدّد المخطط نوع القيمة المستخدَمة في قيمة استجابة الدالة.
responseJsonSchema
value (Value format)
اختياريّ. تصف هذه السمة الناتج من هذه الدالة بتنسيق JSON Schema. القيمة المحدّدة بواسطة المخطط هي قيمة استجابة الدالة.
لا يمكن استخدام هذا الحقل مع response.
السلوك
تحدّد هذه السمة سلوك الدالة. القيمة التلقائية هي BLOCKING.
| عمليات التعداد | |
|---|---|
UNSPECIFIED |
هذه القيمة غير مستخدَمة. |
BLOCKING |
في حال ضبط هذا الخيار، سينتظر النظام تلقّي ردّ الدالة قبل مواصلة المحادثة. |
NON_BLOCKING |
في حال ضبطها، لن ينتظر النظام تلقّي استجابة الدالة. بدلاً من ذلك، سيحاول التعامل مع ردود الوظائف فور توفّرها مع الحفاظ على المحادثة بين المستخدم والنموذج. |
GoogleSearchRetrieval
أداة لاسترداد بيانات الويب العامة من أجل التأسيس، وهي من تطوير Google.
dynamicRetrievalConfig
object (DynamicRetrievalConfig)
تحدّد هذه السمة إعدادات الاسترجاع الديناميكي للمصدر المحدّد.
| تمثيل JSON |
|---|
{
"dynamicRetrievalConfig": {
object ( |
DynamicRetrievalConfig
توضّح هذه السمة خيارات تخصيص الاسترجاع الديناميكي.
mode
enum (Mode)
وضع أداة التوقّع التي سيتم استخدامها في الاسترجاع الديناميكي.
dynamicThreshold
number
الحدّ المستخدَم في الاسترجاع الديناميكي. في حال عدم ضبط هذه السياسة، يتم استخدام قيمة تلقائية للنظام.
| تمثيل JSON |
|---|
{
"mode": enum ( |
الوضع
وضع أداة التوقّع التي سيتم استخدامها في الاسترجاع الديناميكي.
| عمليات التعداد | |
|---|---|
MODE_UNSPECIFIED |
يجب دائمًا بدء عملية الاسترداد. |
MODE_DYNAMIC |
لا يتم تنفيذ عملية الاسترجاع إلا عندما يقرّر النظام أنّها ضرورية. |
CodeExecution
لا يتضمّن هذا النوع أي حقول.
أداة تنفّذ الرمز الذي ينشئه النموذج وتعرض النتيجة تلقائيًا.
يمكنك أيضًا الاطّلاع على ExecutableCode وCodeExecutionResult اللذين يتم إنشاؤهما فقط عند استخدام هذه الأداة.
GoogleSearch
نوع أداة GoogleSearch أداة لدعم "بحث Google" في Model من Google
timeRangeFilter
object (Interval)
اختياريّ. فلترة نتائج البحث لتظهر ضمن نطاق زمني محدّد إذا حدّد العملاء وقت بدء، عليهم تحديد وقت انتهاء (والعكس صحيح).
searchTypes
object (SearchTypes)
اختياريّ. مجموعة أنواع البحث التي سيتم تفعيلها. في حال عدم ضبط هذه السياسة، يتم تفعيل "بحث الويب" تلقائيًا.
| تمثيل JSON |
|---|
{ "timeRangeFilter": { object ( |
الفاصل الزمني
يمثّل فاصلاً زمنيًا محدّدًا يتم ترميزه بطابع زمني للبداية (مشمولة) وطابع زمني للنهاية (غير مشمولة).
يجب أن تكون البداية مساوية أو أقدم من النهاية. إذا كانت البداية مساوية للنهاية، يكون الفاصل فارغًا (أي لا يطابق أي وقت). وإذا لم يتم تحديد البداية والنهاية، يطابق الفاصل أي وقت.
startTime
string (Timestamp format)
اختياريّ. يمثّل بداية الفاصل الزمني (مشمولة).
إذا تم تحديد هذا الحقل، يجب أن يكون أي طابع زمني يطابق هذا الفاصل مساويًا أو لاحقًا لوقت البداية.
يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".
endTime
string (Timestamp format)
اختياري. يمثّل نهاية الفاصل الزمني (غير مشمولة).
إذا تم تحديد هذا الحقل، يجب أن يكون أي طابع زمني يطابق هذا الفاصل قبل وقت النهاية.
يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".
| تمثيل JSON |
|---|
{ "startTime": string, "endTime": string } |
SearchTypes
أنواع مختلفة من البحث يمكن تفعيلها على أداة GoogleSearch
webSearch
object (WebSearch)
اختياريّ. تتيح هذه السمة البحث على الويب. يتم عرض النتائج النصية فقط.
imageSearch
object (ImageSearch)
اختياريّ. تفعيل ميزة البحث بالصور يتم عرض وحدات بايت الصورة.
| تمثيل JSON |
|---|
{ "webSearch": { object ( |
WebSearch
لا يتضمّن هذا النوع أي حقول.
بحث الويب العادي لتحديد المعلومات الأساسية والإعدادات ذات الصلة
ImageSearch
لا يتضمّن هذا النوع أي حقول.
البحث عن الصور لتحديد المعلومات الأساسية والإعدادات ذات الصلة
ComputerUse
نوع أداة استخدام الكمبيوتر
environment
enum (Environment)
الحقل مطلوب. البيئة التي يتم تشغيلها
excludedPredefinedFunctions[]
string
اختياريّ. يتم تضمين الدوال المحدّدة مسبقًا في طلب النموذج النهائي تلقائيًا. يمكن استبعاد بعضها بشكل صريح من تضمينها تلقائيًا. يمكن أن يخدم ذلك غرضَين: 1. استخدام مساحة إجراءات أكثر تقييدًا أو مختلفة 2. تحسين تعريفات / تعليمات الدوال المحدّدة مسبقًا
enablePromptInjectionDetection
boolean
اختياريّ. تحديد ما إذا كان سيتم تفعيل عملية التحقّق من رصد هجمات حقن الطلبات على طلب استخدام الكمبيوتر
disabledSafetyPolicies[]
enum (SafetyPolicy)
اختياريّ. تم إيقاف سياسات الأمان المتعلقة باستخدام الكمبيوتر.
| تمثيل JSON |
|---|
{ "environment": enum ( |
البيئة
تمثّل هذه السمة البيئة التي يتم تشغيلها، مثل متصفّح الويب.
| عمليات التعداد | |
|---|---|
ENVIRONMENT_UNSPECIFIED |
القيمة التلقائية هي "المتصفّح". |
ENVIRONMENT_BROWSER |
يعمل في متصفّح ويب. |
ENVIRONMENT_MOBILE |
تعمل في بيئة الأجهزة الجوّالة. |
ENVIRONMENT_DESKTOP |
تعمل في بيئة كمبيوتر مكتبي. |
SafetyPolicy
سياسات السلامة المحدّدة مسبقًا لاستخدام الكمبيوتر
| عمليات التعداد | |
|---|---|
SAFETY_POLICY_UNSPECIFIED |
سياسة أمان غير محدّدة |
FINANCIAL_TRANSACTIONS |
سياسة الأمان للمعاملات المالية |
SENSITIVE_DATA_MODIFICATION |
سياسة الأمان لتعديل البيانات الحسّاسة |
COMMUNICATION_TOOL |
سياسة الأمان لأدوات التواصل (مثل Gmail وChat وMeet) |
ACCOUNT_CREATION |
سياسة السلامة المتعلّقة بإنشاء الحسابات |
DATA_MODIFICATION |
سياسة الأمان لتعديل البيانات |
USER_CONSENT_MANAGEMENT |
سياسة الأمان المتعلّقة بإدارة موافقة المستخدم |
LEGAL_TERMS_AND_AGREEMENTS |
سياسة الأمان للأحكام والاتفاقيات القانونية |
UrlContext
لا يتضمّن هذا النوع أي حقول.
أداة للمساعدة في استرداد سياق عنوان URL
FileSearch
أداة FileSearch التي تسترجع المعرفة من مجموعات Semantic Retrieval. يتم استيراد الملفات إلى مجموعات Semantic Retrieval باستخدام ImportFile API.
fileSearchStoreNames[]
string
الحقل مطلوب. أسماء fileSearchStores التي سيتم استردادها. مثلاً: fileSearchStores/my-file-search-store-123
metadataFilter
string
اختياريّ. فلتر البيانات الوصفية الذي سيتم تطبيقه على المستندات والأجزاء التي يتم استرجاعها دلاليًا.
topK
integer
اختياريّ. عدد أجزاء الاسترجاع الدلالي المطلوب استرجاعها.
| تمثيل JSON |
|---|
{ "fileSearchStoreNames": [ string ], "metadataFilter": string, "topK": integer } |
McpServer
خادم MCP هو خادم يمكن للنموذج استدعاؤه لتنفيذ إجراءات. وهو خادم ينفّذ بروتوكول MCP. رقم التعريف التالي: 6
name
string
اسم MCPServer
transport
Union type
transport إحدى القيم التالية فقط:streamableHttpTransport
object (StreamableHttpTransport)
نظام نقل يمكنه بث طلبات واستجابات HTTP.
| تمثيل JSON |
|---|
{
"name": string,
// transport
"streamableHttpTransport": {
object ( |
StreamableHttpTransport
نظام نقل يمكنه بث طلبات واستجابات HTTP. رقم التعريف التالي: 6
url
string
عنوان URL الكامل لنقطة نهاية MCPServer مثال: "https://api.example.com/mcp"
headers
map (key: string, value: string)
اختياري: حقول لعناوين المصادقة ومهلات الانتظار وما إلى ذلك، إذا لزم الأمر
عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
timeout
string (Duration format)
مهلة HTTP للعمليات العادية
مدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ "s". مثال: "3.5s".
sseReadTimeout
string (Duration format)
مهلة عمليات القراءة في SSE
مدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ "s". مثال: "3.5s".
terminateOnClose
boolean
تحديد ما إذا كان سيتم إغلاق جلسة العميل عند إغلاق النقل
| تمثيل JSON |
|---|
{ "url": string, "headers": { string: string, ... }, "timeout": string, "sseReadTimeout": string, "terminateOnClose": boolean } |
GoogleMaps
أداة GoogleMaps التي توفّر سياقًا جغرافيًا مكانيًا لطلب بحث المستخدم.
enableWidget
boolean
اختياريّ. تحديد ما إذا كان سيتم عرض رمز مميّز لسياق الأداة في GroundingMetadata الخاص بالردّ. يمكن للمطوّرين استخدام رمز مميّز سياقي للأداة لعرض تطبيق مصغّر لـ "خرائط Google" يتضمّن سياقًا جغرافيًا مكانيًا مرتبطًا بالأماكن التي يشير إليها النموذج في الردّ.
| تمثيل JSON |
|---|
{ "enableWidget": boolean } |
ToolChoiceType
نوع اختيار الأداة
| عمليات التعداد | |
|---|---|
TOOL_CHOICE_TYPE_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
AUTO |
اختيار الأداة المتكيِّف |
ANY |
أي أداة تختارها |
NONE |
لم يتم اختيار أي أداة. |
VALIDATED |
اختيار أداة تم التحقّق من صحتها |
القيمة
يمثّل Value قيمة ذات نوع ديناميكي يمكن أن تكون فارغة أو رقمًا أو سلسلة أو قيمة منطقية أو قيمة بنية تكرارية أو قائمة قيم. من المتوقّع أن يضبط منتج القيمة أحد هذه الخيارات. يشير عدم توفّر أي خيار منتج إلى حدوث خطأ.
kind
Union type
kind إحدى القيم التالية فقط:nullValue
null
تمثّل قيمة فارغة.
numberValue
number
تمثّل قيمة مزدوجة.
stringValue
string
تمثّل قيمة سلسلة.
boolValue
boolean
تمثّل قيمة منطقية.
structValue
object (Struct)
تمثّل قيمة منظَّمة.
listValue
object (ListValue)
تمثّل هذه السمة Value متكرّرة.
contentValue
object (Content)
يمثّل المحتوى الوافٍ (النص والصورة وما إلى ذلك).
ListValue
VisualizationMode
تعداد لوضع العرض المرئي. سنوفّر في النهاية وضعًا تفاعليًا يمكن للمستخدم من خلاله اختيار ما إذا كان يريد تضمين المحتوى المرئي بتنسيق HTML في الردّ.
| عمليات التعداد | |
|---|---|
UNSPECIFIED |
وضع العرض المرئي التلقائي سيتم ضبطها تلقائيًا على AUTO. |
OFF |
لا تضمِّن تصورات. |
AUTO |
تضمين التصورات تلقائيًا |
مورد REST: auth_tokens
- المورد: AuthToken
- BidiGenerateContentSetup
- GenerationConfig
- نمط البيانات
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- ThinkingLevel
- ImageConfig
- MediaResolution
- ResponseFormatConfig
- TextResponseFormat
- MimeType
- AudioResponseFormat
- MimeType
- التسليم
- ImageResponseFormat
- MimeType
- التسليم
- AspectRatio
- ImageSize
- TranslationConfig
- RealtimeInputConfig
- AutomaticActivityDetection
- StartSensitivity
- EndSensitivity
- ActivityHandling
- TurnCoverage
- SessionResumptionConfig
- ContextWindowCompressionConfig
- SlidingWindow
- AudioTranscriptionConfig
- LanguageAuto
- LanguageHints
- HistoryConfig
- الطُرق
المورد: AuthToken
طلب لإنشاء رمز مميّز مؤقت للمصادقة
name
string
النتائج فقط. المعرّف. الرمز المميّز نفسه
expireTime
string (Timestamp format)
اختياريّ. الإدخال فقط غير قابل للتغيير وقت اختياري يتم بعده رفض الرسائل في جلسات BidiGenerateContent عند استخدام الرمز المميّز الناتج. (قد يغلق Gemini الجلسة بشكل استباقي بعد هذا الوقت).
إذا لم يتم ضبط هذا الخيار، سيتم تلقائيًا ضبطه على 30 دقيقة في المستقبل. في حال ضبط هذا الحقل، يجب أن تكون القيمة أقل من 20 ساعة في المستقبل.
يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".
newSessionExpireTime
string (Timestamp format)
اختياريّ. الإدخال فقط غير قابل للتغيير الوقت الذي سيتم بعده رفض جلسات Live API الجديدة التي تستخدم الرمز المميز الناتج من هذا الطلب
إذا لم يتم ضبط هذا الحقل، سيتم ضبطه تلقائيًا على 60 ثانية في المستقبل. في حال ضبط هذا الحقل، يجب أن تكون القيمة أقل من 20 ساعة في المستقبل.
يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".
fieldMask
string (FieldMask format)
اختياريّ. الإدخال فقط غير قابل للتغيير إذا كان fieldMask فارغًا، ولم يكن bidiGenerateContentSetup متوفّرًا، سيتم استرداد رسالة BidiGenerateContentSetup الفعّالة من اتصال Live API.
إذا كان fieldMask فارغًا، وكان bidiGenerateContentSetup موجودًا، سيتم أخذ رسالة BidiGenerateContentSetup الفعّالة بالكامل من bidiGenerateContentSetup في هذا الطلب. يتم تجاهل رسالة الإعداد من عملية الربط المباشر بواجهة برمجة التطبيقات.
إذا لم يكن fieldMask فارغًا، ستؤدي الحقول المطابقة من bidiGenerateContentSetup إلى الكتابة فوق الحقول من رسالة الإعداد في عملية الربط بواجهة برمجة التطبيقات المباشرة.
هذه قائمة قيم مفصولة بفاصلة تتضمّن الأسماء المؤهَّلة بالكامل للحقول. مثال: "user.displayName,photo"
config
Union type
config إحدى القيم التالية فقط:bidiGenerateContentSetup
object (BidiGenerateContentSetup)
اختياريّ. الإدخال فقط غير قابل للتغيير إعدادات خاصة بـ BidiGenerateContent
uses
integer
اختياريّ. الإدخال فقط غير قابل للتغيير عدد المرات التي يمكن فيها استخدام الرمز المميز إذا كانت هذه القيمة صفرًا، لن يتم تطبيق أي حدّ. لا يُحتسب استئناف جلسة Live API كاستخدام. إذا لم يتم تحديد قيمة، تكون القيمة التلقائية هي 1.
| تمثيل JSON |
|---|
{
"name": string,
"expireTime": string,
"newSessionExpireTime": string,
"fieldMask": string,
// config
"bidiGenerateContentSetup": {
object ( |
BidiGenerateContentSetup
الرسالة التي سيتم إرسالها في BidiGenerateContentClientMessage الأول (وفي الأول فقط). يحتوي على إعدادات سيتم تطبيقها طوال مدة RPC البث المباشر.
على العملاء انتظار رسالة BidiGenerateContentSetupComplete قبل إرسال أي رسائل إضافية.
model
string
الحقل مطلوب. اسم مورد النموذج. يُستخدَم هذا المعرّف كمعرّف للنموذج.
التنسيق: models/{model}
generationConfig
object (GenerationConfig)
اختياريّ. إعدادات الإنشاء
الحقول التالية غير متاحة:
responseLogprobsresponseMimeTypelogprobsresponseSchemaresponseJsonSchemastop_sequenceskipResponseCacherouting_configaudio_timestamp
systemInstruction
object (Content)
اختياريّ. قدّم المستخدم تعليمات النظام للنموذج.
ملاحظة: يجب استخدام النص فقط في الأجزاء، وسيكون المحتوى في كل جزء في فقرة منفصلة.
tools[]
object (Tool)
اختياريّ. قائمة Tools قد يستخدمها النموذج لإنشاء الرد التالي
Tool هي جزء من الرمز البرمجي يتيح للنظام التفاعل مع أنظمة خارجية لتنفيذ إجراء أو مجموعة من الإجراءات خارج نطاق معرفة النموذج.
realtimeInputConfig
object (RealtimeInputConfig)
اختياريّ. تضبط هذه السمة طريقة التعامل مع الإدخال في الوقت الفعلي.
sessionResumption
object (SessionResumptionConfig)
اختياريّ. تضبط هذه السمة آلية استئناف الجلسة.
في حال تضمينها، سيرسل الخادم SessionResumptionUpdate رسائل.
contextWindowCompression
object (ContextWindowCompressionConfig)
اختياريّ. تضبط هذه السمة آلية ضغط قدرة الاستيعاب.
في حال تضمينها، سيقلّل الخادم تلقائيًا حجم السياق عندما يتجاوز الطول الذي تم ضبطه.
inputAudioTranscription
object (AudioTranscriptionConfig)
اختياريّ. في حال ضبط هذا الخيار، يتم تفعيل ميزة تحويل الإدخال الصوتي إلى نص. تتوافق عملية تحويل الصوت إلى نص مع لغة الصوت المُدخَل، إذا تم ضبطها.
outputAudioTranscription
object (AudioTranscriptionConfig)
اختياريّ. في حال ضبط هذا الخيار، يتم تفعيل تحويل الصوت الذي ينتجه النموذج إلى نص. تتوافق النسخة المكتوبة مع رمز اللغة المحدّد للصوت الناتج، إذا تم ضبطه.
historyConfig
object (HistoryConfig)
اختياريّ. تضبط هذه السمة تبادل السجلّ بين العميل والخادم.
| تمثيل JSON |
|---|
{ "model": string, "generationConfig": { object ( |
GenerationConfig
خيارات الإعداد لإنشاء النماذج والمخرجات لا يمكن ضبط جميع المَعلمات لكل نموذج.
stopSequences[]
string
اختياريّ. مجموعة تسلسلات الأحرف (حتى 5) التي ستؤدي إلى إيقاف إنشاء المخرجات. في حال تحديد هذا الحقل، ستتوقف واجهة برمجة التطبيقات عند ظهور stop_sequence للمرة الأولى. لن يتم تضمين تسلسل الإيقاف كجزء من الرد.
responseMimeType
string
اختياريّ. نوع MIME للنص المرشّح الذي تم إنشاؤه. أنواع MIME المتوافقة هي: text/plain: (تلقائي) إخراج نصي. application/json: استجابة JSON في المرشّحين للاستجابة text/x.enum: ENUM كاستجابة سلسلة في المرشحين للاستجابة. يُرجى الرجوع إلى المستندات للاطّلاع على قائمة بجميع أنواع MIME المتوافقة مع النصوص.
responseSchema
(deprecated)
object (Schema)
اختياريّ. مخطط الإخراج للنص المرشّح الذي تم إنشاؤه. يجب أن تكون المخططات مجموعة فرعية من مخطط OpenAPI ويمكن أن تكون كائنات أو أنواعًا أساسية أو مصفوفات.
في حال ضبط هذه السياسة، يجب أيضًا ضبط سياسة responseMimeType متوافقة. أنواع MIME المتوافقة: application/json: مخطط لاستجابة JSON. راجِع دليل إنشاء نص JSON لمزيد من التفاصيل.
_responseJsonSchema
(deprecated)
value (Value format)
اختياريّ. مخطط الناتج للردّ الذي تم إنشاؤه. هذا بديل عن responseSchema يقبل مخطط JSON.
في حال ضبطها، يجب حذف responseSchema، ولكن يجب تضمين responseMimeType.
على الرغم من إمكانية إرسال مخطط JSON الكامل، لا تتوفّر جميع الميزات. على وجه التحديد، لا تتوفّر سوى السمات التالية:
$id$defs$ref$anchortypeformattitledescriptionenum(للنصوص والأرقام)itemsprefixItemsminItemsmaxItemsminimummaximumanyOf-
oneOf(يتم تفسيرها على النحو نفسه الذي يتم به تفسيرanyOf) propertiesadditionalPropertiesrequired
يمكن أيضًا ضبط السمة غير العادية propertyOrdering.
يتم فك المراجع الدورية إلى حدّ معيّن، وبالتالي لا يمكن استخدامها إلا في السمات غير المطلوبة. (لا تكفي الخصائص التي تقبل القيم الخالية). إذا تم ضبط $ref على مخطط فرعي، لا يمكن ضبط أي خصائص أخرى، باستثناء تلك التي تبدأ بـ $.
responseJsonSchema
value (Value format)
اختياريّ. تفصيل داخلي استخدِم responseJsonSchema بدلاً من هذا الحقل.
responseModalities[]
enum (Modality)
اختياريّ. طُرق عرض الردّ المطلوبة. تمثّل هذه السمة مجموعة الوسائط التي يمكن أن يعرضها النموذج، ويجب توقّعها في الردّ. هذا مطابق تمامًا لطرق عرض الرد.
قد يتضمّن النموذج عدة مجموعات من الوسائط المتوافقة. إذا لم تتطابق الوسائط المطلوبة مع أي من المجموعات المتوافقة، سيظهر خطأ.
القائمة الفارغة تعادل طلب النص فقط.
candidateCount
integer
اختياريّ. عدد الردود التي تم إنشاؤها والمطلوب عرضها. إذا لم يتم ضبط هذا الحقل، سيتم ضبطه تلقائيًا على 1. يُرجى العِلم أنّ هذه الميزة لا تعمل مع نماذج الجيل السابق (عائلة Gemini 1.0).
maxOutputTokens
integer
اختياريّ. الحد الأقصى لعدد الرموز المميّزة التي يمكن تضمينها في ردّ محتمل
ملاحظة: تختلف القيمة التلقائية حسب الطراز، راجِع السمة Model.output_token_limit التي يتم عرضها من Model من الدالة getModel.
temperature
number
اختياريّ. تتحكّم هذه السمة في عشوائية الناتج.
ملاحظة: تختلف القيمة التلقائية حسب الطراز، راجِع السمة Model.temperature التي يتم عرضها من Model من الدالة getModel.
يمكن أن تتراوح القيم بين [0.0, 2.0].
topP
number
اختياريّ. الحد الأقصى للاحتمال التراكمي للرموز المميّزة التي يجب أخذها في الاعتبار عند أخذ العيّنات.
يستخدم النموذج اختيار العيّنات بناءً على الاحتمال التراكمي وأعلى k احتمال.
يتم ترتيب الرموز المميزة استنادًا إلى الاحتمالات المحدّدة لها، وبالتالي يتم أخذ الرموز المميزة الأكثر ترجيحًا فقط في الاعتبار. يحدّ اختيار العيّنات بناءً على أعلى k من الحد الأقصى لعدد الرموز المميّزة التي يجب أخذها في الاعتبار، بينما يحدّ اختيار العيّنات بناءً على الاحتمال التراكمي من عدد الرموز المميّزة استنادًا إلى الاحتمال التراكمي.
ملاحظة: تختلف القيمة التلقائية حسب Model ويتم تحديدها من خلال السمة Model.top_p التي تعرضها الدالة getModel. تشير السمة topK الفارغة إلى أنّ النموذج لا يطبّق أخذ العينات من أعلى k ولا يسمح بضبط topK على الطلبات.
topK
integer
اختياريّ. الحد الأقصى لعدد الرموز المميّزة التي يجب أخذها في الاعتبار عند أخذ العيّنات
تستخدم نماذج Gemini اختيار العيّنات بناءً على الاحتمال التراكمي أو مزيجًا من اختيار العيّنات بناءً على أعلى k احتمال واختيار العيّنات بناءً على الاحتمال التراكمي. تأخذ عملية أخذ العيّنات من أعلى k رمز مميّز في الاعتبار مجموعة الرموز المميّزة topK الأكثر احتمالاً. لا تسمح النماذج التي تستخدم اختيار العيّنات بناءً على الاحتمال التراكمي بإعداد أعلى K كلمة محتملة.
ملاحظة: تختلف القيمة التلقائية حسب Model ويتم تحديدها من خلال السمة Model.top_p التي تعرضها الدالة getModel. تشير السمة topK الفارغة إلى أنّ النموذج لا يطبّق أخذ العينات من أعلى k ولا يسمح بضبط topK على الطلبات.
seed
integer
اختياريّ. العبارة الأولية المستخدَمة في فك التشفير في حال عدم ضبط هذه القيمة، يستخدم الطلب قيمة أولية تم إنشاؤها عشوائيًا.
presencePenalty
number
اختياريّ. يتم تطبيق عقوبة الحضور على احتمالات تسجيل الرمز المميز التالي إذا سبق أن ظهر الرمز المميز في الردّ.
هذه العقوبة هي عقوبة ثنائية (مفعلة أو غير مفعلة) ولا تعتمد على عدد المرات التي يتم فيها استخدام الرمز المميز (بعد المرة الأولى). استخدِم frequencyPenalty لفرض غرامة تزداد مع كل استخدام.
ستؤدي العقوبة الإيجابية إلى تثبيط استخدام الرموز المميزة التي سبق استخدامها في الرد، ما يزيد من المفردات.
ستشجّع العقوبة السلبية على استخدام الرموز المميزة التي سبق استخدامها في الردّ، ما يؤدي إلى تقليل المفردات.
frequencyPenalty
number
اختياريّ. يتم تطبيق عقوبة عدد مرات الظهور على احتمالات تسجيل الرمز المميز التالي، ويتم ضربها في عدد المرات التي ظهر فيها كل رمز مميز في الرد حتى الآن.
ستؤدي العقوبة الإيجابية إلى تثبيط استخدام الرموز المميزة التي سبق استخدامها، بما يتناسب مع عدد المرات التي تم فيها استخدام الرمز المميز: كلما زاد استخدام الرمز المميز، زادت صعوبة استخدام النموذج لهذا الرمز المميز مرة أخرى، ما يؤدي إلى زيادة مفردات الردود.
تنبيه: ستشجّع العقوبة السالبة النموذج على إعادة استخدام الرموز المميزة بما يتناسب مع عدد المرات التي تم فيها استخدام الرمز المميز. ستؤدي القيم السلبية الصغيرة إلى تقليل مفردات الردّ. ستؤدي القيم السالبة الأكبر إلى بدء النموذج في تكرار رمز مميز شائع إلى أن يصل إلى الحدّ الأقصى وهو maxOutputTokens.
responseLogprobs
boolean
اختياريّ. إذا كانت القيمة صحيحة، سيتم تصدير نتائج logprobs في الردّ.
logprobs
integer
اختياريّ. لا يسري إلا إذا كان responseLogprobs=True. يحدّد هذا المعلمة عدد logprobs الأعلى، بما في ذلك المرشّح المختار، الذي سيتم عرضه في كل خطوة فك ترميز في Candidate.logprobs_result. يجب أن يكون الرقم في النطاق [0, 20].
enableEnhancedCivicAnswers
boolean
اختياريّ. تفعيل الإجابات المحسّنة حول المواضيع المدنية قد لا تكون هذه الميزة متاحة لبعض الطُرز.
speechConfig
object (SpeechConfig)
اختياريّ. إعدادات إنشاء الكلام
thinkingConfig
object (ThinkingConfig)
اختياريّ. إعدادات ميزات التفكير سيتم عرض خطأ إذا تم ضبط هذا الحقل على نماذج لا تتيح التفكير.
imageConfig
object (ImageConfig)
اختياريّ. إعدادات إنشاء الصور سيتم عرض خطأ إذا تم ضبط هذا الحقل للنماذج التي لا تتوافق مع خيارات الإعداد هذه.
mediaResolution
enum (MediaResolution)
اختياريّ. في حال تحديدها، سيتم استخدام دقة الوسائط المحدّدة.
enableAffectiveDialog
boolean
اختياريّ. في حال تفعيل هذا الخيار، سيرصد النموذج المشاعر ويعدّل ردوده وفقًا لذلك.
responseFormat
object (ResponseFormatConfig)
اختياريّ. إعدادات تنسيق إخراج الردّ تسمح هذه السمة بتحديد إعدادات الإخراج لكل نمط بيانات (نص أو صوت أو صورة) في بنية مسطّحة.
translationConfig
object (TranslationConfig)
اختياريّ. إعدادات الترجمة
| تمثيل JSON |
|---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
نمط البيانات
وسائط الردّ المتوافقة
| عمليات التعداد | |
|---|---|
MODALITY_UNSPECIFIED |
القيمة التلقائية |
TEXT |
تشير إلى أنّ النموذج يجب أن يعرض نصًا. |
IMAGE |
تشير إلى أنّ النموذج يجب أن يعرض صورًا. |
AUDIO |
تشير إلى أنّ النموذج يجب أن يعرض صوتًا. |
SpeechConfig
إعدادات إنشاء الصوت وتحويله إلى نص
voiceConfig
object (VoiceConfig)
الإعداد في حال إخراج صوت واحد
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig)
اختياريّ. إعدادات نظام الصوت المتعدد وهو يستبعد الحقل voiceConfig.
languageCode
string
اختياريّ. رمز اللغة BCP-47 التابع لفريق هندسة الإنترنت (IETF) والذي ضبطه المستخدم لاستخدامه في التطبيق تُستخدَم للتعرّف على الكلام وتركيبه.
القيم الصالحة هي: de-DE وen-AU وen-GB وen-IN وen-US وes-US وfr-FR وhi-IN وpt-BR وar-XA وes-ES وfr-CA وid-ID وit-IT وja-JP وtr-TR وvi-VN وbn-IN وgu-IN وkn-IN وml-IN وmr-IN وta-IN وte-IN وnl-NL وko-KR وcmn-CN وpl-PL وru-RU وth-TH.
| تمثيل JSON |
|---|
{ "voiceConfig": { object ( |
VoiceConfig
إعدادات الصوت المطلوب استخدامه
voice_config
Union type
voice_config إحدى القيم التالية فقط:prebuiltVoiceConfig
object (PrebuiltVoiceConfig)
إعدادات الصوت المُعدّ مسبقًا الذي سيتم استخدامه
| تمثيل JSON |
|---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
تحدّد هذه السمة إعدادات مكبّر الصوت المُدمج الذي سيتم استخدامه.
voiceName
string
تمثّل هذه السمة اسم الصوت المضبوط مسبقًا المطلوب استخدامه.
| تمثيل JSON |
|---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
إعدادات نظام الصوت المتعدد
speakerVoiceConfigs[]
object (SpeakerVoiceConfig)
الحقل مطلوب. جميع أصوات مكبّر الصوت المفعَّلة
| تمثيل JSON |
|---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
تمثّل هذه السمة إعدادات مكبّر صوت واحد في إعدادات مكبّرات صوت متعدّدة.
speaker
string
الحقل مطلوب. تمثّل هذه السمة اسم المتحدث المطلوب استخدامه. يجب أن يكون الاسم مطابقًا للاسم الوارد في الطلب.
voiceConfig
object (VoiceConfig)
الحقل مطلوب. إعدادات الصوت المطلوب استخدامه
| تمثيل JSON |
|---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
إعدادات ميزات التفكير
includeThoughts
boolean
تُستخدَم لتحديد ما إذا كان سيتم تضمين الأفكار في الردّ. إذا كانت القيمة صحيحة، يتم عرض الأفكار فقط عندما تكون متاحة.
thinkingBudget
integer
عدد الرموز المميزة للأفكار التي يجب أن ينشئها النموذج.
thinkingLevel
enum (ThinkingLevel)
اختياريّ. تتحكّم هذه السمة في الحدّ الأقصى لعمق عملية الاستدلال الداخلية للنموذج قبل أن ينتج ردًا. تعتمد القيمة التلقائية على النموذج. يمكنك الاطّلاع على دليل مستويات التفكير لمزيد من التفاصيل. يُنصح به لطُرز Gemini 3 أو الأحدث. يؤدي استخدامها مع النماذج السابقة إلى حدوث خطأ.
| تمثيل JSON |
|---|
{
"includeThoughts": boolean,
"thinkingBudget": integer,
"thinkingLevel": enum ( |
ThinkingLevel
السماح للمستخدم بتحديد مقدار التفكير باستخدام تعداد بدلاً من ميزانية عدد صحيح
| عمليات التعداد | |
|---|---|
THINKING_LEVEL_UNSPECIFIED |
القيمة التلقائية |
MINIMAL |
لا يتطلّب الأمر تفكيرًا كبيرًا. |
LOW |
مستوى التفكير منخفض. |
MEDIUM |
مستوى التفكير المتوسط |
HIGH |
مستوى التفكير العالي |
ImageConfig
إعدادات ميزات إنشاء الصور
aspectRatio
string
اختياريّ. نسبة العرض إلى الارتفاع للصورة المطلوب إنشاؤها نسب العرض إلى الارتفاع المتاحة: 1:1 أو 1:4 أو 4:1 أو 1:8 أو 8:1 أو 2:3 أو 3:2 أو 3:4 أو 4:3 أو 4:5 أو 5:4 أو 9:16 أو 16:9 أو 21:9
في حال عدم تحديد نسبة العرض إلى الارتفاع، سيختار النموذج نسبة تلقائية استنادًا إلى أي صور مرجعية مقدَّمة.
imageSize
string
اختياريّ. تحدّد هذه السمة حجم الصور التي يتم إنشاؤها. القيم المسموح بها هي 512 و1K و2K و4K. في حال عدم تحديدها، سيستخدم النموذج القيمة التلقائية 1K.
| تمثيل JSON |
|---|
{ "aspectRatio": string, "imageSize": string } |
MediaResolution
تمثّل هذه السمة دقة الوسائط التي تم إدخالها.
| عمليات التعداد | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
لم يتم ضبط دقة الوسائط. |
MEDIA_RESOLUTION_LOW |
تم ضبط دقة الوسائط على منخفضة (64 رمزًا مميزًا). |
MEDIA_RESOLUTION_MEDIUM |
تم ضبط دقة الوسائط على متوسطة (256 رمزًا مميزًا). |
MEDIA_RESOLUTION_HIGH |
تم ضبط دقة الوسائط على عالية (إعادة ضبط الإطار مع تكبير/تصغير باستخدام 256 رمزًا مميزًا). |
ResponseFormatConfig
إعدادات تنسيق إخراج الردّ هذا عنصر مسطّح يضبط فيه كل حقل فرعي اختياري طريقة إخراج معيّنة.
text
object (TextResponseFormat)
اختياريّ. إعدادات تنسيق إخراج النص
audio
object (AudioResponseFormat)
اختياريّ. إعدادات تنسيق مصدر إخراج الصوت
image
object (ImageResponseFormat)
اختياريّ. إعدادات تنسيق إخراج الصورة
| تمثيل JSON |
|---|
{ "text": { object ( |
TextResponseFormat
MimeType
أنواع MIME المتوافقة مع إخراج النص
| عمليات التعداد | |
|---|---|
MIME_TYPE_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
APPLICATION_JSON |
تنسيق إخراج JSON. |
TEXT_PLAIN |
تنسيق الإخراج النصي العادي |
AudioResponseFormat
إعدادات تنسيق إخراج الصوت
mimeType
enum (MimeType)
اختياريّ. نوع MIME الخاص بمصدر إخراج الصوت
delivery
enum (Delivery)
اختياريّ. طريقة إرسال الصوت
sampleRate
integer
اختياريّ. معدّل البيانات في الملف الصوتي بوحدة هرتز
bitRate
integer
اختياريّ. معدّل نقل البيانات بالبت في الثانية (bps) ينطبق ذلك فقط على التنسيقات المضغوطة (MP3 وOpus).
MimeType
أنواع MIME المتوافقة لمصدر إخراج الصوت
| عمليات التعداد | |
|---|---|
MIME_TYPE_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
AUDIO_MP3 |
تنسيق الصوت MP3 |
AUDIO_OGG_OPUS |
تنسيق الصوت OGG Opus |
AUDIO_L16 |
تنسيق الصوت Raw PCM (L16) |
AUDIO_WAV |
تنسيق الصوت WAV |
AUDIO_ALAW |
تنسيق الصوت A-law |
AUDIO_MULAW |
تنسيق الصوت Mu-law |
إرسال المحتوى
وضع عرض الإعلانات لإخراج الصوت
| عمليات التعداد | |
|---|---|
DELIVERY_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
INLINE |
يتم عرض بيانات الصوت بشكل مضمّن في الردّ. |
URI |
يتم عرض البيانات الصوتية كمعرّف موارد موحّد (URI). |
ImageResponseFormat
إعدادات تنسيق إخراج الصورة
mimeType
enum (MimeType)
اختياريّ. نوع MIME الخاص بإخراج الصورة.
delivery
enum (Delivery)
اختياريّ. طريقة إرسال مخرجات الصورة
aspectRatio
enum (AspectRatio)
اختياريّ. نسبة العرض إلى الارتفاع لناتج الصورة
imageSize
enum (ImageSize)
اختياريّ. حجم الصورة الناتجة
| تمثيل JSON |
|---|
{ "mimeType": enum ( |
MimeType
أنواع MIME المتوافقة لإخراج الصور
| عمليات التعداد | |
|---|---|
MIME_TYPE_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
IMAGE_JPEG |
تنسيق صورة JPEG |
إرسال المحتوى
طريقة إرسال الصور
| عمليات التعداد | |
|---|---|
DELIVERY_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
INLINE |
يتم عرض بيانات الصورة مضمّنة في الردّ. |
URI |
يتم عرض بيانات الصورة كمعرّف URI. |
AspectRatio
نِسب العرض إلى الارتفاع المتاحة لإخراج الصور
| عمليات التعداد | |
|---|---|
ASPECT_RATIO_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
ASPECT_RATIO_ONE_BY_ONE |
نسبة العرض إلى الارتفاع 1:1 |
ASPECT_RATIO_TWO_BY_THREE |
نسبة العرض إلى الارتفاع 2:3 |
ASPECT_RATIO_THREE_BY_TWO |
نسبة العرض إلى الارتفاع 3:2 |
ASPECT_RATIO_THREE_BY_FOUR |
نسبة العرض إلى الارتفاع 3:4 |
ASPECT_RATIO_FOUR_BY_THREE |
نسبة العرض إلى الارتفاع 4:3 |
ASPECT_RATIO_FOUR_BY_FIVE |
نسبة العرض إلى الارتفاع 4:5 |
ASPECT_RATIO_FIVE_BY_FOUR |
نسبة العرض إلى الارتفاع 5:4 |
ASPECT_RATIO_NINE_BY_SIXTEEN |
نسبة العرض إلى الارتفاع 9:16 |
ASPECT_RATIO_SIXTEEN_BY_NINE |
نسبة العرض إلى الارتفاع: 16:9 |
ASPECT_RATIO_TWENTY_ONE_BY_NINE |
نسبة العرض إلى الارتفاع: 21:9 |
ASPECT_RATIO_ONE_BY_EIGHT |
نسبة العرض إلى الارتفاع 1:8 |
ASPECT_RATIO_EIGHT_BY_ONE |
نسبة العرض إلى الارتفاع 8:1 |
ASPECT_RATIO_ONE_BY_FOUR |
نسبة العرض إلى الارتفاع 1:4 |
ASPECT_RATIO_FOUR_BY_ONE |
نسبة العرض إلى الارتفاع 4:1 |
ImageSize
أحجام الصور المتوافقة لإخراج الصور
| عمليات التعداد | |
|---|---|
IMAGE_SIZE_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
IMAGE_SIZE_FIVE_TWELVE |
حجم الصورة 512 بكسل |
IMAGE_SIZE_ONE_K |
حجم الصورة 1K |
IMAGE_SIZE_TWO_K |
حجم الصورة 2K |
IMAGE_SIZE_FOUR_K |
حجم الصورة بدقة 4K |
TranslationConfig
إعدادات ميزات الترجمة
targetLanguageCode
string
الحقل مطلوب. اللغة الهدف للترجمة. القيم المسموح بها هي رموز اللغة المستخدَمة في المقطع الصوتي وفق المعيار BCP-47 (مثل "en" أو "es" أو "fr").
echoTargetLanguage
boolean
اختياريّ. إذا كانت القيمة صحيحة، سينشئ النموذج صوتًا عند التحدث باللغة المستهدَفة، أي أنّه سيقلّد الإدخال. إذا كانت القيمة "خطأ"، لن ننتج محتوًى صوتيًا باللغة المستهدَفة.
| تمثيل JSON |
|---|
{ "targetLanguageCode": string, "echoTargetLanguage": boolean } |
RealtimeInputConfig
تضبط هذه السياسة سلوك الإدخال في الوقت الفعلي في BidiGenerateContent.
automaticActivityDetection
object (AutomaticActivityDetection)
اختياريّ. إذا لم يتم ضبط هذا الخيار، تكون ميزة "الرصد التلقائي للنشاط" مفعّلة تلقائيًا. في حال إيقاف ميزة "الرصد التلقائي للصوت"، على العميل إرسال إشارات النشاط.
activityHandling
enum (ActivityHandling)
اختياريّ. تحدّد هذه السمة تأثير النشاط.
turnCoverage
enum (TurnCoverage)
اختياريّ. تحدّد هذه السمة الإدخال الذي يتم تضمينه في رد المستخدم.
| تمثيل JSON |
|---|
{ "automaticActivityDetection": { object ( |
AutomaticActivityDetection
تضبط هذه السمة عملية الرصد التلقائي للنشاط.
disabled
boolean
اختياريّ. في حال تفعيل هذا الخيار (وهو الإعداد التلقائي)، يتم احتساب عدد عمليات إدخال الصوت والنص التي تم رصدها كنشاط. في حال إيقافها، على العميل إرسال إشارات النشاط.
startOfSpeechSensitivity
enum (StartSensitivity)
اختياريّ. تحدّد هذه السمة مدى احتمال رصد الكلام.
prefixPaddingMs
integer
اختياريّ. المدة المطلوبة للكلام الذي تم رصده قبل بدء الكلام كلما كانت هذه القيمة أقل، كان رصد بداية الكلام أكثر حساسية ويمكن التعرّف على الكلام الأقصر. ومع ذلك، يؤدي ذلك أيضًا إلى زيادة احتمال ظهور نتائج إيجابية خاطئة.
endOfSpeechSensitivity
enum (EndSensitivity)
اختياريّ. تحدّد هذه السمة مدى احتمال انتهاء الكلام الذي تم رصده.
silenceDurationMs
integer
اختياريّ. المدة المطلوبة لرصد أي صوت غير كلامي (مثل الصمت) قبل إكمال الكلام كلما زادت هذه القيمة، زادت مدة فواصل الكلام التي يمكن أن تحدث بدون مقاطعة نشاط المستخدم، ولكن سيؤدي ذلك إلى زيادة وقت الاستجابة للنموذج.
| تمثيل JSON |
|---|
{ "disabled": boolean, "startOfSpeechSensitivity": enum ( |
StartSensitivity
تحدّد هذه السمة كيفية رصد بداية الكلام.
| عمليات التعداد | |
|---|---|
START_SENSITIVITY_UNSPECIFIED |
القيمة التلقائية هي START_SENSITIVITY_HIGH. |
START_SENSITIVITY_HIGH |
ستتعرّف ميزة "الرصد التلقائي" على بداية الكلام بشكل متكرّر. |
START_SENSITIVITY_LOW |
سيتم رصد بداية الكلام بشكل أقل. |
EndSensitivity
تحدّد هذه السمة كيفية رصد نهاية الكلام.
| عمليات التعداد | |
|---|---|
END_SENSITIVITY_UNSPECIFIED |
القيمة التلقائية هي END_SENSITIVITY_HIGH. |
END_SENSITIVITY_HIGH |
تؤدي ميزة "الرصد التلقائي" إلى إنهاء الكلام بشكل متكرّر. |
END_SENSITIVITY_LOW |
تتوقف ميزة "الرصد التلقائي" عن رصد الكلام بمعدّل أقل. |
ActivityHandling
الطرق المختلفة للتعامل مع نشاط المستخدم
| عمليات التعداد | |
|---|---|
ACTIVITY_HANDLING_UNSPECIFIED |
إذا لم يتم تحديد ذلك، يكون السلوك التلقائي هو START_OF_ACTIVITY_INTERRUPTS. |
START_OF_ACTIVITY_INTERRUPTS |
إذا كانت القيمة "صحيح"، سيؤدي بدء النشاط إلى مقاطعة ردّ النموذج (يُعرف أيضًا باسم "المقاطعة"). سيتم قطع الردّ الحالي للنموذج في لحظة المقاطعة. هذا هو السلوك التلقائي. |
NO_INTERRUPTION |
لن يتم إيقاف ردّ النموذج. |
TurnCoverage
خيارات بشأن الإدخال الذي يتم تضمينه في رد المستخدم
| عمليات التعداد | |
|---|---|
TURN_COVERAGE_UNSPECIFIED |
في حال عدم تحديد ذلك، يتم اختيار سلوك تلقائي استنادًا إلى النموذج. على سبيل المثال، بالنسبة إلى Gemini 2.5، يكون الإعداد التلقائي هو TURN_INCLUDES_ONLY_ACTIVITY، بينما يكون TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO هو الإعداد التلقائي بالنسبة إلى Gemini 3.1 والإصدارات الأحدث. |
TURN_INCLUDES_ONLY_ACTIVITY |
يتضمّن النشاط منذ آخر منعطف، باستثناء عدم النشاط (مثل الصمت في بث الصوت). |
TURN_INCLUDES_ALL_INPUT |
يتضمّن جميع البيانات في الوقت الفعلي منذ آخر دورة، بما في ذلك عدم النشاط (مثل الصمت في بث الصوت). |
TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO |
يتضمّن هذا السجلّ النشاط الصوتي وكل الفيديوهات منذ آخر مرة تم فيها إيقاف السجلّ مؤقتًا. باستخدام ميزة "رصد النشاط تلقائيًا"، يشير النشاط الصوتي إلى الكلام ويستثني الصمت. |
SessionResumptionConfig
إعدادات استئناف الجلسة
يتم تضمين هذه الرسالة في إعدادات الجلسة على النحو التالي: BidiGenerateContentSetup.session_resumption. في حال ضبطه، سيرسل الخادم رسائل SessionResumptionUpdate.
handle
string
معرّف جلسة سابقة. إذا لم يكن متوفّرًا، يتم إنشاء جلسة جديدة.
تأتي معرّفات الجلسات من قيم SessionResumptionUpdate.token في عمليات الربط السابقة.
| تمثيل JSON |
|---|
{ "handle": string } |
ContextWindowCompressionConfig
تفعيل ضغط قدرة استيعاب النموذج — آلية لإدارة قدرة استيعاب النموذج حتى لا تتجاوز طولاً معيّنًا
compression_mechanism
Union type
compression_mechanism إحدى القيم التالية فقط:slidingWindow
object (SlidingWindow)
آلية النافذة المنزلقة
triggerTokens
string (int64 format)
عدد الرموز المميزة (قبل تنفيذ جولة) المطلوبة لتفعيل ضغط نافذة السياق
يمكن استخدام ذلك لتحقيق التوازن بين الجودة ووقت الاستجابة، لأنّ نوافذ السياق الأقصر قد تؤدي إلى استجابات أسرع من النموذج. ومع ذلك، ستؤدي أي عملية ضغط إلى زيادة مؤقتة في وقت الاستجابة، لذا يجب عدم تشغيلها بشكل متكرر.
إذا لم يتم ضبطها، تكون القيمة التلقائية هي% 80 من الحد الأقصى لقدرة استيعاب النموذج. يتبقى بذلك% 20 لطلب المستخدم التالي أو ردّ النموذج.
| تمثيل JSON |
|---|
{
// compression_mechanism
"slidingWindow": {
object ( |
SlidingWindow
تعمل طريقة SlidingWindow من خلال تجاهل المحتوى في بداية قدرة الاستيعاب. سيبدأ السياق الناتج دائمًا عند بداية دور المستخدم. ستبقى تعليمات النظام وأي BidiGenerateContentSetup.prefix_turns في بداية النتيجة دائمًا.
targetTokens
string (int64 format)
عدد الرموز المميزة المستهدَفة التي يجب الاحتفاظ بها. القيمة التلقائية هي triggerTokens/2.
يؤدي تجاهل أجزاء من قدرة الاستيعاب إلى زيادة مؤقتة في وقت الاستجابة، لذا يجب معايرة هذه القيمة لتجنُّب عمليات الضغط المتكررة.
| تمثيل JSON |
|---|
{ "targetTokens": string } |
AudioTranscriptionConfig
إعدادات تحويل الصوت إلى نص
adaptationPhrases[]
(deprecated)
string
اختياريّ. قائمة بالعبارات المستخدَمة لتكييف الكلام، ما يؤدي إلى تحسين نموذج التعرّف التلقائي على الكلام (ASR) للتعرّف على هذه المصطلحات المحدّدة.
customVocabulary[]
string
اختياريّ. قائمة بعبارات المفردات المخصّصة لتوجيه نموذج التعرّف على الكلام نحو التعرّف على مصطلحات معيّنة (أسماء المنتجات والأسماء الصحيحة والمصطلحات الفنية).
language_config
Union type
language_config إحدى القيم التالية فقط:languageAuto
object (LanguageAuto)
اختياريّ. سيتعرّف النموذج على اللغة تلقائيًا.
languageHints
object (LanguageHints)
اختياريّ. تحدّد هذه السمة لغة واحدة أو أكثر في الصوت.
| تمثيل JSON |
|---|
{ "adaptationPhrases": [ string ], "customVocabulary": [ string ], // language_config "languageAuto": { object ( |
LanguageAuto
لا يتضمّن هذا النوع أي حقول.
تشير إلى أنّه يجب التعرّف تلقائيًا على لغة الصوت.
LanguageHints
تقدّم تلميحات للنموذج بشأن اللغات المحتملة في الصوت.
languageCodes[]
string
الحقل مطلوب. رموز اللغة BCP-47
| تمثيل JSON |
|---|
{ "languageCodes": [ string ] } |
HistoryConfig
إعدادات السجلّ
يتم تضمين هذه الرسالة في إعدادات الجلسة على النحو التالي: BidiGenerateContentSetup.history_config. تضبط هذه السمة تبادل رسائل السجلّ.
initialHistoryInClientContent
boolean
اختياريّ. إذا كانت القيمة true، سينتظر الخادم بعد إرسال setupComplete، وسيعالج أولاً clientContent رسالة إلى أن تصبح قيمة turnComplete هي true. لن يؤدي هذا السجلّ الأوّلي إلى بدء مكالمة مع النموذج، وقد ينتهي بالدور MODEL. بعد turnComplete، يتم عرض true، ويمكن للعميل بدء المحادثة في الوقت الفعلي من خلال realtimeInput.
| تمثيل JSON |
|---|
{ "initialHistoryInClientContent": boolean } |
الطريقة: auth_tokens.create
تنشئ هذه الدالة رمزًا مميزًا يمكن استخدامه لتقييد سلوك جلسة BidiGenerateContent.
نقطة نهاية
posthttps: / /generativelanguage.googleapis.com /v1beta /auth_tokens
نص الطلب
يحتوي نص الطلب على مثال AuthToken.
expireTime
string (Timestamp format)
اختياريّ. الإدخال فقط غير قابل للتغيير وقت اختياري يتم بعده رفض الرسائل في جلسات BidiGenerateContent عند استخدام الرمز المميّز الناتج. (قد يغلق Gemini الجلسة بشكل استباقي بعد هذا الوقت).
إذا لم يتم ضبط هذا الخيار، سيتم تلقائيًا ضبطه على 30 دقيقة في المستقبل. في حال ضبط هذا الحقل، يجب أن تكون القيمة أقل من 20 ساعة في المستقبل.
يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".
newSessionExpireTime
string (Timestamp format)
اختياريّ. الإدخال فقط غير قابل للتغيير الوقت الذي سيتم بعده رفض جلسات Live API الجديدة التي تستخدم الرمز المميز الناتج من هذا الطلب
إذا لم يتم ضبط هذا الحقل، سيتم ضبطه تلقائيًا على 60 ثانية في المستقبل. في حال ضبط هذا الحقل، يجب أن تكون القيمة أقل من 20 ساعة في المستقبل.
يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".
fieldMask
string (FieldMask format)
اختياريّ. الإدخال فقط غير قابل للتغيير إذا كان fieldMask فارغًا، ولم يكن bidiGenerateContentSetup متوفّرًا، سيتم استرداد رسالة BidiGenerateContentSetup الفعّالة من اتصال Live API.
إذا كان fieldMask فارغًا، وكان bidiGenerateContentSetup موجودًا، سيتم أخذ رسالة BidiGenerateContentSetup الفعّالة بالكامل من bidiGenerateContentSetup في هذا الطلب. يتم تجاهل رسالة الإعداد من عملية الربط المباشر بواجهة برمجة التطبيقات.
إذا لم يكن fieldMask فارغًا، ستؤدي الحقول المطابقة من bidiGenerateContentSetup إلى الكتابة فوق الحقول من رسالة الإعداد في عملية الربط بواجهة برمجة التطبيقات المباشرة.
هذه قائمة قيم مفصولة بفاصلة تتضمّن الأسماء المؤهَّلة بالكامل للحقول. مثال: "user.displayName,photo"
config
Union type
config إحدى القيم التالية فقط:bidiGenerateContentSetup
object (BidiGenerateContentSetup)
اختياريّ. الإدخال فقط غير قابل للتغيير إعدادات خاصة بـ BidiGenerateContent
uses
integer
اختياريّ. الإدخال فقط غير قابل للتغيير عدد المرات التي يمكن فيها استخدام الرمز المميز إذا كانت هذه القيمة صفرًا، لن يتم تطبيق أي حدّ. لا يُحتسب استئناف جلسة Live API كاستخدام. إذا لم يتم تحديد قيمة، تكون القيمة التلقائية هي 1.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال تم إنشاؤه حديثًا AuthToken.