Method: models.embedContent

Menghasilkan embedding dari model yang diberi Content input.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
model

string

Wajib. Nama resource model. Ini berfungsi sebagai ID untuk digunakan oleh Model.

Nama ini harus cocok dengan nama model yang ditampilkan oleh metode models.list.

Format: models/{model}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
Kolom
content

object (Content)

Wajib. Konten yang akan disematkan. Hanya kolom parts.text yang akan dihitung.
taskType

enum (TaskType)

Opsional. Jenis tugas opsional yang menggunakan embeddings. Hanya dapat disetel untuk models/embedding-001.
title

string

Opsional. Judul opsional untuk teks. Hanya berlaku jika TaskType adalah RETRIEVAL_DOCUMENT.

Catatan: Menentukan title untuk RETRIEVAL_DOCUMENT akan memberikan embedding kualitas yang lebih baik untuk pengambilan.
outputDimensionality

integer

Opsional. Dimensi opsional yang dikurangi untuk embedding output. Jika ditetapkan, nilai yang berlebihan dalam embedding output akan dipotong dari bagian akhir. Didukung oleh model yang lebih baru sejak tahun 2024, dan model sebelumnya (models/embedding-001) tidak dapat menentukan nilai ini.

Isi respons

Respons terhadap EmbedContentRequest.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "embedding": {
    object (ContentEmbedding)
  }
}
Kolom
embedding

object (ContentEmbedding)

Hanya output. Embedding yang dihasilkan dari konten input.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • 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

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.