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

Groups function/custom tools under a shared namespace.

Fields

  • :description - required - String.t()
    A description of the namespace shown to the model.
    Constraints: minLength: 1

  • :name - required - String.t()
    The namespace name used in tool calls (for example, crm).
    Constraints: minLength: 1

  • :tools - required - [ExOpenAI.Components.FunctionToolParam.t() | ExOpenAI.Components.CustomToolParam.t()]
    The function/custom tools available inside this namespace.
    Constraints: minItems: 1

  • :type - required - :namespace
    The type of the tool. Always namespace.
    Allowed values: "namespace"
    Default: "namespace"

Summary

Types

@type t() :: %ExOpenAI.Components.NamespaceToolParam{
  description: String.t(),
  name: String.t(),
  tools: [
    ExOpenAI.Components.FunctionToolParam.t()
    | ExOpenAI.Components.CustomToolParam.t()
  ],
  type: :namespace
}