Class: Google::Cloud::AIPlatform::V1::FunctionDeclaration

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

Overview

Structured representation of a function declaration as defined by the OpenAPI 3.0 specification. Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client.

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.

Returns:

  • (::String) —

    Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.



228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 228

class FunctionDeclaration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.

Returns:

  • (::String) —

    Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.



228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 228

class FunctionDeclaration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parameters ⇒ ::Google::Cloud::AIPlatform::V1::Schema

Returns Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required:

  • param1.

Returns:

  • (::Google::Cloud::AIPlatform::V1::Schema) —

    Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required:

    • param1


228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 228

class FunctionDeclaration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parameters_json_schema ⇒ ::Google::Protobuf::Value

Returns Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example:

{
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "age": { "type": "integer" }
  },
  "additionalProperties": false,
  "required": ["name", "age"],
  "propertyOrdering": ["name", "age"]
}

This field is mutually exclusive with parameters.

Returns:

  • (::Google::Protobuf::Value) —

    Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example:

    {
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "age": { "type": "integer" }
  },
  "additionalProperties": false,
  "required": ["name", "age"],
  "propertyOrdering": ["name", "age"]
}

    This field is mutually exclusive with parameters.



228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 228

class FunctionDeclaration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#response ⇒ ::Google::Cloud::AIPlatform::V1::Schema

Returns Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.

Returns:

  • (::Google::Cloud::AIPlatform::V1::Schema) —

    Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.



228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 228

class FunctionDeclaration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#response_json_schema ⇒ ::Google::Protobuf::Value

Returns Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function.

This field is mutually exclusive with response.

Returns:

  • (::Google::Protobuf::Value) —

    Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function.

    This field is mutually exclusive with response.



228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 228

class FunctionDeclaration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end