Method: models.embedContent

تنشئ هذه الدالة تضمينًا من النموذج الذي تم أخذه في الاعتبار Content.

طلب HTTP

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContent

يستخدم عنوان URL بنية تحويل الترميز gRPC.

معلمات المسار

المَعلمات
model

string

مطلوبة. اسم مورد النموذج. ويكون هذا بمثابة معرِّف للنموذج.

يجب أن يتطابق هذا الاسم مع اسم الطراز الذي تعرضه طريقة models.list.

تنسيق الملف: models/{model}

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
الحقول
content

object (Content)

مطلوبة. المحتوى المراد تضمينه. لن يتم احتساب سوى الحقول parts.text.
taskType

enum (TaskType)

اختياريّ. نوع المهمة الاختياري الذي سيتم استخدام التضمينات له. لا يمكن ضبطها إلا على models/embedding-001.
title

string

اختياريّ. تمثّل هذه السمة عنوانًا اختياريًا للنص. لا ينطبق ذلك إلا عندما يكون نوع TaskType هو RETRIEVAL_DOCUMENT.

ملاحظة: يؤدي تحديد title لـ RETRIEVAL_DOCUMENT إلى توفير تضمينات ذات جودة أفضل لاستردادها.
outputDimensionality

integer

اختياريّ. بُعد اختياري مخفَّض من أجل تضمين الناتج. وفي حال ضبط هذه السياسة، يتم اقتطاع القيم الزائدة في تضمين الإخراج من النهاية. متوافق مع الطُرز الأحدث منذ 2024، ولا يمكن للطراز السابق (models/embedding-001) تحديد هذه القيمة.

نص الاستجابة

الردّ على EmbedContentRequest.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "embedding": {
    object (ContentEmbedding)
  }
}
الحقول
embedding

object (ContentEmbedding)

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.