Class: Google::Cloud::AIPlatform::V1::FunctionCallingConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/tool.rb

Overview

Function calling config.

Defined Under Namespace

Modules: Mode

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_function_names ⇒ ::Array<::String>

Returns Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.

Returns:

  • (::Array<::String>) —

    Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 198

class FunctionCallingConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Function calling mode.
  module Mode
    # Unspecified function calling mode. This value should not be used.
    MODE_UNSPECIFIED = 0

    # Default model behavior, model decides to predict either a function call
    # or a natural language response.
    AUTO = 1

    # Model is constrained to always predicting a function call only.
    # If "allowed_function_names" are set, the predicted function call will be
    # limited to any one of "allowed_function_names", else the predicted
    # function call will be any one of the provided "function_declarations".
    ANY = 2

    # Model will not predict any function call. Model behavior is same as when
    # not passing any function declarations.
    NONE = 3
  end
end

#mode ⇒ ::Google::Cloud::AIPlatform::V1::FunctionCallingConfig::Mode

Returns Optional. Function calling mode.

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 198

class FunctionCallingConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Function calling mode.
  module Mode
    # Unspecified function calling mode. This value should not be used.
    MODE_UNSPECIFIED = 0

    # Default model behavior, model decides to predict either a function call
    # or a natural language response.
    AUTO = 1

    # Model is constrained to always predicting a function call only.
    # If "allowed_function_names" are set, the predicted function call will be
    # limited to any one of "allowed_function_names", else the predicted
    # function call will be any one of the provided "function_declarations".
    ANY = 2

    # Model will not predict any function call. Model behavior is same as when
    # not passing any function declarations.
    NONE = 3
  end
end