Package com.google.cloud.aiplatform.v1

Class SupervisedTuningDataStats

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.SupervisedTuningDataStats
All Implemented Interfaces:
SupervisedTuningDataStatsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SupervisedTuningDataStats extends com.google.protobuf.GeneratedMessage implements SupervisedTuningDataStatsOrBuilder
 Tuning data statistics for Supervised Tuning.
Protobuf type google.cloud.aiplatform.v1.SupervisedTuningDataStats
See Also:

  • Field Details

    • TUNING_DATASET_EXAMPLE_COUNT_FIELD_NUMBER

      public static final int TUNING_DATASET_EXAMPLE_COUNT_FIELD_NUMBER
      See Also:

    • TOTAL_TUNING_CHARACTER_COUNT_FIELD_NUMBER

      public static final int TOTAL_TUNING_CHARACTER_COUNT_FIELD_NUMBER
      See Also:

    • TOTAL_BILLABLE_CHARACTER_COUNT_FIELD_NUMBER

      public static final int TOTAL_BILLABLE_CHARACTER_COUNT_FIELD_NUMBER
      See Also:

    • TOTAL_BILLABLE_TOKEN_COUNT_FIELD_NUMBER

      public static final int TOTAL_BILLABLE_TOKEN_COUNT_FIELD_NUMBER
      See Also:

    • TUNING_STEP_COUNT_FIELD_NUMBER

      public static final int TUNING_STEP_COUNT_FIELD_NUMBER
      See Also:

    • USER_INPUT_TOKEN_DISTRIBUTION_FIELD_NUMBER

      public static final int USER_INPUT_TOKEN_DISTRIBUTION_FIELD_NUMBER
      See Also:

    • USER_OUTPUT_TOKEN_DISTRIBUTION_FIELD_NUMBER

      public static final int USER_OUTPUT_TOKEN_DISTRIBUTION_FIELD_NUMBER
      See Also:

    • USER_MESSAGE_PER_EXAMPLE_DISTRIBUTION_FIELD_NUMBER

      public static final int USER_MESSAGE_PER_EXAMPLE_DISTRIBUTION_FIELD_NUMBER
      See Also:

    • USER_DATASET_EXAMPLES_FIELD_NUMBER

      public static final int USER_DATASET_EXAMPLES_FIELD_NUMBER
      See Also:

    • TOTAL_TRUNCATED_EXAMPLE_COUNT_FIELD_NUMBER

      public static final int TOTAL_TRUNCATED_EXAMPLE_COUNT_FIELD_NUMBER
      See Also:

    • TRUNCATED_EXAMPLE_INDICES_FIELD_NUMBER

      public static final int TRUNCATED_EXAMPLE_INDICES_FIELD_NUMBER
      See Also:

    • DROPPED_EXAMPLE_REASONS_FIELD_NUMBER

      public static final int DROPPED_EXAMPLE_REASONS_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

    • 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];
      Specified by:
      getTuningDatasetExampleCount in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      The tuningDatasetExampleCount.

    • 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];
      Specified by:
      getTotalTuningCharacterCount in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      The totalTuningCharacterCount.

    • 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=250
       Output only. Number of billable characters in the tuning dataset.
      int64 total_billable_character_count = 3 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTotalBillableCharacterCount in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      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];
      Specified by:
      getTotalBillableTokenCount in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      The totalBillableTokenCount.

    • 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];
      Specified by:
      getTuningStepCount in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      The tuningStepCount.

    • 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];
      Specified by:
      hasUserInputTokenDistribution in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      Whether the userInputTokenDistribution field is set.

    • 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];
      Specified by:
      getUserInputTokenDistribution in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      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];
      Specified by:
      getUserInputTokenDistributionOrBuilder in interface SupervisedTuningDataStatsOrBuilder

    • 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];
      Specified by:
      hasUserOutputTokenDistribution in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      Whether the userOutputTokenDistribution field is set.

    • 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];
      Specified by:
      getUserOutputTokenDistribution in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      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];
      Specified by:
      getUserOutputTokenDistributionOrBuilder in interface SupervisedTuningDataStatsOrBuilder

    • 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];
      Specified by:
      hasUserMessagePerExampleDistribution in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      Whether the userMessagePerExampleDistribution field is set.

    • 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];
      Specified by:
      getUserMessagePerExampleDistribution in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      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];
      Specified by:
      getUserMessagePerExampleDistributionOrBuilder in interface SupervisedTuningDataStatsOrBuilder

    • 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];
      Specified by:
      getUserDatasetExamplesList in interface SupervisedTuningDataStatsOrBuilder

    • 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];
      Specified by:
      getUserDatasetExamplesOrBuilderList in interface SupervisedTuningDataStatsOrBuilder

    • 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];
      Specified by:
      getUserDatasetExamplesCount in interface SupervisedTuningDataStatsOrBuilder

    • getUserDatasetExamples

      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];
      Specified by:
      getUserDatasetExamples in interface SupervisedTuningDataStatsOrBuilder

    • getUserDatasetExamplesOrBuilder

      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];
      Specified by:
      getUserDatasetExamplesOrBuilder in interface SupervisedTuningDataStatsOrBuilder

    • getTotalTruncatedExampleCount

      public long getTotalTruncatedExampleCount()
       Output only. The number of examples in the dataset that have been dropped.
 An example can be dropped for reasons including: too many tokens, contains
 an invalid image, contains too many images, etc.
      int64 total_truncated_example_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTotalTruncatedExampleCount in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      The totalTruncatedExampleCount.

    • getTruncatedExampleIndicesList

      public List<Long> getTruncatedExampleIndicesList()
       Output only. A partial sample of the indices (starting from 1) of the
 dropped examples.
      repeated int64 truncated_example_indices = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTruncatedExampleIndicesList in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      A list containing the truncatedExampleIndices.

    • getTruncatedExampleIndicesCount

      public int getTruncatedExampleIndicesCount()
       Output only. A partial sample of the indices (starting from 1) of the
 dropped examples.
      repeated int64 truncated_example_indices = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTruncatedExampleIndicesCount in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      The count of truncatedExampleIndices.

    • getTruncatedExampleIndices

      public long getTruncatedExampleIndices(int index)
       Output only. A partial sample of the indices (starting from 1) of the
 dropped examples.
      repeated int64 truncated_example_indices = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTruncatedExampleIndices in interface SupervisedTuningDataStatsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The truncatedExampleIndices at the given index.

    • getDroppedExampleReasonsList

      public com.google.protobuf.ProtocolStringList getDroppedExampleReasonsList()
       Output only. For each index in `truncated_example_indices`, the user-facing
 reason why the example was dropped.
      repeated string dropped_example_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDroppedExampleReasonsList in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      A list containing the droppedExampleReasons.

    • getDroppedExampleReasonsCount

      public int getDroppedExampleReasonsCount()
       Output only. For each index in `truncated_example_indices`, the user-facing
 reason why the example was dropped.
      repeated string dropped_example_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDroppedExampleReasonsCount in interface SupervisedTuningDataStatsOrBuilder
      Returns:
      The count of droppedExampleReasons.

    • getDroppedExampleReasons

      public String getDroppedExampleReasons(int index)
       Output only. For each index in `truncated_example_indices`, the user-facing
 reason why the example was dropped.
      repeated string dropped_example_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDroppedExampleReasons in interface SupervisedTuningDataStatsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The droppedExampleReasons at the given index.

    • getDroppedExampleReasonsBytes

      public com.google.protobuf.ByteString getDroppedExampleReasonsBytes(int index)
       Output only. For each index in `truncated_example_indices`, the user-facing
 reason why the example was dropped.
      repeated string dropped_example_reasons = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDroppedExampleReasonsBytes in interface SupervisedTuningDataStatsOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the droppedExampleReasons at the given index.

    • 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 SupervisedTuningDataStats parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SupervisedTuningDataStats parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static SupervisedTuningDataStats parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SupervisedTuningDataStats.Builder newBuilder()

    • newBuilder

      public static SupervisedTuningDataStats.Builder newBuilder(SupervisedTuningDataStats prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SupervisedTuningDataStats getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SupervisedTuningDataStats> 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 SupervisedTuningDataStats getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder