Package com.google.cloud.aiplatform.v1

Enum FunctionCallingConfig.Mode

java.lang.Object
java.lang.Enum<FunctionCallingConfig.Mode>
com.google.cloud.aiplatform.v1.FunctionCallingConfig.Mode
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<FunctionCallingConfig.Mode>
Enclosing class:
FunctionCallingConfig
public static enum FunctionCallingConfig.Mode extends Enum<FunctionCallingConfig.Mode> implements com.google.protobuf.ProtocolMessageEnum
 Function calling mode.
Protobuf enum google.cloud.aiplatform.v1.FunctionCallingConfig.Mode

  • Enum Constant Details

    • MODE_UNSPECIFIED

      public static final FunctionCallingConfig.Mode MODE_UNSPECIFIED
       Unspecified function calling mode. This value should not be used.
      MODE_UNSPECIFIED = 0;

    • AUTO

      public static final FunctionCallingConfig.Mode AUTO
       Default model behavior, model decides to predict either function calls
 or natural language response.
      AUTO = 1;

    • ANY

      public static final FunctionCallingConfig.Mode ANY
       Model is constrained to always predicting function calls only.
 If "allowed_function_names" are set, the predicted function calls will be
 limited to any one of "allowed_function_names", else the predicted
 function calls will be any one of the provided "function_declarations".
      ANY = 2;

    • NONE

      public static final FunctionCallingConfig.Mode NONE
       Model will not predict any function calls. Model behavior is same as when
 not passing any function declarations.
      NONE = 3;

    • VALIDATED

      public static final FunctionCallingConfig.Mode VALIDATED
       Model is constrained to predict either function calls or natural language
 response.
 If [allowed_function_names][FunctionCallingConfig.allowed_function_names]
 are set, the predicted function calls will be limited to any one of
 `allowed_function_names`, else the predicted function calls will be any
 one of the provided [FunctionDeclaration].
      VALIDATED = 5;

    • UNRECOGNIZED

      public static final FunctionCallingConfig.Mode UNRECOGNIZED

  • Field Details

    • MODE_UNSPECIFIED_VALUE

      public static final int MODE_UNSPECIFIED_VALUE
       Unspecified function calling mode. This value should not be used.
      MODE_UNSPECIFIED = 0;
      See Also:

    • AUTO_VALUE

      public static final int AUTO_VALUE
       Default model behavior, model decides to predict either function calls
 or natural language response.
      AUTO = 1;
      See Also:

    • ANY_VALUE

      public static final int ANY_VALUE
       Model is constrained to always predicting function calls only.
 If "allowed_function_names" are set, the predicted function calls will be
 limited to any one of "allowed_function_names", else the predicted
 function calls will be any one of the provided "function_declarations".
      ANY = 2;
      See Also:

    • NONE_VALUE

      public static final int NONE_VALUE
       Model will not predict any function calls. Model behavior is same as when
 not passing any function declarations.
      NONE = 3;
      See Also:

    • VALIDATED_VALUE

      public static final int VALIDATED_VALUE
       Model is constrained to predict either function calls or natural language
 response.
 If [allowed_function_names][FunctionCallingConfig.allowed_function_names]
 are set, the predicted function calls will be limited to any one of
 `allowed_function_names`, else the predicted function calls will be any
 one of the provided [FunctionDeclaration].
      VALIDATED = 5;
      See Also:

  • Method Details

    • values

      public static FunctionCallingConfig.Mode[] 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 FunctionCallingConfig.Mode 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 FunctionCallingConfig.Mode 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 FunctionCallingConfig.Mode 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<FunctionCallingConfig.Mode> 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 FunctionCallingConfig.Mode 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