Package com.google.cloud.aiplatform.v1

Class EmbedContentRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.EmbedContentRequest
All Implemented Interfaces:
EmbedContentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class EmbedContentRequest extends com.google.protobuf.GeneratedMessage implements EmbedContentRequestOrBuilder
 Request message for
 [PredictionService.EmbedContent][google.cloud.aiplatform.v1.PredictionService.EmbedContent].
Protobuf type google.cloud.aiplatform.v1.EmbedContentRequest
See Also:

  • Field Details

    • MODEL_FIELD_NUMBER

      public static final int MODEL_FIELD_NUMBER
      See Also:

    • CONTENT_FIELD_NUMBER

      public static final int CONTENT_FIELD_NUMBER
      See Also:

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

    • OUTPUT_DIMENSIONALITY_FIELD_NUMBER

      public static final int OUTPUT_DIMENSIONALITY_FIELD_NUMBER
      See Also:

    • AUTO_TRUNCATE_FIELD_NUMBER

      public static final int AUTO_TRUNCATE_FIELD_NUMBER
      See Also:

    • EMBED_CONTENT_CONFIG_FIELD_NUMBER

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

    • hasModel

      public boolean hasModel()
       Required. The name of the publisher model requested to serve the
 prediction. Format:
 `projects/{project}/locations/{location}/publishers/*/models/*`
      optional string model = 1 [(.google.api.resource_reference) = { ... }
      Specified by:
      hasModel in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the model field is set.

    • getModel

      public String getModel()
       Required. The name of the publisher model requested to serve the
 prediction. Format:
 `projects/{project}/locations/{location}/publishers/*/models/*`
      optional string model = 1 [(.google.api.resource_reference) = { ... }
      Specified by:
      getModel in interface EmbedContentRequestOrBuilder
      Returns:
      The model.

    • getModelBytes

      public com.google.protobuf.ByteString getModelBytes()
       Required. The name of the publisher model requested to serve the
 prediction. Format:
 `projects/{project}/locations/{location}/publishers/*/models/*`
      optional string model = 1 [(.google.api.resource_reference) = { ... }
      Specified by:
      getModelBytes in interface EmbedContentRequestOrBuilder
      Returns:
      The bytes for model.

    • hasContent

      public boolean hasContent()
       Required. Input content to be embedded.
      optional .google.cloud.aiplatform.v1.Content content = 2;
      Specified by:
      hasContent in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the content field is set.

    • getContent

      public Content getContent()
       Required. Input content to be embedded.
      optional .google.cloud.aiplatform.v1.Content content = 2;
      Specified by:
      getContent in interface EmbedContentRequestOrBuilder
      Returns:
      The content.

    • getContentOrBuilder

      public ContentOrBuilder getContentOrBuilder()
       Required. Input content to be embedded.
      optional .google.cloud.aiplatform.v1.Content content = 2;
      Specified by:
      getContentOrBuilder in interface EmbedContentRequestOrBuilder

    • hasTitle

      @Deprecated public boolean hasTitle()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=968
       Optional. Deprecated: Please use EmbedContentConfig.title instead.
 The title for the text.
      optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasTitle in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the title field is set.

    • getTitle

      @Deprecated public String getTitle()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=968
       Optional. Deprecated: Please use EmbedContentConfig.title instead.
 The title for the text.
      optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTitle in interface EmbedContentRequestOrBuilder
      Returns:
      The title.

    • getTitleBytes

      @Deprecated public com.google.protobuf.ByteString getTitleBytes()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=968
       Optional. Deprecated: Please use EmbedContentConfig.title instead.
 The title for the text.
      optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTitleBytes in interface EmbedContentRequestOrBuilder
      Returns:
      The bytes for title.

    • hasTaskType

      @Deprecated public boolean hasTaskType()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=973
       Optional. Deprecated: Please use EmbedContentConfig.task_type instead.
 The task type of the embedding.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasTaskType in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the taskType field is set.

    • getTaskTypeValue

      @Deprecated public int getTaskTypeValue()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=973
       Optional. Deprecated: Please use EmbedContentConfig.task_type instead.
 The task type of the embedding.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTaskTypeValue in interface EmbedContentRequestOrBuilder
      Returns:
      The enum numeric value on the wire for taskType.

    • getTaskType

      @Deprecated public EmbedContentRequest.EmbeddingTaskType getTaskType()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=973
       Optional. Deprecated: Please use EmbedContentConfig.task_type instead.
 The task type of the embedding.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTaskType in interface EmbedContentRequestOrBuilder
      Returns:
      The taskType.

    • hasOutputDimensionality

      @Deprecated public boolean hasOutputDimensionality()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.output_dimensionality is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=979
       Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality
 instead. Reduced dimension for the output embedding. If set, excessive
 values in the output embedding are truncated from the end.
      optional int32 output_dimensionality = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasOutputDimensionality in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the outputDimensionality field is set.

    • getOutputDimensionality

      @Deprecated public int getOutputDimensionality()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.output_dimensionality is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=979
       Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality
 instead. Reduced dimension for the output embedding. If set, excessive
 values in the output embedding are truncated from the end.
      optional int32 output_dimensionality = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOutputDimensionality in interface EmbedContentRequestOrBuilder
      Returns:
      The outputDimensionality.

    • hasAutoTruncate

      @Deprecated public boolean hasAutoTruncate()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.auto_truncate is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=985
       Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead.
 Whether to silently truncate the input content if it's longer
 than the maximum sequence length.
      optional bool auto_truncate = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAutoTruncate in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the autoTruncate field is set.

    • getAutoTruncate

      @Deprecated public boolean getAutoTruncate()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.auto_truncate is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=985
       Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead.
 Whether to silently truncate the input content if it's longer
 than the maximum sequence length.
      optional bool auto_truncate = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAutoTruncate in interface EmbedContentRequestOrBuilder
      Returns:
      The autoTruncate.

    • hasEmbedContentConfig

      public boolean hasEmbedContentConfig()
       Optional. Configuration for the EmbedContent request.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEmbedContentConfig in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the embedContentConfig field is set.

    • getEmbedContentConfig

      public EmbedContentRequest.EmbedContentConfig getEmbedContentConfig()
       Optional. Configuration for the EmbedContent request.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEmbedContentConfig in interface EmbedContentRequestOrBuilder
      Returns:
      The embedContentConfig.

    • getEmbedContentConfigOrBuilder

      public EmbedContentRequest.EmbedContentConfigOrBuilder getEmbedContentConfigOrBuilder()
       Optional. Configuration for the EmbedContent request.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEmbedContentConfigOrBuilder in interface EmbedContentRequestOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static EmbedContentRequest 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 parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static EmbedContentRequest.Builder newBuilder()

    • newBuilder

      public static EmbedContentRequest.Builder newBuilder(EmbedContentRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static EmbedContentRequest getDefaultInstance()

    • parser

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

    • getParserForType

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