Package com.google.cloud.discoveryengine.v1beta

Class TrainCustomModelRequest.GcsTrainingInput.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<TrainCustomModelRequest.GcsTrainingInput.Builder>
com.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput.Builder
All Implemented Interfaces:
TrainCustomModelRequest.GcsTrainingInputOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
TrainCustomModelRequest.GcsTrainingInput
public static final class TrainCustomModelRequest.GcsTrainingInput.Builder extends com.google.protobuf.GeneratedMessage.Builder<TrainCustomModelRequest.GcsTrainingInput.Builder> implements TrainCustomModelRequest.GcsTrainingInputOrBuilder
 Cloud Storage training data input.
Protobuf type google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<TrainCustomModelRequest.GcsTrainingInput.Builder>

    • clear

      public TrainCustomModelRequest.GcsTrainingInput.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<TrainCustomModelRequest.GcsTrainingInput.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<TrainCustomModelRequest.GcsTrainingInput.Builder>

    • getDefaultInstanceForType

      public TrainCustomModelRequest.GcsTrainingInput getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public TrainCustomModelRequest.GcsTrainingInput build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public TrainCustomModelRequest.GcsTrainingInput buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public TrainCustomModelRequest.GcsTrainingInput.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TrainCustomModelRequest.GcsTrainingInput.Builder>

    • mergeFrom

      public TrainCustomModelRequest.GcsTrainingInput.Builder mergeFrom(TrainCustomModelRequest.GcsTrainingInput other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<TrainCustomModelRequest.GcsTrainingInput.Builder>

    • mergeFrom

      public TrainCustomModelRequest.GcsTrainingInput.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TrainCustomModelRequest.GcsTrainingInput.Builder>
      Throws:
      IOException

    • getCorpusDataPath

      public String getCorpusDataPath()
       The Cloud Storage corpus data which could be associated in train data.
 The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
 A newline delimited jsonl/ndjson file.

 For search-tuning model, each line should have the _id, title
 and text. Example:
 `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
      string corpus_data_path = 1;
      Specified by:
      getCorpusDataPath in interface TrainCustomModelRequest.GcsTrainingInputOrBuilder
      Returns:
      The corpusDataPath.

    • getCorpusDataPathBytes

      public com.google.protobuf.ByteString getCorpusDataPathBytes()
       The Cloud Storage corpus data which could be associated in train data.
 The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
 A newline delimited jsonl/ndjson file.

 For search-tuning model, each line should have the _id, title
 and text. Example:
 `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
      string corpus_data_path = 1;
      Specified by:
      getCorpusDataPathBytes in interface TrainCustomModelRequest.GcsTrainingInputOrBuilder
      Returns:
      The bytes for corpusDataPath.

    • setCorpusDataPath

      public TrainCustomModelRequest.GcsTrainingInput.Builder setCorpusDataPath(String value)
       The Cloud Storage corpus data which could be associated in train data.
 The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
 A newline delimited jsonl/ndjson file.

 For search-tuning model, each line should have the _id, title
 and text. Example:
 `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
      string corpus_data_path = 1;
      Parameters:
      value - The corpusDataPath to set.
      Returns:
      This builder for chaining.

    • clearCorpusDataPath

      public TrainCustomModelRequest.GcsTrainingInput.Builder clearCorpusDataPath()
       The Cloud Storage corpus data which could be associated in train data.
 The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
 A newline delimited jsonl/ndjson file.

 For search-tuning model, each line should have the _id, title
 and text. Example:
 `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
      string corpus_data_path = 1;
      Returns:
      This builder for chaining.

    • setCorpusDataPathBytes

      public TrainCustomModelRequest.GcsTrainingInput.Builder setCorpusDataPathBytes(com.google.protobuf.ByteString value)
       The Cloud Storage corpus data which could be associated in train data.
 The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
 A newline delimited jsonl/ndjson file.

 For search-tuning model, each line should have the _id, title
 and text. Example:
 `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
      string corpus_data_path = 1;
      Parameters:
      value - The bytes for corpusDataPath to set.
      Returns:
      This builder for chaining.

    • getQueryDataPath

      public String getQueryDataPath()
       The gcs query data which could be associated in train data.
 The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
 A newline delimited jsonl/ndjson file.

 For search-tuning model, each line should have the _id
 and text. Example: {"_id": "query1",  "text": "example query"}
      string query_data_path = 2;
      Specified by:
      getQueryDataPath in interface TrainCustomModelRequest.GcsTrainingInputOrBuilder
      Returns:
      The queryDataPath.

    • getQueryDataPathBytes

      public com.google.protobuf.ByteString getQueryDataPathBytes()
       The gcs query data which could be associated in train data.
 The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
 A newline delimited jsonl/ndjson file.

 For search-tuning model, each line should have the _id
 and text. Example: {"_id": "query1",  "text": "example query"}
      string query_data_path = 2;
      Specified by:
      getQueryDataPathBytes in interface TrainCustomModelRequest.GcsTrainingInputOrBuilder
      Returns:
      The bytes for queryDataPath.

    • setQueryDataPath

      public TrainCustomModelRequest.GcsTrainingInput.Builder setQueryDataPath(String value)
       The gcs query data which could be associated in train data.
 The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
 A newline delimited jsonl/ndjson file.

 For search-tuning model, each line should have the _id
 and text. Example: {"_id": "query1",  "text": "example query"}
      string query_data_path = 2;
      Parameters:
      value - The queryDataPath to set.
      Returns:
      This builder for chaining.

    • clearQueryDataPath

      public TrainCustomModelRequest.GcsTrainingInput.Builder clearQueryDataPath()
       The gcs query data which could be associated in train data.
 The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
 A newline delimited jsonl/ndjson file.

 For search-tuning model, each line should have the _id
 and text. Example: {"_id": "query1",  "text": "example query"}
      string query_data_path = 2;
      Returns:
      This builder for chaining.

    • setQueryDataPathBytes

      public TrainCustomModelRequest.GcsTrainingInput.Builder setQueryDataPathBytes(com.google.protobuf.ByteString value)
       The gcs query data which could be associated in train data.
 The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
 A newline delimited jsonl/ndjson file.

 For search-tuning model, each line should have the _id
 and text. Example: {"_id": "query1",  "text": "example query"}
      string query_data_path = 2;
      Parameters:
      value - The bytes for queryDataPath to set.
      Returns:
      This builder for chaining.

    • getTrainDataPath

      public String getTrainDataPath()
       Cloud Storage training data path whose format should be
 `gs://<bucket_to_data>/<tsv_file_name>`. The file should be in tsv
 format. Each line should have the doc_id and query_id and score (number).

 For search-tuning model, it should have the query-id corpus-id
 score as tsv file header. The score should be a number in `[0, inf+)`.
 The larger the number is, the more relevant the pair is. Example:

 * `query-id\tcorpus-id\tscore`
 * `query1\tdoc1\t1`
      string train_data_path = 3;
      Specified by:
      getTrainDataPath in interface TrainCustomModelRequest.GcsTrainingInputOrBuilder
      Returns:
      The trainDataPath.

    • getTrainDataPathBytes

      public com.google.protobuf.ByteString getTrainDataPathBytes()
       Cloud Storage training data path whose format should be
 `gs://<bucket_to_data>/<tsv_file_name>`. The file should be in tsv
 format. Each line should have the doc_id and query_id and score (number).

 For search-tuning model, it should have the query-id corpus-id
 score as tsv file header. The score should be a number in `[0, inf+)`.
 The larger the number is, the more relevant the pair is. Example:

 * `query-id\tcorpus-id\tscore`
 * `query1\tdoc1\t1`
      string train_data_path = 3;
      Specified by:
      getTrainDataPathBytes in interface TrainCustomModelRequest.GcsTrainingInputOrBuilder
      Returns:
      The bytes for trainDataPath.

    • setTrainDataPath

      public TrainCustomModelRequest.GcsTrainingInput.Builder setTrainDataPath(String value)
       Cloud Storage training data path whose format should be
 `gs://<bucket_to_data>/<tsv_file_name>`. The file should be in tsv
 format. Each line should have the doc_id and query_id and score (number).

 For search-tuning model, it should have the query-id corpus-id
 score as tsv file header. The score should be a number in `[0, inf+)`.
 The larger the number is, the more relevant the pair is. Example:

 * `query-id\tcorpus-id\tscore`
 * `query1\tdoc1\t1`
      string train_data_path = 3;
      Parameters:
      value - The trainDataPath to set.
      Returns:
      This builder for chaining.

    • clearTrainDataPath

      public TrainCustomModelRequest.GcsTrainingInput.Builder clearTrainDataPath()
       Cloud Storage training data path whose format should be
 `gs://<bucket_to_data>/<tsv_file_name>`. The file should be in tsv
 format. Each line should have the doc_id and query_id and score (number).

 For search-tuning model, it should have the query-id corpus-id
 score as tsv file header. The score should be a number in `[0, inf+)`.
 The larger the number is, the more relevant the pair is. Example:

 * `query-id\tcorpus-id\tscore`
 * `query1\tdoc1\t1`
      string train_data_path = 3;
      Returns:
      This builder for chaining.

    • setTrainDataPathBytes

      public TrainCustomModelRequest.GcsTrainingInput.Builder setTrainDataPathBytes(com.google.protobuf.ByteString value)
       Cloud Storage training data path whose format should be
 `gs://<bucket_to_data>/<tsv_file_name>`. The file should be in tsv
 format. Each line should have the doc_id and query_id and score (number).

 For search-tuning model, it should have the query-id corpus-id
 score as tsv file header. The score should be a number in `[0, inf+)`.
 The larger the number is, the more relevant the pair is. Example:

 * `query-id\tcorpus-id\tscore`
 * `query1\tdoc1\t1`
      string train_data_path = 3;
      Parameters:
      value - The bytes for trainDataPath to set.
      Returns:
      This builder for chaining.

    • getTestDataPath

      public String getTestDataPath()
       Cloud Storage test data. Same format as train_data_path. If not provided,
 a random 80/20 train/test split will be performed on train_data_path.
      string test_data_path = 4;
      Specified by:
      getTestDataPath in interface TrainCustomModelRequest.GcsTrainingInputOrBuilder
      Returns:
      The testDataPath.

    • getTestDataPathBytes

      public com.google.protobuf.ByteString getTestDataPathBytes()
       Cloud Storage test data. Same format as train_data_path. If not provided,
 a random 80/20 train/test split will be performed on train_data_path.
      string test_data_path = 4;
      Specified by:
      getTestDataPathBytes in interface TrainCustomModelRequest.GcsTrainingInputOrBuilder
      Returns:
      The bytes for testDataPath.

    • setTestDataPath

      public TrainCustomModelRequest.GcsTrainingInput.Builder setTestDataPath(String value)
       Cloud Storage test data. Same format as train_data_path. If not provided,
 a random 80/20 train/test split will be performed on train_data_path.
      string test_data_path = 4;
      Parameters:
      value - The testDataPath to set.
      Returns:
      This builder for chaining.

    • clearTestDataPath

      public TrainCustomModelRequest.GcsTrainingInput.Builder clearTestDataPath()
       Cloud Storage test data. Same format as train_data_path. If not provided,
 a random 80/20 train/test split will be performed on train_data_path.
      string test_data_path = 4;
      Returns:
      This builder for chaining.

    • setTestDataPathBytes

      public TrainCustomModelRequest.GcsTrainingInput.Builder setTestDataPathBytes(com.google.protobuf.ByteString value)
       Cloud Storage test data. Same format as train_data_path. If not provided,
 a random 80/20 train/test split will be performed on train_data_path.
      string test_data_path = 4;
      Parameters:
      value - The bytes for testDataPath to set.
      Returns:
      This builder for chaining.