Method: models.generateContent

Gera uma resposta do modelo que recebe uma entrada GenerateContentRequest.

Os recursos de entrada diferem entre os modelos, incluindo os ajustados. Consulte o guia de modelo e o guia de ajuste para mais detalhes.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
model

string

Obrigatório. O nome da Model que será usada para gerar a conclusão.

Formato: name=models/{model}.

Corpo da solicitação

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

Representação JSON
{
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string
}
Campos
contents[]

object (Content)

Obrigatório. O conteúdo da conversa atual com o modelo.

Para consultas de turno único, esta é uma instância única. Para consultas de vários turnos, esse é um campo repetido que contém o histórico de conversas + a solicitação mais recente.

tools[]

object (Tool)

Opcional. Uma lista de Tools que o modelo pode usar para gerar a próxima resposta.

Um Tool é um trecho de código que permite ao sistema interagir com sistemas externos para realizar uma ação, ou conjunto de ações, fora do conhecimento e do escopo do modelo. No momento, a única ferramenta compatível é Function.

toolConfig

object (ToolConfig)

Opcional. Configuração de ferramenta para qualquer Tool especificado na solicitação.

safetySettings[]

object (SafetySetting)

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

Isso será aplicado no GenerateContentRequest.contents e no GenerateContentResponse.candidates. Não pode haver mais de uma configuração para cada tipo de SafetyCategory. A API vai bloquear todos os conteúdos e respostas que não atenderem aos limites definidos por essas configurações. Essa lista substitui as configurações padrão de cada SafetyCategory especificada em safetySettings. Se não houver 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_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT e HARM_CATEGORY_HARASSMENT são compatíveis.

systemInstruction

object (Content)

Opcional. O desenvolvedor definiu as instruções do sistema. No momento, somente texto.

generationConfig

object (GenerationConfig)

Opcional. Opções de configuração para geração e saídas de modelos.

cachedContent

string

Opcional. O nome do conteúdo armazenado em cache usado como contexto para disponibilizar a previsão. Observação: usado apenas em cache explícito, em que os usuários podem ter controle sobre o armazenamento em cache (por exemplo, qual conteúdo armazenar em cache) e aproveitar a economia de custos garantida. Formato: cachedContents/{cachedContent}

Corpo da resposta

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

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.