التضمينات هي تمثيل رقمي للإدخالات النصية التي تفتح عددًا من حالات الاستخدام الفريدة، مثل التجميع العنقودي وقياس التشابه واسترجاع المعلومات. للاطّلاع على مقدمة، يمكنك الاطّلاع على دليل التضمينات.
الطريقة: models.embedContent
تُنشئ هذه الدالة متجهًا لتمثيل النص من الإدخال Content
باستخدام نموذج تمثيل Gemini المحدّد.
نقطة نهاية
post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContentمَعلمات المسار
model
string
مطلوب. اسم مورد النموذج. ويعمل هذا كرقم تعريف لكي يستخدمه النموذج.
يجب أن يتطابق هذا الاسم مع اسم طراز يعرضه الإجراء models.list
.
التنسيق: models/{model}
يكون على الشكل models/{model}
.
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
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
).
مثال على الطلب
Python
Node.js
صَدفة
نص الاستجابة
الردّ على EmbedContentRequest
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
embedding
object (ContentEmbedding
)
النتائج فقط. العنصر المضمّن الذي تم إنشاؤه من محتوى الإدخال
تمثيل JSON |
---|
{
"embedding": {
object ( |
الطريقة: models.batchEmbedContents
إنشاء عدة متجهات تضمين من الإدخال Content
الذي يتكون من مجموعة من السلاسل ممثلة ككائنات EmbedContentRequest
.
نقطة نهاية
post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContentsمَعلمات المسار
model
string
مطلوب. اسم مورد النموذج. ويعمل هذا كرقم تعريف لكي يستخدمه النموذج.
يجب أن يتطابق هذا الاسم مع اسم طراز يعرضه الإجراء models.list
.
التنسيق: models/{model}
يكون على الشكل models/{model}
.
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
requests[]
object (EmbedContentRequest
)
مطلوب. طلبات التضمين للمجموعة يجب أن يتطابق النموذج في كلّ من هذه الطلبات مع النموذج المحدّد BatchEmbedContentsRequest.model
.
مثال على الطلب
Python
Node.js
صَدفة
نص الاستجابة
تمثّل هذه السمة الردّ على BatchEmbedContentsRequest
.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
embeddings[]
object (ContentEmbedding
)
النتائج فقط. عمليات التضمين لكل طلب، بالترتيب نفسه الوارد في طلب الدفعة
تمثيل JSON |
---|
{
"embeddings": [
{
object ( |
EmbedContentRequest
طلب يحتوي على Content
للنموذج المطلوب تضمينه
model
string
مطلوب. اسم مورد النموذج. ويعمل هذا كرقم تعريف لكي يستخدمه النموذج.
يجب أن يتطابق هذا الاسم مع اسم طراز يعرضه الإجراء models.list
.
التنسيق: models/{model}
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
).
ContentEmbedding
قائمة بالقيم العائمة التي تمثل عملية تضمين.
values[]
number
قيم التضمين.
تمثيل JSON |
---|
{ "values": [ number ] } |
TaskType
نوع المهمة التي سيتم استخدام التضمين لها.
عمليات التعداد | |
---|---|
TASK_TYPE_UNSPECIFIED |
لم يتم ضبط قيمة، وسيتم ضبطها تلقائيًا على إحدى قيم التعداد الأخرى. |
RETRIEVAL_QUERY |
لتحديد أن النص المقدم هو طلب بحث في إعداد البحث/الاسترجاع. |
RETRIEVAL_DOCUMENT |
تُستخدَم لتحديد أنّ النص المقدَّم هو مستند من مجموعة النصوص التي يتم البحث فيها. |
SEMANTIC_SIMILARITY |
تُحدِّد هذه السمة النص الذي سيتم استخدامه لبروتوكول STS. |
CLASSIFICATION |
لتحديد أنه سيتم تصنيف النص المقدم. |
CLUSTERING |
تُستخدَم هذه السمة لتحديد أنّه سيتم استخدام البيانات المضمّنة في التجميع. |
QUESTION_ANSWERING |
تُستخدَم لتحديد أنّ النص المقدَّم سيتم استخدامه للإجابة عن السؤال. |
FACT_VERIFICATION |
تشير هذه العلامة إلى أنّ النص المقدَّم سيُستخدم للتحقق من صحة الأخبار. |