Method: models.streamGenerateContent

Gera uma resposta transmitida do modelo com uma entrada GenerateContentRequest.

Solicitação HTTP

POST https://generativelanguage.googleapis.com/v1/{model=models/*}:streamGenerateContent

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

Parâmetros de caminho

Parâmetros
model

string

Obrigatório. O nome do Model a ser usado 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)
    }
  ],
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "generationConfig": {
    object (GenerationConfig)
  }
}
Campos
contents[]

object (Content)

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

Para consultas de uma única resposta, trata-se de uma instância única. Para consultas em vários turnos, esse é um campo repetido que contém o histórico da conversa + a solicitação mais recente.

safetySettings[]

object (SafetySetting)

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

Isso será aplicado a GenerateContentRequest.contents e GenerateContentResponse.candidates. Não pode haver mais de uma configuração para cada tipo de SafetyCategory. A API vai bloquear qualquer conteúdo e respostas que não atendam aos limites definidos por essas configurações. Essa lista substitui as configurações padrão para cada SafetyCategory especificado nas safetySettings. Se não houver uma SafetySetting para uma determinada SafetyCategory fornecida na lista, a API vai usar a configuração de segurança padrão para essa categoria. As categorias de danos HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT e HARM_CATEGORY_HARASSMENT são compatíveis.

generationConfig

object (GenerationConfig)

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

Corpo da resposta

Se bem-sucedido, o corpo da resposta terá um stream de instâncias 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.