يتيح 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}
مثال على الطلب
نص
Python
Node.js
انتقال
محارة
Kotlin
Swift
Dart
Java
صورة
Python
Node.js
انتقال
محارة
Kotlin
Swift
Dart
Java
الصوت
Python
Node.js
انتقال
محارة
فيديو
Python
Node.js
انتقال
محارة
Python
انتقال
محارة
Chat
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
.
نقطة نهاية
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}
مثال على الطلب
نص
Python
Node.js
انتقال
محارة
Kotlin
Swift
Dart
Java
صورة
Python
Node.js
انتقال
محارة
Kotlin
Swift
Dart
Java
الصوت
Python
انتقال
محارة
فيديو
Python
Node.js
انتقال
محارة
Python
انتقال
محارة
Chat
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
)
النتائج فقط. البيانات الوصفية المتعلقة باستخدام الرموز المميزة لطلبات الإنشاء
modelVersion
string
النتائج فقط. إصدار النموذج المستخدَم لإنشاء الردّ.
responseId
string
لإخراج البيانات فقط، ويُستخدم responseId لتحديد كل رد.
تمثيل 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 ( |
مرشح
- تمثيل JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- الويب
- 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
النتائج فقط. فهرس المرشح في قائمة المرشحين للردّ
تمثيل JSON |
---|
{ "content": { object ( |
FinishReason
تحدّد هذه السمة سبب توقّف النموذج عن إنشاء الرموز المميزة.
عمليات التعداد | |
---|---|
FINISH_REASON_UNSPECIFIED |
القيمة التلقائية هذه القيمة غير مستخدَمة. |
STOP |
نقطة التوقف الطبيعية للنموذج أو تسلسل التوقف المقدَّم |
MAX_TOKENS |
تم الوصول إلى الحد الأقصى لعدد الرموز المميّزة المحدّد في الطلب. |
SAFETY |
تم الإبلاغ عن المحتوى المرشّح للردّ لأسباب تتعلّق بالأمان. |
RECITATION |
تم الإبلاغ عن محتوى مرشّح الردّ لأسباب تتعلّق بالتلاوة. |
LANGUAGE |
تم الإبلاغ عن المحتوى المرشّح للردّ بسبب استخدام لغة غير متوافقة. |
OTHER |
السبب غير معروف. |
BLOCKLIST |
توقّف إنشاء الرموز المميزة لأنّ المحتوى يتضمّن عبارات محظورة. |
PROHIBITED_CONTENT |
تم إيقاف إنشاء الرموز المميزة لاحتمال احتوائها على محتوى محظور. |
SPII |
تم إيقاف إنشاء الرموز المميزة لأنّ المحتوى قد يتضمّن معلومات حسّاسة تكشف عن الهويّة (SPII). |
MALFORMED_FUNCTION_CALL |
طلب الدالة الذي أنشأه النموذج غير صالح. |
IMAGE_SAFETY |
توقّفت عملية إنشاء الرموز المميزة لأنّ الصور التي تم إنشاؤها تتضمّن انتهاكات متعلّقة بالأمان. |
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
طلبات البحث على الويب التي يتم إرسالها لمتابعة البحث على الويب
searchEntryPoint
object (SearchEntryPoint
)
اختيارية: إدخال البحث في Google لعمليات البحث اللاحقة على الويب
retrievalMetadata
object (RetrievalMetadata
)
البيانات الوصفية المرتبطة باسترجاع المعلومات في مسار التأسيس
تمثيل JSON |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
نقطة دخول إلى "بحث Google"
renderedContent
string
اختيارية: مقتطف من محتوى الويب يمكن تضمينه في صفحة ويب أو عرض ويب داخل تطبيق
sdkBlob
string (bytes format)
اختيارية: تمثّل هذه السمة JSON مرمّزًا بتنسيق Base64 يعرض مصفوفة من مجموعة <عبارة البحث، عنوان URL للبحث>.
سلسلة مرمّزة باستخدام Base64
تمثيل JSON |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
القطعة الأساسية
chunk_type
Union type
chunk_type
إحدى القيم التالية فقط:web
object (Web
)
جزء من المحتوى من الويب
تمثيل JSON |
---|
{
// chunk_type
"web": {
object ( |
الويب
مقتطف من الويب
uri
string
يشير إلى معرّف الموارد المنتظم (URI) الخاص بالجزء.
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
النتائج فقط. فهرس كائن "الجزء" ضِمن كائن "المحتوى" الرئيسي
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 أو لا يكونون.
تمثيل 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 بسبب حدوث خطأ. |
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
- 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 Schema الكامل، لا تتوفّر جميع الميزات. على وجه التحديد، لا تتوفّر سوى السمات التالية:
$id
$defs
$ref
$anchor
type
format
title
description
enum
(للنصوص والأرقام)items
prefixItems
minItems
maxItems
minimum
maximum
anyOf
-
oneOf
(يتم تفسيرها على النحو نفسه كما فيanyOf
) properties
additionalProperties
required
يمكن أيضًا ضبط السمة propertyOrdering
غير العادية.
يتم فك المراجع الدورية إلى حدّ معيّن، وبالتالي لا يمكن استخدامها إلا في السمات غير المطلوبة. (لا تكفي الخصائص التي تقبل القيم الخالية). إذا تم ضبط $ref
على مخطط فرعي، لا يمكن ضبط أي خصائص أخرى، باستثناء تلك التي تبدأ بـ $
.
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
اختيارية: الحد الأقصى للاحتمالية التراكمية للرموز المميّزة التي يجب أخذها في الاعتبار عند أخذ العيّنات.
يستخدم النموذج أسلوب أخذ العيّنات المجمّع Top-k وTop-p (النواة).
يتم ترتيب الرموز المميزة استنادًا إلى الاحتمالات المحدّدة لها، وبالتالي يتم أخذ الرموز المميزة الأكثر ترجيحًا فقط في الاعتبار. يحدّ أخذ العيّنات من أعلى k من الحدّ الأقصى لعدد الرموز المميّزة التي يجب أخذها في الاعتبار، بينما يحدّ أخذ العيّنات من النواة من عدد الرموز المميّزة استنادًا إلى الاحتمال التراكمي.
ملاحظة: تختلف القيمة التلقائية حسب Model
ويتم تحديدها من خلال السمة Model.top_p
التي تعرضها الدالة getModel
. تشير السمة topK
الفارغة إلى أنّ النموذج لا يطبّق أخذ العيّنات من أعلى k، ولا يسمح بضبط topK
على الطلبات.
topK
integer
اختيارية: الحد الأقصى لعدد الرموز المميزة التي يجب أخذها في الاعتبار عند أخذ العيّنات
تستخدم نماذج Gemini أسلوب أخذ العيّنات Top-p (النواة) أو مزيجًا من أسلوبَي أخذ العيّنات Top-k والنواة. تأخذ عملية أخذ العيّنات من أعلى k مجموعة الرموز المميزة topK
الأكثر احتمالاً في الاعتبار. لا تسمح النماذج التي تعمل باستخدام أخذ العينات من النواة بإعداد topK.
ملاحظة: تختلف القيمة التلقائية حسب Model
ويتم تحديدها من خلال السمة Model.top_p
التي تعرضها الدالة getModel
. تشير السمة topK
الفارغة إلى أنّ النموذج لا يطبّق أخذ العيّنات من أعلى k، ولا يسمح بضبط topK
على الطلبات.
seed
integer
اختيارية: العبارة الأساسية المستخدَمة في فك التشفير في حال عدم ضبط هذه القيمة، يستخدم الطلب قيمة أولية تم إنشاؤها عشوائيًا.
presencePenalty
number
اختيارية: يتم تطبيق عقوبة الحضور على logprobs للرمز المميز التالي إذا سبق أن تم عرض الرمز المميز في الرد.
هذه العقوبة هي عقوبة ثنائية (مفعلة أو غير مفعلة) ولا تعتمد على عدد المرات التي يتم فيها استخدام الرمز المميّز (بعد المرة الأولى). استخدِم frequencyPenalty
لفرض غرامة تزداد مع كل استخدام.
ستؤدي العقوبة الإيجابية إلى تثبيط استخدام الرموز المميزة التي سبق استخدامها في الرد، ما يزيد من المفردات.
ستشجّع العقوبة السلبية على استخدام الرموز المميزة التي تم استخدامها من قبل في الردّ، ما يؤدي إلى تقليل المفردات.
frequencyPenalty
number
اختيارية: يتم تطبيق عقوبة عدد مرات الظهور على احتمالات تسجيل الرمز المميز التالي، ويتم ضربها في عدد المرات التي ظهر فيها كل رمز مميز في الرد حتى الآن.
ستؤدي العقوبة الإيجابية إلى تثبيط استخدام الرموز المميزة التي سبق استخدامها، بما يتناسب مع عدد المرات التي تم فيها استخدام الرمز المميز: كلما زاد استخدام الرمز المميز، زادت صعوبة استخدام النموذج لهذا الرمز المميز مرة أخرى، ما يؤدي إلى زيادة مفردات الردود.
تنبيه: ستشجّع العقوبة السالبة النموذج على إعادة استخدام الرموز المميزة بما يتناسب مع عدد المرات التي تم فيها استخدام الرمز المميز. ستؤدي القيم السلبية الصغيرة إلى تقليل مفردات الرد. ستؤدي القيم السالبة الأكبر إلى بدء النموذج في تكرار رمز مميز شائع إلى أن يصل إلى الحدّ الأقصى وهو maxOutputTokens
.
responseLogprobs
boolean
اختيارية: إذا كانت القيمة true، سيتم تصدير نتائج logprobs في الردّ.
logprobs
integer
اختيارية: لا يسري إلا إذا كان responseLogprobs=True
. يضبط هذا الخيار عدد أعلى قيم logprobs المطلوب إرجاعها في كل خطوة فك ترميز في Candidate.logprobs_result
.
enableEnhancedCivicAnswers
boolean
اختيارية: تفعيل الإجابات المحسّنة حول المواضيع المدنية قد لا تتوفّر هذه الميزة في بعض الطُرز.
speechConfig
object (SpeechConfig
)
اختيارية: إعدادات إنشاء الكلام
thinkingConfig
object (ThinkingConfig
)
اختيارية: إعدادات ميزات التفكير سيتم عرض خطأ إذا تم ضبط هذا الحقل على نماذج لا تتيح التفكير.
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، مثلاً "en-US") لتركيب الكلام
القيم الصالحة هي: 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
عدد الرموز المميزة للأفكار التي يجب أن ينشئها النموذج.
تمثيل JSON |
---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
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: المحتوى الذي قد يُستخدم للإضرار بالنزاهة المدنية |
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 |
سيُسمح بالمحتوى الذي يتضمّن تصنيفات NEGLIGIBLE وLOW وMEDIUM. |
BLOCK_NONE |
سيتم السماح بكل المحتوى. |
OFF |
أوقِف فلتر الأمان. |