Struct FunctionDeclaration 

#[non_exhaustive]
pub struct FunctionDeclaration {
    pub name: String,
    pub description: String,
    pub parameters: Option<Schema>,
    pub parameters_json_schema: Option<Value>,
    pub response: Option<Schema>,
    pub response_json_schema: Option<Value>,
    /* private fields */
}

Available on crate features gen-ai-cache-service or llm-utility-service or prediction-service only.

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: 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.

description: String

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

parameters: Option<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: Option<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: Option<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: Option<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.

Implementations

impl FunctionDeclaration

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = FunctionDeclaration::new().set_name("example");

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

Example

let x = FunctionDeclaration::new().set_description("example");

pub fn set_parameters<T>(self, v: T) -> Self

where T: Into<Schema>,

Sets the value of parameters.

Example

use google_cloud_aiplatform_v1::model::Schema;
let x = FunctionDeclaration::new().set_parameters(Schema::default()/* use setters */);

pub fn set_or_clear_parameters<T>(self, v: Option<T>) -> Self

where T: Into<Schema>,

Sets or clears the value of parameters.

Example

use google_cloud_aiplatform_v1::model::Schema;
let x = FunctionDeclaration::new().set_or_clear_parameters(Some(Schema::default()/* use setters */));
let x = FunctionDeclaration::new().set_or_clear_parameters(None::<Schema>);

pub fn set_parameters_json_schema<T>(self, v: T) -> Self

where T: Into<Value>,

Sets the value of parameters_json_schema.

Example

use wkt::Value;
let x = FunctionDeclaration::new().set_parameters_json_schema(Value::default()/* use setters */);

pub fn set_or_clear_parameters_json_schema<T>(self, v: Option<T>) -> Self

where T: Into<Value>,

Sets or clears the value of parameters_json_schema.

Example

use wkt::Value;
let x = FunctionDeclaration::new().set_or_clear_parameters_json_schema(Some(Value::default()/* use setters */));
let x = FunctionDeclaration::new().set_or_clear_parameters_json_schema(None::<Value>);

pub fn set_response<T>(self, v: T) -> Self

where T: Into<Schema>,

Sets the value of response.

Example

use google_cloud_aiplatform_v1::model::Schema;
let x = FunctionDeclaration::new().set_response(Schema::default()/* use setters */);

pub fn set_or_clear_response<T>(self, v: Option<T>) -> Self

where T: Into<Schema>,

Sets or clears the value of response.

Example

use google_cloud_aiplatform_v1::model::Schema;
let x = FunctionDeclaration::new().set_or_clear_response(Some(Schema::default()/* use setters */));
let x = FunctionDeclaration::new().set_or_clear_response(None::<Schema>);

pub fn set_response_json_schema<T>(self, v: T) -> Self

where T: Into<Value>,

Sets the value of response_json_schema.

Example

use wkt::Value;
let x = FunctionDeclaration::new().set_response_json_schema(Value::default()/* use setters */);

pub fn set_or_clear_response_json_schema<T>(self, v: Option<T>) -> Self

where T: Into<Value>,

Sets or clears the value of response_json_schema.

Example

use wkt::Value;
let x = FunctionDeclaration::new().set_or_clear_response_json_schema(Some(Value::default()/* use setters */));
let x = FunctionDeclaration::new().set_or_clear_response_json_schema(None::<Value>);

Trait Implementations

impl Clone for FunctionDeclaration

fn clone(&self) -> FunctionDeclaration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FunctionDeclaration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FunctionDeclaration

fn default() -> FunctionDeclaration

Returns the “default value” for a type.

impl Message for FunctionDeclaration

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FunctionDeclaration

fn eq(&self, other: &FunctionDeclaration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FunctionDeclaration