gopenai/tool

Types

DataType

pub type DataType {
  StringType
  NumberType
  ArrayType
  BooleanType
  NullType
  ObjectType
}

Constructors

```
StringType
```
```
NumberType
```
```
ArrayType
```
```
BooleanType
```
```
NullType
```
```
ObjectType
```

Function

pub type Function {
  Function(
    description: String,
    name: String,
    parameters: Option(FunctionParameters),
  )
}

Constructors

Function(
  description: String,
  name: String,
  parameters: Option(FunctionParameters),
)

FunctionCall

pub type FunctionCall {
  FunctionCall(name: String, arguments: String)
}

Constructors

FunctionCall(name: String, arguments: String)

FunctionParameters

pub type FunctionParameters {
  FunctionParameters(
    paramter_type: DataType,
    properties: dict.Dict(String, FunctionProperty),
    requiered: List(String),
  )
}

Constructors

FunctionParameters(
  paramter_type: DataType,
  properties: dict.Dict(String, FunctionProperty),
  requiered: List(String),
)

FunctionProperty

pub type FunctionProperty {
  FunctionProperty(
    property_type: DataType,
    description: String,
    enum: Option(List(String)),
  )
}

Constructors

FunctionProperty(
  property_type: DataType,
  description: String,
  enum: Option(List(String)),
)

Tool

pub type Tool {
  Tool(tool_type: ToolType, function: Function)
}

Constructors

Tool(tool_type: ToolType, function: Function)

ToolCall

pub type ToolCall {
  ToolCall(
    id: String,
    tool_type: ToolType,
    function: FunctionCall,
  )
}

Constructors

ToolCall(id: String, tool_type: ToolType, function: FunctionCall)

ToolType

pub type ToolType {
  FunctionType
}

Constructors

```
FunctionType
```

Value

pub type Value {
  Int
  Float
  String
}

Constructors

```
Int
```
```
Float
```
```
String
```

Functions

function_call_from_json

pub fn function_call_from_json(
  from data: Dynamic,
) -> Result(FunctionCall, List(DecodeError))

tool_to_json

pub fn tool_to_json(tool: Tool) -> Json

tool_type_from_json

pub fn tool_type_from_json(
  from data: Dynamic,
) -> Result(ToolType, List(DecodeError))

tools_to_json

pub fn tools_to_json(tools: Option(List(Tool))) -> Json

validate_property

pub fn validate_property(prop: FunctionProperty) -> Bool