PaLM (decommissioned)

Método: models.generateText

Gera uma resposta do modelo com base em uma mensagem de entrada.

Endpoint

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

Parâmetros de caminho

model string

Obrigatório. O nome do Model ou TunedModel a ser usado para gerar a conclusão. Exemplos: models/text-bison-001 tunedModels/sentence-translator-u3b7m. Ele tem a forma models/{model}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Campos
prompt object (TextPrompt)

Obrigatório. O texto de entrada de formato livre fornecido ao modelo como um comando.

Dado um comando, o modelo vai gerar uma resposta TextCompletion que ele prevê como a conclusão do texto de entrada.

safetySettings[] object (SafetySetting)

Opcional. Uma lista de instâncias SafetySetting exclusivas para bloquear conteúdo não seguro.

que será aplicado no GenerateTextRequest.prompt e no GenerateTextResponse.candidates. Não pode haver mais de uma configuração para cada tipo de SafetyCategory. A API vai bloquear todos os comandos e respostas que não atenderem aos limites definidos por essas configurações. Essa lista substitui as configurações padrão de cada SafetyCategory especificado em "safetySettings". Se não houver um SafetySetting para um determinado SafetyCategory fornecido na lista, a API vai usar a configuração de segurança padrão para essa categoria. As categorias de dano HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDICAL e HARM_CATEGORY_DANGEROUS são compatíveis com o serviço de texto.

stopSequences[] string

O conjunto de sequências de caracteres (até 5) que vão interromper a geração de saída. Se especificado, a API vai parar na primeira aparição de uma sequência de parada. Ela não será incluída como parte da resposta.

temperature number

Opcional. Controla a aleatoriedade da saída. Observação: o valor padrão varia de acordo com o modelo. Consulte o atributo Model.temperature do Model retornado pela função getModel.

Os valores podem variar de [0,0, 1,0], inclusive. Um valor mais próximo de 1,0 vai gerar respostas mais variadas e criativas, enquanto um valor mais próximo de 0,0 geralmente resulta em respostas mais diretas do modelo.

candidateCount integer

Opcional. Número de respostas geradas a serem retornadas.

Esse valor precisa estar entre [1, 8], inclusive. Se não for definido, o padrão será 1.

maxOutputTokens integer

Opcional. O número máximo de tokens a serem incluídos em um candidato.

Se não for definido, o padrão será "outputTokenLimit" especificado na especificação Model.

topP number

Opcional. A probabilidade cumulativa máxima de tokens a serem considerados na amostragem.

O modelo usa amostragem combinada Top-k e de núcleo.

Os tokens são classificados com base nas probabilidades atribuídas para que apenas os mais prováveis sejam considerados. A amostragem Top-k limita diretamente o número máximo de tokens a serem considerados, enquanto a amostragem de núcleo limita o número de tokens com base na probabilidade cumulativa.

Observação: o valor padrão varia de acordo com o modelo. Consulte o atributo Model.top_p do Model retornado pela função getModel.

topK integer

Opcional. O número máximo de tokens a serem considerados ao fazer a amostragem.

O modelo usa amostragem combinada Top-k e de núcleo.

A amostragem Top-K considera o conjunto dos topK tokens mais prováveis. O padrão é 40.

Observação: o valor padrão varia de acordo com o modelo. Consulte o atributo Model.top_k do Model retornado pela função getModel.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de GenerateTextResponse.

Método: models.countTextTokens

Executa o tokenizador de um modelo em um texto e retorna a contagem de tokens.

Endpoint

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

Parâmetros de caminho

model string

Obrigatório. O nome do recurso do modelo. Ele serve como um ID para o modelo usar.

Esse nome precisa corresponder a um nome de modelo retornado pelo método models.list.

Formato: models/{model}. Ele tem o formato models/{model}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Campos
prompt object (TextPrompt)

Obrigatório. O texto de entrada de formato livre fornecido ao modelo como um comando.

Corpo da resposta

Uma resposta de models.countTextTokens.

Ele retorna o tokenCount do modelo para o prompt.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Campos
tokenCount integer

O número de tokens que o model tokeniza o prompt.

Sempre não negativo.

Representação JSON 
{
  "tokenCount": integer
}

Método: models.generateMessage

Gera uma resposta do modelo com base em uma entrada MessagePrompt.

Endpoint

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

Parâmetros de caminho

model string

Obrigatório. O nome do modelo a ser usado.

Formato: name=models/{model}. Ele tem o formato models/{model}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Campos
prompt object (MessagePrompt)

Obrigatório. A entrada textual estruturada fornecida ao modelo como um comando.

Com base em um comando, o modelo retorna o que ele prevê que será a próxima mensagem na conversa.

temperature number

Opcional. Controla a aleatoriedade da saída.

Os valores podem variar em [0.0,1.0], inclusive. Um valor mais próximo de 1.0 vai gerar respostas mais variadas, enquanto um valor mais próximo de 0.0 geralmente resulta em respostas menos surpreendentes do modelo.

candidateCount integer

Opcional. O número de mensagens de resposta geradas a serem retornadas.

Esse valor precisa estar entre [1, 8], inclusive. Se não for definido, o padrão será 1.

topP number

Opcional. A probabilidade cumulativa máxima de tokens a serem considerados na amostragem.

O modelo usa amostragem combinada Top-k e de núcleo.

A amostragem de núcleo considera o menor conjunto de tokens cuja soma de probabilidade é pelo menos topP.

topK integer

Opcional. O número máximo de tokens a serem considerados ao fazer a amostragem.

O modelo usa amostragem combinada Top-k e de núcleo.

A amostragem Top-K considera o conjunto dos topK tokens mais prováveis.

Corpo da resposta

A resposta do modelo.

Isso inclui mensagens de candidatos e o histórico de conversas na forma de mensagens ordenadas cronologicamente.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Campos
candidates[] object (Message)

Mensagens de resposta candidatas do modelo.

messages[] object (Message)

O histórico de conversa usado pelo modelo.

filters[] object (ContentFilter)

Um conjunto de metadados de filtragem de conteúdo para o texto do comando e da resposta.

Isso indica quais SafetyCategorys bloquearam um candidato dessa resposta, o HarmProbability mais baixo que acionou um bloqueio e a configuração de HarmThreshold para essa categoria.

Representação JSON 
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}

Método: models.countMessageTokens

Executa o tokenizador de um modelo em uma string e retorna a contagem de tokens.

Endpoint

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

Parâmetros de caminho

model string

Obrigatório. O nome do recurso do modelo. Ele serve como um ID para o modelo usar.

Esse nome precisa corresponder a um nome de modelo retornado pelo método models.list.

Formato: models/{model}. Ele tem o formato models/{model}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Campos
prompt object (MessagePrompt)

Obrigatório. O comando, cuja contagem de tokens será retornada.

Corpo da resposta

Uma resposta de models.countMessageTokens.

Ele retorna o tokenCount do modelo para o prompt.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Campos
tokenCount integer

O número de tokens que o model tokeniza o prompt.

Sempre não negativo.

Representação JSON 
{
  "tokenCount": integer
}

Método: models.embedText

Gera um embedding do modelo com base em uma mensagem de entrada.

Endpoint

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

Parâmetros de caminho

model string

Obrigatório. O nome do modelo a ser usado com o formato model=models/{model}. Ele tem o formato models/{model}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Campos
text string

Opcional. O texto de entrada livre que o modelo vai transformar em um embedding.

Corpo da resposta

A resposta a um EmbedTextRequest.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Campos
embedding object (Embedding)

Apenas saída. O embedding gerado com base no texto de entrada.

Representação JSON 
{
  "embedding": {
    object (Embedding)
  }
}

Método: models.batchEmbedText

Gera várias incorporações do modelo com base no texto de entrada em uma chamada síncrona.

Endpoint

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

Parâmetros de caminho

model string

Obrigatório. O nome do Model a ser usado para gerar o embedding. Exemplos: models/embedding-gecko-001. Ele tem o formato models/{model}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Campos
texts[] string

Opcional. Os textos de entrada de formato livre que o modelo vai transformar em um embedding. O limite atual é de 100 textos, e um erro será gerado se esse número for excedido.

requests[] object (EmbedTextRequest)

Opcional. Solicitações de incorporação para o lote. Apenas um de texts ou requests pode ser definido.

Corpo da resposta

A resposta a um EmbedTextRequest.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Campos
embeddings[] object (Embedding)

Apenas saída. Os embeddings gerados com base no texto de entrada.

Representação JSON 
{
  "embeddings": [
    {
      object (Embedding)
    }
  ]
}

EmbedTextRequest

Solicitação para receber um embedding de texto do modelo.

Campos
model string

Obrigatório. O nome do modelo a ser usado com o formato model=models/{model}.

text string

Opcional. O texto de entrada livre que o modelo vai transformar em um embedding.

Representação JSON 
{
  "model": string,
  "text": string
}

ContentFilter

Metadados de filtragem de conteúdo associados ao processamento de uma única solicitação.

O ContentFilter contém um motivo e uma string de suporte opcional. O motivo pode não ter sido especificado.

Campos
reason enum (BlockedReason)

O motivo pelo qual o conteúdo foi bloqueado durante o processamento da solicitação.

message string

Uma string que descreve o comportamento de filtragem com mais detalhes.

Representação JSON 
{
  "reason": enum (BlockedReason),
  "message": string
}

BlockedReason

Uma lista de motivos pelos quais o conteúdo pode ter sido bloqueado.

Enums
BLOCKED_REASON_UNSPECIFIED Um motivo de bloqueio não foi especificado.
SAFETY O conteúdo foi bloqueado pelas configurações de segurança.
OTHER O conteúdo foi bloqueado, mas o motivo não foi categorizado.

Incorporação

Uma lista de pontos flutuantes que representam a incorporação.

Campos
value[] number

Os valores de embedding.

Representação JSON 
{
  "value": [
    number
  ]
}

Mensagem

A unidade básica de texto estruturado.

Um Message inclui um author e o content do Message.

O author é usado para marcar mensagens quando elas são inseridas no modelo como texto.

Campos
author string

Opcional. O autor desta mensagem.

Isso serve como uma chave para adicionar tags ao conteúdo desta mensagem quando ela é enviada ao modelo como texto.

O autor pode ser qualquer string alfanumérica.

content string

Obrigatório. O conteúdo de texto do Message estruturado.

citationMetadata object (CitationMetadata)

Apenas saída. Informações de citação para content gerados por modelos neste Message.

Se esse Message foi gerado como saída do modelo, esse campo poderá ser preenchido com informações de atribuição para qualquer texto incluído no content. Este campo é usado apenas na saída.

Representação JSON 
{
  "author": string,
  "content": string,
  "citationMetadata": {
    object (CitationMetadata)
  }
}

MessagePrompt

Todo o texto de entrada estruturado transmitido ao modelo como um comando.

Um MessagePrompt contém um conjunto estruturado de campos que fornecem contexto para a conversa, exemplos de pares de mensagens de entrada do usuário/saída do modelo que preparam o modelo para responder de diferentes maneiras e o histórico da conversa ou a lista de mensagens que representam os turnos alternados da conversa entre o usuário e o modelo.

Campos
context string

Opcional. Texto que deve ser fornecido ao modelo primeiro para fundamentar a resposta.

Se não estiver vazio, esse context será fornecido ao modelo primeiro, antes de examples e messages. Ao usar um context, forneça-o em todas as solicitações para manter a continuidade.

Esse campo pode ser uma descrição do seu comando para o modelo, ajudando a fornecer contexto e orientar as respostas. Exemplos: "Traduza a frase do inglês para o francês" ou "Classifique o sentimento de uma declaração como feliz, triste ou neutro".

Tudo o que for incluído nesse campo terá precedência sobre o histórico de mensagens se o tamanho total da entrada exceder o inputTokenLimit do modelo e a solicitação de entrada for truncada.

examples[] object (Example)

Opcional. Exemplos do que o modelo deve gerar.

Isso inclui a entrada do usuário e a resposta que o modelo deve imitar.

Esses examples são tratados de forma idêntica às mensagens de conversa, exceto que têm precedência sobre o histórico em messages: se o tamanho total da entrada exceder o inputTokenLimit do modelo, a entrada será truncada. Os itens serão removidos de messages antes de examples.

messages[] object (Message)

Obrigatório. Um snapshot do histórico de conversas recentes classificado em ordem cronológica.

As falas alternam entre dois autores.

Se o tamanho total da entrada exceder o inputTokenLimit do modelo, a entrada será truncada: os itens mais antigos serão descartados de messages.

Representação JSON 
{
  "context": string,
  "examples": [
    {
      object (Example)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ]
}

Exemplo

Um exemplo de entrada/saída usado para instruir o modelo.

Ele demonstra como o modelo deve responder ou formatar a resposta.

Campos
input object (Message)

Obrigatório. Exemplo de uma entrada Message do usuário.

output object (Message)

Obrigatório. Um exemplo do que o modelo deve gerar com base na entrada.

Representação JSON 
{
  "input": {
    object (Message)
  },
  "output": {
    object (Message)
  }
}

GenerateTextResponse

A resposta do modelo, incluindo conclusões candidatas.

Campos
candidates[] object (TextCompletion)

Respostas candidatas do modelo.

filters[] object (ContentFilter)

Um conjunto de metadados de filtragem de conteúdo para o texto do comando e da resposta.

Isso indica quais SafetyCategorys bloquearam um candidato dessa resposta, o HarmProbability mais baixo que acionou um bloqueio e a configuração de HarmThreshold para essa categoria. Isso indica a menor mudança no SafetySettings necessária para desbloquear pelo menos uma resposta.

O bloqueio é configurado pelo SafetySettings na solicitação (ou o SafetySettings padrão da API).

safetyFeedback[] object (SafetyFeedback)

Retorna qualquer feedback de segurança relacionado à filtragem de conteúdo.

Representação JSON 
{
  "candidates": [
    {
      object (TextCompletion)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ],
  "safetyFeedback": [
    {
      object (SafetyFeedback)
    }
  ]
}

TextCompletion

Texto de saída retornado de um modelo.

Campos
output string

Apenas saída. O texto gerado retornado do modelo.

safetyRatings[] object (SafetyRating)

Classificações para a segurança de uma resposta.

Há no máximo uma classificação por categoria.

citationMetadata object (CitationMetadata)

Apenas saída. Informações de citação para output gerados por modelos neste TextCompletion.

Esse campo pode ser preenchido com informações de atribuição para qualquer texto incluído no output.

Representação JSON 
{
  "output": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  }
}

SafetyFeedback

Feedback de segurança para uma solicitação inteira.

Esse campo é preenchido se o conteúdo na entrada e/ou resposta for bloqueado devido às configurações de segurança. O SafetyFeedback pode não existir para todas as HarmCategory. Cada SafetyFeedback vai retornar as configurações de segurança usadas pela solicitação, bem como a menor HarmProbability que deve ser permitida para retornar um resultado.

Campos
rating object (SafetyRating)

Classificação de segurança avaliada com base no conteúdo.

setting object (SafetySetting)

Configurações de segurança aplicadas à solicitação.

Representação JSON 
{
  "rating": {
    object (SafetyRating)
  },
  "setting": {
    object (SafetySetting)
  }
}

TextPrompt

Texto fornecido ao modelo como um comando.

O modelo vai usar esse TextPrompt para gerar uma conclusão de texto.

Campos
text string

Obrigatório. O texto do comando.

Representação JSON 
{
  "text": string
}