Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::FunctionDeclaration (v1.27.0)

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

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — 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.

#name

def name() -> ::String
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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.
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.

#parameters

def parameters() -> ::Google::Cloud::AIPlatform::V1::Schema
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

#parameters=

def parameters=(value) -> ::Google::Cloud::AIPlatform::V1::Schema
Parameter
  • value (::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
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

#parameters_json_schema

def parameters_json_schema() -> ::Google::Protobuf::Value
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.

#parameters_json_schema=

def parameters_json_schema=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::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.

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.

#response

def response() -> ::Google::Cloud::AIPlatform::V1::Schema
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.

#response=

def response=(value) -> ::Google::Cloud::AIPlatform::V1::Schema
Parameter
  • value (::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.
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.

#response_json_schema

def response_json_schema() -> ::Google::Protobuf::Value
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.

#response_json_schema=

def response_json_schema=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::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.

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.