PaLM (decommissioned)

Método: models.generateText

Genera una respuesta del modelo a partir de un mensaje de entrada.

Extremo

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

Parámetros de ruta

model string

Obligatorio. Nombre del Model o TunedModel que se usará para generar la finalización. Ejemplos: models/text-bison-001 tunedModels/sentence-translator-u3b7m Toma la forma models/{model}.

Cuerpo de la solicitud

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

Campos
prompt object (TextPrompt)

Obligatorio. Es el texto de entrada de formato libre que se le proporciona al modelo como instrucción.

Dado un mensaje, el modelo generará una respuesta de TextCompletion que predice como la finalización del texto de entrada.

safetySettings[] object (SafetySetting)

Opcional. Es una lista de instancias 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á cualquier instrucción y respuesta que no cumpla con los umbrales establecidos por estos parámetros de configuración. Esta lista anula la configuración predeterminada de cada SafetyCategory especificado en safetySettings. Si no hay un SafetySetting para un SafetyCategory determinado proporcionado en la lista, la API usará el parámetro de configuración de seguridad predeterminado para esa categoría. Las categorías de daño HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDICAL y HARM_CATEGORY_DANGEROUS se admiten en el servicio de texto.

stopSequences[] string

Es el conjunto de secuencias de caracteres (hasta 5) que detendrán la generación de resultados. 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 devolvió 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 más cercano a 0.0 generalmente generará respuestas más directas del modelo.

candidateCount integer

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

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

maxOutputTokens integer

Opcional. Es la cantidad máxima de tokens que se pueden incluir en un candidato.

Si no se configura, se establecerá de forma predeterminada en el valor de outputTokenLimit especificado en la especificación de Model.

topP number

Opcional. Es la probabilidad acumulativa máxima de los tokens que se deben tener en cuenta durante el muestreo.

El modelo usa una combinación de muestreo de Top-K y de núcleos.

Los tokens se ordenan según las probabilidades asignadas para que solo se tengan en cuenta los tokens más probables. El muestreo Top-k limita directamente la cantidad máxima de tokens que se deben 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 devolvió la función getModel.

topK integer

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

El modelo usa una combinación de muestreo de Top-K y de núcleos.

El muestreo Top-k considera el conjunto de los topK tokens más probables. 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 devolvió la función getModel.

Cuerpo de la respuesta

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

Método: models.countTextTokens

Ejecuta el tokenizador de un modelo en un texto y devuelve el recuento de tokens.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countTextTokens

Parámetros de ruta

model string

Obligatorio. Es el nombre del recurso del modelo. Este valor sirve como ID para que lo use el modelo.

Este nombre debe coincidir con un nombre de modelo que muestre el método models.list.

Formato: models/{model}. Toma la forma models/{model}.

Cuerpo de la solicitud

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

Campos
prompt object (TextPrompt)

Obligatorio. Es el texto de entrada de formato libre que se le proporciona al modelo como instrucción.

Cuerpo de la respuesta

Es una respuesta de models.countTextTokens.

Devuelve el tokenCount del modelo para el prompt.

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

Campos
tokenCount integer

Es la cantidad de tokens en los que el token model divide el token prompt.

Siempre no negativo.

Representación JSON 
{
  "tokenCount": integer
}

Método: models.generateMessage

Genera una respuesta del modelo a partir de una entrada MessagePrompt.

Extremo

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

Parámetros de ruta

model string

Obligatorio. Nombre del modelo que se usará.

Formato: name=models/{model}. Toma la forma models/{model}.

Cuerpo de la solicitud

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

Campos
prompt object (MessagePrompt)

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

Dado un mensaje, el modelo devolverá lo que predice que será el siguiente mensaje en la conversación.

temperature number

Opcional. Controla la aleatoriedad del resultado.

Los valores pueden oscilar entre [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 generalmente generará respuestas menos sorprendentes del modelo.

candidateCount integer

Opcional. Es la cantidad de mensajes de respuesta generados que se devolverán.

Este valor debe ser mayor o igual que [1, 8]. Si no se configura, el valor predeterminado será 1.

topP number

Opcional. Es la probabilidad acumulativa máxima de los tokens que se deben tener en cuenta durante el muestreo.

El modelo usa una combinación de muestreo de Top-K y de núcleos.

El muestreo de núcleo considera el conjunto más pequeño de tokens cuya suma de probabilidades es al menos topP.

topK integer

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

El modelo usa una combinación de muestreo de Top-K y de núcleos.

El muestreo Top-k considera el conjunto de los topK tokens más probables.

Cuerpo de la respuesta

Es 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:

Campos
candidates[] object (Message)

Son los mensajes de respuesta candidatos del modelo.

messages[] object (Message)

Es el historial de conversación que usa el modelo.

filters[] object (ContentFilter)

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

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.

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

Método: models.countMessageTokens

Ejecuta el tokenizador de un modelo en una cadena y devuelve el recuento de tokens.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countMessageTokens

Parámetros de ruta

model string

Obligatorio. Es el nombre del recurso del modelo. Este valor sirve como ID para que lo use el modelo.

Este nombre debe coincidir con un nombre de modelo que muestre el método models.list.

Formato: models/{model}. Toma la forma models/{model}.

Cuerpo de la solicitud

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

Campos
prompt object (MessagePrompt)

Obligatorio. Es la instrucción cuya cantidad de tokens se devolverá.

Cuerpo de la respuesta

Es una respuesta de models.countMessageTokens.

Devuelve el tokenCount del modelo para el prompt.

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

Campos
tokenCount integer

Es la cantidad de tokens en los que el token model divide el token prompt.

Siempre no negativo.

Representación JSON 
{
  "tokenCount": integer
}

Método: models.embedText

Genera un embedding a partir del modelo con un mensaje de entrada.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedText

Parámetros de ruta

model string

Obligatorio. Nombre del modelo que se usará con el formato model=models/{model}. Toma la forma models/{model}.

Cuerpo de la solicitud

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

Campos
text string

Opcional. Es el texto de entrada de formato libre que el modelo convertirá en una incorporación.

Cuerpo de la respuesta

Es la respuesta a una EmbedTextRequest.

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

Campos
embedding object (Embedding)

Solo salida. Es la incorporación generada a partir del texto de entrada.

Representación JSON 
{
  "embedding": {
    object (Embedding)
  }
}

Método: models.batchEmbedText

Genera múltiples embeddings a partir del modelo, dado el texto de entrada en una llamada síncrona.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedText

Parámetros de ruta

model string

Obligatorio. Es el nombre del Model que se usará para generar el embedding. Ejemplos: models/embedding-gecko-001. Tiene el formato models/{model}.

Cuerpo de la solicitud

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

Campos
texts[] string

Opcional. Son los textos de entrada de formato libre que el modelo convertirá en una incorporación. El límite actual es de 100 textos, y se arrojará un error si se supera.

requests[] object (EmbedTextRequest)

Opcional. Son las solicitudes de incorporación para el lote. Solo se puede establecer uno de los valores texts o requests.

Cuerpo de la respuesta

Es la respuesta a una EmbedTextRequest.

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

Campos
embeddings[] object (Embedding)

Solo salida. Son las incorporaciones generadas a partir del texto de entrada.

Representación JSON 
{
  "embeddings": [
    {
      object (Embedding)
    }
  ]
}

EmbedTextRequest

Es una solicitud para obtener una incorporación de texto del modelo.

Campos
model string

Obligatorio. Nombre del modelo que se usará con el formato model=models/{model}.

text string

Opcional. Es el texto de entrada de formato libre que el modelo convertirá en una incorporación.

Representación JSON 
{
  "model": string,
  "text": string
}

ContentFilter

Son los metadatos de filtrado de contenido asociados con el procesamiento de una sola solicitud.

ContentFilter contiene un motivo y una cadena de asistencia opcional. Es posible que el motivo no se especifique.

Campos
reason enum (BlockedReason)

Es el motivo por el que se bloqueó el contenido durante el procesamiento de la solicitud.

message string

Es una cadena que describe el comportamiento del filtro con más detalle.

Representación JSON 
{
  "reason": enum (BlockedReason),
  "message": string
}

BlockedReason

Es una lista de los motivos por los que se puede haber bloqueado el contenido.

Enumeraciones
BLOCKED_REASON_UNSPECIFIED No se especificó un motivo de bloqueo.
SAFETY La configuración de seguridad bloqueó el contenido.
OTHER Se bloqueó el contenido, pero el motivo no está categorizado.

Embedding

Es una lista de números de punto flotante que representa la incorporación.

Campos
value[] number

Son los valores de la incorporación.

Representación JSON 
{
  "value": [
    number
  ]
}

Mensaje

Es la unidad base del texto estructurado.

Un Message incluye un author y el content del Message.

El author se usa para etiquetar mensajes cuando se ingresan en el modelo como texto.

Campos
author string

Opcional. Es el autor de este mensaje.

Sirve como clave para etiquetar el contenido de este mensaje cuando se ingresa en el modelo como texto.

El autor puede ser cualquier cadena alfanumérica.

content string

Obligatorio. Es el contenido de texto del Message estructurado.

citationMetadata object (CitationMetadata)

Solo salida. Es la información de la cita para el content generado por el modelo en este Message.

Si este Message se generó como resultado del modelo, es posible que este campo se complete con información de atribución para cualquier texto incluido en el content. Este campo solo se usa en la salida.

Representación JSON 
{
  "author": string,
  "content": string,
  "citationMetadata": {
    object (CitationMetadata)
  }
}

MessagePrompt

Es todo el texto de entrada estructurado que se pasa al modelo como instrucción.

Un MessagePrompt contiene un conjunto estructurado de campos que proporcionan contexto para la conversación, ejemplos de pares de mensajes de entrada del usuario y salida del modelo que preparan al modelo para responder de diferentes maneras, y el historial de conversaciones o la lista de mensajes que representan los turnos alternados de la conversación entre el usuario y el modelo.

Campos
context string

Opcional. Texto que se debe proporcionar primero al modelo para fundamentar la respuesta.

Si no está vacío, este context se proporcionará al modelo antes que el examples y el messages. Cuando uses un context, asegúrate de proporcionarlo con cada solicitud para mantener la continuidad.

Este campo puede ser una descripción de tu instrucción al modelo para ayudar a proporcionar contexto y guiar las respuestas. Ejemplos: "Traduce la frase del inglés al francés" o "Dada una declaración, clasifica el sentimiento como feliz, triste o neutral".

Todo lo que se incluya en este campo tendrá prioridad sobre el historial de mensajes si el tamaño total de la entrada supera el inputTokenLimit del modelo y se trunca la solicitud de entrada.

examples[] object (Example)

Opcional. Ejemplos de lo que debería generar el modelo.

Esto incluye tanto la entrada del usuario como la respuesta que debería emular el modelo.

Estos examples se tratan de forma idéntica a los mensajes de conversación, excepto que tienen prioridad sobre el historial en messages: Si el tamaño total de la entrada supera el inputTokenLimit del modelo, la entrada se truncará. Los elementos se quitarán de messages antes de examples.

messages[] object (Message)

Obligatorio. Es una instantánea del historial de conversaciones recientes ordenado cronológicamente.

Los turnos se alternan entre dos autores.

Si el tamaño total de la entrada supera el inputTokenLimit del modelo, la entrada se truncará: los elementos más antiguos se quitarán de messages.

Representación JSON 
{
  "context": string,
  "examples": [
    {
      object (Example)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ]
}

Ejemplo

Es un ejemplo de entrada o salida que se usa para dar instrucciones al modelo.

Demuestra cómo debe responder el modelo o cómo debe formatear su respuesta.

Campos
input object (Message)

Obligatorio. Ejemplo de una entrada Message del usuario.

output object (Message)

Obligatorio. Es un ejemplo de lo que el modelo debería generar dada la entrada.

Representación JSON 
{
  "input": {
    object (Message)
  },
  "output": {
    object (Message)
  }
}

GenerateTextResponse

Es la respuesta del modelo, incluidas las sugerencias de completado.

Campos
candidates[] object (TextCompletion)

Son las respuestas candidatas del modelo.

filters[] object (ContentFilter)

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

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. Esto indica el cambio más pequeño en el SafetySettings que sería necesario para desbloquear al menos 1 respuesta.

El bloqueo se configura con el parámetro SafetySettings en la solicitud (o el parámetro SafetySettings predeterminado de la API).

safetyFeedback[] object (SafetyFeedback)

Devuelve cualquier comentario de seguridad relacionado con el filtrado de contenido.

Representación JSON 
{
  "candidates": [
    {
      object (TextCompletion)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ],
  "safetyFeedback": [
    {
      object (SafetyFeedback)
    }
  ]
}

TextCompletion

Es el texto de salida que devuelve un modelo.

Campos
output string

Solo salida. Es el texto generado que devuelve el modelo.

safetyRatings[] object (SafetyRating)

Son las calificaciones de seguridad de una respuesta.

Hay, como máximo, una clasificación por categoría.

citationMetadata object (CitationMetadata)

Solo salida. Es la información de la cita para el output generado por el modelo en este TextCompletion.

Este campo puede completarse con información de atribución para cualquier texto incluido en output.

Representación JSON 
{
  "output": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  }
}

SafetyFeedback

Es la opinión sobre la seguridad de una solicitud completa.

Este campo se completa si el contenido de la entrada o la respuesta se bloquea debido a la configuración de seguridad. Es posible que SafetyFeedback no exista para cada HarmCategory. Cada SafetyFeedback devolverá la configuración de seguridad que usó la solicitud, así como la probabilidad de daño más baja que se debe permitir para devolver un resultado.

Campos
rating object (SafetyRating)

Es la calificación de seguridad que se evalúa a partir del contenido.

setting object (SafetySetting)

Es la configuración de seguridad que se aplicó a la solicitud.

Representación JSON 
{
  "rating": {
    object (SafetyRating)
  },
  "setting": {
    object (SafetySetting)
  }
}

TextPrompt

Es el texto que se le proporciona al modelo como instrucción.

El Modelo usará este TextPrompt para generar una finalización de texto.

Campos
text string

Obligatorio. Es el texto de la instrucción.

Representación JSON 
{
  "text": string
}