Package com.google.cloud.discoveryengine.v1beta

Class TrainCustomModelRequest.GcsTrainingInput

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

  • Field Details

    • CORPUS_DATA_PATH_FIELD_NUMBER

      public static final int CORPUS_DATA_PATH_FIELD_NUMBER
      See Also:

    • QUERY_DATA_PATH_FIELD_NUMBER

      public static final int QUERY_DATA_PATH_FIELD_NUMBER
      See Also:

    • TRAIN_DATA_PATH_FIELD_NUMBER

      public static final int TRAIN_DATA_PATH_FIELD_NUMBER
      See Also:

    • TEST_DATA_PATH_FIELD_NUMBER

      public static final int TEST_DATA_PATH_FIELD_NUMBER
      See Also:

  • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TrainCustomModelRequest.GcsTrainingInput parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static TrainCustomModelRequest.GcsTrainingInput.Builder newBuilder()

    • newBuilder

      public static TrainCustomModelRequest.GcsTrainingInput.Builder newBuilder(TrainCustomModelRequest.GcsTrainingInput prototype)

    • toBuilder

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

    • newBuilderForType

      protected TrainCustomModelRequest.GcsTrainingInput.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TrainCustomModelRequest.GcsTrainingInput getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TrainCustomModelRequest.GcsTrainingInput> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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