Method: projects.locations.collections.dataStores.trainCustomModel

Entraîne un modèle personnalisé.

Requête HTTP


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

Les URL utilisent la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
dataStore

string

Obligatoire. Nom de ressource du datastore, tel que projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Ce champ permet d'identifier le data store dans lequel entraîner les modèles.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
modelType

string

Modèle à entraîner. Valeurs acceptées :

  • search-tuning : affiner le système de recherche en fonction des données fournies.
errorConfig

object (ImportErrorConfig)

Emplacement souhaité des erreurs survenues lors de l'ingestion de données et de l'entraînement.
modelId

string

Si aucun n'est fourni, un UUID sera généré.
Entrée pour l'entraînement du modèle. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
gcsTrainingInput

object (GcsTrainingInput)

Entrée d'entraînement Cloud Storage.
Fin des champs qui s'excluent mutuellement.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource dataStore :

  • discoveryengine.dataStores.trainCustomModel

Pour en savoir plus, consultez la documentation IAM.

GcsTrainingInput

Entrée des données d'entraînement Cloud Storage.

Représentation JSON 
{
  "corpusDataPath": string,
  "queryDataPath": string,
  "trainDataPath": string,
  "testDataPath": string
}
Champs
corpusDataPath

string

Données du corpus Cloud Storage pouvant être associées aux données d'entraînement. Le format du chemin d'accès aux données est gs://<bucket_to_data>/<jsonl_file_name>. Fichier JSONL/ndJSON délimité par un retour à la ligne.

Pour le modèle d'optimisation de la recherche, chaque ligne doit comporter l'ID, le titre et le texte. Exemple : {"Id": "doc1", title: "relevant doc", "text": "relevant text"}
queryDataPath

string

Données de requête GCS pouvant être associées aux données d'entraînement. Le format du chemin d'accès aux données est gs://<bucket_to_data>/<jsonl_file_name>. Fichier JSONL/ndJSON délimité par un retour à la ligne.

Pour le modèle d'optimisation de la recherche, chaque ligne doit comporter l'ID et le texte. Exemple : {"Id": "query1", "text": "exemple de requête"}
trainDataPath

string

Chemin d'accès aux données d'entraînement Cloud Storage dont le format doit être gs://<bucket_to_data>/<tsv_file_name>. Le fichier doit être au format TSV. Chaque ligne doit comporter le docId, le queryId et le score (nombre).

Pour le modèle d'optimisation de la recherche, il doit comporter l'ID de requête, l'ID de corpus et le score en tant qu'en-tête de fichier TSV. Le score doit être un nombre compris dans [0, inf+). Plus le nombre est élevé, plus la paire est pertinente. Exemple :

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

string

Données de test Cloud Storage. Même format que trainDataPath. Si aucune valeur n'est fournie, une répartition aléatoire 80/20 entre l'ensemble d'entraînement et l'ensemble de test sera effectuée sur trainDataPath.