تتيح Gemini API إنشاء المحتوى باستخدام الصور والملفات الصوتية والرموز البرمجية والأدوات وغير ذلك. للاطّلاع على تفاصيل حول كل من هذه الميزات، واصِل القراءة واطّلِع على نموذج الرمز البرمجي الذي يركّز على المهام، أو اقرأ الأدلة الشاملة.
الطريقة: 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. راجِع الدليل للحصول على معلومات تفصيلية حول إعدادات الأمان المتاحة. يمكنك أيضًا الرجوع إلى إرشادات الأمان للتعرّف على كيفية تضمين اعتبارات الأمان في تطبيقات الذكاء الاصطناعي.
systemInstruction
object (Content)
اختياريّ. يضع المطوّر تعليمات النظام. في الوقت الحالي، يمكن إدخال نص فقط.
generationConfig
object (GenerationConfig)
اختياريّ. خيارات الإعداد لإنشاء النماذج والنتائج
cachedContent
string
اختياريّ. اسم المحتوى المخزَّن مؤقتًا لاستخدامه كسياق لعرض التوقّع التنسيق: cachedContents/{cachedContent}
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. راجِع الدليل للحصول على معلومات تفصيلية حول إعدادات الأمان المتاحة. يمكنك أيضًا الرجوع إلى إرشادات الأمان للتعرّف على كيفية تضمين اعتبارات الأمان في تطبيقات الذكاء الاصطناعي.
systemInstruction
object (Content)
اختياريّ. يضع المطوّر تعليمات النظام. في الوقت الحالي، يمكن إدخال نص فقط.
generationConfig
object (GenerationConfig)
اختياريّ. خيارات الإعداد لإنشاء النماذج والنتائج
cachedContent
string
اختياريّ. اسم المحتوى المخزَّن مؤقتًا لاستخدامه كسياق لعرض التوقّع التنسيق: cachedContents/{cachedContent}
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)
النتائج فقط. قائمة بالوسائط التي تمت معالجتها لإدخالات طلب استخدام الأدوات
| تمثيل 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 |
تم إنهاء المحادثة بسبب ردّ مكتوب بشكل غير صحيح. |
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
| تمثيل 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" يتوافق جزء "خرائط 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 } |
GenerationConfig
- تمثيل JSON
- نمط البيانات
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- ThinkingLevel
- ImageConfig
- MediaResolution
خيارات الإعداد لإنشاء النماذج والنتائج لا يمكن ضبط جميع المَعلمات لكل نموذج.
stopSequences[]
string
اختياريّ. مجموعة تسلسلات الأحرف (حتى 5) التي ستؤدي إلى إيقاف إنشاء الناتج. في حال تحديدها، ستتوقف واجهة برمجة التطبيقات عند ظهور stop_sequence للمرة الأولى. لن يتم تضمين تسلسل الإيقاف كجزء من الرد.
responseMimeType
string
اختياريّ. نوع MIME للنص المرشّح الذي تم إنشاؤه. أنواع MIME المتوافقة هي: text/plain: (تلقائي) إخراج نصي. application/json: استجابة JSON في المرشّحين للاستجابة text/x.enum: ENUM كاستجابة سلسلة في المرشحين للاستجابة. يُرجى الرجوع إلى المستندات للاطّلاع على قائمة بجميع أنواع MIME المتوافقة مع النصوص.
responseSchema
object (Schema)
اختياريّ. مخطط الإخراج للنص المرشّح الذي تم إنشاؤه. يجب أن تكون المخططات مجموعة فرعية من مخطط OpenAPI ويمكن أن تكون كائنات أو أنواعًا أساسية أو مصفوفات.
في حال ضبط هذه السياسة، يجب أيضًا ضبط سياسة responseMimeType متوافقة. أنواع MIME المتوافقة: application/json: مخطط لاستجابة JSON. راجِع دليل إنشاء نص JSON لمزيد من التفاصيل.
_responseJsonSchema
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
اختياريّ. يتم تطبيق عقوبة عدد مرات الظهور على logprobs للرمز المميز التالي، مضروبًا في عدد المرات التي ظهر فيها كل رمز مميز في الرد حتى الآن.
ستؤدي العقوبة الإيجابية إلى تثبيط استخدام الرموز المميزة التي سبق استخدامها، بما يتناسب مع عدد المرات التي تم فيها استخدام الرمز المميز: كلما زاد استخدام الرمز المميز، زادت صعوبة استخدام النموذج لهذا الرمز المميز مرة أخرى، ما يؤدي إلى زيادة مفردات الردود.
تنبيه: ستشجّع العقوبة السالبة النموذج على إعادة استخدام الرموز المميزة بما يتناسب مع عدد المرات التي تم فيها استخدام الرمز المميز. ستؤدي القيم السلبية الصغيرة إلى تقليل مفردات الردّ. ستؤدي القيم السالبة الأكبر إلى بدء النموذج في تكرار رمز مميز شائع إلى أن يصل إلى الحدّ الأقصى البالغ 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)
اختياريّ. في حال تحديدها، سيتم استخدام درجة دقة الوسائط المحدّدة.
| تمثيل 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)
اختياريّ. تتحكّم هذه السمة في الحدّ الأقصى لعمق عملية الاستدلال الداخلية للنموذج قبل أن ينتج ردًا. إذا لم يتم تحديدها، تكون القيمة التلقائية هي HIGH. يُنصح به لطُرز 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 رمزًا مميزًا). |
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 بدلاً منها. |
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 |
سيُسمح بالمحتوى الذي يتضمّن تصنيفًا بـ "ضئيل" و"منخفض". |
BLOCK_ONLY_HIGH |
سيُسمح بالمحتوى الذي يتضمّن مستوى خطورة "ضئيل" و"منخفض" و"متوسط". |
BLOCK_NONE |
سيتم السماح بكل المحتوى. |
OFF |
أوقِف فلتر الأمان. |