Método: tunnelModels.generateContent
- Extremo
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Ejemplo de solicitud
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.
Extremo
publicación
https://generativelanguage.googleapis.com/v1beta/{model=tunedModels/*}:generateContent
Parámetros de ruta
model
string
Obligatorio. Es el nombre de Model
que se usará para generar la finalización.
Formato: name=models/{model}
. Toma la forma tunedModels/{tunedmodel}
.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
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}
Ejemplo de solicitud
Texto
Python
Node.js
Kotlin
Swift
Dart
Java
Imagen
Python
Node.js
Kotlin
Swift
Dart
Java
Audio
Python
Node.js
Video
Python
Node.js
Chat
Python
Node.js
Una caracola
Kotlin
Swift
Dart
Java
Caché
Python
Node.js
Modelo ajustado
Python
Modo JSON
Python
Node.js
Kotlin
Swift
Dart
Java
Ejecución de código
Python
Kotlin
Java
Llamadas a función
Python
Node.js
Kotlin
Swift
Dart
Java
Configuración de generación
Python
Node.js
Una caracola
Kotlin
Swift
Dart
Java
Configuración de seguridad
Python
Node.js
Una caracola
Kotlin
Swift
Dart
Java
Instrucción del sistema
Python
Node.js
Kotlin
Swift
Dart
Java
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de GenerateContentResponse
.
Método: matchingModels.create
- Extremo
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Ejemplo de solicitud
Crea un modelo ajustado. Se puede acceder al progreso intermedio del ajuste (si corresponde) a través del servicio google.longrunning.Operations
.
Se puede acceder al estado y los resultados a través del servicio de operaciones. Ejemplo: GET /v1/tunedModels/az2mb0bpw6i/operations/000-111-222
Extremo
publicación
https://generativelanguage.googleapis.com/v1beta/tunedModels
Parámetros de consulta
tunedModelId
string
Opcional. El ID único para el modelo ajustado, si se especifica. Este valor debe tener hasta 40 caracteres; el primer carácter debe ser una letra y el último puede ser una letra o un número. El id debe coincidir con la expresión regular: a-z?.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene una instancia de TunedModel
.
Ejemplo de solicitud
Python
Cuerpo de la respuesta
Este recurso representa una operación de larga duración que es el resultado de una llamada a la API de la red.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
name
string
El nombre asignado por el servidor, que solo es único dentro del mismo servicio que originalmente lo muestra. Si usas la asignación HTTP predeterminada, el name
debe ser un nombre de recurso que termine con operations/{unique_id}
.
metadata
object
Metadatos específicos del servicio asociados con la operación. Por lo general, contiene información de progreso y metadatos comunes, como la fecha de creación. Puede que algunos servicios no proporcionen estos metadatos. Cualquier método que muestra una operación de larga duración debe documentar el tipo de metadatos, si corresponde.
Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type"
contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }
.
done
boolean
Si el valor es false
, significa que la operación aún está en progreso. Si es true
, la operación está completa, y error
o response
están disponibles.
result
. El resultado de la operación, que puede ser un error
o una response
válida. Si done
== false
, no se establecen error
ni response
. Si done
== true
, se puede establecer error
o response
. Es posible que algunos servicios no proporcionen el resultado. result
puede ser uno de los siguientes:
error
object (Status
)
El resultado de error de la operación en caso de falla o cancelación.
response
object
La respuesta normal y correcta de la operación. Si el método original no muestra datos en caso de éxito, como Delete
, la respuesta es google.protobuf.Empty
. Si el método original es Get
, Create
o Update
estándar, la respuesta debe ser el recurso. Para otros métodos, la respuesta debe tener el tipo XxxResponse
, en la que Xxx
es el nombre del método original. Por ejemplo, si el nombre del método original es TakeSnapshot()
, el tipo de respuesta inferido es TakeSnapshotResponse
.
Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type"
contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }
.
Representación JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Método: matchingModels.get
- Extremo
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Ejemplo de solicitud
Obtiene información sobre un TunedModel específico.
Extremo
obtener
https://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*}
Parámetros de ruta
name
string
Obligatorio. El nombre del recurso del modelo.
Formato: tunedModels/my-model-id
Toma la forma tunedModels/{tunedmodel}
.
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Ejemplo de solicitud
Python
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de TunedModel
.
Método: AdjustModels.list
- Extremo
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Ejemplo de solicitud
Muestra una lista de los modelos ajustados que pertenecen al usuario.
Extremo
obtener
https://generativelanguage.googleapis.com/v1beta/tunedModels
Parámetros de consulta
pageSize
integer
Opcional. La cantidad máxima de TunedModels
que se mostrarán (por página). Es posible que el servicio muestre menos modelos ajustados.
Si no se especifica, se mostrarán 10 modelos ajustados como máximo. Este método muestra 1,000 modelos como máximo por página, incluso si pasas un valor de pageSize más grande.
pageToken
string
Opcional. Un token de página, recibido desde una llamada tunedModels.list
anterior.
Proporciona el pageToken
que muestra una solicitud como argumento para la siguiente solicitud a fin de recuperar la página siguiente.
Cuando se pagina, todos los demás parámetros proporcionados a tunedModels.list
deben coincidir con la llamada que proporcionó el token de la página.
filter
string
Opcional. Un filtro es una búsqueda de texto completa sobre la descripción y el nombre visible del modelo ajustado. De forma predeterminada, los resultados no incluirán los modelos ajustados que se comparten con todos.
Operadores adicionales: - owner:me - writers:me - lectores:yo - lectores:todos
Ejemplos: "owner:me" muestra todos los modelos ajustados para los que el emisor tiene el rol de propietario "readers:me" muestra todos los modelos ajustados en los que el emisor tiene el rol de lector “readers:todos” muestra todos los modelos ajustados que se comparten con todos
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Ejemplo de solicitud
Python
Cuerpo de la respuesta
Respuesta de tunedModels.list
que contiene una lista paginada de modelos.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
tunedModels[]
object (TunedModel
)
Los modelos devueltos
nextPageToken
string
Un token, que se puede enviar como pageToken
para recuperar la página siguiente.
Si se omite este campo, no habrá más páginas.
Representación JSON |
---|
{
"tunedModels": [
{
object ( |
Método: tunnelModels.patch
- Extremo
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
Actualiza un modelo ajustado.
Extremo
parche
https://generativelanguage.googleapis.com/v1beta/{tunedModel.name=tunedModels/*}
PATCH https://generativelanguage.googleapis.com/v1beta/{tunedModel.name=tunedModels/*}
Parámetros de ruta
tunedModel.name
string
Solo salida. El nombre del modelo ajustado. En el momento de la creación, se generará un nombre único. Ejemplo: tunedModels/az2mb0bpw6i
Si se establece displayName en el momento de la creación, se establecerá la parte del ID del nombre concatenando las palabras del displayName con guiones y agregando una parte aleatoria para que sea único. Ejemplo: displayName = “Traductor de oraciones” name = "tunedModels/sentence-translator-u3b7m" Toma la forma tunedModels/{tunedmodel}
.
Parámetros de consulta
updateMask
string (FieldMask
format)
Obligatorio. La lista de campos que se deben actualizar.
Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo"
.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene una instancia de TunedModel
.
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de TunedModel
.
Método: tunnelModels.delete
- Extremo
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
Borra un modelo ajustado.
Extremo
borrar
https://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*}
Parámetros de ruta
name
string
Obligatorio. El nombre del recurso del modelo. Formato: tunedModels/my-model-id
Toma la forma tunedModels/{tunedmodel}
.
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta está vacío.
Recurso de REST: tunnelModels
- Recurso: TunedModel
- TunedModelSource
- Estado
- TuningTask
- TuningSnapshot
- Conjunto de datos
- TuningExamples
- TuningExample
- Hiperparámetros
- Métodos
Recurso: TunedModel
Un modelo ajustado creado con ModelService.CreateTunedModel.
Representación JSON |
---|
{ "name": string, "displayName": string, "description": string, "state": enum ( |
name
string
Solo salida. El nombre del modelo ajustado. En el momento de la creación, se generará un nombre único. Ejemplo: tunedModels/az2mb0bpw6i
Si se establece displayName en el momento de la creación, se establecerá la parte del ID del nombre concatenando las palabras del displayName con guiones y agregando una parte aleatoria para que sea único. Ejemplo: displayName = “Traductor de oraciones” name = "tunedModels/sentence-translator-u3b7m"
displayName
string
Opcional. El nombre que se mostrará para este modelo en las interfaces de usuario. El nombre visible debe tener hasta 40 caracteres, incluidos los espacios.
description
string
Opcional. Una descripción breve de este modelo.
state
enum (State
)
Solo salida. El estado del modelo ajustado.
createTime
string (Timestamp
format)
Solo salida. La marca de tiempo cuando se creó el modelo.
Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z"
y "2014-10-02T15:01:23.045123456Z"
.
updateTime
string (Timestamp
format)
Solo salida. La marca de tiempo de la actualización de este modelo.
Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z"
y "2014-10-02T15:01:23.045123456Z"
.
tuningTask
object (TuningTask
)
Obligatorio. La tarea de ajuste que crea el modelo ajustado.
source_model
. El modelo que se usa como punto de partida para el ajuste. Las direcciones (source_model
) solo pueden ser una de las siguientes opciones:
tunedModelSource
object (TunedModelSource
)
Opcional. TunedModel para usarlo como punto de partida en el entrenamiento del modelo nuevo.
baseModel
string
Inmutable. Es el nombre del Model
que se ajustará. Ejemplo: models/text-bison-001
temperature
number
Opcional. Controla la aleatorización de la salida.
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
generalmente dará como resultado respuestas menos sorprendentes del modelo.
Este valor especifica que la configuración predeterminada es la que usa el modelo base cuando se crea el modelo.
topP
number
Opcional. Para muestreos de núcleos.
El muestreo de núcleo considera el conjunto más pequeño de tokens cuya suma de probabilidad es al menos topP
.
Este valor especifica que la configuración predeterminada es la que usa el modelo base cuando se crea el modelo.
topK
integer
Opcional. Para muestreo de Top-K.
El muestreo de k superior considera el conjunto de topK
tokens más probables. Este valor especifica la configuración predeterminada que usará el backend mientras realiza la llamada al modelo.
Este valor especifica que la configuración predeterminada es la que usa el modelo base cuando se crea el modelo.
TunedModelSource
Modelo ajustado como fuente para entrenar un modelo nuevo.
Representación JSON |
---|
{ "tunedModel": string, "baseModel": string } |
tunedModel
string
Inmutable. El nombre de la TunedModel
que se usará como punto de partida para entrenar el modelo nuevo. Ejemplo: tunedModels/my-tuned-model
baseModel
string
Solo salida. El nombre del Model
base desde el que se realizó el ajuste de este TunedModel
. Ejemplo: models/text-bison-001
Estado
El estado del modelo ajustado.
Enumeraciones | |
---|---|
STATE_UNSPECIFIED |
Es el valor predeterminado. Este valor no se usa. |
CREATING |
Se está creando el modelo. |
ACTIVE |
El modelo está listo para usarse. |
FAILED |
No se pudo crear el modelo. |
TuningTask
Tareas de ajuste que crean modelos ajustados
Representación JSON |
---|
{ "startTime": string, "completeTime": string, "snapshots": [ { object ( |
startTime
string (Timestamp
format)
Solo salida. La marca de tiempo cuando comenzó el ajuste de este modelo.
Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z"
y "2014-10-02T15:01:23.045123456Z"
.
completeTime
string (Timestamp
format)
Solo salida. La marca de tiempo cuando se completó el ajuste de este modelo.
Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z"
y "2014-10-02T15:01:23.045123456Z"
.
snapshots[]
object (TuningSnapshot
)
Solo salida. Métricas recopiladas durante el ajuste
trainingData
object (Dataset
)
Obligatorio. Solo entrada. Inmutable. Los datos de entrenamiento del modelo.
hyperparameters
object (Hyperparameters
)
Inmutable. Hiperparámetros que controlan el proceso de ajuste. Si no se proporcionan, se usarán los valores predeterminados.
TuningSnapshot
Registra un solo paso de ajuste.
Representación JSON |
---|
{ "step": integer, "epoch": integer, "meanLoss": number, "computeTime": string } |
step
integer
Solo salida. El paso de ajuste
epoch
integer
Solo salida. El ciclo de entrenamiento del que formó parte este paso.
meanLoss
number
Solo salida. La pérdida media de los ejemplos de entrenamiento para este paso.
computeTime
string (Timestamp
format)
Solo salida. La marca de tiempo cuando se calculó esta métrica.
Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z"
y "2014-10-02T15:01:23.045123456Z"
.
Conjunto de datos
Conjunto de datos para entrenamiento o validación.
Representación JSON |
---|
{ // Union field |
dataset
. Datos intercalados o una referencia a los datos dataset
puede ser solo uno de los siguientes:
examples
object (TuningExamples
)
Opcional. Ejemplos intercalados.
TuningExamples
Un conjunto de ejemplos de ajuste. Pueden ser datos de entrenamiento o validación.
Representación JSON |
---|
{
"examples": [
{
object ( |
examples[]
object (TuningExample
)
Obligatorio. Los ejemplos. La entrada de ejemplo puede ser para texto o análisis, pero todos los ejemplos de un conjunto deben ser del mismo tipo.
TuningExample
Un solo ejemplo de ajuste.
Representación JSON |
---|
{ "output": string, // Union field |
output
string
Obligatorio. El resultado esperado del modelo.
model_input
. La entrada al modelo para este ejemplo. Las direcciones (model_input
) solo pueden ser una de las siguientes opciones:
textInput
string
Opcional. Entrada de modelo de texto
Hiperparámetros
Hiperparámetros que controlan el proceso de ajuste. Más información en https://ai.google.dev/docs/model_tuning_guidance
Representación JSON |
---|
{ // Union field |
learning_rate_option
. Opciones para especificar la tasa de aprendizaje durante el ajuste. learning_rate_option
puede ser solo uno de los siguientes:
learningRate
number
Opcional. Inmutable. Es el hiperparámetro de la tasa de aprendizaje para el ajuste. Si no se establece, se calculará un valor predeterminado de 0.001 o 0.0002 según la cantidad de ejemplos de entrenamiento.
learningRateMultiplier
number
Opcional. Inmutable. El multiplicador de la tasa de aprendizaje se usa para calcular una tasa de aprendizaje final según el valor predeterminado (recomendado). Tasa de aprendizaje real := learningRateMultiplier * tasa de aprendizaje predeterminada La tasa de aprendizaje predeterminada depende del modelo base y el tamaño del conjunto de datos. Si no se establece, se usará un valor predeterminado de 1.0.
epochCount
integer
Inmutable. La cantidad de ciclos de entrenamiento. Un ciclo de entrenamiento es una pasada por los datos de entrenamiento. Si no la estableces, se usará un valor predeterminado de 5.
batchSize
integer
Inmutable. El hiperparámetro del tamaño del lote para el ajuste. Si no se establece, se usará un valor predeterminado de 4 o 16 según la cantidad de ejemplos de entrenamiento.