Yerleştirmeler, metin girişinin sayısal bir gösterimidir. Bu sayede kümeleme, benzerlik ölçümü ve bilgi alma gibi benzersiz kullanım alanları ortaya çıkar. Giriş için Embeddings kılavuzuna göz atın.
Yeni içerik oluşturan üretken yapay zeka modellerinin aksine, Gemini Embedding modeli yalnızca giriş verilerinizin biçimini sayısal bir temsile dönüştürmek için tasarlanmıştır. Google, giriş verilerinizin biçimini istenen sayısal biçime dönüştüren bir yerleştirme modeli sağlamaktan sorumlu olsa da kullanıcılar, girdikleri veriler ve ortaya çıkan yerleştirmelerle ilgili tüm sorumluluğu üstlenir. Gemini Embedding modelini kullanarak yüklediğiniz tüm içeriklerle ilgili gerekli haklara sahip olduğunuzu onaylarsınız. Başkalarının fikri mülkiyet veya gizlilik haklarını ihlal eden içerikler üretmeyin. Bu hizmeti kullanımınız Yasaklanan Kullanım Politikamıza ve Google'ın Hizmet Şartları'na tabidir.
Yöntem: models.embedContent
Belirtilen Gemini yerleştirme modeli kullanılarak giriş Content değerinden bir metin yerleştirme vektörü oluşturur.
Uç nokta
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:embedContent
Yol parametreleri
model
string
Zorunlu. Modelin kaynak adı. Bu, Model'in 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} models/{model} biçimindedir.
İstek metni
İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:
content
object (Content)
Zorunlu. Yerleştirilecek içerik. Yalnızca parts.text alanları sayılır.
taskType
(deprecated)
enum (TaskType)
İsteğe bağlı. Desteği sonlandırıldı: Lütfen bunun yerine EmbedContentConfig.task_type kullanın. Gömme işlemlerinin kullanılacağı isteğe bağlı görev türü. Daha eski modellerde (models/embedding-001) desteklenmez.
title
(deprecated)
string
İsteğe bağlı. Desteği sonlandırıldı: Lütfen bunun yerine EmbedContentConfig.title kullanın. Metin için isteğe bağlı başlık. Yalnızca TaskType RETRIEVAL_DOCUMENT olduğunda geçerlidir.
Not: RETRIEVAL_DOCUMENT için title belirtmek, alma işlemi için daha kaliteli yerleştirmeler sağlar.
outputDimensionality
(deprecated)
integer
İsteğe bağlı. Desteği sonlandırıldı: Lütfen bunun yerine EmbedContentConfig.output_dimensionality kullanın. Çıkış yerleştirme için isteğe bağlı olarak azaltılmış boyut. Ayarlanırsa çıkış yerleştirmesindeki aşırı değerler sondan kesilir. Yalnızca 2024'ten itibaren çıkan yeni modellerde desteklenir. Önceki modeli (models/embedding-001) kullanıyorsanız bu değeri ayarlayamazsınız.
embedContentConfig
object (EmbedContentConfig)
İsteğe bağlı. models.embedContent isteği için yapılandırma.
Örnek istek
Python
Node.js
Go
kabuk
Yanıt metni
Başarılıysa yanıt metni, EmbedContentResponse öğesinin bir örneğini içerir.
Yöntem: models.batchEmbedContents
EmbedContentRequest nesneleri olarak temsil edilen bir dizi dizeden oluşan giriş Content değerinden birden fazla yerleştirme vektörü oluşturur.
Uç nokta
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:batchEmbedContents
Yol parametreleri
model
string
Zorunlu. Modelin kaynak adı. Bu, Model'in 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} models/{model} biçimindedir.
İstek metni
İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:
requests[]
object (EmbedContentRequest)
Zorunlu. Toplu işlem için yerleştirme istekleri. Bu isteklerin her birindeki model, BatchEmbedContentsRequest.model içinde belirtilen modelle eşleşmelidir.
Örnek istek
Python
Node.js
Go
kabuk
Yanıt metni
BatchEmbedContentsRequest yanıtı.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
embeddings[]
object (ContentEmbedding)
Yalnızca çıkış. Her isteğin yerleştirmeleri, toplu istekte sağlanan sırayla.
usageMetadata
object (EmbeddingUsageMetadata)
Yalnızca çıkış. İsteğin kullanım meta verileri.
| JSON gösterimi |
|---|
{ "embeddings": [ { object ( |
Yöntem: models.asyncBatchEmbedContent
Toplu işlem için models.embedContent isteğinden oluşan bir grubu sıraya alır. models.batchEmbedContents, GenerativeService içinde işleyiciye sahip ancak senkronize edildi. Bu nedenle, karışıklığı önlemek için bu öğeyi Async olarak adlandırıyoruz.
Uç nokta
posthttps: / /generativelanguage.googleapis.com /v1beta /{batch.model=models /*}:asyncBatchEmbedContent
Yol parametreleri
batch.model
string
Zorunlu. Tamamlama oluşturmak için kullanılacak Model öğesinin adı.
Biçim: models/{model}. models/{model} biçimindedir.
İstek metni
İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:
batch.name
string
Yalnızca çıkış. Tanımlayıcı. Toplu işlemin kaynak adı.
Biçim: batches/{batchId}.
batch.displayName
string
Zorunlu. Bu toplu işlemin kullanıcı tanımlı adı.
batch.inputConfig
object (InputEmbedContentConfig)
Zorunlu. Toplu işleme işlemlerinin gerçekleştirildiği örneklerin giriş yapılandırması.
batch.output
object (EmbedContentBatchOutput)
Yalnızca çıkış. Toplu isteğin çıktısı.
batch.createTime
string (Timestamp format)
Yalnızca çıkış. Toplu işlemin oluşturulduğu zaman.
Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
batch.endTime
string (Timestamp format)
Yalnızca çıkış. Toplu işlemenin tamamlandığı zaman.
Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
batch.updateTime
string (Timestamp format)
Yalnızca çıkış. Toplu işlemin son güncellenme zamanı.
Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
batch.batchStats
object (EmbedContentBatchStats)
Yalnızca çıkış. Toplu işlemle ilgili istatistikler.
batch.state
enum (BatchState)
Yalnızca çıkış. Toplu işlemin durumu.
batch.priority
string (int64 format)
İsteğe bağlı. Toplu işlemin önceliği. Daha yüksek öncelik değerine sahip toplu işlemler, daha düşük öncelik değerine sahip toplu işlemlerden önce işlenir. Negatif değerlere izin verilir. Varsayılan değer 0'dır.
batch.webhookConfig.uris[]
string
İsteğe bağlı. Ayarlanırsa bu webhook URI'leri, kayıtlı webhook'lar yerine webhook etkinlikleri için kullanılır.
Yanıt metni
Başarılıysa yanıt metni, Operation öğesinin bir örneğini içerir.
EmbedContentResponse
EmbedContentRequest yanıtı.
embedding
object (ContentEmbedding)
Yalnızca çıkış. Giriş içeriğinden oluşturulan yerleştirme.
usageMetadata
object (EmbeddingUsageMetadata)
Yalnızca çıkış. İsteğin kullanım meta verileri.
| JSON gösterimi |
|---|
{ "embedding": { object ( |
ContentEmbedding
Bir yerleştirmeyi temsil eden kayan nokta sayılarının listesi.
values[]
number
Yerleştirme değerleri. Bu yalnızca üçüncü taraf kullanıcıları içindir ve birinci taraf aramaları için doldurulmaz.
shape[]
integer
Bu alan, yumuşak jetonların tensör çerçeve şeklini (ör. [1, 1, 256, 2048]) depolar.
| JSON gösterimi |
|---|
{ "values": [ number ], "shape": [ integer ] } |
TaskType
Yerleştirmenin kullanılacağı görev türü.
| Sıralamalar | |
|---|---|
TASK_TYPE_UNSPECIFIED |
Diğer enum değerlerinden birine varsayılan olarak ayarlanacak olan ayarlanmamış değer. |
RETRIEVAL_QUERY |
Belirtilen metnin, arama/alma ayarındaki bir sorgu olduğunu belirtir. |
RETRIEVAL_DOCUMENT |
Belirtilen metnin, aranan külliyattaki bir belge olduğunu belirtir. |
SEMANTIC_SIMILARITY |
Belirtilen metnin STS için kullanılacağını belirtir. |
CLASSIFICATION |
Belirtilen metnin sınıflandırılacağını belirtir. |
CLUSTERING |
Yerleştirilmiş öğelerin kümeleme için kullanılacağını belirtir. |
QUESTION_ANSWERING |
Belirtilen metnin soru yanıtlama için kullanılacağını belirtir. |
FACT_VERIFICATION |
Belirtilen metnin doğruluk kontrolü için kullanılacağını belirtir. |
CODE_RETRIEVAL_QUERY |
Belirtilen metnin kod alma için kullanılacağını belirtir. |
EmbedContentBatch
- JSON gösterimi
- InputEmbedContentConfig
- InlinedEmbedContentRequests
- InlinedEmbedContentRequest
- EmbedContentBatchOutput
- InlinedEmbedContentResponses
- InlinedEmbedContentResponse
- EmbedContentBatchStats
Bir grup EmbedContent isteğini temsil eden kaynak.
model
string
Zorunlu. Tamamlama oluşturmak için kullanılacak Model öğesinin adı.
Biçim: models/{model}.
name
string
Yalnızca çıkış. Tanımlayıcı. Toplu işlemin kaynak adı.
Biçim: batches/{batchId}.
displayName
string
Zorunlu. Bu toplu işlemin kullanıcı tanımlı adı.
inputConfig
object (InputEmbedContentConfig)
Zorunlu. Toplu işleme işlemlerinin gerçekleştirildiği örneklerin giriş yapılandırması.
output
object (EmbedContentBatchOutput)
Yalnızca çıkış. Toplu isteğin çıktısı.
createTime
string (Timestamp format)
Yalnızca çıkış. Toplu işlemin oluşturulduğu zaman.
Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
endTime
string (Timestamp format)
Yalnızca çıkış. Toplu işlemenin tamamlandığı zaman.
Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
updateTime
string (Timestamp format)
Yalnızca çıkış. Toplu işlemin son güncellenme zamanı.
Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
batchStats
object (EmbedContentBatchStats)
Yalnızca çıkış. Toplu işlemle ilgili istatistikler.
state
enum (BatchState)
Yalnızca çıkış. Toplu işlemin durumu.
priority
string (int64 format)
İsteğe bağlı. Toplu işlemin önceliği. Daha yüksek öncelik değerine sahip toplu işlemler, daha düşük öncelik değerine sahip toplu işlemlerden önce işlenir. Negatif değerlere izin verilir. Varsayılan değer 0'dır.
| JSON gösterimi |
|---|
{ "model": string, "name": string, "displayName": string, "inputConfig": { object ( |
InputEmbedContentConfig
Toplu istek için girişi yapılandırır.
source
Union type
fileName
string
Giriş isteklerini içeren File'nın adı.
requests
object (InlinedEmbedContentRequests)
Toplu işlemde işlenecek istekler.
| JSON gösterimi |
|---|
{
// source
"fileName": string,
"requests": {
object ( |
InlinedEmbedContentRequests
Toplu oluşturma isteğinin bir parçası olarak sağlanırsa toplu işlemde işlenecek istekler.
requests[]
object (InlinedEmbedContentRequest)
Zorunlu. Toplu işlemde işlenecek istekler.
| JSON gösterimi |
|---|
{
"requests": [
{
object ( |
InlinedEmbedContentRequest
Toplu işlemde işlenecek istek.
request
object (EmbedContentRequest)
Zorunlu. Toplu işlemde işlenecek istek.
metadata
object (Struct format)
İsteğe bağlı. İstekle ilişkilendirilecek meta veriler.
| JSON gösterimi |
|---|
{
"request": {
object ( |
EmbedContentBatchOutput
Toplu isteğin çıktısı. Bu değer, AsyncBatchEmbedContentResponse veya EmbedContentBatch.output alanında döndürülür.
output
Union type
responsesFile
string
Yalnızca çıkış. Yanıtları içeren dosyanın dosya kimliği. Dosya, her satırda tek bir yanıt içeren bir JSONL dosyası olur. Yanıtlar, JSON olarak biçimlendirilmiş EmbedContentResponse mesajlarıdır. Yanıtlar, giriş istekleriyle aynı sırada yazılır.
inlinedResponses
object (InlinedEmbedContentResponses)
Yalnızca çıkış. Toplu işteki isteklere verilen yanıtlar. Toplu işlem, satır içi istekler kullanılarak oluşturulduğunda döndürülür. Yanıtlar, giriş istekleriyle aynı sırada verilir.
| JSON gösterimi |
|---|
{
// output
"responsesFile": string,
"inlinedResponses": {
object ( |
InlinedEmbedContentResponses
Toplu işteki isteklere verilen yanıtlar.
inlinedResponses[]
object (InlinedEmbedContentResponse)
Yalnızca çıkış. Toplu işteki isteklere verilen yanıtlar.
| JSON gösterimi |
|---|
{
"inlinedResponses": [
{
object ( |
InlinedEmbedContentResponse
Gruptaki tek bir isteğe verilen yanıt.
metadata
object (Struct format)
Yalnızca çıkış. İstekle ilişkili meta veriler.
output
Union type
error
object (Status)
Yalnızca çıkış. İstek işlenirken karşılaşılan hata.
response
object (EmbedContentResponse)
Yalnızca çıkış. İsteğe verilen yanıt.
| JSON gösterimi |
|---|
{ "metadata": { object }, // output "error": { object ( |
EmbedContentBatchStats
Toplu işlemle ilgili istatistikler.
requestCount
string (int64 format)
Yalnızca çıkış. Toplu işlemdeki isteklerin sayısı.
successfulRequestCount
string (int64 format)
Yalnızca çıkış. Başarıyla işlenen istek sayısı.
failedRequestCount
string (int64 format)
Yalnızca çıkış. İşlenemeyen isteklerin sayısı.
pendingRequestCount
string (int64 format)
Yalnızca çıkış. İşlenmeyi bekleyen istek sayısı.
| JSON gösterimi |
|---|
{ "requestCount": string, "successfulRequestCount": string, "failedRequestCount": string, "pendingRequestCount": string } |
EmbedContentConfig
EmbedContent isteği için yapılandırmalar.
title
string
İsteğe bağlı. Metnin başlığı.
taskType
enum (TaskType)
İsteğe bağlı. Yerleştirmenin görev türü.
autoTruncate
boolean
İsteğe bağlı. Giriş içeriği, maksimum dizi uzunluğundan daha uzunsa sessizce kesilip kesilmeyeceği.
outputDimensionality
integer
İsteğe bağlı. Çıkış yerleştirme için azaltılmış boyut. Ayarlanırsa çıkış yerleştirmesindeki aşırı değerler sondan kesilir.
documentOcr
boolean
İsteğe bağlı. Belge içeriği için OCR'nin etkinleştirilip etkinleştirilmeyeceği.
audioTrackExtraction
boolean
İsteğe bağlı. Video içeriğinden sesin çıkarılıp çıkarılmayacağı.
| JSON gösterimi |
|---|
{
"title": string,
"taskType": enum ( |
EmbeddingUsageMetadata
Yerleştirme isteğinin kullanımıyla ilgili meta veriler.
promptTokenCount
integer
Yalnızca çıkış. İstemdeki jeton sayısı.
promptTokenDetails[]
object (ModalityTokenCount)
Yalnızca çıkış. İstek girişinde işlenen yöntemlerin listesi.
| JSON gösterimi |
|---|
{
"promptTokenCount": integer,
"promptTokenDetails": [
{
object ( |