Method: models.embedContent

یک جاسازی از مدل داده شده به Content ورودی ایجاد می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.