View Source ExOpenAI.Components.FunctionToolParam (ex_openai.ex v2.0.0-beta2)

Module for representing the OpenAI schema FunctionToolParam.

Fields

  • :defer_loading - optional - boolean()
    Whether this function should be deferred and discovered via tool search.

  • :description - optional - String.t() | any()

  • :name - required - String.t()
    Constraints: minLength: 1, maxLength: 128, pattern: "^[a-zA-Z0-9_-]+$"

  • :parameters - optional - ExOpenAI.Components.EmptyModelParam.t() | any()

  • :strict - optional - boolean() | any()

  • :type - required - :function
    Allowed values: "function"
    Default: "function"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.FunctionToolParam{
  defer_loading: boolean() | nil,
  description: (String.t() | any()) | nil,
  name: String.t(),
  parameters: (ExOpenAI.Components.EmptyModelParam.t() | any()) | nil,
  strict: (boolean() | any()) | nil,
  type: :function
}