View Source InstructorLite.Adapters.OpenAI (instructor_lite v0.1.0)

OpenAI adapter.

This adapter is implemented using chat completions endpoint and structured outputs.

Params

params argument should be shaped as a Create chat completion request body.

Example

InstructorLite.instruct(%{
    messages: [%{role: "user", content: "John is 25yo"}],
    model: "gpt-4o-mini",
    service_tier: "default"
  },
  response_model: %{name: :string, age: :integer},
  adapter: InstructorLite.Adapters.OpenAI,
  adapter_context: [api_key: Application.fetch_env!(:instructor_lite, :openai_key)]
)
{:ok, %{name: "John", age: 25}}

Summary

Functions

initial_prompt(params, opts)

Updates params with prompt based on json_schema and notes.

parse_response(response, opts)

Parse chat completion endpoint response.

retry_prompt(params, resp_params, errors, response, opts)

Updates params with prompt for retrying a request.

send_request(params, opts)

Make request to OpenAI API.