Package com.google.cloud.aiplatform.v1

Enum EmbedContentRequest.EmbeddingTaskType

java.lang.Object
java.lang.Enum<EmbedContentRequest.EmbeddingTaskType>
com.google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<EmbedContentRequest.EmbeddingTaskType>
Enclosing class:
EmbedContentRequest
public static enum EmbedContentRequest.EmbeddingTaskType extends Enum<EmbedContentRequest.EmbeddingTaskType> implements com.google.protobuf.ProtocolMessageEnum
 Represents a downstream task the embeddings will be used for.
Protobuf enum google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType

  • Enum Constant Details

  • Field Details

    • UNSPECIFIED_VALUE

      public static final int UNSPECIFIED_VALUE
       Unset value, which will default to one of the other enum values.
      UNSPECIFIED = 0;
      See Also:

    • RETRIEVAL_QUERY_VALUE

      public static final int RETRIEVAL_QUERY_VALUE
       Specifies the given text is a query in a search/retrieval setting.
      RETRIEVAL_QUERY = 2;
      See Also:

    • RETRIEVAL_DOCUMENT_VALUE

      public static final int RETRIEVAL_DOCUMENT_VALUE
       Specifies the given text is a document from the corpus being searched.
      RETRIEVAL_DOCUMENT = 3;
      See Also:

    • SEMANTIC_SIMILARITY_VALUE

      public static final int SEMANTIC_SIMILARITY_VALUE
       Specifies the given text will be used for STS.
      SEMANTIC_SIMILARITY = 4;
      See Also:

    • CLASSIFICATION_VALUE

      public static final int CLASSIFICATION_VALUE
       Specifies that the given text will be classified.
      CLASSIFICATION = 5;
      See Also:

    • CLUSTERING_VALUE

      public static final int CLUSTERING_VALUE
       Specifies that the embeddings will be used for clustering.
      CLUSTERING = 6;
      See Also:

    • QUESTION_ANSWERING_VALUE

      public static final int QUESTION_ANSWERING_VALUE
       Specifies that the embeddings will be used for question answering.
      QUESTION_ANSWERING = 7;
      See Also:

    • FACT_VERIFICATION_VALUE

      public static final int FACT_VERIFICATION_VALUE
       Specifies that the embeddings will be used for fact verification.
      FACT_VERIFICATION = 8;
      See Also:

    • CODE_RETRIEVAL_QUERY_VALUE

      public static final int CODE_RETRIEVAL_QUERY_VALUE
       Specifies that the embeddings will be used for code retrieval.
      CODE_RETRIEVAL_QUERY = 9;
      See Also:

  • Method Details

    • values

      public static EmbedContentRequest.EmbeddingTaskType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static EmbedContentRequest.EmbeddingTaskType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static EmbedContentRequest.EmbeddingTaskType valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static EmbedContentRequest.EmbeddingTaskType forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<EmbedContentRequest.EmbeddingTaskType> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static EmbedContentRequest.EmbeddingTaskType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null