Method: models.generateMessage

Gera uma resposta do modelo com uma entrada MessagePrompt.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
model

string

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

Formato: name=models/{model}.

Corpo da solicitação

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

Representação JSON 
{
  "prompt": {
    object (MessagePrompt)
  },
  "temperature": number,
  "candidateCount": integer,
  "topP": number,
  "topK": integer
}
Campos
prompt

object (MessagePrompt)

Obrigatório. A entrada de texto estruturada dada ao modelo como um comando.

Com um comando, o modelo retorna o que está previsto na próxima mensagem da discussão.
temperature

number

Opcional. Controla a aleatoriedade da saída.

Os valores podem variar a partir de [0.0,1.0]. Um valor mais próximo de 1.0 produzirá respostas mais variadas, enquanto um valor mais próximo de 0.0 normalmente resulta em respostas menos surpreendentes do modelo.
candidateCount

integer

Opcional. O número de mensagens de resposta geradas que serão retornadas.

Esse valor precisa estar entre [1, 8]. 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 de Top-k e de núcleos.

A amostragem Nucleus considera o menor conjunto de tokens cuja soma de probabilidade é de pelo menos topP.
topK

integer

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

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

A amostragem top-k considera o conjunto de topK tokens mais prováveis.

Corpo da resposta

A resposta do modelo.

Isso inclui as mensagens de candidatos e o histórico de conversas na forma de mensagens em ordem cronológica.

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

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

object (Message)

Mensagens de resposta do candidato do modelo.
messages[]

object (Message)

O histórico de conversas usado pelo modelo.
filters[]

object (ContentFilter)

Um conjunto de metadados de filtragem de conteúdo para o texto de solicitação e resposta.

Isso indica quais SafetyCategory(s) bloquearam um candidato desta resposta, a menor HarmProbability que acionou um bloqueio e a configuração HarmThreshold para essa categoria.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • 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

Para saber mais, consulte a Visão geral da autenticação.