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

A tool that allows the model to execute shell commands.

Fields

  • :environment - optional - ExOpenAI.Components.ContainerAutoParam.t() | ExOpenAI.Components.LocalEnvironmentParam.t() | ExOpenAI.Components.ContainerReferenceParam.t() | any()

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

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.FunctionShellToolParam{
  environment:
    (((ExOpenAI.Components.ContainerAutoParam.t()
       | ExOpenAI.Components.LocalEnvironmentParam.t())
      | ExOpenAI.Components.ContainerReferenceParam.t())
     | any())
    | nil,
  type: :shell
}