Struct FunctionObject

pub struct FunctionObject {
    pub parameters: Option<FunctionParameters>,
    pub description: Option<String>,
    pub name: String,
    pub strict: Option<bool>,
}

on openapi.yaml

FunctionObject:
  type: object
  properties:
    description:
      type: string
      description:
        A description of what the function does, used by the model to
        choose when and how to call the function.
    name:
      type: string
      description:
        The name of the function to be called. Must be a-z, A-Z, 0-9, or
        contain underscores and dashes, with a maximum length of 64.
    parameters:
      $ref: "#/components/schemas/FunctionParameters"
    strict:
      type: boolean
      nullable: true
      default: false
      description:
        Whether to enable strict schema adherence when generating the
        function call. If set to true, the model will follow the exact
        schema defined in the `parameters` field. Only a subset of JSON
        Schema is supported when `strict` is `true`. Learn more about
        Structured Outputs in the [function calling
        guide](docs/guides/function-calling).
  required:
    - name

Fields

parameters: Option<FunctionParameters>

description: Option<String>

A description of what the function does, used by the model to choose when and how to call the function.

name: String

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

strict: Option<bool>

Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the function calling guide.

Trait Implementations

impl Debug for FunctionObject

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionObject

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FunctionObject

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.