public sealed class TrainCustomModelRequest : IMessage<TrainCustomModelRequest>, IEquatable<TrainCustomModelRequest>, IDeepCloneable<TrainCustomModelRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1 API class TrainCustomModelRequest.
Request message for
[SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1.SearchTuningService.TrainCustomModel]
method.
Required. The resource name of the Data Store, such as
projects/*/locations/global/collections/default_collection/dataStores/default_data_store.
This field is used to identify the data store where to train the models.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThis page provides reference documentation for the \u003ccode\u003eTrainCustomModelRequest\u003c/code\u003e class within the Google Cloud Discovery Engine v1 API, with the latest version being 1.6.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eTrainCustomModelRequest\u003c/code\u003e class is used to send requests to the \u003ccode\u003eSearchTuningService.TrainCustomModel\u003c/code\u003e method for model training, and it supports various versions, including a beta version, 1.0.0-beta06.\u003c/p\u003e\n"],["\u003cp\u003eIt implements multiple interfaces, such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and inherits from the base \u003ccode\u003eobject\u003c/code\u003e class, allowing for features like deep cloning and message buffering.\u003c/p\u003e\n"],["\u003cp\u003eThe class allows you to specify parameters such as \u003ccode\u003eDataStore\u003c/code\u003e, \u003ccode\u003eErrorConfig\u003c/code\u003e, \u003ccode\u003eGcsTrainingInput\u003c/code\u003e, \u003ccode\u003eModelId\u003c/code\u003e, and \u003ccode\u003eModelType\u003c/code\u003e, enabling users to customize the model training process, including options to use a generated UUID for the Model ID.\u003c/p\u003e\n"],["\u003cp\u003eThe supported \u003ccode\u003eModelType\u003c/code\u003e currently is \u003ccode\u003esearch-tuning\u003c/code\u003e, which means fine-tuning the search system based on the data you provide, and you can input the data in a Cloud Storage location.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1 API - Class TrainCustomModelRequest (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.8.0/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.7.0/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.6.0/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.5.0/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.4.0/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.3.0/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.2.0/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.1.0/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.0.0-beta06/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest) \n\n public sealed class TrainCustomModelRequest : IMessage\u003cTrainCustomModelRequest\u003e, IEquatable\u003cTrainCustomModelRequest\u003e, IDeepCloneable\u003cTrainCustomModelRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Discovery Engine v1 API class TrainCustomModelRequest.\n\nRequest message for\n\\[SearchTuningService.TrainCustomModel\\]\\[google.cloud.discoveryengine.v1.SearchTuningService.TrainCustomModel\\]\nmethod. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e TrainCustomModelRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[TrainCustomModelRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[TrainCustomModelRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[TrainCustomModelRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DiscoveryEngine.V1](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1.dll\n\nConstructors\n------------\n\n### TrainCustomModelRequest()\n\n public TrainCustomModelRequest()\n\n### TrainCustomModelRequest(TrainCustomModelRequest)\n\n public TrainCustomModelRequest(TrainCustomModelRequest other)\n\nProperties\n----------\n\n### DataStore\n\n public string DataStore { get; set; }\n\nRequired. The resource name of the Data Store, such as\n`projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.\nThis field is used to identify the data store where to train the models.\n\n### DataStoreAsDataStoreName\n\n public DataStoreName DataStoreAsDataStoreName { get; set; }\n\n[DataStoreName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.DataStoreName)-typed view over the [DataStore](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.TrainCustomModelRequest#Google_Cloud_DiscoveryEngine_V1_TrainCustomModelRequest_DataStore) resource name property.\n\n### ErrorConfig\n\n public ImportErrorConfig ErrorConfig { get; set; }\n\nThe desired location of errors incurred during the data ingestion and\ntraining.\n\n### GcsTrainingInput\n\n public TrainCustomModelRequest.Types.GcsTrainingInput GcsTrainingInput { get; set; }\n\nCloud Storage training input.\n\n### ModelId\n\n public string ModelId { get; set; }\n\nIf not provided, a UUID will be generated.\n\n### ModelType\n\n public string ModelType { get; set; }\n\nModel to be trained. Supported values are:\n\n- **search-tuning**: Fine tuning the search system based on data provided.\n\n### TrainingInputCase\n\n public TrainCustomModelRequest.TrainingInputOneofCase TrainingInputCase { get; }"]]
