- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
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 |
Obrigatório. O nome do modelo a ser usado. Formato: |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{
"prompt": {
object ( |
Campos | |
---|---|
prompt |
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 |
Opcional. Controla a aleatoriedade da saída. Os valores podem variar a partir de |
candidateCount |
Opcional. O número de mensagens de resposta geradas que serão retornadas. Esse valor precisa estar entre |
topP |
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 |
topK |
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 |
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 ( |
Campos | |
---|---|
candidates[] |
Mensagens de resposta do candidato do modelo. |
messages[] |
O histórico de conversas usado pelo modelo. |
filters[] |
Um conjunto de metadados de filtragem de conteúdo para o texto de solicitação e resposta. Isso indica quais |
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.