Class TrainCustomModelRequest.GcsTrainingInput (0.33.0)

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

Gcs training data input.

Protobuf type google.cloud.discoveryengine.v1alpha.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
TypeDescription
int

QUERY_DATA_PATH_FIELD_NUMBER

public static final int QUERY_DATA_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

TEST_DATA_PATH_FIELD_NUMBER

public static final int TEST_DATA_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

TRAIN_DATA_PATH_FIELD_NUMBER

public static final int TRAIN_DATA_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TrainCustomModelRequest.GcsTrainingInput getDefaultInstance()
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TrainCustomModelRequest.GcsTrainingInput.Builder newBuilder()
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput.Builder

newBuilder(TrainCustomModelRequest.GcsTrainingInput prototype)

public static TrainCustomModelRequest.GcsTrainingInput.Builder newBuilder(TrainCustomModelRequest.GcsTrainingInput prototype)
Parameter
NameDescription
prototypeTrainCustomModelRequest.GcsTrainingInput
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput.Builder

parseDelimitedFrom(InputStream input)

public static TrainCustomModelRequest.GcsTrainingInput parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest.GcsTrainingInput parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCorpusDataPath()

public String getCorpusDataPath()

The gcs 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
TypeDescription
String

The corpusDataPath.

getCorpusDataPathBytes()

public ByteString getCorpusDataPathBytes()

The gcs 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
TypeDescription
ByteString

The bytes for corpusDataPath.

getDefaultInstanceForType()

public TrainCustomModelRequest.GcsTrainingInput getDefaultInstanceForType()
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput

getParserForType()

public Parser<TrainCustomModelRequest.GcsTrainingInput> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for queryDataPath.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTestDataPath()

public String getTestDataPath()

Gcs 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
TypeDescription
String

The testDataPath.

getTestDataPathBytes()

public ByteString getTestDataPathBytes()

Gcs 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
TypeDescription
ByteString

The bytes for testDataPath.

getTrainDataPath()

public String getTrainDataPath()

Gcs 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
TypeDescription
String

The trainDataPath.

getTrainDataPathBytes()

public ByteString getTrainDataPathBytes()

Gcs 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
TypeDescription
ByteString

The bytes for trainDataPath.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TrainCustomModelRequest.GcsTrainingInput.Builder newBuilderForType()
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TrainCustomModelRequest.GcsTrainingInput.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TrainCustomModelRequest.GcsTrainingInput.Builder toBuilder()
Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException