تتيح Gemini API إنشاء المحتوى باستخدام الصور والملفات الصوتية والرموز البرمجية والأدوات وغير ذلك. للاطّلاع على تفاصيل حول كل من هذه الميزات، واصِل القراءة واطّلِع على نموذج الرمز البرمجي الذي يركّز على المهام، أو اقرأ الأدلة الشاملة.
- إنشاء النصوص
- النظر
- الصوت
- عمليات التضمين
- السياق الطويل
- تنفيذ الرموز البرمجية
- وضع JSON
- استدعاء الدوال
- تعليمات النظام
الطريقة: models.generateContent
ينشئ ردًا من النموذج بناءً على الإدخال GenerateContentRequest. راجِع دليل إنشاء النصوص للحصول على معلومات مفصّلة حول الاستخدام. تختلف إمكانات الإدخال بين النماذج، بما في ذلك النماذج المضبوطة. يُرجى الرجوع إلى دليل النماذج ودليل الضبط للاطّلاع على التفاصيل.
نقطة نهاية
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
مَعلمات المسار
model
string
الحقل مطلوب. اسم Model المطلوب استخدامه لإنشاء الإكمال.
التنسيق: models/{model} ويكون بالتنسيق التالي: models/{model}.
نص الطلب
يتضمن نص الطلب بيانات بالبنية التالية:
tools[]
object (Tool)
اختياريّ. قائمة Tools يمكن Model استخدامها لإنشاء الرد التالي.
Tool هي جزء من الرمز البرمجي يتيح للنظام التفاعل مع أنظمة خارجية لتنفيذ إجراء أو مجموعة من الإجراءات خارج نطاق معرفة Model. Tool المتاحة هي 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}.
نص الطلب
يتضمن نص الطلب بيانات بالبنية التالية:
tools[]
object (Tool)
اختياريّ. قائمة Tools يمكن Model استخدامها لإنشاء الرد التالي.
Tool هي جزء من الرمز البرمجي يتيح للنظام التفاعل مع أنظمة خارجية لتنفيذ إجراء أو مجموعة من الإجراءات خارج نطاق معرفة Model. Tool المتاحة هي 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
اختياريّ. اسم مورد blob الوسائط لنتائج البحث عن الملفات المتعدّدة الوسائط التنسيق: 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_DEROGATORY |
PaLM: تعليقات سلبية أو مؤذية تستهدف الهوية و/أو السمات المحمية |
HARM_CATEGORY_TOXICITY |
PaLM: المحتوى الذي يتضمّن لغة وقحة أو غير محترمة أو نابية |
HARM_CATEGORY_VIOLENCE |
PaLM: يصف سيناريوهات تصوّر العنف ضد فرد أو مجموعة، أو أوصافًا عامة للمشاهد الدموية. |
HARM_CATEGORY_SEXUAL |
PaLM: تتضمّن السمة إشارات إلى أفعال جنسية أو محتوًى بذيئًا آخر. |
HARM_CATEGORY_MEDICAL |
PaLM: يروّج لنصائح طبية غير مدقَّقة. |
HARM_CATEGORY_DANGEROUS |
PaLM: المحتوى الخطير الذي يروّج لأفعال ضارّة أو يسهّل تنفيذها أو يشجّع عليها |
HARM_CATEGORY_HARASSMENT |
Gemini - المحتوى الذي يهدف إلى المضايقة |
HARM_CATEGORY_HATE_SPEECH |
Gemini: الكلام الذي يحض على الكراهية والمحتوى |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini - المحتوى الجنسي الفاضح |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini - المحتوى الخطير |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini: المحتوى الذي قد يُستخدم للإضرار بالنزاهة المدنية تم إيقاف هذه السمة نهائيًا، لذا يُرجى استخدام enableEnhancedCivicAnswers بدلاً منها. |
HARM_CATEGORY_JAILBREAK |
Gemini: الطلبات التي تحاول تجاوز إرشادات السلامة في النموذج أو التحايل عليها (محاولات اختراق). |
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
فئة الخدمة للطلب
| عمليات التعداد | |
|---|---|
unspecified |
فئة الخدمة التلقائية، وهي الفئة العادية |
standard |
فئة الخدمة العادية |
flex |
فئة خدمة Flex |
priority |
فئة الخدمة ذات الأولوية |
المحتوى
- تمثيل JSON
- الجزء
- Blob
- FunctionCall
- FunctionResponse
- FunctionResponsePart
- FunctionResponseBlob
- الجدولة
- FileData
- ExecutableCode
- اللغة
- CodeExecutionResult
- النتيجة
- ToolCall
- ToolType
- ToolResponse
- VideoMetadata
- MediaResolution
- المستوى
- MediaProcessing
نوع البيانات المنظَّمة الأساسي الذي يحتوي على محتوى متعدد الأجزاء لرسالة
يتضمّن Content حقل role يحدّد منتج Content وحقل parts يحتوي على بيانات متعدّدة الأجزاء تتضمّن محتوى دورة الرسالة.
parts[]
object (Part)
Parts بالترتيب التي تشكّل رسالة واحدة قد تحتوي الأجزاء على أنواع MIME مختلفة.
role
string
اختياريّ. تمثّل هذه السمة منتج المحتوى. يجب أن تكون القيمة إما "user" أو "model".
من المفيد ضبط هذه السمة للمحادثات المترابطة، وإلا يمكن تركها فارغة أو بدون ضبط.
| تمثيل JSON |
|---|
{
"parts": [
{
object ( |
الجزء
نوع بيانات يحتوي على وسائط تشكّل جزءًا من رسالة Content متعددة الأجزاء.
يتألف Part من بيانات لها نوع بيانات مرتبط بها. لا يمكن أن يحتوي Part إلا على نوع واحد من الأنواع المقبولة في Part.data.
يجب أن يحتوي Part على نوع MIME ثابت من IANA يحدّد نوع الوسائط ونوعها الفرعي إذا كان الحقل inlineData مملوءًا بوحدات بايت أولية.
thought
boolean
اختياريّ. تشير إلى ما إذا كان الجزء مستنتجًا من النموذج.
thoughtSignature
string (bytes format)
اختياريّ. توقيع غير شفاف للفكرة حتى يمكن إعادة استخدامه في الطلبات اللاحقة.
سلسلة مرمّزة باستخدام Base64
partMetadata
object (Struct format)
بيانات وصفية مخصّصة مرتبطة بالجزء قد يحتاج الوكلاء الذين يستخدمون genai.Part كتمثيل للمحتوى إلى تتبُّع المعلومات الإضافية. على سبيل المثال، يمكن أن يكون اسم ملف أو مصدر ينشأ منه الجزء أو طريقة لدمج عدة تدفقات أجزاء.
mediaResolution
object (MediaResolution)
اختياريّ. تمثّل هذه السمة دقة الوسائط التي تم إدخالها.
mediaProcessing
enum (MediaProcessing)
اختياريّ. كيف يعالج النموذج وسائط هذا الجزء لفهمها هذه السمة مهمة فقط لأجزاء الفيديو (inlineData أو fileData مع نوع MIME للفيديو). تتجاهل الأجزاء غير المرتبطة بالفيديو هذا الحقل.
data
Union type
data إحدى القيم التالية فقط:text
string
نص مضمّن
inlineData
object (Blob)
وحدات بايت الوسائط المضمّنة
functionCall
object (FunctionCall)
تمثّل FunctionCall متوقّعة تم إرجاعها من النموذج تحتوي على سلسلة تمثّل FunctionDeclaration.name مع الوسيطات وقيمها.
functionResponse
object (FunctionResponse)
يتم استخدام نتيجة تنفيذ FunctionCall التي تحتوي على سلسلة تمثّل FunctionDeclaration.name وعنصر JSON منظَّم يحتوي على أي ناتج من الدالة كسياق للنموذج.
fileData
object (FileData)
البيانات المستندة إلى معرّف الموارد المنتظم (URI)
executableCode
object (ExecutableCode)
الرمز الذي أنشأه النموذج والمخصّص للتنفيذ
codeExecutionResult
object (CodeExecutionResult)
نتيجة تنفيذ ExecutableCode
toolCall
object (ToolCall)
طلب استخدام أداة من جهة الخادم يتم ملء هذا الحقل عندما يتوقّع النموذج استدعاء أداة يجب تنفيذها على الخادم. من المتوقّع أن يعيد العميل إرسال هذه الرسالة إلى واجهة برمجة التطبيقات.
toolResponse
object (ToolResponse)
الناتج من تنفيذ ToolCall من جهة الخادم يملأ العميل هذا الحقل بنتائج تنفيذ ToolCall المقابل.
metadata
Union type
metadata إحدى القيم التالية فقط:videoMetadata
object (VideoMetadata)
اختياريّ. البيانات الوصفية للفيديو يجب تحديد البيانات الوصفية فقط أثناء عرض بيانات الفيديو في inlineData أو fileData.
| تمثيل JSON |
|---|
{ "thought": boolean, "thoughtSignature": string, "partMetadata": { object }, "mediaResolution": { object ( |
بلوب
وحدات بايت الوسائط الأولية
يجب عدم إرسال النص كبايتات أولية، بل استخدام الحقل "text".
mimeType
string
نوع MIME المتوافق مع معيار IANA لبيانات المصدر. أمثلة على الأنواع المتوافقة: - الصور: image/png وimage/jpeg وimage/jpg وimage/webp وimage/heic وimage/heif وimage/gif وimage/avif - الصوت: audio/* وvideo/audio/s16le وvideo/audio/wav - الفيديو: video/* - النص: text/plain وtext/html وtext/css وtext/javascript وtext/x-typescript وtext/csv وtext/markdown وtext/x-python وtext/xml وtext/rtf وvideo/text/timestamp - التطبيقات: application/x-javascript وapplication/x-typescript وapplication/x-python-code وapplication/json وapplication/x-ipynb+json وapplication/rtf وapplication/pdf لمزيد من السياق، يُرجى الاطّلاع على تنسيقات الملفات المتوافقة. //
data
string (bytes format)
وحدات البايت الأولية لتنسيقات الوسائط
سلسلة مرمّزة باستخدام Base64
| تمثيل JSON |
|---|
{ "mimeType": string, "data": string } |
FunctionCall
تمثّل FunctionCall متوقّعة تم إرجاعها من النموذج تحتوي على سلسلة تمثّل FunctionDeclaration.name مع الوسيطات وقيمها.
id
string
اختياريّ. المعرّف الفريد لطلب تنفيذ الدالة. إذا تم ملؤها، سيتم تنفيذ functionCall من خلال العميل وإرجاع الردّ مع id المطابق.
name
string
الحقل مطلوب. اسم الدالة المطلوب استدعاؤها. يجب أن يتضمّن أحرفًا من a إلى z أو من A إلى Z أو أرقامًا من 0 إلى 9 أو شرطات سفلية وواصلات، وبحد أقصى 128 حرفًا.
args
object (Struct format)
اختياريّ. مَعلمات الدالة وقيمها بتنسيق عنصر JSON
| تمثيل JSON |
|---|
{ "id": string, "name": string, "args": { object } } |
FunctionResponse
يتم استخدام نتيجة الإخراج من FunctionCall التي تحتوي على سلسلة تمثّل FunctionDeclaration.name وعنصر JSON منظَّم يحتوي على أي إخراج من الدالة كسياق للنموذج. يجب أن يحتوي هذا الحقل على نتيجة FunctionCall تم إجراؤها استنادًا إلى توقّعات النموذج.
id
string
اختياريّ. معرّف استدعاء الدالة الذي يخصّه هذا الردّ. يتم ملء هذا الحقل من خلال العميل لمطابقة استدعاء الدالة id ذي الصلة.
name
string
الحقل مطلوب. اسم الدالة المطلوب استدعاؤها. يجب أن يتضمّن أحرفًا من a إلى z أو من A إلى Z أو أرقامًا من 0 إلى 9 أو شرطات سفلية وواصلات، وبحد أقصى 128 حرفًا.
response
object (Struct format)
الحقل مطلوب. ردّ الدالة بتنسيق عنصر JSON. يمكن للمتصلين استخدام أي مفاتيح يختارونها وتناسب بنية الدالة لعرض ناتج الدالة، مثل "output" أو "result" أو غير ذلك. على وجه الخصوص، إذا تعذّر تنفيذ طلب الدالة، يمكن أن يتضمّن الردّ المفتاح "error" لعرض تفاصيل الخطأ للنموذج.
يمكن تضمين الوسائط المتعددة باستخدام عنصر فرعي يحتوي على مفتاح "$ref" واحد تكون قيمته هي inlineData.display_name لعنصر FunctionResponsePart يحتوي على الوسائط المتعددة. يُرجى الاطّلاع على https://ai.google.dev/gemini-api/docs/function-calling#multimodal.
parts[]
object (FunctionResponsePart)
اختياريّ. Parts مرتّبة تشكّل ردّ الدالة قد تحتوي الأجزاء على أنواع MIME مختلفة من IANA.
willContinue
boolean
اختياريّ. تشير إلى أنّ استدعاء الدالة مستمر، وسيتم عرض المزيد من الردود، ما يحوّل استدعاء الدالة إلى مولّد. لا ينطبق إلا على استدعاءات الدالة NON_BLOCKING، ويتم تجاهله في الحالات الأخرى. في حال ضبطها على "خطأ"، لن يتم النظر في الردود المستقبلية. يُسمح بعرض response فارغ مع willContinue=False للإشارة إلى انتهاء استدعاء الدالة. قد يؤدي ذلك إلى بدء عملية إنشاء النموذج. لتجنُّب بدء عملية الإنشاء وإنهاء استدعاء الدالة، اضبط scheduling على SILENT أيضًا.
scheduling
enum (Scheduling)
اختياريّ. تحدّد هذه السمة كيفية جدولة الرد في المحادثة. لا ينطبق إلا على استدعاءات الدالة NON_BLOCKING، ويتم تجاهله في الحالات الأخرى. القيمة التلقائية هي WHEN_IDLE.
| تمثيل JSON |
|---|
{ "id": string, "name": string, "response": { object }, "parts": [ { object ( |
FunctionResponsePart
نوع بيانات يحتوي على وسائط تشكّل جزءًا من رسالة FunctionResponse.
يتألف FunctionResponsePart من بيانات لها نوع بيانات مرتبط بها. لا يمكن أن يحتوي FunctionResponsePart إلا على نوع واحد من الأنواع المقبولة في FunctionResponsePart.data.
يجب أن يحتوي FunctionResponsePart على نوع MIME ثابت من IANA يحدّد نوع الوسائط ونوعها الفرعي إذا كان الحقل inlineData مملوءًا بوحدات بايت أولية.
data
Union type
data إحدى القيم التالية فقط:inlineData
object (FunctionResponseBlob)
وحدات بايت الوسائط المضمّنة
| تمثيل JSON |
|---|
{
// data
"inlineData": {
object ( |
FunctionResponseBlob
وحدات البايت الأولية للوسائط الخاصة بردّ الدالة
يجب عدم إرسال النص كبايتات أولية، بل استخدام الحقل FunctionResponse.response.
mimeType
string
نوع MIME المعياري الخاص بـ IANA لبيانات المصدر أمثلة: - image/png - image/jpeg في حال تقديم نوع MIME غير متوافق، سيتم عرض رسالة خطأ. للحصول على قائمة كاملة بالأنواع المتوافقة، راجِع تنسيقات الملفات المتوافقة.
data
string (bytes format)
وحدات البايت الأولية لتنسيقات الوسائط
سلسلة مرمّزة باستخدام Base64
| تمثيل JSON |
|---|
{ "mimeType": string, "data": string } |
الجدولة
تحدّد هذه السمة كيفية جدولة الرد في المحادثة.
| عمليات التعداد | |
|---|---|
SCHEDULING_UNSPECIFIED |
هذه القيمة غير مستخدَمة. |
SILENT |
أضِف النتيجة إلى سياق المحادثة فقط، ولا تقاطع المحادثة أو تبدأ عملية إنشاء الردّ. |
WHEN_IDLE |
أضِف النتيجة إلى سياق المحادثة، واطلب إنشاء الناتج بدون مقاطعة عملية الإنشاء الجارية. |
INTERRUPT |
إضافة النتيجة إلى سياق المحادثة وإيقاف عملية الإنشاء الجارية مؤقتًا وطلب إنشاء الناتج |
FileData
البيانات المستندة إلى معرّف الموارد المنتظم (URI)
mimeType
string
اختياريّ. نوع MIME المتوافق مع معيار IANA لبيانات المصدر.
fileUri
string
الحقل مطلوب. URI.
| تمثيل JSON |
|---|
{ "mimeType": string, "fileUri": string } |
ExecutableCode
التعليمات البرمجية التي ينشئها النموذج والمخصّصة للتنفيذ، والنتيجة التي يتم إرجاعها إلى النموذج
يتم إنشاؤه فقط عند استخدام أداة CodeExecution، حيث سيتم تنفيذ الرمز تلقائيًا، وسيتم أيضًا إنشاء CodeExecutionResult مطابق.
id
string
اختياريّ. المعرّف الفريد لجزء ExecutableCode يعرض الخادم CodeExecutionResult مع id المطابق.
language
enum (Language)
الحقل مطلوب. لغة البرمجة الخاصة بـ code
code
string
الحقل مطلوب. الرمز المطلوب تنفيذه
| تمثيل JSON |
|---|
{
"id": string,
"language": enum ( |
اللغة
لغات البرمجة المتوافقة مع الرمز البرمجي الذي تم إنشاؤه
| عمليات التعداد | |
|---|---|
LANGUAGE_UNSPECIFIED |
لغة غير محدّدة يجب عدم استخدام هذه القيمة. |
PYTHON |
الإصدار 3.10 من Python أو إصدار أحدث، مع توفُّر numpy وsimpy لغة Python هي اللغة التلقائية. |
CodeExecutionResult
نتيجة تنفيذ ExecutableCode
يتم إنشاؤها فقط عند استخدام الأداة CodeExecution.
id
string
اختياريّ. تمثّل هذه السمة معرّف جزء ExecutableCode الذي تعود إليه هذه النتيجة. لا تتم تعبئة هذا الحقل إلا إذا كان ExecutableCode المقابل يتضمّن معرّفًا.
outcome
enum (Outcome)
الحقل مطلوب. نتيجة تنفيذ الرمز البرمجي
output
string
اختياريّ. يحتوي على stdout عند تنفيذ الرمز البرمجي بنجاح، أو stderr أو وصف آخر في حال عدم النجاح.
| تمثيل JSON |
|---|
{
"id": string,
"outcome": enum ( |
النتيجة
تعداد النتائج المحتملة لتنفيذ الرمز البرمجي
| عمليات التعداد | |
|---|---|
OUTCOME_UNSPECIFIED |
حالة غير محدَّدة يجب عدم استخدام هذه القيمة. |
OUTCOME_OK |
اكتمل تنفيذ الرموز البرمجية بنجاح. يحتوي output على stdout، إن وُجد. |
OUTCOME_FAILED |
تعذَّر تنفيذ الرمز البرمجي. يحتوي output على stderr وstdout، إذا كانا متوفرَين. |
OUTCOME_DEADLINE_EXCEEDED |
استغرق تنفيذ الرمز البرمجي وقتًا أطول من اللازم وتم إلغاؤه. قد يكون هناك output جزئي أو لا يكون. |
ToolCall
تم عرض الخطأ ToolCall المتوقّع من جهة الخادم من النموذج. تحتوي هذه الرسالة على معلومات حول أداة يريد النموذج استدعاءها. لا يُتوقّع من العميل تنفيذ ToolCall هذا. بدلاً من ذلك، على العميل إعادة تمرير ToolCall إلى واجهة برمجة التطبيقات في ردّ لاحق ضمن رسالة Content، بالإضافة إلى ToolResponse المقابل.
id
string
اختياريّ. المعرّف الفريد لاستدعاء الأداة. يعرض الخادم ردّ الأداة مع id المطابق.
toolName
string
اختياريّ. تمثّل هذه السمة اسم الأداة التي تم استدعاؤها.
toolType
enum (ToolType)
الحقل مطلوب. نوع الأداة التي تم استدعاؤها.
args
object (Struct format)
اختياريّ. وسيطات طلب استخدام الأداة مثال: {"arg1" : "value1", "arg2" : "value2" , ...}
| تمثيل JSON |
|---|
{
"id": string,
"toolName": string,
"toolType": enum ( |
ToolType
نوع الأداة في طلب تنفيذ الدالة
| عمليات التعداد | |
|---|---|
TOOL_TYPE_UNSPECIFIED |
نوع الأداة غير محدَّد. |
GOOGLE_SEARCH_WEB |
أداة البحث من Google، وتتطابق مع Tool.google_search.search_types.web_search. |
GOOGLE_SEARCH_IMAGE |
أداة البحث بالصور، ويتم ربطها بـ Tool.google_search.search_types.image_search. |
URL_CONTEXT |
أداة سياق عنوان URL، ويتم ربطها بـ Tool.url_context. |
GOOGLE_MAPS |
أداة "خرائط Google"، ويتم ربطها بـ Tool.google_maps. |
FILE_SEARCH |
أداة البحث عن الملفات، ويتم ربطها بـ Tool.file_search. |
ToolResponse
الناتج من تنفيذ ToolCall من جهة الخادم تحتوي هذه الرسالة على نتائج استدعاء أداة بدأها ToolCall من النموذج. على العميل إعادة تمرير ToolResponse إلى واجهة برمجة التطبيقات في ردّ لاحق ضمن رسالة Content، بالإضافة إلى ToolCall المقابل.
id
string
اختياريّ. المعرّف الخاص باستدعاء الأداة الذي تم إنشاء هذا الردّ من أجله.
toolType
enum (ToolType)
الحقل مطلوب. نوع الأداة التي تم استدعاؤها، والتي تتطابق مع toolType في ToolCall المقابل
response
object (Struct format)
اختياريّ. استجابة الأداة
| تمثيل JSON |
|---|
{
"id": string,
"toolType": enum ( |
VideoMetadata
تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة GenerateContentRequest.processing_options بدلاً منها. تصف البيانات الوصفية محتوى الفيديو الذي يتم إدخاله.
startOffset
string (Duration format)
اختياريّ. تمثّل هذه السمة فرق التوقيت عند بداية الفيديو.
مدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ "s". مثال: "3.5s".
endOffset
string (Duration format)
اختياريّ. الإزاحة النهائية للفيديو
مدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ "s". مثال: "3.5s".
fps
number
اختياريّ. تمثّل هذه السمة عدد اللقطات في الثانية للفيديو الذي تم إرساله إلى النموذج. إذا لم يتم تحديدها، ستكون القيمة التلقائية 1.0. نطاق عدد اللقطات في الثانية هو (0.0, 24.0].
| تمثيل JSON |
|---|
{ "startOffset": string, "endOffset": string, "fps": number } |
MediaResolution
درجة دقة الوسائط لإنشاء الرموز المميّزة
value
Union type
value إحدى القيم التالية فقط:level
enum (Level)
جودة تقسيم المحتوى إلى رموز مميّزة المستخدَمة للوسائط المحدّدة
| تمثيل JSON |
|---|
{
// value
"level": enum ( |
المستوى
مستوى دقة الوسائط
| عمليات التعداد | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
لم يتم ضبط دقة الوسائط. |
MEDIA_RESOLUTION_LOW |
تم ضبط دقة الوسائط على منخفضة. |
MEDIA_RESOLUTION_MEDIUM |
تم ضبط دقة الوسائط على متوسطة. |
MEDIA_RESOLUTION_HIGH |
تم ضبط دقة الوسائط على "عالية". |
MEDIA_RESOLUTION_ULTRA_HIGH |
تم ضبط دقة الوسائط على فائقة الدقة. |
MediaProcessing
طريقة معالجة النموذج للوسائط المدخلة من أجل فهمها
| عمليات التعداد | |
|---|---|
MEDIA_PROCESSING_UNSPECIFIED |
تلقائي: يستخدم معالجة خاصة بالطراز (3.5 Pro+ -> AGENTIC، الطُرز الأقدم -> STATIC). |
STATIC |
استخراج اللقطات بمعدّل ثابت يتم وضع جميع اللقطات في السياق. |
AGENTIC |
التنقّل الديناميكي المستند إلى النموذج يُنصح باستخدام هذا الوضع في معظم حالات الاستخدام. |
البيئة
تمثّل هذه السمة بيئة تنفيذ لوكيل.
id
string
الحقل مطلوب. النتائج فقط. رقم تعريف البيئة.
sources[]
object (Source)
المصادر التي سيتم ربطها بالبيئة
created
string
النتائج فقط. الوقت الذي تم فيه إنشاء البيئة بتنسيق ISO 8601 (YYYY-MM-DDThh:mm:ssZ)
updated
string
النتائج فقط. تمثّل هذه السمة الوقت الذي تم فيه آخر تعديل على البيئة بتنسيق ISO 8601 (YYYY-MM-DDThh:mm:ssZ).
lastAccessed
string
النتائج فقط. تمثّل هذه السمة الوقت الذي تم فيه الوصول إلى البيئة آخر مرة بتنسيق ISO 8601 (YYYY-MM-DDThh:mm:ssZ).
status
enum (Status)
النتائج فقط. حالة حاوية البيئة.
fileCount
string (int64 format)
النتائج فقط. عدد الملفات في البيئة، نتائج فقط.
sizeBytes
string (int64 format)
النتائج فقط. الحجم الإجمالي لملفات البيئة بالبايت، ويتم عرض هذا الحقل فقط.
network
Union type
network إحدى القيم التالية فقط:networkAllowlist
object (EnvironmentNetworkEgressAllowlist)
السماح بنطاقات محدّدة فقط
networkMode
enum (NetworkMode)
وضع خروج الشبكة
| تمثيل JSON |
|---|
{ "id": string, "sources": [ { object ( |
الحالة
تمثّل هذه السمة حالة البيئة.
| عمليات التعداد | |
|---|---|
STATUS_UNSPECIFIED |
|
ACTIVE |
|
EXPIRED |
|
NetworkMode
وضع خروج الشبكة لإعدادات غير تلك المُضافة إلى القائمة المسموح بها
| عمليات التعداد | |
|---|---|
NETWORK_MODE_UNSPECIFIED |
القيمة التلقائية غير مستخدَمة |
DISABLED |
يتم حظر جميع عمليات الخروج من الشبكة. |
المخطط
يسمح العنصر 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 الحد الأدنى لطول النوع 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 والرقم
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 |
نوع القيمة الخالية |
الأداة
- تمثيل JSON
- FunctionDeclaration
- السلوك
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- الوضع
- CodeExecution
- GoogleSearch
- الفاصل الزمني
- SearchTypes
- WebSearch
- ImageSearch
- ComputerUse
- البيئة
- SafetyPolicy
- UrlContext
- FileSearch
- McpServer
- StreamableHttpTransport
- GoogleMaps
تفاصيل الأداة التي قد يستخدمها النموذج لإنشاء الرد
Tool هي جزء من الرمز البرمجي يتيح للنظام التفاعل مع أنظمة خارجية لتنفيذ إجراء أو مجموعة من الإجراءات خارج نطاق معرفة النموذج.
Next ID: 17
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 } |
مورد 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
- AudioTranscriptionConfig
- LanguageAuto
- LanguageHints
- RealtimeInputConfig
- AutomaticActivityDetection
- StartSensitivity
- EndSensitivity
- ActivityHandling
- TurnCoverage
- SessionResumptionConfig
- ContextWindowCompressionConfig
- SlidingWindow
- 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 الأكثر احتمالاً في الاعتبار. لا تسمح النماذج التي تعمل باستخدام اختيار العيّنات بناءً على الاحتمال التراكمي بإعداد topK.
ملاحظة: تختلف القيمة التلقائية حسب 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)
اختياريّ. إعدادات الترجمة
audioTranscriptionConfig
object (AudioTranscriptionConfig)
اختياريّ. إعدادات تحويل الصوت إلى نص (التعرّف على الكلام)
| تمثيل 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 } |
AudioTranscriptionConfig
إعدادات تحويل الصوت إلى نص
languageCodes[]
string
اختياريّ. رموز اللغة BCP-47 التي تقدّم تلميحات حول اللغات المتوفرة في الصوت في حال عدم تحديد اللغة أو ترك الحقل فارغًا، يتم ضبط الإعدادات التلقائية على ميزة "التعرّف التلقائي على اللغة".
adaptationPhrases[]
(deprecated)
string
اختياريّ. قائمة بالعبارات المستخدَمة لتكييف الكلام، ما يؤدي إلى تحسين نموذج التعرّف التلقائي على الكلام (ASR) للتعرّف على هذه المصطلحات المحدّدة.
customVocabulary[]
string
اختياريّ. قائمة بعبارات المفردات المخصّصة لتوجيه نموذج التعرّف على الكلام نحو التعرّف على مصطلحات معيّنة (أسماء المنتجات والأسماء الصحيحة والمصطلحات الفنية).
wordTimestamp
boolean
اختياريّ. تضبط هذه السمة عملية إنشاء طوابع زمنية على مستوى الكلمات.
diarization
boolean
اختياريّ. تضبط هذه السياسة إعدادات ميزة "تمييز أصوات المتحدّثِين".
language_config
Union type
language_codes على المستوى الأعلى بدلاً منها. يمكن أن يكون التعليق language_config إحدى القيم التالية فقط:languageAuto
(deprecated)
object (LanguageAuto)
اختياريّ. سيتعرّف النموذج على اللغة تلقائيًا.
languageHints
(deprecated)
object (LanguageHints)
اختياريّ. تحدّد هذه السمة لغة واحدة أو أكثر في الصوت.
| تمثيل JSON |
|---|
{ "languageCodes": [ string ], "adaptationPhrases": [ string ], "customVocabulary": [ string ], "wordTimestamp": boolean, "diarization": boolean, // language_config "languageAuto": { object ( |
LanguageAuto
لا يتضمّن هذا النوع أي حقول.
تشير إلى أنّه يجب التعرّف تلقائيًا على لغة الصوت.
LanguageHints
تقدّم تلميحات للنموذج بشأن اللغات المحتملة في الصوت.
languageCodes[]
(deprecated)
string
الحقل مطلوب. رموز اللغة BCP-47
| تمثيل JSON |
|---|
{ "languageCodes": [ string ] } |
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 } |
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.