Package com.google.cloud.aiplatform.v1

Class EmbedContentRequest.EmbedContentConfig

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

  • Field Details

    • TITLE_FIELD_NUMBER

      public static final int TITLE_FIELD_NUMBER
      See Also:

    • TASK_TYPE_FIELD_NUMBER

      public static final int TASK_TYPE_FIELD_NUMBER
      See Also:

    • AUTO_TRUNCATE_FIELD_NUMBER

      public static final int AUTO_TRUNCATE_FIELD_NUMBER
      See Also:

    • OUTPUT_DIMENSIONALITY_FIELD_NUMBER

      public static final int OUTPUT_DIMENSIONALITY_FIELD_NUMBER
      See Also:

    • DOCUMENT_OCR_FIELD_NUMBER

      public static final int DOCUMENT_OCR_FIELD_NUMBER
      See Also:

    • AUDIO_TRACK_EXTRACTION_FIELD_NUMBER

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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static EmbedContentRequest.EmbedContentConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static EmbedContentRequest.EmbedContentConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static EmbedContentRequest.EmbedContentConfig.Builder newBuilder()

    • newBuilder

      public static EmbedContentRequest.EmbedContentConfig.Builder newBuilder(EmbedContentRequest.EmbedContentConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static EmbedContentRequest.EmbedContentConfig getDefaultInstance()

    • parser

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

    • getParserForType

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