View Source GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1FunctionDeclaration (google_api_ai_platform v0.13.0)

Structured representation of a function declaration as defined by the OpenAPI 3.0 specification. Included in this declaration are the function name and parameters. 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.

Attributes

description (type: String.t, default: nil) - Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
name (type: String.t, default: nil) - 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 (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Schema.t, default: nil) - 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

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1FunctionDeclaration{
    description: String.t() | nil,
    name: String.t() | nil,
    parameters:
      GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Schema.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.