Class SupervisedTuningDataStats (3.54.0)

See more code actions.
public final class SupervisedTuningDataStats extends GeneratedMessageV3 implements SupervisedTuningDataStatsOrBuilder

Tuning data statistics for Supervised Tuning.

Protobuf type google.cloud.aiplatform.v1.SupervisedTuningDataStats

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

TOTAL_BILLABLE_CHARACTER_COUNT_FIELD_NUMBER

public static final int TOTAL_BILLABLE_CHARACTER_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_BILLABLE_TOKEN_COUNT_FIELD_NUMBER

public static final int TOTAL_BILLABLE_TOKEN_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_TRUNCATED_EXAMPLE_COUNT_FIELD_NUMBER

public static final int TOTAL_TRUNCATED_EXAMPLE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_TUNING_CHARACTER_COUNT_FIELD_NUMBER

public static final int TOTAL_TUNING_CHARACTER_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TRUNCATED_EXAMPLE_INDICES_FIELD_NUMBER

public static final int TRUNCATED_EXAMPLE_INDICES_FIELD_NUMBER
Field Value
Type Description
int

TUNING_DATASET_EXAMPLE_COUNT_FIELD_NUMBER

public static final int TUNING_DATASET_EXAMPLE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TUNING_STEP_COUNT_FIELD_NUMBER

public static final int TUNING_STEP_COUNT_FIELD_NUMBER
Field Value
Type Description
int

USER_DATASET_EXAMPLES_FIELD_NUMBER

public static final int USER_DATASET_EXAMPLES_FIELD_NUMBER
Field Value
Type Description
int

USER_INPUT_TOKEN_DISTRIBUTION_FIELD_NUMBER

public static final int USER_INPUT_TOKEN_DISTRIBUTION_FIELD_NUMBER
Field Value
Type Description
int

USER_MESSAGE_PER_EXAMPLE_DISTRIBUTION_FIELD_NUMBER

public static final int USER_MESSAGE_PER_EXAMPLE_DISTRIBUTION_FIELD_NUMBER
Field Value
Type Description
int

USER_OUTPUT_TOKEN_DISTRIBUTION_FIELD_NUMBER

public static final int USER_OUTPUT_TOKEN_DISTRIBUTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SupervisedTuningDataStats getDefaultInstance()
Returns
Type Description
SupervisedTuningDataStats

getDescriptor()

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

newBuilder()

public static SupervisedTuningDataStats.Builder newBuilder()
Returns
Type Description
SupervisedTuningDataStats.Builder

newBuilder(SupervisedTuningDataStats prototype)

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

parseDelimitedFrom(InputStream input)

public static SupervisedTuningDataStats parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SupervisedTuningDataStats
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SupervisedTuningDataStats parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SupervisedTuningDataStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SupervisedTuningDataStats parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SupervisedTuningDataStats
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SupervisedTuningDataStats parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SupervisedTuningDataStats
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SupervisedTuningDataStats parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SupervisedTuningDataStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SupervisedTuningDataStats> parser()
Returns
Type Description
Parser<SupervisedTuningDataStats>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SupervisedTuningDataStats getDefaultInstanceForType()
Returns
Type Description
SupervisedTuningDataStats

getParserForType()

public Parser<SupervisedTuningDataStats> getParserForType()
Returns
Type Description
Parser<SupervisedTuningDataStats>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalBillableCharacterCount() (deprecated)

public long getTotalBillableCharacterCount()

Deprecated. google.cloud.aiplatform.v1.SupervisedTuningDataStats.total_billable_character_count is deprecated. See google/cloud/aiplatform/v1/tuning_job.proto;l=212

Output only. Number of billable characters in the tuning dataset.

int64 total_billable_character_count = 3 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The totalBillableCharacterCount.

getTotalBillableTokenCount()

public long getTotalBillableTokenCount()

Output only. Number of billable tokens in the tuning dataset.

int64 total_billable_token_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The totalBillableTokenCount.

getTotalTruncatedExampleCount()

public long getTotalTruncatedExampleCount()

The number of examples in the dataset that have been truncated by any amount.

int64 total_truncated_example_count = 10;

Returns
Type Description
long

The totalTruncatedExampleCount.

getTotalTuningCharacterCount()

public long getTotalTuningCharacterCount()

Output only. Number of tuning characters in the tuning dataset.

int64 total_tuning_character_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The totalTuningCharacterCount.

getTruncatedExampleIndices(int index)

public long getTruncatedExampleIndices(int index)

A partial sample of the indices (starting from 1) of the truncated examples.

repeated int64 truncated_example_indices = 11;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
long

The truncatedExampleIndices at the given index.

getTruncatedExampleIndicesCount()

public int getTruncatedExampleIndicesCount()

A partial sample of the indices (starting from 1) of the truncated examples.

repeated int64 truncated_example_indices = 11;

Returns
Type Description
int

The count of truncatedExampleIndices.

getTruncatedExampleIndicesList()

public List<Long> getTruncatedExampleIndicesList()

A partial sample of the indices (starting from 1) of the truncated examples.

repeated int64 truncated_example_indices = 11;

Returns
Type Description
List<Long>

A list containing the truncatedExampleIndices.

getTuningDatasetExampleCount()

public long getTuningDatasetExampleCount()

Output only. Number of examples in the tuning dataset.

int64 tuning_dataset_example_count = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The tuningDatasetExampleCount.

getTuningStepCount()

public long getTuningStepCount()

Output only. Number of tuning steps for this Tuning Job.

int64 tuning_step_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The tuningStepCount.

getUserDatasetExamples(int index)

public Content getUserDatasetExamples(int index)

Output only. Sample user messages in the training dataset uri.

repeated .google.cloud.aiplatform.v1.Content user_dataset_examples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Content

getUserDatasetExamplesCount()

public int getUserDatasetExamplesCount()

Output only. Sample user messages in the training dataset uri.

repeated .google.cloud.aiplatform.v1.Content user_dataset_examples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getUserDatasetExamplesList()

public List<Content> getUserDatasetExamplesList()

Output only. Sample user messages in the training dataset uri.

repeated .google.cloud.aiplatform.v1.Content user_dataset_examples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Content>

getUserDatasetExamplesOrBuilder(int index)

public ContentOrBuilder getUserDatasetExamplesOrBuilder(int index)

Output only. Sample user messages in the training dataset uri.

repeated .google.cloud.aiplatform.v1.Content user_dataset_examples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ContentOrBuilder

getUserDatasetExamplesOrBuilderList()

public List<? extends ContentOrBuilder> getUserDatasetExamplesOrBuilderList()

Output only. Sample user messages in the training dataset uri.

repeated .google.cloud.aiplatform.v1.Content user_dataset_examples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.ContentOrBuilder>

getUserInputTokenDistribution()

public SupervisedTuningDatasetDistribution getUserInputTokenDistribution()

Output only. Dataset distributions for the user input tokens.

.google.cloud.aiplatform.v1.SupervisedTuningDatasetDistribution user_input_token_distribution = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SupervisedTuningDatasetDistribution

The userInputTokenDistribution.

getUserInputTokenDistributionOrBuilder()

public SupervisedTuningDatasetDistributionOrBuilder getUserInputTokenDistributionOrBuilder()

Output only. Dataset distributions for the user input tokens.

.google.cloud.aiplatform.v1.SupervisedTuningDatasetDistribution user_input_token_distribution = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

getUserMessagePerExampleDistribution()

public SupervisedTuningDatasetDistribution getUserMessagePerExampleDistribution()

Output only. Dataset distributions for the messages per example.

.google.cloud.aiplatform.v1.SupervisedTuningDatasetDistribution user_message_per_example_distribution = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SupervisedTuningDatasetDistribution

The userMessagePerExampleDistribution.

getUserMessagePerExampleDistributionOrBuilder()

public SupervisedTuningDatasetDistributionOrBuilder getUserMessagePerExampleDistributionOrBuilder()

Output only. Dataset distributions for the messages per example.

.google.cloud.aiplatform.v1.SupervisedTuningDatasetDistribution user_message_per_example_distribution = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

getUserOutputTokenDistribution()

public SupervisedTuningDatasetDistribution getUserOutputTokenDistribution()

Output only. Dataset distributions for the user output tokens.

.google.cloud.aiplatform.v1.SupervisedTuningDatasetDistribution user_output_token_distribution = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SupervisedTuningDatasetDistribution

The userOutputTokenDistribution.

getUserOutputTokenDistributionOrBuilder()

public SupervisedTuningDatasetDistributionOrBuilder getUserOutputTokenDistributionOrBuilder()

Output only. Dataset distributions for the user output tokens.

.google.cloud.aiplatform.v1.SupervisedTuningDatasetDistribution user_output_token_distribution = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUserInputTokenDistribution()

public boolean hasUserInputTokenDistribution()

Output only. Dataset distributions for the user input tokens.

.google.cloud.aiplatform.v1.SupervisedTuningDatasetDistribution user_input_token_distribution = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the userInputTokenDistribution field is set.

hasUserMessagePerExampleDistribution()

public boolean hasUserMessagePerExampleDistribution()

Output only. Dataset distributions for the messages per example.

.google.cloud.aiplatform.v1.SupervisedTuningDatasetDistribution user_message_per_example_distribution = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the userMessagePerExampleDistribution field is set.

hasUserOutputTokenDistribution()

public boolean hasUserOutputTokenDistribution()

Output only. Dataset distributions for the user output tokens.

.google.cloud.aiplatform.v1.SupervisedTuningDatasetDistribution user_output_token_distribution = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the userOutputTokenDistribution field is set.

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 SupervisedTuningDataStats.Builder newBuilderForType()
Returns
Type Description
SupervisedTuningDataStats.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SupervisedTuningDataStats.Builder toBuilder()
Returns
Type Description
SupervisedTuningDataStats.Builder

writeTo(CodedOutputStream output)

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