gopenai/chat

Types

ChatError

pub type ChatError {
  DynamicError(dynamic.Dynamic)
  JsonDecodeError(json.DecodeError)
}

Constructors

```
DynamicError(dynamic.Dynamic)
```
```
JsonDecodeError(json.DecodeError)
```

Choice

pub type Choice {
  Choice(
    finish_reason: FinishReason,
    index: Int,
    message: ModelMessage,
  )
}

Constructors

Choice(
  finish_reason: FinishReason,
  index: Int,
  message: ModelMessage,
)

CompletionResponse

pub type CompletionResponse {
  CompletionResponse(
    id: String,
    choices: List(Choice),
    created: Int,
    model: String,
    system_fingerprint: String,
    object: String,
    usage: Usage,
  )
}

Constructors

CompletionResponse(
  id: String,
  choices: List(Choice),
  created: Int,
  model: String,
  system_fingerprint: String,
  object: String,
  usage: Usage,
)

FinishReason

pub type FinishReason {
  Stop
  Length
  ContentFilter
  ToolCalls
  FunctionCall
}

Constructors

```
Stop
```
```
Length
```
```
ContentFilter
```
```
ToolCalls
```
```
FunctionCall
```

Message

pub type Message {
  Message(role: Role, content: String)
}

Constructors

```
Message(role: Role, content: String)
```

ModelMessage

pub type ModelMessage {
  ModelMessage(
    role: Role,
    content: Option(String),
    tool_calls: Option(List(tool.ToolCall)),
  )
}

Constructors

ModelMessage(
  role: Role,
  content: Option(String),
  tool_calls: Option(List(tool.ToolCall)),
)

Request

pub type Request {
  Request(
    model: Model,
    messages: List(Message),
    temperature: Float,
    tools: Option(List(tool.Tool)),
  )
}

Constructors

Request(
  model: Model,
  messages: List(Message),
  temperature: Float,
  tools: Option(List(tool.Tool)),
)

Role

pub type Role {
  System
  Assistant
  User
  Function
}

Constructors

```
System
```
```
Assistant
```
```
User
```
```
Function
```

Usage

pub type Usage {
  Usage(
    completion_tokens: Int,
    prompt_tokens: Int,
    total_tokens: Int,
  )
}

Constructors

Usage(
  completion_tokens: Int,
  prompt_tokens: Int,
  total_tokens: Int,
)

Functions

completion

pub fn completion(
  client: Client,
  req: Request,
) -> Result(CompletionResponse, ChatError)

completion_from_json

pub fn completion_from_json(
  data: String,
) -> Result(CompletionResponse, DecodeError)

request_to_json

pub fn request_to_json(req: Request) -> String