Method: models.generateText

Genera una respuesta del modelo cuando recibe un mensaje de entrada.

Solicitud HTTP

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

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 o TunedModel que se usará para generar la función de finalización. Ejemplos: models/text-bison-001 recibaModels/sentence-translator-u3b7m

Cuerpo de la solicitud

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

Representación JSON
{
  "prompt": {
    object (TextPrompt)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "stopSequences": [
    string
  ],
  "temperature": number,
  "candidateCount": integer,
  "maxOutputTokens": integer,
  "topP": number,
  "topK": integer
}
Campos
prompt

object (TextPrompt)

Obligatorio. El texto de entrada de formato libre dado al modelo como una instrucción.

Cuando se recibe una instrucción, el modelo generará una respuesta TextCompletion que predice como la finalización del texto de entrada.

safetySettings[]

object (SafetySetting)

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

que se aplicará en GenerateTextRequest.prompt y GenerateTextResponse.candidates. No debe haber más de un parámetro de configuración para cada tipo de SafetyCategory. La API bloqueará los mensajes y las respuestas que no cumplan con los umbrales que establece esta configuración. Esta lista anula la configuración predeterminada de cada SafetyCategory especificado en safetySettings. Si no se proporciona ningún SafetySetting para un SafetyCategory determinado en la lista, la API usará la configuración de seguridad predeterminada para esa categoría. Los servicios de texto admiten las categorías de daños HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDICAL y HARM_CATEGORY_DANGEROUS.

stopSequences[]

string

El conjunto de secuencias de caracteres (hasta 5) que detendrán la generación del resultado. Si se especifica, la API se detendrá en la primera aparición de una secuencia de detención. La secuencia de detención no se incluirá como parte de la respuesta.

temperature

number

Opcional. Controla la aleatoriedad del resultado. Nota: El valor predeterminado varía según el modelo. Consulta el atributo Model.temperature del Model que mostró la función getModel.

Los valores pueden variar de [0.0,1.0] inclusive. Un valor más cercano a 1.0 producirá respuestas más variadas y creativas, mientras que un valor cercano a 0.0 generalmente dará como resultado respuestas más sencillas por parte del modelo.

candidateCount

integer

Opcional. Cantidad de respuestas generadas que se mostrarán.

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

maxOutputTokens

integer

Opcional. La cantidad máxima de tokens que se deben incluir en un candidato.

Si no se configura, se usará de forma predeterminada como outputTokenLimit especificado en la especificación Model.

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.

Los tokens se ordenan según las probabilidades asignadas de modo que solo se consideren los más probables. El muestreo de k superior limita directamente la cantidad máxima de tokens a considerar, mientras que el muestreo de Nucleus limita la cantidad de tokens según la probabilidad acumulativa.

Nota: El valor predeterminado varía según el modelo. Consulta el atributo Model.top_p del Model que mostró la función getModel.

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. La configuración predeterminada es 40.

Nota: El valor predeterminado varía según el modelo. Consulta el atributo Model.top_k del Model que mostró la función getModel.

Cuerpo de la respuesta

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

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.