Method: projects.locations.collections.dataStores.trainCustomModel

カスタムモデルをトレーニングします。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
dataStore

string

必須。データストアのリソース名（例: projects/*/locations/global/collections/default_collection/dataStores/default_data_store）。このフィールドは、モデルをトレーニングするデータストアを特定するために使用されます。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "modelType": string,
  "errorConfig": {
    object (ImportErrorConfig)
  },
  "modelId": string,

  // Union field training_input can be only one of the following:
  "gcsTrainingInput": {
    object (GcsTrainingInput)
  }
  // End of list of possible types for union field training_input.
}
フィールド
modelType

string

トレーニングするモデル。サポートされている値は次のとおりです。

  • search-tuning: 提供されたデータに基づいて検索システムを微調整します。
errorConfig

object (ImportErrorConfig)

データ取り込みとトレーニング中に発生したエラーを記録する目的の場所。
modelId

string

指定しない場合、UUID が生成されます。
共用体フィールド training_input。モデル トレーニングの入力。training_input は次のいずれかになります。
gcsTrainingInput

object (GcsTrainingInput)

Cloud Storage トレーニング入力。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

dataStore リソースに対する次の IAM 権限が必要です。

  • discoveryengine.dataStores.trainCustomModel

詳細については、IAM のドキュメントをご覧ください。

GcsTrainingInput

Cloud Storage トレーニング データ入力。

JSON 表現 
{
  "corpusDataPath": string,
  "queryDataPath": string,
  "trainDataPath": string,
  "testDataPath": string
}
フィールド
corpusDataPath

string

トレーニング データに関連付けることができる Cloud Storage コーパス データ。データパスの形式は gs://<bucket_to_data>/<jsonl_file_name> です。改行区切りの jsonl/ndjson ファイル。

検索チューニング モデルの場合、各行には ID、タイトル、テキストが必要です。例: {"Id": "doc1", title: "relevant doc", "text": "relevant text"}
queryDataPath

string

トレーニング データに関連付けることができる gcs クエリデータ。データパスの形式は gs://<bucket_to_data>/<jsonl_file_name> です。改行区切りの jsonl/ndjson ファイル。

検索チューニング モデルの場合、各行には ID とテキストが必要です。例: {"Id": "query1", "text": "example query"}
trainDataPath

string

Cloud Storage トレーニング データパス。形式は gs://<bucket_to_data>/<tsv_file_name> である必要があります。ファイルは tsv 形式にする必要があります。各行には、docId、queryId、スコア（数値）が必要です。

検索チューニング モデルの場合、tsv ファイルのヘッダーとして query-id corpus-id score が必要です。スコアは [0, inf+) の数値である必要があります。数値が大きいほど、ペアの関連性が高くなります。例:

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

string

Cloud Storage テストデータ。trainDataPath と同じ形式。指定されていない場合は、trainDataPath で 80/20 のトレーニング/テスト分割がランダムに実行されます。