جاسازیها (Embeddings) نمایش عددی از ورودی متن هستند که تعدادی از موارد استفاده منحصر به فرد، مانند خوشهبندی، اندازهگیری شباهت و بازیابی اطلاعات را فراهم میکنند. برای آشنایی با این موضوع، راهنمای جاسازیها (Embeddings) را بررسی کنید.
برخلاف مدلهای هوش مصنوعی مولد که محتوای جدید ایجاد میکنند، مدل جاسازی Gemini فقط برای تبدیل قالب دادههای ورودی شما به یک نمایش عددی در نظر گرفته شده است. در حالی که گوگل مسئول ارائه یک مدل جاسازی است که قالب دادههای ورودی شما را به قالب عددی درخواستی تبدیل میکند، کاربران مسئولیت کامل دادههایی را که وارد میکنند و جاسازیهای حاصل از آن را بر عهده دارند. با استفاده از مدل جاسازی Gemini، شما تأیید میکنید که از حقوق لازم برای هر محتوایی که آپلود میکنید، برخوردار هستید. محتوایی تولید نکنید که حقوق مالکیت معنوی یا حریم خصوصی دیگران را نقض کند. استفاده شما از این سرویس تابع سیاست استفاده ممنوعه ما و شرایط خدمات گوگل است.
روش: models.embedContent
با استفاده از مدل Gemini Embedding مشخص شده، یک بردار جاسازی متن از ورودی Content تولید میکند.
نقطه پایانی
پستhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:embedContentپارامترهای مسیر
string modelالزامی. نام منبع مدل. این به عنوان شناسهای برای استفاده مدل عمل میکند.
این نام باید با نام مدلی که توسط متد models.list برگردانده میشود، مطابقت داشته باشد.
قالب: models/{model} به شکل models/{model} است.
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
contentobject ( Content ) الزامی. محتوایی که باید جاسازی شود. فقط فیلدهای parts.text شمارش خواهند شد.
taskTypeenum ( TaskType ) اختیاری. نوع وظیفهای که جاسازیها برای آن استفاده خواهند شد اختیاری است. در مدلهای قبلی ( models/embedding-001 ) پشتیبانی نمیشود.
string title اختیاری. یک عنوان اختیاری برای متن. فقط زمانی قابل اجرا است که TaskType RETRIEVAL_DOCUMENT باشد.
نکته: تعیین title برای RETRIEVAL_DOCUMENT جاسازیهای با کیفیتتری را برای بازیابی فراهم میکند.
outputDimensionalityinteger اختیاری. ابعاد کاهشیافتهی اختیاری برای جاسازی خروجی. در صورت تنظیم، مقادیر اضافی در جاسازی خروجی از انتها کوتاه میشوند. فقط از سال ۲۰۲۴ توسط مدلهای جدیدتر پشتیبانی میشود. در صورت استفاده از مدل قبلی ( models/embedding-001 ) نمیتوانید این مقدار را تنظیم کنید.
درخواست نمونه
پایتون
نود جی اس
برو
پوسته
بدنه پاسخ
در صورت موفقیت، بدنه پاسخ شامل نمونهای از EmbedContentResponse است.
روش: models.batchEmbedContents
چندین بردار جاسازی از ورودی Content تولید میکند که شامل دستهای از رشتهها است که به صورت اشیاء EmbedContentRequest نمایش داده میشوند.
نقطه پایانی
پستhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:batchEmbedContentsپارامترهای مسیر
string modelالزامی. نام منبع مدل. این به عنوان شناسهای برای استفاده مدل عمل میکند.
این نام باید با نام مدلی که توسط متد models.list برگردانده میشود، مطابقت داشته باشد.
قالب: models/{model} به شکل models/{model} است.
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
requests[]object ( EmbedContentRequest ) الزامی. درخواستهای جاسازی برای دسته. مدل در هر یک از این درخواستها باید با مدل مشخص شده در BatchEmbedContentsRequest.model مطابقت داشته باشد.
درخواست نمونه
پایتون
نود جی اس
برو
پوسته
بدنه پاسخ
پاسخ به یک BatchEmbedContentsRequest .
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
embeddings[]object ( ContentEmbedding )فقط خروجی. جاسازیها برای هر درخواست، به همان ترتیبی که در درخواست دستهای ارائه شده است.
| نمایش JSON |
|---|
{
"embeddings": [
{
object ( |
روش: models.asyncBatchEmbedContent
دستهای از درخواستهای models.embedContent را برای پردازش دستهای در صف قرار میدهد. ما یک هندلر models.batchEmbedContents در GenerativeService داریم، اما همگامسازی شده است. بنابراین برای جلوگیری از سردرگمی، نام آن را Async میگذاریم.
نقطه پایانی
پستhttps: / /generativelanguage.googleapis.com /v1beta /{batch.model=models /*}:asyncBatchEmbedContentپارامترهای مسیر
string batch.model الزامی. نام Model که برای تولید تکمیل استفاده میشود.
قالب: models/{model} . این قالب به صورت models/{model} است.
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
string batch.nameفقط خروجی. شناسه. نام منبع دسته.
قالب: batches/{batchId} .
string batch.displayNameالزامی. نام تعریفشده توسط کاربر برای این دسته.
batch.inputConfigobject ( InputEmbedContentConfig )الزامی. پیکربندی ورودی نمونههایی که پردازش دستهای روی آنها انجام میشود.
batch.outputobject ( EmbedContentBatchOutput )فقط خروجی. خروجی درخواست دستهای.
batch.createTimestring ( Timestamp format)فقط خروجی. زمانی که دسته ایجاد شده است.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
batch.endTimestring ( Timestamp format)فقط خروجی. زمانی که پردازش دستهای تکمیل شده است.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
batch.updateTimestring ( Timestamp format)فقط خروجی. زمانی که دسته آخرین بار بهروزرسانی شده است.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
batch.batchStatsobject ( EmbedContentBatchStats )فقط خروجی. آمار مربوط به دسته.
batch.stateenum ( BatchState )فقط خروجی. وضعیت دسته.
batch.prioritystring ( int64 format)اختیاری. اولویت دسته. دستههایی با مقدار اولویت بالاتر قبل از دستههایی با مقدار اولویت پایینتر پردازش میشوند. مقادیر منفی مجاز هستند. پیشفرض ۰ است.
بدنه پاسخ
در صورت موفقیت، بدنه پاسخ شامل نمونهای از Operation است.
پاسخ محتوا را جاسازی کنید
پاسخ به یک EmbedContentRequest .
embeddingobject ( ContentEmbedding )فقط خروجی. جاسازی تولید شده از محتوای ورودی.
| نمایش JSON |
|---|
{
"embedding": {
object ( |
جاسازی محتوا
فهرستی از اعداد اعشاری که نشاندهندهی یک جاسازی هستند.
values[]numberمقادیر جاسازی شده.
| نمایش JSON |
|---|
{ "values": [ number ] } |
نوع وظیفه
نوع وظیفهای که از جاسازی برای آن استفاده خواهد شد.
| انومها | |
|---|---|
TASK_TYPE_UNSPECIFIED | مقدار را غیرفعال کنید، که به طور پیشفرض روی یکی از مقادیر enum دیگر قرار میگیرد. |
RETRIEVAL_QUERY | مشخص میکند که متن داده شده، یک پرسوجو در تنظیمات جستجو/بازیابی است. |
RETRIEVAL_DOCUMENT | مشخص میکند که متن داده شده، سندی از مجموعهی مورد جستجو است. |
SEMANTIC_SIMILARITY | مشخص میکند که متن داده شده برای STS استفاده خواهد شد. |
CLASSIFICATION | مشخص میکند که متن داده شده طبقهبندی خواهد شد. |
CLUSTERING | مشخص میکند که از جاسازیها برای خوشهبندی استفاده خواهد شد. |
QUESTION_ANSWERING | مشخص میکند که متن داده شده برای پاسخ به سوال استفاده خواهد شد. |
FACT_VERIFICATION | مشخص میکند که متن داده شده برای تأیید صحت استفاده خواهد شد. |
CODE_RETRIEVAL_QUERY | مشخص میکند که متن داده شده برای بازیابی کد استفاده خواهد شد. |
جاسازی دستهای محتوا
- نمایش JSON
- پیکربندی محتوا/ورودی/جاسازی
- درخواستهای درونخطی جاسازی محتوا
- درخواست محتوای جاسازیشدهی درونخطی
- خروجی دستهای محتوا (EmbedContentBatchOutput)
- پاسخهای درونخطی EmbedContent
- پاسخ درونخطی EmbedContent
- آمار دستهای محتوا (EmbedContentBatchStats)
منبعی که نشاندهندهی مجموعهای از درخواستهای EmbedContent است.
string model الزامی. نام Model که برای تولید تکمیل استفاده میشود.
قالب: models/{model} .
string nameفقط خروجی. شناسه. نام منبع دسته.
قالب: batches/{batchId} .
string displayNameالزامی. نام تعریفشده توسط کاربر برای این دسته.
inputConfigobject ( InputEmbedContentConfig )الزامی. پیکربندی ورودی نمونههایی که پردازش دستهای روی آنها انجام میشود.
outputobject ( EmbedContentBatchOutput )فقط خروجی. خروجی درخواست دستهای.
createTimestring ( Timestamp format)فقط خروجی. زمانی که دسته ایجاد شده است.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
endTimestring ( Timestamp format)فقط خروجی. زمانی که پردازش دستهای تکمیل شده است.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
updateTimestring ( Timestamp format)فقط خروجی. زمانی که دسته آخرین بار بهروزرسانی شده است.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
batchStatsobject ( EmbedContentBatchStats )فقط خروجی. آمار مربوط به دسته.
stateenum ( BatchState )فقط خروجی. وضعیت دسته.
prioritystring ( int64 format)اختیاری. اولویت دسته. دستههایی با مقدار اولویت بالاتر قبل از دستههایی با مقدار اولویت پایینتر پردازش میشوند. مقادیر منفی مجاز هستند. پیشفرض ۰ است.
| نمایش JSON |
|---|
{ "model": string, "name": string, "displayName": string, "inputConfig": { object ( |
پیکربندی محتوا/ورودی/جاسازی
ورودی درخواست دستهای را پیکربندی میکند.
sourceUnion typesource میتواند فقط یکی از موارد زیر باشد: string fileName نام File که شامل درخواستهای ورودی است.
requestsobject ( InlinedEmbedContentRequests )درخواستهایی که قرار است در یک دسته پردازش شوند.
| نمایش JSON |
|---|
{
// source
"fileName": string,
"requests": {
object ( |
درخواستهای درونخطی جاسازی محتوا
درخواستهایی که قرار است در دسته پردازش شوند، در صورتی که به عنوان بخشی از درخواست ایجاد دسته ارائه شده باشند.
requests[]object ( InlinedEmbedContentRequest )الزامی. درخواستهایی که باید در دسته پردازش شوند.
| نمایش JSON |
|---|
{
"requests": [
{
object ( |
درخواست محتوای جاسازیشدهی درونخطی
درخواستی که قرار است در دسته پردازش شود.
requestobject ( EmbedContentRequest )الزامی. درخواستی که قرار است در دسته پردازش شود.
metadataobject ( Struct format)اختیاری. فرادادهای که قرار است به درخواست مرتبط شود.
| نمایش JSON |
|---|
{
"request": {
object ( |
خروجی دستهای محتوا (EmbedContentBatchOutput)
خروجی یک درخواست دستهای. این خروجی در AsyncBatchEmbedContentResponse یا فیلد EmbedContentBatch.output برگردانده میشود.
Union type outputoutput میتواند فقط یکی از موارد زیر باشد: string responsesFile فقط خروجی. شناسه فایل حاوی پاسخها. این فایل یک فایل JSONL با یک پاسخ در هر خط خواهد بود. پاسخها پیامهای EmbedContentResponse با فرمت JSON خواهند بود. پاسخها به همان ترتیب درخواستهای ورودی نوشته میشوند.
inlinedResponsesobject ( InlinedEmbedContentResponses )فقط خروجی. پاسخها به درخواستهای موجود در دسته. هنگام ساخت دسته با استفاده از درخواستهای درونخطی، بازگردانده میشود. پاسخها به همان ترتیب درخواستهای ورودی خواهند بود.
| نمایش JSON |
|---|
{
// output
"responsesFile": string,
"inlinedResponses": {
object ( |
پاسخهای درونخطی EmbedContent
پاسخ به درخواستهای موجود در دسته.
inlinedResponses[]object ( InlinedEmbedContentResponse )فقط خروجی. پاسخها به درخواستهای موجود در دسته.
| نمایش JSON |
|---|
{
"inlinedResponses": [
{
object ( |
پاسخ درونخطی EmbedContent
پاسخ به یک درخواست واحد در دسته.
metadataobject ( Struct format)فقط خروجی. فراداده مرتبط با درخواست.
Union type outputoutput فقط میتواند یکی از موارد زیر باشد: errorobject ( Status )فقط خروجی. خطایی که هنگام پردازش درخواست رخ داده است.
responseobject ( EmbedContentResponse )فقط خروجی. پاسخ به درخواست.
| نمایش JSON |
|---|
{ "metadata": { object }, // output "error": { object ( |
آمار دستهای محتوا (EmbedContentBatchStats)
آمار مربوط به دسته.
requestCountstring ( int64 format)فقط خروجی. تعداد درخواستهای موجود در دسته.
successfulRequestCountstring ( int64 format)فقط خروجی. تعداد درخواستهایی که با موفقیت پردازش شدهاند.
failedRequestCountstring ( int64 format)فقط خروجی. تعداد درخواستهایی که پردازش نشدهاند.
pendingRequestCountstring ( int64 format)فقط خروجی. تعداد درخواستهایی که هنوز در انتظار پردازش هستند.
| نمایش JSON |
|---|
{ "requestCount": string, "successfulRequestCount": string, "failedRequestCount": string, "pendingRequestCount": string } |