- تمثيل JSON
- المرشح
- FinishReason
- SafetyRating
- HarmProbability
- CitationMetadata
- CitationSource
- PromptFeedback
- BlockReason
- UsageMetadata
رد من النموذج يدعم عدة مرشحين.
ملاحظة بشأن تقييمات الأمان وفلترة المحتوى يتم الإبلاغ عنها لكل من الطلب في GenerateContentResponse.prompt_feedback
ولكل مرشّح في finishReason
وفي safetyRatings
. ينص عقد واجهة برمجة التطبيقات على ما يلي: إما عرض جميع المرشحين المطلوبين أو عدم إرجاع أي مرشح على الإطلاق - وعدم عرض أي مرشحين فقط في حال وجود خطأ في الطلب (يُرجى الاطّلاع على promptFeedback
) - يتم الإبلاغ عن الملاحظات بشأن كل مرشّح في finishReason
وsafetyRatings
.
تمثيل JSON |
---|
{ "candidates": [ { object ( |
الحقول | |
---|---|
candidates[] |
ردود المرشح من النموذج. |
promptFeedback |
عرض ملاحظات عن الطلب ذات صلة بفلاتر المحتوى |
usageMetadata |
النتائج فقط. البيانات الوصفية حول استخدام الرمز المميّز لطلبات الإنشاء |
مرشح
استجابة مرشحة من النموذج.
تمثيل JSON |
---|
{ "content": { object ( |
الحقول | |
---|---|
content |
النتائج فقط. المحتوى الذي تم إنشاؤه بالاستناد إلى النموذج |
finishReason |
اختياريّ. النتائج فقط. سبب توقف النموذج عن إنشاء رموز مميزة. إذا كان الحقل فارغًا، لم يتوقف النموذج عن إنشاء الرموز المميّزة. |
safetyRatings[] |
قائمة بالتقييمات لسلامة المرشح للاستجابة يجب توفير تقييم واحد كحدّ أقصى لكل فئة. |
citationMetadata |
النتائج فقط. معلومات الاقتباس الخاصة بالمرشح الذي يتم إنشاؤه من خلال نموذج قد يتم ملء هذا الحقل بمعلومات التلاوة لأي نص مضمّن في |
tokenCount |
النتائج فقط. عدد الرموز المميّزة لهذا المرشح. |
index |
النتائج فقط. فهرس المرشّح في قائمة المرشّحين |
FinishReason
تحدّد هذه السمة سبب توقف النموذج عن إنشاء رموز مميّزة.
عمليات التعداد | |
---|---|
FINISH_REASON_UNSPECIFIED |
القيمة التلقائية. هذه القيمة غير مستخدمة. |
STOP |
نقطة توقف طبيعية للنموذج أو تسلسل التوقف المقدم. |
MAX_TOKENS |
تم الوصول إلى الحد الأقصى لعدد الرموز المميّزة كما هو محدّد في الطلب. |
SAFETY |
تم الإبلاغ عن المحتوى المرشح لأسباب تتعلق بالسلامة. |
RECITATION |
تم الإبلاغ عن المحتوى المحفّز لعرض الإعلان لأسباب تتعلّق بالتلاقي. |
OTHER |
السبب غير معروف. |
SafetyRating
تقييم الأمان لجزء من المحتوى
يتضمّن تقييم الأمان فئة الضرر ومستوى احتمالية حدوث ضرر في تلك الفئة من المحتوى. يكون المحتوى مصنّفًا للأمان على مستوى عدد من فئات الضرر ويتم هنا تصنيف احتمالية وقوع الضرر.
تمثيل JSON |
---|
{ "category": enum ( |
الحقول | |
---|---|
category |
مطلوبة. فئة هذا التقييم. |
probability |
مطلوبة. احتمالية وقوع الضرر على هذا المحتوى |
blocked |
هل تم حظر هذا المحتوى بسبب هذا التقييم؟ |
HarmProbability
احتمالية أن يكون جزء من المحتوى ضارًا.
يمنح نظام التصنيف احتمالية أن المحتوى غير آمن. ولا يشير ذلك إلى خطورة الضرر الذي يقع فيه المحتوى.
عمليات التعداد | |
---|---|
HARM_PROBABILITY_UNSPECIFIED |
لم يتم تحديد الاحتمالية. |
NEGLIGIBLE |
هناك احتمال ضئيل أن يكون المحتوى غير آمن. |
LOW |
من المرجّح أن يكون المحتوى غير آمن بدرجة منخفضة. |
MEDIUM |
هناك احتمال متوسط بأن يكون المحتوى غير آمن. |
HIGH |
هناك احتمال كبير بأن يكون المحتوى غير آمن. |
CitationMetadata
يشير ذلك المصطلح إلى مجموعة من عمليات تحديد المصدر لجزء من المحتوى.
تمثيل JSON |
---|
{
"citationSources": [
{
object ( |
الحقول | |
---|---|
citationSources[] |
اقتباسات من مصادر لرد محدّد |
CitationSource
هي معلومات مصدرها جزء من ردّ محدّد.
تمثيل JSON |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
الحقول | |
---|---|
startIndex |
اختياريّ. بداية شريحة الرد المنسوبة إلى هذا المصدر يشير الفهرس إلى بداية المقطع، ويتم قياسه بالبايت. |
endIndex |
اختياريّ. نهاية الشريحة المنسوبة، حصرية. |
uri |
اختياريّ. معرّف الموارد المنتظم (URI) المنسوب كمصدر لجزء من النص. |
license |
اختياريّ. ترخيص لمشروع GitHub الذي يتم إسناده كمصدر للقطاع. يجب إدخال معلومات الترخيص في عمليات الاقتباس من الرموز. |
PromptFeedback
مجموعة من البيانات الوصفية للملاحظات التي تم تحديدها في GenerateContentRequest.content
تمثيل JSON |
---|
{ "blockReason": enum ( |
الحقول | |
---|---|
blockReason |
اختياريّ. وفي حال ضبطها، يتم حظر الطلب ولا يتم عرض أي مرشح. أعِد صياغة طلبك. |
safetyRatings[] |
تقييمات لسلامة رسالة الطلب يجب توفير تقييم واحد كحدّ أقصى لكل فئة. |
BlockReason
يحدِّد سبب حظر الطلب.
عمليات التعداد | |
---|---|
BLOCK_REASON_UNSPECIFIED |
القيمة التلقائية. هذه القيمة غير مستخدمة. |
SAFETY |
تم حظر الطلب لأسباب تتعلق بالسلامة. يمكنك فحص "safetyRatings " لمعرفة فئة الأمان التي حظرتها. |
OTHER |
تم حظر الطلب بسبب أسباب غير معروفة. |
UsageMetadata
البيانات الوصفية حول استخدام الرمز المميّز لطلب الإنشاء
تمثيل JSON |
---|
{ "promptTokenCount": integer, "candidatesTokenCount": integer, "totalTokenCount": integer } |
الحقول | |
---|---|
promptTokenCount |
عدد الرموز المميّزة في الطلب |
candidatesTokenCount |
إجمالي عدد الرموز المميّزة بين الاقتراحات التي تم إنشاؤها |
totalTokenCount |
إجمالي عدد الرموز المميّزة لطلب الإنشاء (الطلب + المرشّحون) |