Method: projects.locations.collections.dataStores.trainCustomModel

Entrena un modelo personalizado.

Solicitud HTTP


POST https://discoveryengine.googleapis.com/v1/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:trainCustomModel

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
dataStore

string

Obligatorio. Es el nombre del recurso del almacén de datos, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Este campo se usa para identificar el almacén de datos en el que se entrenarán los modelos.

Cuerpo de la solicitud

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

Representación JSON 
{
  "modelType": string,
  "errorConfig": {
    object (ImportErrorConfig)
  },
  "modelId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsTrainingInput": {
    object (GcsTrainingInput)
  }
  // End of mutually exclusive fields.
}
Campos
modelType

string

Es el modelo que se entrenará. Los valores admitidos son los que se detallan a continuación:

  • search-tuning: Ajuste preciso del sistema de búsqueda en función de los datos proporcionados.
errorConfig

object (ImportErrorConfig)

Ubicación deseada de los errores que se produjeron durante la transferencia de datos y el entrenamiento.
modelId

string

Si no se proporciona, se generará un UUID.
Es la entrada del entrenamiento del modelo. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
gcsTrainingInput

object (GcsTrainingInput)

Es la entrada de entrenamiento de Cloud Storage.
Fin de los campos mutuamente excluyentes.

Cuerpo de la respuesta

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

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso dataStore:

  • discoveryengine.dataStores.trainCustomModel

Para obtener más información, consulta la documentación de IAM.

GcsTrainingInput

Es la entrada de datos de entrenamiento de Cloud Storage.

Representación JSON 
{
  "corpusDataPath": string,
  "queryDataPath": string,
  "trainDataPath": string,
  "testDataPath": string
}
Campos
corpusDataPath

string

Son los datos del corpus de Cloud Storage que se podrían asociar a los datos de entrenamiento. El formato de la ruta de datos es gs://<bucket_to_data>/<jsonl_file_name>. Es un archivo jsonl/ndjson delimitado por saltos de línea.

En el caso del modelo de ajuste de la búsqueda, cada línea debe tener el ID, el título y el texto. Ejemplo: {"Id": "doc1", title: "relevant doc", "text": "relevant text"}
queryDataPath

string

Son los datos de la consulta de GCS que se podrían asociar a los datos de entrenamiento. El formato de la ruta de datos es gs://<bucket_to_data>/<jsonl_file_name>. Es un archivo jsonl/ndjson delimitado por saltos de línea.

Para el modelo de ajuste de la búsqueda, cada línea debe tener el ID y el texto. Ejemplo: {"Id": "query1", "text": "example query"}
trainDataPath

string

Ruta de acceso a los datos de entrenamiento de Cloud Storage cuyo formato debe ser gs://<bucket_to_data>/<tsv_file_name>. El archivo debe estar en formato TSV. Cada línea debe tener el docId, el queryId y la puntuación (número).

En el caso del modelo de ajuste de la búsqueda, debe tener la puntuación de corpus-id de ID de búsqueda como encabezado del archivo TSV. La puntuación debe ser un número en [0, inf+). Cuanto mayor sea el número, más relevante será el par. Ejemplo:

  • query-id\tcorpus-id\tscore
  • query1\tdoc1\t1
testDataPath

string

Son los datos de prueba de Cloud Storage. Tiene el mismo formato que trainDataPath. Si no se proporciona, se realizará una división aleatoria del 80/20 entre los datos de entrenamiento y los de prueba en trainDataPath.