Class TrainCustomModelRequest.GcsTrainingInput (0.45.0)

public static final class TrainCustomModelRequest.GcsTrainingInput extends GeneratedMessageV3 implements TrainCustomModelRequest.GcsTrainingInputOrBuilder

Cloud Storage training data input.

Protobuf type google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TrainCustomModelRequest.GcsTrainingInput

Static Fields

CORPUS_DATA_PATH_FIELD_NUMBER

public static final int CORPUS_DATA_PATH_FIELD_NUMBER
Field Value
Type Description
int

QUERY_DATA_PATH_FIELD_NUMBER

public static final int QUERY_DATA_PATH_FIELD_NUMBER
Field Value
Type Description
int

TEST_DATA_PATH_FIELD_NUMBER

public static final int TEST_DATA_PATH_FIELD_NUMBER
Field Value
Type Description
int

TRAIN_DATA_PATH_FIELD_NUMBER

public static final int TRAIN_DATA_PATH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TrainCustomModelRequest.GcsTrainingInput getDefaultInstance()
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TrainCustomModelRequest.GcsTrainingInput.Builder newBuilder()
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput.Builder

newBuilder(TrainCustomModelRequest.GcsTrainingInput prototype)

public static TrainCustomModelRequest.GcsTrainingInput.Builder newBuilder(TrainCustomModelRequest.GcsTrainingInput prototype)
Parameter
Name Description
prototype TrainCustomModelRequest.GcsTrainingInput
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput.Builder

parseDelimitedFrom(InputStream input)

public static TrainCustomModelRequest.GcsTrainingInput parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TrainCustomModelRequest.GcsTrainingInput> parser()
Returns
Type Description
Parser<GcsTrainingInput>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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;

Returns
Type Description
String

The corpusDataPath.

getCorpusDataPathBytes()

public 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;

Returns
Type Description
ByteString

The bytes for corpusDataPath.

getDefaultInstanceForType()

public TrainCustomModelRequest.GcsTrainingInput getDefaultInstanceForType()
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput

getParserForType()

public Parser<TrainCustomModelRequest.GcsTrainingInput> getParserForType()
Returns
Type Description
Parser<GcsTrainingInput>
Overrides

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;

Returns
Type Description
String

The queryDataPath.

getQueryDataPathBytes()

public 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;

Returns
Type Description
ByteString

The bytes for queryDataPath.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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;

Returns
Type Description
String

The testDataPath.

getTestDataPathBytes()

public 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;

Returns
Type Description
ByteString

The bytes for testDataPath.

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;

Returns
Type Description
String

The trainDataPath.

getTrainDataPathBytes()

public 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;

Returns
Type Description
ByteString

The bytes for trainDataPath.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TrainCustomModelRequest.GcsTrainingInput.Builder newBuilderForType()
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TrainCustomModelRequest.GcsTrainingInput.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TrainCustomModelRequest.GcsTrainingInput.Builder toBuilder()
Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException