PaLM (decommissioned)

Yöntem: models.generateText

Giriş mesajı verildiğinde modelden yanıt oluşturur.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateText

Yol parametreleri

model string

Zorunlu. Tamamlama oluşturmak için kullanılacak Model veya TunedModel öğesinin adı. Örnekler: models/text-bison-001 tunedModels/sentence-translator-u3b7m models/{model} biçimindedir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
prompt object (TextPrompt)

Zorunlu. Modele istem olarak verilen serbest biçimli giriş metni.

Model, verilen isteme göre giriş metninin tamamlanması olarak tahmin ettiği bir TextCompletion yanıtı oluşturur.

safetySettings[] object (SafetySetting)

İsteğe bağlıdır. Güvenli olmayan içeriğin engellenmesi için benzersiz SafetySetting örneklerinin listesi.

Bu değişiklikler GenerateTextRequest.prompt ve GenerateTextResponse.candidates üzerinde zorunlu kılınacak. Her SafetyCategory türü için birden fazla ayar olmamalıdır. API, bu ayarlarla belirlenen eşikleri karşılamayan tüm istemleri ve yanıtları engeller. Bu liste, safetySettings içinde belirtilen her SafetyCategory için varsayılan ayarları geçersiz kılar. Listede belirtilen belirli bir SafetyCategory için SafetySetting yoksa API, bu kategori için varsayılan güvenlik ayarını kullanır. Metin hizmetinde HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDICAL, HARM_CATEGORY_DANGEROUS zarar kategorileri desteklenir.

stopSequences[] string

Çıkış oluşturmayı durduracak karakter dizileri kümesi (en fazla 5). Belirtilirse API, durdurma dizisinin ilk görünümünde durur. Durdurma dizisi, yanıtın bir parçası olarak dahil edilmez.

temperature number

İsteğe bağlıdır. Çıkışın rastgeleliğini kontrol eder. Not: Varsayılan değer modele göre değişir. getModel işlevinin döndürdüğü Model öğesinin Model.temperature özelliğine bakın.

Değerler [0.0,1.0] aralığında olabilir. 1,0'a daha yakın bir değer, daha çeşitli ve yaratıcı yanıtlar üretirken 0,0'a daha yakın bir değer genellikle modelden daha basit yanıtlar alınmasını sağlar.

candidateCount integer

İsteğe bağlıdır. Döndürülecek oluşturulmuş yanıt sayısı.

Bu değer, [1, 8] arasında (değerler dahil) olmalıdır. Ayarlanmamışsa varsayılan olarak 1 olur.

maxOutputTokens integer

İsteğe bağlıdır. Bir adayda bulunacak maksimum jeton sayısı.

Ayarlanmamışsa bu, Model spesifikasyonunda belirtilen outputTokenLimit değerine ayarlanır.

topP number

İsteğe bağlıdır. Örnekleme sırasında dikkate alınacak jetonların maksimum kümülatif olasılığı.

Modelde, Top-k ve çekirdek örnekleme bir arada kullanılır.

Parçalar, yalnızca en olası parçaların dikkate alınması için atanmış olasılıklarına göre sıralanır. Top-k örnekleme, dikkate alınacak maksimum jeton sayısını doğrudan sınırlar. Nucleus örnekleme ise jeton sayısını kümülatif olasılığa göre sınırlar.

Not: Varsayılan değer modele göre değişir. getModel işlevinin döndürdüğü Model öğesinin Model.top_p özelliğine bakın.

topK integer

İsteğe bağlıdır. Örnekleme sırasında dikkate alınacak maksimum jeton sayısı.

Modelde, Top-k ve çekirdek örnekleme bir arada kullanılır.

Top-k örnekleme, topK en olası jeton kümesini dikkate alır. Varsayılan olarak 40 değerine ayarlanır.

Not: Varsayılan değer modele göre değişir. getModel işlevinin döndürdüğü Model öğesinin Model.top_k özelliğine bakın.

Yanıt gövdesi

Başarılıysa yanıt metni, GenerateTextResponse öğesinin bir örneğini içerir.

Yöntem: models.countTextTokens

Bir metinde modelin belirteçleştiricisini çalıştırır ve belirteç sayısını döndürür.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countTextTokens

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 içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
prompt object (TextPrompt)

Zorunlu. Modele istem olarak verilen serbest biçimli giriş metni.

Yanıt gövdesi

models.countTextTokens adlı kullanıcıdan yanıt.

prompt için modelin tokenCount değerini döndürür.

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

Alanlar
tokenCount integer

model tarafından prompt öğesinin jetonlaştırıldığı jeton sayısı.

Her zaman negatif olmayan bir değerdir.

JSON gösterimi 
{
  "tokenCount": integer
}

Yöntem: models.generateMessage

MessagePrompt girişiyle modele yanıt oluşturur.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateMessage

Yol parametreleri

model string

Zorunlu. Kullanılacak modelin adı.

Biçim: name=models/{model}. models/{model} biçimindedir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
prompt object (MessagePrompt)

Zorunlu. Modele istem olarak verilen yapılandırılmış metin girişi.

Model, verilen isteme göre tartışmadaki sonraki mesajın ne olacağını tahmin ederek yanıt verir.

temperature number

İsteğe bağlıdır. Çıkışın rastgeleliğini kontrol eder.

Değerler [0.0,1.0] arasında (bu değerler dahil) olabilir. 1.0 değerine yakın bir değer, daha çeşitli yanıtlar üretirken 0.0 değerine yakın bir değer genellikle modelden daha az şaşırtıcı yanıtlar alınmasına neden olur.

candidateCount integer

İsteğe bağlıdır. Döndürülecek oluşturulmuş yanıt mesajlarının sayısı.

Bu değer [1, 8] arasında olmalıdır. Ayarlanmamışsa varsayılan olarak 1 olur.

topP number

İsteğe bağlıdır. Örnekleme sırasında dikkate alınacak jetonların maksimum kümülatif olasılığı.

Modelde, Top-k ve çekirdek örnekleme bir arada kullanılır.

Çekirdek örnekleme, olasılık toplamı en az topP olan en küçük jeton grubunu dikkate alır.

topK integer

İsteğe bağlıdır. Örnekleme sırasında dikkate alınacak maksimum jeton sayısı.

Modelde, Top-k ve çekirdek örnekleme bir arada kullanılır.

Top-k örnekleme, topK en olası jeton kümesini dikkate alır.

Yanıt gövdesi

Modelin yanıtı.

Bu, kronolojik olarak sıralanmış mesajlar biçimindeki aday mesajlarını ve görüşme geçmişini içerir.

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

Alanlar
candidates[] object (Message)

Modelden gelen aday yanıt mesajları.

messages[] object (Message)

Modelin kullandığı görüşme geçmişi.

filters[] object (ContentFilter)

İstem ve yanıt metni için bir dizi içerik filtreleme meta verisi.

Bu, hangi SafetyCategory'ların bir adayın bu yanıttan engellenmesine neden olduğunu, engellemeyi tetikleyen en düşük HarmProbability'ı ve bu kategori için HarmThreshold ayarını gösterir.

JSON gösterimi 
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}

Yöntem: models.countMessageTokens

Bir modelin belirteçleştiricisini bir dizede çalıştırır ve belirteç sayısını döndürür.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countMessageTokens

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 içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
prompt object (MessagePrompt)

Zorunlu. Jeton sayısı döndürülecek istem.

Yanıt gövdesi

models.countMessageTokens adlı kullanıcıdan yanıt.

prompt için modelin tokenCount değerini döndürür.

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

Alanlar
tokenCount integer

model tarafından prompt öğesinin jetonlaştırıldığı jeton sayısı.

Her zaman negatif olmayan bir değerdir.

JSON gösterimi 
{
  "tokenCount": integer
}

Yöntem: models.embedText

Giriş mesajı verildiğinde modelden yerleştirme oluşturur.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedText

Yol parametreleri

model string

Zorunlu. model=models/{model} biçimiyle kullanılacak model adı. models/{model} biçimindedir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
text string

İsteğe bağlıdır. Modelin yerleştirmeye dönüştüreceği serbest biçimli giriş metni.

Yanıt gövdesi

EmbedTextRequest'e verilen yanıt.

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

Alanlar
embedding object (Embedding)

Yalnızca çıkış. Giriş metninden oluşturulan yerleştirme.

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

Yöntem: models.batchEmbedText

Senkron bir çağrıda, modele verilen giriş metninden birden fazla yerleştirilmiş öğe oluşturur.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedText

Yol parametreleri

model string

Zorunlu. Yerleştirme oluşturmak için kullanılacak Model'nın adı. Örnek: models/embedding-gecko-001. models/{model} biçimindedir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
texts[] string

İsteğe bağlıdır. Modelin yerleştirilmiş öğeye dönüştüreceği serbest biçimli giriş metinleri. Mevcut sınır 100 metindir. Bu sınır aşıldığında hata verilir.

requests[] object (EmbedTextRequest)

İsteğe bağlıdır. Toplu iş için yerleştirme istekleri. Yalnızca bir texts veya requests ayarlanabilir.

Yanıt gövdesi

EmbedTextRequest'e verilen yanıt.

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

Alanlar
embeddings[] object (Embedding)

Yalnızca çıkış. Giriş metninden oluşturulan gömmeler.

JSON gösterimi 
{
  "embeddings": [
    {
      object (Embedding)
    }
  ]
}

EmbedTextRequest

Modelden metin yerleştirme isteğinde bulunma.

Alanlar
model string

Zorunlu. model=models/{model} biçimiyle kullanılacak model adı.

text string

İsteğe bağlıdır. Modelin yerleştirmeye dönüştüreceği serbest biçimli giriş metni.

JSON gösterimi 
{
  "model": string,
  "text": string
}

ContentFilter

Tek bir isteğin işlenmesiyle ilişkili içerik filtreleme meta verileri.

ContentFilter, bir neden ve isteğe bağlı bir destekleyici dize içerir. Neden belirtilmemiş olabilir.

Alanlar
reason enum (BlockedReason)

İçeriğin istek işlenirken engellenme nedeni.

message string

Filtreleme davranışını daha ayrıntılı olarak açıklayan bir dize.

JSON gösterimi 
{
  "reason": enum (BlockedReason),
  "message": string
}

BlockedReason

İçeriğin engellenmiş olabileceği nedenlerin listesi.

Sıralamalar
BLOCKED_REASON_UNSPECIFIED Engelleme nedeni belirtilmedi.
SAFETY İçerik, güvenlik ayarları tarafından engellendi.
OTHER İçerik engellendi ancak nedeni kategorize edilmedi.

Yerleştirme

Yerleştirme işlemini temsil eden kayan noktalı sayılardan oluşan bir liste.

Alanlar
value[] number

Yerleştirme değerleri.

JSON gösterimi 
{
  "value": [
    number
  ]
}

Mesaj

Yapılandırılmış metnin temel birimi.

Message, author ve Message'nın content'ını içerir.

author, mesajlar metin olarak modele aktarılırken etiketlemek için kullanılır.

Alanlar
author string

İsteğe bağlıdır. Bu İletinin yazarı.

Bu, modele metin olarak beslendiğinde bu Mesajın içeriğini etiketlemek için anahtar görevi görür.

Yazar, herhangi bir alfanümerik dize olabilir.

content string

Zorunlu. Yapılandırılmış Message öğesinin metin içeriği.

citationMetadata object (CitationMetadata)

Yalnızca çıkış. Bu Message içinde model tarafından oluşturulan content için alıntı bilgileri.

Bu Message, modelden çıktı olarak oluşturulduysa bu alan, content içinde yer alan tüm metinlerin ilişkilendirme bilgileriyle doldurulabilir. Bu alan yalnızca çıkışta kullanılır.

JSON gösterimi 
{
  "author": string,
  "content": string,
  "citationMetadata": {
    object (CitationMetadata)
  }
}

MessagePrompt

Yapılandırılmış giriş metninin tamamı, istem olarak modele iletilir.

Bir MessagePrompt, görüşme için bağlam sağlayan yapılandırılmış bir alan grubu, modeli farklı şekillerde yanıt vermeye hazırlayan kullanıcı girişi/model çıkışı mesaj çiftleri örnekleri ve kullanıcı ile model arasındaki görüşmenin dönüşümlü olarak ilerlemesini temsil eden görüşme geçmişi veya mesaj listesini içerir.

Alanlar
context string

İsteğe bağlıdır. Yanıtı temellendirmek için önce modele sağlanması gereken metin.

Boş değilse bu context, examples ve messages'den önce modele verilir. context kullanırken sürekliliği korumak için her istekle birlikte bu bilgiyi sağladığınızdan emin olun.

Bu alan, bağlam sağlamaya ve yanıtları yönlendirmeye yardımcı olmak için modele gönderdiğiniz istemin açıklaması olabilir. Örnekler: "İfadeyi İngilizceden Fransızcaya çevir." veya "Bir ifade verildiğinde duyguyu mutlu, üzgün veya nötr olarak sınıflandır."

Toplam giriş boyutu modelin inputTokenLimit değerini aşıp giriş isteği kısaltılırsa bu alana dahil edilen her şey ileti geçmişine göre öncelikli olur.

examples[] object (Example)

İsteğe bağlıdır. Modelin oluşturması gerekenlere dair örnekler.

Buna hem kullanıcı girişi hem de modelin taklit etmesi gereken yanıt dahildir.

Bu examples, messages içindeki geçmişe göre öncelikli olması dışında, görüşme mesajlarıyla aynı şekilde değerlendirilir: Toplam giriş boyutu modelin inputTokenLimit değerini aşarsa giriş kesilir. Öğeler, examples tarihinden önce messages'dan kaldırılacak.

messages[] object (Message)

Zorunlu. Son görüşme geçmişinin kronolojik olarak sıralanmış anlık görüntüsü.

İki yazar arasında dönüşümlü olarak alternatifler sunulur.

Toplam giriş boyutu modelin inputTokenLimit değerini aşarsa giriş kesilir: En eski öğeler messages değerinden çıkarılır.

JSON gösterimi 
{
  "context": string,
  "examples": [
    {
      object (Example)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ]
}

Örnek

Modele talimat vermek için kullanılan bir giriş/çıkış örneği.

Modelin nasıl yanıt vermesi veya yanıtını nasıl biçimlendirmesi gerektiğini gösterir.

Alanlar
input object (Message)

Zorunlu. Kullanıcıdan gelen bir giriş Message örneği.

output object (Message)

Zorunlu. Giriş verildiğinde modelin nasıl bir çıkış vermesi gerektiğine dair bir örnek.

JSON gösterimi 
{
  "input": {
    object (Message)
  },
  "output": {
    object (Message)
  }
}

GenerateTextResponse

Aday tamamlama dahil olmak üzere modelin yanıtı.

Alanlar
candidates[] object (TextCompletion)

Modelin aday yanıtları.

filters[] object (ContentFilter)

İstem ve yanıt metni için bir dizi içerik filtreleme meta verisi.

Bu, hangi SafetyCategory'ların bir adayın bu yanıttan engellenmesine neden olduğunu, engellemeyi tetikleyen en düşük HarmProbability'ı ve bu kategori için HarmThreshold ayarını gösterir. Bu, en az 1 yanıtın engellemesini kaldırmak için SafetySettings üzerinde yapılması gereken en küçük değişikliği gösterir.

Engelleme, istekteki SafetySettings tarafından (veya API'nin varsayılan SafetySettings'sı) yapılandırılır.

safetyFeedback[] object (SafetyFeedback)

İçerik filtreleme ile ilgili tüm güvenlik geri bildirimlerini döndürür.

JSON gösterimi 
{
  "candidates": [
    {
      object (TextCompletion)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ],
  "safetyFeedback": [
    {
      object (SafetyFeedback)
    }
  ]
}

TextCompletion

Modelden döndürülen çıkış metni.

Alanlar
output string

Yalnızca çıkış. Modelden döndürülen oluşturulmuş metin.

safetyRatings[] object (SafetyRating)

Yanıtın güvenliğiyle ilgili puanlar.

Kategori başına en fazla bir puan verilebilir.

citationMetadata object (CitationMetadata)

Yalnızca çıkış. Bu TextCompletion içinde model tarafından oluşturulan output için alıntı bilgileri.

Bu alan, output içinde yer alan tüm metinler için ilişkilendirme bilgileriyle doldurulabilir.

JSON gösterimi 
{
  "output": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  }
}

SafetyFeedback

Tüm istek için güvenlik geri bildirimi.

Bu alan, giriş ve/veya yanıttaki içerik güvenlik ayarları nedeniyle engellendiyse doldurulur. SafetyFeedback, her HarmCategory için mevcut olmayabilir. Her SafetyFeedback, istek tarafından kullanılan güvenlik ayarlarının yanı sıra sonuç döndürmek için izin verilmesi gereken en düşük HarmProbability değerini döndürür.

Alanlar
rating object (SafetyRating)

İçerikten değerlendirilen güvenlik derecelendirmesi.

setting object (SafetySetting)

İsteğe uygulanan güvenlik ayarları.

JSON gösterimi 
{
  "rating": {
    object (SafetyRating)
  },
  "setting": {
    object (SafetySetting)
  }
}

TextPrompt

Modele istem olarak verilen metin.

Model, metin tamamlama oluşturmak için bu TextPrompt'u kullanır.

Alanlar
text string

Zorunlu. İstem metni.

JSON gösterimi 
{
  "text": string
}