Method: models.embedContent

Content girdisi verilen modelden bir yerleştirme oluşturur.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
model

string

Zorunlu. Modelin kaynak adı. Bu, Modelin kullanacağı bir kimlik görevi görür.

Bu ad, models.list yöntemi tarafından döndürülen bir model adıyla eşleşmelidir.

Biçim: models/{model}

İstek içeriği

İsteğin gövdesi, aşağıdaki yapıya sahip veriler içerir:

JSON gösterimi
{
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
Alanlar
content

object (Content)

Zorunlu. Yerleştirilecek içerik. Yalnızca parts.text alanları sayılacak.

taskType

enum (TaskType)

İsteğe bağlı. Yerleştirmelerin kullanılacağı isteğe bağlı görev türü. Yalnızca models/embedding-001 için ayarlanabilir.

title

string

İsteğe bağlı. Metin için isteğe bağlı bir başlık. Yalnızca TaskType RETRIEVAL_DOCUMENT olduğunda geçerlidir.

Not: RETRIEVAL_DOCUMENT için bir title belirtmek, alma için daha iyi kaliteli yerleştirmeler sağlar.

outputDimensionality

integer

İsteğe bağlı. Çıkışı yerleştirme için isteğe bağlı azaltılmış boyut. Ayarlanırsa çıkış yerleştirilmiş öğedeki fazladan değerler sondan kesilir. 2024'ten itibaren yeni modeller tarafından desteklenir ve önceki model (models/embedding-001) bu değeri belirtemez.

Yanıt gövdesi

EmbedContentRequest için yanıt.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "embedding": {
    object (ContentEmbedding)
  }
}
Alanlar
embedding

object (ContentEmbedding)

Yalnızca çıkış. Giriş içeriğinden oluşturulan yerleştirme.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • 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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış sayfasına göz atın.