Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::FunctionCall (v1.33.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::FunctionCall.

A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#args

def args() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

#args=

def args=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
Returns
  • (::Google::Protobuf::Struct) — Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

#name

def name() -> ::String
Returns
  • (::String) — Optional. The name of the function to call. Matches [FunctionDeclaration.name].

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Optional. The name of the function to call. Matches [FunctionDeclaration.name].
Returns
  • (::String) — Optional. The name of the function to call. Matches [FunctionDeclaration.name].

#partial_args

def partial_args() -> ::Array<::Google::Cloud::AIPlatform::V1::PartialArg>
Returns

#partial_args=

def partial_args=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::PartialArg>
Parameter
Returns

#will_continue

def will_continue() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.

#will_continue=

def will_continue=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
Returns
  • (::Boolean) — Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.