تتيح واجهة برمجة التطبيقات Gemini API إنشاء المحتوى باستخدام الصور والصوت والرموز البرمجية والأدوات وغير ذلك. للاطّلاع على تفاصيل حول كلّ من هذه الميزات، واصِل القراءة واطّلِع على نموذج الرموز البرمجية المخصّص للمهام، أو اطّلِع على الأدلة الشاملة.
الطريقة: models.generateContent
تُنشئ نموذجًا للردّ استنادًا إلى إدخال GenerateContentRequest
. يُرجى الرجوع إلى دليل إنشاء النصوص للحصول على معلومات تفصيلية عن الاستخدام. تختلف إمكانات الإدخال بين النماذج، بما في ذلك النماذج المحسّنة. يُرجى الرجوع إلى دليل النماذج ودليل الضبط للاطّلاع على التفاصيل.
نقطة نهاية
post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateContentمَعلمات المسار
model
string
مطلوب. اسم Model
المطلوب استخدامه لإنشاء الإكمال.
التنسيق: name=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
محدّدة في "إعدادات الأمان". إذا لم يكن هناك SafetySetting
لـ SafetyCategory
معيّن مقدَّم في القائمة، ستستخدم واجهة برمجة التطبيقات إعدادات السلامة التلقائية لهذه الفئة. يمكن استخدام فئات المحتوى الضار HARM_CATEGORY_HATE_SPEECH وHARM_CATEGORY_SEXUALLY_EXPLICIT وHARM_CATEGORY_DANGEROUS_CONTENT وHARM_CATEGORY_HARASSMENT. يُرجى الرجوع إلى الدليل للحصول على معلومات تفصيلية عن إعدادات الأمان المتاحة. يمكنك أيضًا الرجوع إلى إرشادات السلامة للتعرّف على كيفية دمج اعتبارات السلامة في تطبيقات الذكاء الاصطناعي.
systemInstruction
object (Content
)
اختياريّ. يضبط المطوّر تعليمات النظام. تتوفّر حاليًا النصوص فقط.
generationConfig
object (GenerationConfig
)
اختياريّ. خيارات الضبط لإنشاء النماذج والنواتج
cachedContent
string
اختياريّ. اسم المحتوى المخزّن مؤقتًا لاستخدامه كسياق لعرض التوقّعات تنسيق الملف: cachedContents/{cachedContent}
مثال على الطلب
نص
Python
Node.js
البدء
صَدفة
Kotlin
Swift
Dart
Java
صورة
Python
Node.js
البدء
صَدفة
Kotlin
Swift
Dart
Java
الصوت
Python
Node.js
صَدفة
فيديو
Python
Node.js
البدء
صَدفة
Python
صَدفة
دردشة
Python
Node.js
البدء
صَدفة
Kotlin
Swift
Dart
Java
ذاكرة التخزين المؤقت
Python
Node.js
النموذج المحسَّن
Python
وضع JSON
Python
Node.js
البدء
صَدفة
Kotlin
Swift
Dart
Java
تنفيذ الرمز البرمجي
Python
Kotlin
Java
استدعاء الدالة
Python
Node.js
صَدفة
Kotlin
Swift
Dart
Java
إعدادات الإنشاء
Python
Node.js
البدء
صَدفة
Kotlin
Swift
Dart
Java
إعدادات الأمان
Python
Node.js
البدء
صَدفة
Kotlin
Swift
Dart
Java
تعليمات النظام
Python
Node.js
البدء
صَدفة
Kotlin
Swift
Dart
Java
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال GenerateContentResponse
.
الطريقة: models.streamGenerateContent
تُنشئ استجابة مُذاعة من النموذج استنادًا إلى إدخال GenerateContentRequest
.
نقطة نهاية
مشاركة https://generativelanguage.googleapis.com/v1beta/{model=models/*}:streamGenerateContentمَعلمات المسار
model
string
مطلوب. اسم Model
المطلوب استخدامه لإنشاء الإكمال.
التنسيق: name=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 متاحة. يُرجى الرجوع إلى الدليل للحصول على معلومات تفصيلية عن إعدادات الأمان المتاحة. يمكنك أيضًا الرجوع إلى إرشادات السلامة للتعرّف على كيفية دمج اعتبارات السلامة في تطبيقات الذكاء الاصطناعي.
systemInstruction
object (Content
)
اختياريّ. يضبط المطوّر تعليمات النظام. وهي متاحة حاليًا عبر الرسائل النصية فقط.
generationConfig
object (GenerationConfig
)
اختياريّ. خيارات الضبط لإنشاء النماذج والنواتج
cachedContent
string
اختياريّ. اسم المحتوى المخزّن مؤقتًا لاستخدامه كسياق لعرض التوقّعات التنسيق: cachedContents/{cachedContent}
مثال على الطلب
نص
Python
Node.js
البدء
صَدفة
Kotlin
Swift
Dart
Java
صورة
Python
Node.js
البدء
صَدفة
Kotlin
Swift
Dart
Java
الصوت
Python
صَدفة
فيديو
Python
Node.js
البدء
صَدفة
Python
صَدفة
دردشة
Python
Node.js
البدء
صَدفة
Kotlin
Swift
Dart
Java
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على بثّ لعناصر GenerateContentResponse
.
GenerateContentResponse
استجابة من النموذج تتيح عدّة إجابات مرشحة
يتم تسجيل تقييمات السلامة وفلترة المحتوى لكل من الطلب في GenerateContentResponse.prompt_feedback
ولكل نموذج في finishReason
وsafetyRatings
. واجهة برمجة التطبيقات: - تعرض جميع المرشحين المطلوبين أو لا تعرض أيّ منهم - لا تعرض أيّ مرشحين على الإطلاق إلا إذا كان هناك خطأ في الطلب (التحقّق من promptFeedback
) - تُبلغ عن الملاحظات بشأن كلّ مرشّح في finishReason
وsafetyRatings
.
candidates[]
object (Candidate
)
ردود المرشحين من النموذج
promptFeedback
object (PromptFeedback
)
تعرِض هذه السمة ملاحظات الطلب المتعلّقة بفلاتر المحتوى.
usageMetadata
object (UsageMetadata
)
النتائج فقط. البيانات الوصفية حول استخدام الرموز المميّزة لطلبات الإنشاء
تمثيل 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 |
تم حظر الطلب بسبب محتوى محظور. |
UsageMetadata
البيانات الوصفية المتعلقة باستخدام الرمز المميّز لطلب الإنشاء
promptTokenCount
integer
عدد الرموز المميّزة في الطلب عند ضبط القيمة cachedContent
، يظلّ هذا هو إجمالي حجم الطلب الفعّال، ما يعني أنّه يشمل عدد الرموز المميّزة في المحتوى المخزّن مؤقتًا.
cachedContentTokenCount
integer
عدد الرموز المميّزة في الجزء المُخزَّن مؤقتًا من الطلب (المحتوى المُخزَّن مؤقتًا)
candidatesTokenCount
integer
إجمالي عدد الرموز في جميع الردود المُحتمَلة التي تم إنشاؤها
totalTokenCount
integer
إجمالي عدد الرموز المميّزة لطلب الإنشاء (الطلب + المرشحون للردّ)
تمثيل JSON |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "totalTokenCount": integer } |
مرشح
- تمثيل JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- الويب
- GroundingSupport
- القسم
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- المرشّح
عبارة مرشحة للردّ تم إنشاؤها من النموذج.
content
object (Content
)
النتائج فقط. المحتوى الذي تم إنشاؤه وتم عرضه من النموذج
finishReason
enum (FinishReason
)
اختياريّ. النتائج فقط. سبب توقّف النموذج عن إنشاء الرموز المميّزة
إذا كان الحقل فارغًا، يعني ذلك أنّ النموذج لم يتوقف عن إنشاء الرموز المميّزة.
safetyRatings[]
object (SafetyRating
)
قائمة بتقييمات أمان المرشح للردّ
يجب أن يكون هناك تقييم واحد كحد أقصى لكل فئة.
citationMetadata
object (CitationMetadata
)
النتائج فقط. معلومات الاقتباس للمرشح الذي تم إنشاؤه بالاستناد إلى نموذج
قد تتم تعبئة هذا الحقل بمعلومات حول القراءة لأي نص مضمّن في content
. هذه الفقرات هي الفقرات التي يتم "تلاقيها" من مواد محمية بحقوق الطبع والنشر ضمن بيانات تدريب النموذج اللغوي الكبير (LLM) الأساسي.
tokenCount
integer
النتائج فقط. عدد الرموز المميّزة لهذا المرشّح.
groundingAttributions[]
object (GroundingAttribution
)
النتائج فقط. معلومات الإسناد للمصادر التي ساهمت في تقديم إجابة مستندة إلى الحقائق
تتم تعبئة هذا الحقل لمكالمات GenerateAnswer
.
groundingMetadata
object (GroundingMetadata
)
النتائج فقط. البيانات الوصفية الأساسية للمرشح
يتمّ ملء هذا الحقل لطلبات GenerateContent
.
avgLogprobs
number
النتائج فقط.
logprobsResult
object (LogprobsResult
)
النتائج فقط. نتائج الاحتمالية اللوغاريتمية لعلامات الاستجابة وعلامات الترميز الرئيسية
index
integer
النتائج فقط. فهرس المرشح في قائمة مرشّحي الردود
تمثيل JSON |
---|
{ "content": { object ( |
FinishReason
يحدِّد سبب توقُّف النموذج عن إنشاء الرموز المميّزة.
عمليات التعداد | |
---|---|
FINISH_REASON_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
STOP |
نقطة التوقف الطبيعية للنموذج أو تسلسل التوقف المقدَّم |
MAX_TOKENS |
تم الوصول إلى الحدّ الأقصى لعدد الرموز المميّزة على النحو المحدّد في الطلب. |
SAFETY |
تم الإبلاغ عن المحتوى المُقترَح للردّ لأسباب تتعلّق بالأمان. |
RECITATION |
تم الإبلاغ عن محتوى المرشح للردّ لأسباب تتعلّق بالقراءة. |
LANGUAGE |
تم الإبلاغ عن المحتوى المرشّح للرد بسبب استخدام لغة غير متاحة. |
OTHER |
سبب غير معروف |
BLOCKLIST |
توقّف إنشاء الرمز المميّز لأنّ المحتوى يتضمّن عبارات محظورة. |
PROHIBITED_CONTENT |
تم إيقاف إنشاء الرمز المميّز لأنّه يُحتمل أن يتضمّن محتوى محظورًا. |
SPII |
تم إيقاف إنشاء الرموز المميّزة لأنّه من المحتمل أن يتضمّن المحتوى معلومات حسّاسة تكشف عن الهويّة (SPII). |
MALFORMED_FUNCTION_CALL |
طلب الدالة الذي أنشأه النموذج غير صالح. |
GroundingAttribution
مصدر مساهم في الإجابة
sourceId
object (AttributionSourceId
)
النتائج فقط. معرّف المصدر الذي يساهم في عملية تحديد المصدر هذه
content
object (Content
)
يشير إلى محتوى المصدر الأساسي الذي يتألّف من عملية تحديد المصدر.
تمثيل JSON |
---|
{ "sourceId": { object ( |
AttributionSourceId
معرّف المصدر الذي يساهم في عملية تحديد المصدر هذه
حقل الربط source
يمكن أن يكون source
واحدًا فقط مما يلي:
groundingPassage
object (GroundingPassageId
)
معرّف لمقطع مضمّن
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
معرّف Chunk
تم استرجاعه من خلال "أداة استرجاع المحتوى الدلالي"
تمثيل JSON |
---|
{ // Union field |
GroundingPassageId
معرّف لجزء ضمن GroundingPassage
passageId
string
النتائج فقط. رقم تعريف الفقرة التي تتطابق مع GroundingPassage.id
في GenerateAnswerRequest
partIndex
integer
النتائج فقط. فهرس الجزء ضمن GroundingPassage.content
في GenerateAnswerRequest
تمثيل JSON |
---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
معرّف Chunk
الذي تم استرجاعه من خلال "أداة استرجاع المحتوى الدلالي" المحدّدة في 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
طلبات بحث الويب لمتابعة بحث الويب
searchEntryPoint
object (SearchEntryPoint
)
اختياريّ. إدخال بحث Google لإجراء عمليات بحث لاحقة على الويب
retrievalMetadata
object (RetrievalMetadata
)
البيانات الوصفية ذات الصلة بالاسترداد في عملية التأصيل
تمثيل JSON |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
نقطة دخول "بحث Google"
renderedContent
string
اختياريّ. مقتطف محتوى الويب الذي يمكن تضمينه في صفحة ويب أو WebView في تطبيق.
sdkBlob
string (bytes format)
اختياريّ. تنسيق JSON بترميز Base64 يمثّل صفيفًا من مجموعة <عبارة البحث، عنوان URL للبحث>.
سلسلة بترميز base64
تمثيل JSON |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
مجموعة بيانات أساسية
chunk_type
. نوع المقطع يمكن أن يكون chunk_type
واحدًا فقط مما يلي:
web
object (Web
)
قطعة أساسية من الويب.
تمثيل JSON |
---|
{ // Union field |
الويب
مقتطف من الويب
uri
string
مرجع معرّف الموارد المنتظم للقطعة
title
string
عنوان المقطع
تمثيل JSON |
---|
{ "uri": string, "title": string } |
GroundingSupport
دعم التأريض
groundingChunkIndices[]
integer
قائمة بالفهارس (إلى 'grounding_chunk') تحدّد الاقتباسات المرتبطة بالمطالبة. على سبيل المثال، يعني [1,3,4] أنّ grounding_chunk[1] وgrounding_chunk[3] وgrounding_chunk[4] هي المحتوى الذي تم استرجاعه والمرتبط بالمطالبة.
confidenceScores[]
number
درجة الثقة في مراجع الدعم تتراوح بين 0 و1. 1 هو الأكثر ثقة. يجب أن تكون هذه القائمة بالحجم نفسه مثل groundingChunkIndices.
segment
object (Segment
)
جزء من المحتوى الذي ينتمي إليه هذا الدعم
تمثيل JSON |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
تقسيم
جزء من المحتوى
partIndex
integer
النتائج فقط. فهرس عنصر Part ضمن عنصر Content الرئيسي
startIndex
integer
النتائج فقط. فهرس البدء في الجزء المحدّد، ويقاس بوحدات البايت. معادلة من بداية الجزء، شاملة، تبدأ من الصفر.
endIndex
integer
النتائج فقط. فهرس النهاية في الجزء المحدَّد، ويقاس بالبايت. القيمة المضافة إلى بداية الجزء، حصرية، تبدأ من القيمة صفر.
text
string
النتائج فقط. النص المقابل للقطعة من الردّ
تمثيل JSON |
---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
البيانات الوصفية ذات الصلة بالاسترداد في عملية التأصيل
googleSearchDynamicRetrievalScore
number
اختياريّ. نتيجة تشير إلى مدى احتمالية أن تساعد المعلومات الواردة من "بحث Google" في الإجابة عن الطلب. تقع النتيجة في النطاق [0, 1]، حيث يشير الصفر إلى أقل احتمال و1 إلى أعلى احتمال. لا تتم تعبئة هذه النتيجة إلا عند تفعيل ميزة "الربط بنتائج البحث من Google" وميزة "الاسترداد الديناميكي". وسيتمّ مقارنتها بالحدّ الأدنى لتحديد ما إذا كان سيتمّ تفعيل "بحث Google".
تمثيل JSON |
---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
نتيجة Logprobs
topCandidates[]
object (TopCandidates
)
الطول = إجمالي عدد خطوات فك التشفير
chosenCandidates[]
object (Candidate
)
الطول = إجمالي عدد خطوات فك التشفير وقد يكون أو لا يكون المرشحون المحدّدون من بين أفضل المرشحين.
تمثيل JSON |
---|
{ "topCandidates": [ { object ( |
TopCandidates
المرشّحات التي تتضمن أعلى احتمالات السجلّ في كل خطوة من خطوات فك التشفير
candidates[]
object (Candidate
)
تم ترتيبها تنازليًا حسب اللوغاريتم اللوغاريتمي لاحتمالات حدوثها.
تمثيل JSON |
---|
{
"candidates": [
{
object ( |
مرشح
مرشح لرمز logprobs وعلامته
token
string
قيمة سلسلة الرمز المميّز للمرشح.
tokenId
integer
قيمة معرّف الرمز المميّز للمرشّح
logProbability
number
احتمالية سجل المرشح.
تمثيل JSON |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
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
خيارات الضبط لإنشاء النماذج والنواتج لا يمكن ضبط بعض المَعلمات لكلّ نموذج.
stopSequences[]
string
اختياريّ. مجموعة تسلسلات الأحرف (ما يصل إلى 5) التي ستؤدي إلى إيقاف إنشاء الإخراج في حال تحديد هذا الحقل، ستتوقف واجهة برمجة التطبيقات عند أول ظهور لـ stop_sequence
. لن يتم تضمين تسلسل الإيقاف كجزء من الاستجابة.
responseMimeType
string
اختياريّ. نوع MIME للنص المُقترَح الذي تم إنشاؤه أنواع MIME المتوافقة هي: text/plain
: (تلقائي) إخراج نصي. application/json
: استجابة JSON في العناصر المُحتمَلة للاستجابة text/x.enum
: ENUM كسلسلة ردّ في المرشحين للردّ يُرجى الرجوع إلى المستندات للحصول على قائمة بجميع أنواع MIME النصية المتوافقة.
responseSchema
object (Schema
)
اختياريّ. مخطّط الإخراج للنص المقترَح الذي تم إنشاؤه يجب أن تكون المخططات مجموعة فرعية من مخطّط OpenAPI ويمكن أن تكون عناصر أو عناصر أساسية أو صفائف.
في حال ضبط responseMimeType
، يجب أيضًا ضبط responseMimeType
متوافق. أنواع MIME المتوافقة: application/json
: مخطط لاستجابة JSON. راجِع دليل إنشاء النصوص بتنسيق JSON للاطّلاع على مزيد من التفاصيل.
candidateCount
integer
اختياريّ. عدد الردود التي تم إنشاؤها المطلوب عرضها.
لا يمكن حاليًا ضبط هذه القيمة إلا على 1. في حال عدم ضبط هذا الخيار، سيتم ضبطه تلقائيًا على 1.
maxOutputTokens
integer
اختياريّ. الحد الأقصى لعدد الرموز المميّزة المطلوب تضمينها في أحد الردود المُحتمَلة
ملاحظة: تختلف القيمة التلقائية حسب الطراز، اطّلِع على سمة Model.output_token_limit
للعنصر Model
الذي تم إرجاعه من الدالة getModel
.
temperature
number
اختياريّ. تتحكّم هذه السمة في العشوائية في الإخراج.
ملاحظة: تختلف القيمة التلقائية حسب الطراز، اطّلِع على سمة Model.temperature
للعنصر Model
الذي تم إرجاعه من الدالة getModel
.
يمكن أن تتراوح القيم بين [0.0, 2.0].
topP
number
اختياريّ. يشير ذلك المصطلح إلى الحد الأقصى للاحتمالية التراكمية للرموز المميّزة التي يجب أخذها في الاعتبار عند جمع العيّنات.
يستخدم النموذج أسلوب أخذ العينات من النوعَين Top-k وTop-p (النواة).
يتم ترتيب الرموز بناءً على الاحتمالات المحدّدة لها حتى لا يتمّ أخذ سوى الرموز الأكثر احتمالًا في الاعتبار. يحدّ أسلوب أخذ عيّنات من أهمّ k عنصرًا مباشرةً من الحدّ الأقصى لعدد الرموز التي يجب أخذها في الاعتبار، في حين يحدّ أسلوب أخذ عيّنات من نواة النصّ من عدد الرموز استنادًا إلى الاحتمالية التراكمية.
ملاحظة: تختلف القيمة التلقائية حسب Model
ويتم تحديدها من خلال السمة Model.top_p
التي يتم عرضها من دالة getModel
. تشير السمة topK
الفارغة إلى أنّ النموذج لا يطبّق تحليل عيّنات "أهم k" ولا يسمح بضبط topK
على الطلبات.
topK
integer
اختياريّ. يشير ذلك المصطلح إلى الحد الأقصى لعدد الرموز المميّزة التي يجب أخذها في الاعتبار عند جمع العيّنات.
تستخدِم نماذج Gemini أسلوب أخذ عيّنات Top-p (النواة) أو مزيجًا من أسلوب أخذ عيّنات Top-k وأسلوب أخذ عيّنات النواة. وفي أخذ العيّنات الأعلى درجة في الاعتبار، يتم جمع topK
من الرموز المميّزة الأكثر ترجيحًا. لا تسمح النماذج التي تعمل باستخدام تحليل عيّنات النوى بإعداد topK.
ملاحظة: تختلف القيمة التلقائية حسب Model
ويتم تحديدها من خلال السمة Model.top_p
التي يتم عرضها من دالة getModel
. تشير السمة topK
الفارغة إلى أنّ النموذج لا يطبّق تحليل عيّنات "أهم k" ولا يسمح بضبط topK
على الطلبات.
presencePenalty
number
اختياريّ. يتم تطبيق عقوبة الحضور على logprobs للرمز المميّز التالي إذا سبق أن ظهر الرمز المميّز في الاستجابة.
تكون هذه العقوبة تفعيل/إيقاف تشغيل ثنائي ولا تعتمد على عدد مرات استخدام الرمز (بعد الأول). استخدِم frequencyPenalty
لفرض عقوبة تزداد مع كل استخدام.
ستؤدي العقوبة الإيجابية إلى عدم استخدام الرموز التي سبق استخدامها في الردّ، ما يؤدي إلى زيادة المفردات.
ستشجّع العقوبة السلبية استخدام الرموز التي سبق استخدامها في الردّ، ما يؤدي إلى تقليل المفردات.
frequencyPenalty
number
اختياريّ. يتم تطبيق عقوبة التكرار على سجلّ الطلبات للرمز المميّز التالي، مضروبًا في عدد مرات ظهور كل رمز مميّز في الردّ حتى الآن.
ستؤدي العقوبة الإيجابية إلى عدم استخدام الرموز المميزة التي سبق استخدامها، وذلك بما يتناسب مع عدد المرات التي تم فيها استخدام الرمز المميّز: وكلما زاد استخدام الرمز المميّز، زادت صعوبة استخدام النموذج لهذا الرمز المميّز مرة أخرى، ما يؤدي إلى زيادة مفردات الردود.
تحذير: ستشجّع العقوبة السلبية النموذج على إعادة استخدام الرموز المميّزة بما يتناسب مع عدد المرات التي تم فيها استخدام الرمز المميّز. ستؤدي القيم السلبية الصغيرة إلى تقليل مفردات الردّ. ستؤدي القيم السالبة الأكبر إلى بدء تكرار النموذج لوحدة ترميز شائعة إلى أن يصل إلى الحدّ الأقصى maxOutputTokens
: "...the the the the the...".
responseLogprobs
boolean
اختياريّ. إذا كانت القيمة هي true، يتم تصدير نتائج logprobs في الردّ.
logprobs
integer
اختياريّ. لا يكون صالحًا إلا إذا كان responseLogprobs=True
. يؤدي ذلك إلى تحديد عدد أهم السجلّات التي سيتم عرضها في كل خطوة من خطوات فك الترميز في Candidate.logprobs_result
.
تمثيل JSON |
---|
{
"stopSequences": [
string
],
"responseMimeType": string,
"responseSchema": {
object ( |
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: المحتوى الذي يمكن استخدامه للإضرار بالنزاهة المدنية |
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 |
سيتم السماح بالمحتوى الذي يتضمّن NEGLIGIBLE. |
BLOCK_MEDIUM_AND_ABOVE |
سيتم السماح بالمحتوى الذي يتضمن تقييمَي NEGLIGIBLE وLOW. |
BLOCK_ONLY_HIGH |
سيتم السماح بالمحتوى الذي يتضمن قيم "منخفضة" و"متوسطة" و"منخفضة جدًا". |
BLOCK_NONE |
سيتم السماح بكل المحتوى. |
OFF |
أوقِف فلتر الأمان. |