Package com.google.cloud.aiplatform.v1

Class EmbedContentRequest.EmbedContentConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<EmbedContentRequest.EmbedContentConfig.Builder>
com.google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig.Builder
All Implemented Interfaces:
EmbedContentRequest.EmbedContentConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
EmbedContentRequest.EmbedContentConfig
public static final class EmbedContentRequest.EmbedContentConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<EmbedContentRequest.EmbedContentConfig.Builder> implements EmbedContentRequest.EmbedContentConfigOrBuilder
 Configurations for the EmbedContent API.
Protobuf type google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig

  • 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.Builder<EmbedContentRequest.EmbedContentConfig.Builder>

    • clear

      public EmbedContentRequest.EmbedContentConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<EmbedContentRequest.EmbedContentConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<EmbedContentRequest.EmbedContentConfig.Builder>

    • getDefaultInstanceForType

      public EmbedContentRequest.EmbedContentConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public EmbedContentRequest.EmbedContentConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public EmbedContentRequest.EmbedContentConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public EmbedContentRequest.EmbedContentConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<EmbedContentRequest.EmbedContentConfig.Builder>

    • mergeFrom

      public EmbedContentRequest.EmbedContentConfig.Builder mergeFrom(EmbedContentRequest.EmbedContentConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<EmbedContentRequest.EmbedContentConfig.Builder>

    • mergeFrom

      public EmbedContentRequest.EmbedContentConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<EmbedContentRequest.EmbedContentConfig.Builder>
      Throws:
      IOException

    • hasTitle

      public boolean hasTitle()
       Optional. The title for the text.

 Only applicable to text-only embedding models.
      optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasTitle in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      Whether the title field is set.

    • getTitle

      public String getTitle()
       Optional. The title for the text.

 Only applicable to text-only embedding models.
      optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTitle in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      The title.

    • getTitleBytes

      public com.google.protobuf.ByteString getTitleBytes()
       Optional. The title for the text.

 Only applicable to text-only embedding models.
      optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTitleBytes in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      The bytes for title.

    • setTitle

      public EmbedContentRequest.EmbedContentConfig.Builder setTitle(String value)
       Optional. The title for the text.

 Only applicable to text-only embedding models.
      optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The title to set.
      Returns:
      This builder for chaining.

    • clearTitle

      public EmbedContentRequest.EmbedContentConfig.Builder clearTitle()
       Optional. The title for the text.

 Only applicable to text-only embedding models.
      optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setTitleBytes

      public EmbedContentRequest.EmbedContentConfig.Builder setTitleBytes(com.google.protobuf.ByteString value)
       Optional. The title for the text.

 Only applicable to text-only embedding models.
      optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for title to set.
      Returns:
      This builder for chaining.

    • hasTaskType

      public boolean hasTaskType()
       Optional. The task type of the embedding.

 Only applicable to text-only embedding models.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasTaskType in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      Whether the taskType field is set.

    • getTaskTypeValue

      public int getTaskTypeValue()
       Optional. The task type of the embedding.

 Only applicable to text-only embedding models.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTaskTypeValue in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      The enum numeric value on the wire for taskType.

    • setTaskTypeValue

      public EmbedContentRequest.EmbedContentConfig.Builder setTaskTypeValue(int value)
       Optional. The task type of the embedding.

 Only applicable to text-only embedding models.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for taskType to set.
      Returns:
      This builder for chaining.

    • getTaskType

      public EmbedContentRequest.EmbeddingTaskType getTaskType()
       Optional. The task type of the embedding.

 Only applicable to text-only embedding models.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTaskType in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      The taskType.

    • setTaskType

      public EmbedContentRequest.EmbedContentConfig.Builder setTaskType(EmbedContentRequest.EmbeddingTaskType value)
       Optional. The task type of the embedding.

 Only applicable to text-only embedding models.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The taskType to set.
      Returns:
      This builder for chaining.

    • clearTaskType

      public EmbedContentRequest.EmbedContentConfig.Builder clearTaskType()
       Optional. The task type of the embedding.

 Only applicable to text-only embedding models.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasAutoTruncate

      public boolean hasAutoTruncate()
       Optional. Whether to silently truncate the input content if it's longer
 than the maximum sequence length.

 Only applicable to text-only embedding models.
      optional bool auto_truncate = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAutoTruncate in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      Whether the autoTruncate field is set.

    • getAutoTruncate

      public boolean getAutoTruncate()
       Optional. Whether to silently truncate the input content if it's longer
 than the maximum sequence length.

 Only applicable to text-only embedding models.
      optional bool auto_truncate = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAutoTruncate in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      The autoTruncate.

    • setAutoTruncate

      public EmbedContentRequest.EmbedContentConfig.Builder setAutoTruncate(boolean value)
       Optional. Whether to silently truncate the input content if it's longer
 than the maximum sequence length.

 Only applicable to text-only embedding models.
      optional bool auto_truncate = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The autoTruncate to set.
      Returns:
      This builder for chaining.

    • clearAutoTruncate

      public EmbedContentRequest.EmbedContentConfig.Builder clearAutoTruncate()
       Optional. Whether to silently truncate the input content if it's longer
 than the maximum sequence length.

 Only applicable to text-only embedding models.
      optional bool auto_truncate = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasOutputDimensionality

      public boolean hasOutputDimensionality()
       Optional. Reduced dimension for the output embedding. If set, excessive
 values in the output embedding are truncated from the end.
      optional int32 output_dimensionality = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasOutputDimensionality in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      Whether the outputDimensionality field is set.

    • getOutputDimensionality

      public int getOutputDimensionality()
       Optional. Reduced dimension for the output embedding. If set, excessive
 values in the output embedding are truncated from the end.
      optional int32 output_dimensionality = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOutputDimensionality in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      The outputDimensionality.

    • setOutputDimensionality

      public EmbedContentRequest.EmbedContentConfig.Builder setOutputDimensionality(int value)
       Optional. Reduced dimension for the output embedding. If set, excessive
 values in the output embedding are truncated from the end.
      optional int32 output_dimensionality = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The outputDimensionality to set.
      Returns:
      This builder for chaining.

    • clearOutputDimensionality

      public EmbedContentRequest.EmbedContentConfig.Builder clearOutputDimensionality()
       Optional. Reduced dimension for the output embedding. If set, excessive
 values in the output embedding are truncated from the end.
      optional int32 output_dimensionality = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasDocumentOcr

      public boolean hasDocumentOcr()
       Optional. Whether to enable OCR for document content.
      optional bool document_ocr = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasDocumentOcr in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      Whether the documentOcr field is set.

    • getDocumentOcr

      public boolean getDocumentOcr()
       Optional. Whether to enable OCR for document content.
      optional bool document_ocr = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDocumentOcr in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      The documentOcr.

    • setDocumentOcr

      public EmbedContentRequest.EmbedContentConfig.Builder setDocumentOcr(boolean value)
       Optional. Whether to enable OCR for document content.
      optional bool document_ocr = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The documentOcr to set.
      Returns:
      This builder for chaining.

    • clearDocumentOcr

      public EmbedContentRequest.EmbedContentConfig.Builder clearDocumentOcr()
       Optional. Whether to enable OCR for document content.
      optional bool document_ocr = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasAudioTrackExtraction

      public boolean hasAudioTrackExtraction()
       Optional. Whether to extract audio from video content.
      optional bool audio_track_extraction = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAudioTrackExtraction in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      Whether the audioTrackExtraction field is set.

    • getAudioTrackExtraction

      public boolean getAudioTrackExtraction()
       Optional. Whether to extract audio from video content.
      optional bool audio_track_extraction = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAudioTrackExtraction in interface EmbedContentRequest.EmbedContentConfigOrBuilder
      Returns:
      The audioTrackExtraction.

    • setAudioTrackExtraction

      public EmbedContentRequest.EmbedContentConfig.Builder setAudioTrackExtraction(boolean value)
       Optional. Whether to extract audio from video content.
      optional bool audio_track_extraction = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The audioTrackExtraction to set.
      Returns:
      This builder for chaining.

    • clearAudioTrackExtraction

      public EmbedContentRequest.EmbedContentConfig.Builder clearAudioTrackExtraction()
       Optional. Whether to extract audio from video content.
      optional bool audio_track_extraction = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.