Method: models.generateContent

Genera una respuesta del modelo según una GenerateContentRequest de entrada.

Las capacidades de entrada difieren entre los modelos, incluidos los ajustados. Consulta la guía del modelo y la guía de ajuste para obtener más detalles.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
model

string

Obligatorio. Es el nombre de Model que se usará para generar la finalización.

Formato: name=models/{model}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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)

Obligatorio. El contenido de la conversación actual con el modelo.

Para consultas de un solo turno, esta es una instancia única. Para consultas de varios turnos, es un campo repetido que contiene el historial de conversaciones y la solicitud más reciente.

tools[]

object (Tool)

Opcional. Una lista de Tools que el modelo puede usar para generar la siguiente respuesta.

Un Tool es un fragmento de código que permite que el sistema interactúe con sistemas externos para realizar una acción, o un conjunto de acciones, fuera del conocimiento y el alcance del modelo. Por el momento, la única herramienta compatible es Function.

toolConfig

object (ToolConfig)

Opcional. Configuración de herramientas para cualquier Tool especificado en la solicitud.

safetySettings[]

object (SafetySetting)

Opcional. Una lista de instancias de SafetySetting únicas para bloquear contenido no seguro.

Esto se aplicará de manera forzosa en GenerateContentRequest.contents y GenerateContentResponse.candidates. No debe haber más de un parámetro de configuración para cada tipo de SafetyCategory. La API bloqueará el contenido y las respuestas que no cumplan con los umbrales establecidos por esta configuración. Esta lista anula la configuración predeterminada para cada SafetyCategory especificado en SafetySettings. Si no hay un SafetySetting para un SafetyCategory determinado proporcionado en la lista, la API usará la configuración de seguridad predeterminada para esa categoría. Se admiten las categorías de daños HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT.

systemInstruction

object (Content)

Opcional. Instrucción del sistema establecida por el desarrollador. Actualmente, es solo texto.

generationConfig

object (GenerationConfig)

Opcional. Opciones de configuración para la generación y la salida de modelos.

cachedContent

string

Opcional. Es el nombre del contenido almacenado en caché que se usa como contexto para entregar la predicción. Nota: Solo se usa en el almacenamiento en caché explícito, donde los usuarios pueden tener control sobre el almacenamiento en caché (p.ej., qué contenido almacenar en caché) y disfrutar de ahorros de costos garantizados. Formato: cachedContents/{cachedContent}

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de GenerateContentResponse.

Alcances de autorización

Se necesita uno de los siguientes permisos 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 obtener más información, consulta Descripción general de la autenticación.