pig - v0.1.0

pig/ai/openai

Types

OpenAIConfig

</>

Configuration for an OpenAI-compatible provider.

pub type OpenAIConfig {
  OpenAIConfig(
    api_key: String,
    model: String,
    base_url: String,
    http_timeout_ms: Int,
  )
}

Constructors 

  • OpenAIConfig(
  api_key: String,
  model: String,
  base_url: String,
  http_timeout_ms: Int,
)

OpenAIProvider

</>

An OpenAI-compatible provider wrapping a callable function with its config.

pub type OpenAIProvider {
  OpenAIProvider(
    config: OpenAIConfig,
    call: fn(
      List(message.Message),
      List(tool_definition.ToolDefinition),
    ) -> Result(provider.InferenceResult, error.AiError),
  )
}

Constructors

ProviderFn

</>

The function signature for a provider call.

pub type ProviderFn =
  fn(List(message.Message), List(tool_definition.ToolDefinition)) -> Result(
    provider.InferenceResult,
    error.AiError,
  )

Values

build_request_body

</> 
pub fn build_request_body(
  messages: List(message.Message),
  tools: List(tool_definition.ToolDefinition),
  model: String,
) -> String

Build the JSON request body for the OpenAI Chat Completions API. Pure function — no IO.

default_base_url

</> 
pub const default_base_url: String

The default OpenAI base URL.

default_http_timeout_ms

</> 
pub const default_http_timeout_ms: Int

The default HTTP timeout for OpenAI API calls (120 seconds).

parse_response

</> 
pub fn parse_response(
  raw: String,
) -> Result(provider.InferenceResult, error.AiError)

Parse an OpenAI Chat Completions JSON response into an InferenceResult. Pure function — no IO.

provider

</> 
pub fn provider(api_key: String, model: String) -> OpenAIProvider

Create a provider with the default OpenAI base URL.

provider_with_base_url

</> 
pub fn provider_with_base_url(
  api_key: String,
  model: String,
  base_url: String,
) -> OpenAIProvider

Create a provider with a custom base URL (for Ollama, Together, etc).

provider_with_base_url_and_timeout

</> 
pub fn provider_with_base_url_and_timeout(
  api_key: String,
  model: String,
  base_url: String,
  http_timeout_ms: Int,
) -> OpenAIProvider

Create a provider with a custom base URL and HTTP timeout.

with_http_timeout

</> 
pub fn with_http_timeout(
  provider: OpenAIProvider,
  timeout_ms: Int,
) -> OpenAIProvider

Set the HTTP timeout in milliseconds on an OpenAI provider.

✨ Search Document