Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::FunctionResponse (v0.57.0)

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

The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#name

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

#name=

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

#response

def response() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.

#response=

def response=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
Returns
  • (::Google::Protobuf::Struct) — Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.