Method: models.generateMessage

Genera una respuesta del modelo en función de una MessagePrompt de entrada.

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
model

string

Obligatorio. El nombre del modelo que se usará.

Formato: name=models/{model}.

Cuerpo de la solicitud

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

Representación JSON 
{
  "prompt": {
    object (MessagePrompt)
  },
  "temperature": number,
  "candidateCount": integer,
  "topP": number,
  "topK": integer
}
Campos
prompt

object (MessagePrompt)

Obligatorio. Es la entrada textual estructurada que se le proporciona al modelo como una instrucción.

Cuando se le da una instrucción, el modelo mostrará lo que predice que es el siguiente mensaje de la discusión.
temperature

number

Opcional. Controla la aleatoriedad del resultado.

Los valores pueden ser superiores a [0.0,1.0], inclusive. Un valor más cercano a 1.0 producirá respuestas más variadas, mientras que un valor más cercano a 0.0 normalmente dará como resultado respuestas menos sorprendentes del modelo.
candidateCount

integer

Opcional. La cantidad de mensajes de respuesta generados que se mostrarán.

Este valor debe estar entre [1, 8] inclusive. Si no la estableces, el valor predeterminado será 1.
topP

number

Opcional. Es la probabilidad acumulada máxima de los tokens que se deben tener en cuenta cuando se realiza el muestreo.

El modelo usa el muestreo combinado de k superior y núcleo.

El muestreo de Nucleus considera el conjunto más pequeño de tokens cuya suma de probabilidad es al menos topP.
topK

integer

Opcional. Es la cantidad máxima de tokens que se deben tener en cuenta cuando se realiza el muestreo.

El modelo usa el muestreo combinado de k superior y núcleo.

El muestreo de k superior considera el conjunto de tokens más probables de topK.

Cuerpo de la respuesta

La respuesta del modelo.

Esto incluye los mensajes de los candidatos y el historial de conversaciones en forma de mensajes ordenados cronológicamente.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}
Campos
candidates[]

object (Message)

Mensajes de respuesta de candidatos del modelo.
messages[]

object (Message)

El historial de conversaciones que usa el modelo.
filters[]

object (ContentFilter)

Es un conjunto de metadatos de filtrado de contenido para el texto de instrucción y respuesta.

Esto indica qué SafetyCategory bloquearon a un candidato de esta respuesta, el HarmProbability más bajo que activó un bloqueo y el parámetro de configuración HarmThreshold para esa categoría.

Permisos de autorización

Se necesita uno de los siguientes alcances 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.