GenerateContentResponse

استجابة من النموذج الذي يدعم عدة مرشحين.

ملاحظة حول تقييمات الأمان وفلترة المحتوى ويتم الإبلاغ عنها لكل من الطلب في GenerateContentResponse.prompt_feedback ولكل مرشّح في finishReason وفي safetyRatings. بموجب عقد واجهة برمجة التطبيقات: إما أنّه يتم إرجاع جميع المرشحين المطلوبين أو عدم إرجاع أي مرشحين على الإطلاق، لا يتم إرجاع أي مرشحين فقط في حال حدوث خطأ في الطلب (راجِع promptFeedback) - يتم الإبلاغ عن الملاحظات حول كل مرشح في finishReason وsafetyRatings.

تمثيل JSON
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "promptFeedback": {
    object (PromptFeedback)
  },
  "usageMetadata": {
    object (UsageMetadata)
  }
}
الحقول
candidates[]

object (Candidate)

ردود المرشحين من النموذج

promptFeedback

object (PromptFeedback)

عرض ملاحظات الطلب ذات الصلة بفلاتر المحتوى

usageMetadata

object (UsageMetadata)

النتائج فقط. البيانات الوصفية حول استخدام الرمز المميّز لطلبات الإنشاء

مرشح

مرشّح للرد تم إنشاؤه من النموذج

تمثيل JSON
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "index": integer
}
الحقول
content

object (Content)

النتائج فقط. المحتوى الذي تم إنشاؤه وتم عرضه من النموذج

finishReason

enum (FinishReason)

اختياريّ. النتائج فقط. سبب توقّف النموذج عن إنشاء الرموز المميّزة

وإذا كانت فارغة، هذا يعني أنّ النموذج لم يتوقف عن إنشاء الرموز المميّزة.

safetyRatings[]

object (SafetyRating)

قائمة التقييمات الخاصة بأمان أحد المرشّحين للرد

يتوفّر تقييم واحد كحدّ أقصى لكل فئة.

citationMetadata

object (CitationMetadata)

النتائج فقط. معلومات الاقتباس للمرشح الذي تم إنشاؤه من خلال النموذج

يمكن تعبئة هذا الحقل بمعلومات الإشادة لأي نص مضمّن في content. هذه الفقرات يتم "تلاقيها" من مواد محمية بحقوق الطبع والنشر ضمن بيانات تدريب النموذج اللغوي الكبير (LLM) الأساسي.

tokenCount

integer

النتائج فقط. عدد الرموز المميّزة لهذا المرشح.

index

integer

النتائج فقط. فهرس المرشّح في قائمة المرشحين.

FinishReason

تحدد هذه السمة سبب توقّف النموذج عن إنشاء رموز مميّزة.

عمليات التعداد
FINISH_REASON_UNSPECIFIED القيمة التلقائية. هذه القيمة غير مستخدمة.
STOP نقطة التوقّف الطبيعية للنموذج أو تسلسل التوقّف المُقدّم.
MAX_TOKENS تم الوصول إلى الحدّ الأقصى لعدد الرموز المميّزة على النحو المحدّد في الطلب.
SAFETY تم الإبلاغ عن المحتوى المرشّح لأسباب تتعلّق بالأمان.
RECITATION تم الإبلاغ عن المحتوى المرشّح لأغراض القراءة.
OTHER السبب غير معروف.

SafetyRating

تقييم الأمان لجزء من المحتوى

يتضمّن تقييم الأمان فئة الضرر ومستوى احتمالية الضرر في تلك الفئة لجزء من المحتوى. ويتم تصنيف المحتوى للحفاظ على السلامة ضمن عدد من فئات الضرر، وقد تم إدراج احتمالية هذا التصنيف هنا.

تمثيل JSON
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "blocked": boolean
}
الحقول
category

enum (HarmCategory)

مطلوبة. فئة هذا التقييم.

probability

enum (HarmProbability)

مطلوبة. احتمالية الضرر لهذا المحتوى.

blocked

boolean

هل تم حظر هذا المحتوى بسبب هذا التقييم؟

HarmProbability

يشير ذلك المصطلح إلى احتمالية أن يكون جزء من المحتوى ضارًا.

يمنح نظام التصنيف احتمالية أن يكون المحتوى غير آمن. ولا يشير ذلك إلى خطورة الضرر الناتج عن محتوى معيّن.

عمليات التعداد
HARM_PROBABILITY_UNSPECIFIED لم يتم تحديد الاحتمال.
NEGLIGIBLE إن فرصة المحتوى غير آمنة ضئيلة.
LOW إنّ احتمال أن يصبح المحتوى غير آمن بنسبة منخفضة.
MEDIUM هناك احتمال متوسط أن يكون المحتوى غير آمن.
HIGH هناك احتمال كبير بأن يكون المحتوى غير آمن.

CitationMetadata

يشير ذلك المصطلح إلى مجموعة من عمليات تحديد المصدر الخاصة بجزء من المحتوى.

تمثيل JSON
{
  "citationSources": [
    {
      object (CitationSource)
    }
  ]
}
الحقول
citationSources[]

object (CitationSource)

الاقتباسات من مصادر ردّ محدّد

CitationSource

يشير إلى الاقتباس من مصدر لجزء من ردّ محدّد.

تمثيل JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "license": string
}
الحقول
startIndex

integer

اختياريّ. بداية شريحة الردّ المنسوبة إلى هذا المصدر

يشير المؤشر إلى بداية المقطع، ويتم قياسه بالبايت.

endIndex

integer

اختياريّ. نهاية المقطع المنسوب، حصري.

uri

string

اختياريّ. يشير إلى معرّف الموارد المنتظم (URI) الذي يُعزى إليه كمصدر لجزء من النص.

license

string

اختياريّ. ترخيص مشروع GitHub الذي تم تحديده كمصدر للقسم

يجب إدخال معلومات الترخيص عند الاقتباس من الرموز.

PromptFeedback

مجموعة من البيانات الوصفية للملاحظات للطلب المحدّد في GenerateContentRequest.content.

تمثيل JSON
{
  "blockReason": enum (BlockReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ]
}
الحقول
blockReason

enum (BlockReason)

اختياريّ. وفي حال ضبطها، تم حظر الطلب ولن يتم عرض أي اقتراحات. أعِد صياغة طلبك.

safetyRatings[]

object (SafetyRating)

التقييمات للتأكّد من أمان الطلب يتوفّر تقييم واحد كحدّ أقصى لكل فئة.

BlockReason

تحدّد هذه السياسة سبب حظر الطلب.

عمليات التعداد
BLOCK_REASON_UNSPECIFIED القيمة التلقائية. هذه القيمة غير مستخدمة.
SAFETY تم حظر الطلب لأسباب تتعلق بالسلامة. يمكنك فحص "safetyRatings" لمعرفة فئة الأمان التي حظرته.
OTHER تم حظر الطلب لأسباب غير معروفة.

UsageMetadata

البيانات الوصفية المتعلقة باستخدام الرمز المميّز لطلب الإنشاء

تمثيل JSON
{
  "promptTokenCount": integer,
  "candidatesTokenCount": integer,
  "totalTokenCount": integer
}
الحقول
promptTokenCount

integer

عدد الرموز المميّزة في الطلب عند ضبط cacheContent، يبقى هذا هو إجمالي حجم الطلب الفعال. بمعنى أن يشمل ذلك عدد الرموز المميّزة في المحتوى المخزّن مؤقتًا.

candidatesTokenCount

integer

إجمالي عدد الرموز المميّزة على مستوى العناصر المحفّزة لعرض الإعلان

totalTokenCount

integer

إجمالي عدد الرموز المميّزة لطلب الإنشاء (الطلب + الطلبات المرشحة)