Type Alias FunctionParameters

pub type FunctionParameters = Value;

on openapi.yaml

FunctionParameters:
  type: object
  description: >-
    The parameters the functions accepts, described as a JSON Schema object.
    See the [guide](/docs/guides/function-calling) for examples, and the
    [JSON Schema reference](https:///json-schema.org/understanding-json-schema/) for
    documentation about the format.


    Omitting `parameters` defines a function with an empty parameter list.
  additionalProperties: true

Aliased Type

pub enum FunctionParameters {
    Null,
    Bool(bool),
    Number(Number),
    String(String),
    Array(Vec<Value>),
    Object(Map<String, Value>),
}

Variants

Null

Represents a JSON null value.

let v = json!(null);

Bool(bool)

Represents a JSON boolean.

let v = json!(true);

Number(Number)

Represents a JSON number, whether integer or floating point.

let v = json!(12.5);

String(String)

Represents a JSON string.

let v = json!("a string");

Array(Vec<Value>)

Represents a JSON array.

let v = json!(["an", "array"]);

Object(Map<String, Value>)

Represents a JSON object.

By default the map is backed by a BTreeMap. Enable the preserve_order feature of serde_json to use IndexMap instead, which preserves entries in the order they are inserted into the map. In particular, this allows JSON data to be deserialized into a Value and serialized to a string while retaining the order of map keys in the input.

let v = json!({ "an": "object" });