Current section

Files

Jump to
openai_ex lib openai_ex beta threads_runs.ex
Raw

lib/openai_ex/beta/threads_runs.ex

defmodule OpenaiEx.Beta.Threads.Runs do
@moduledoc """
This module provides an implementation of the OpenAI run API. The API
reference can be found at https://platform.openai.com/docs/api-reference/runs.
"""
alias OpenaiEx.{Http, HttpSse}
@api_fields [
:assistant_id,
:model,
:instructions,
:additional_instructions,
:additional_messages,
:tools,
:metadata,
:temperature,
:top_p,
:max_prompt_tokens,
:max_completion_tokens,
:truncation_strategy,
:tool_choice,
:response_format
]
@ep_url "/threads/runs"
defp ep_url(thread_id, run_id \\ nil, action \\ nil) do
"/threads/#{thread_id}/runs" <>
if(is_nil(run_id), do: "", else: "/#{run_id}") <>
if(is_nil(action), do: "", else: "/#{action}")
end
@doc """
Creates a new run request with the given arguments.
## Arguments
- `args`: A list of key-value pairs, or a map, representing the fields of the run request.
## Returns
A map containing the fields of the run request.
The `:thread_id` and `:assistant_id` fields are required.
Example usage:
iex> _request = OpenaiEx.Beta.Threads.Runs.new(thread_id: "thread_foo", assistant_id: "assistant_bar")
%{assistant_id: "assistant_bar", thread_id: "thread_foo"}
"""
def new(args = [_ | _]) do
args |> Enum.into(%{}) |> new()
end
def new(args = %{thread_id: _}) do
args |> Map.take([:thread_id | @api_fields])
end
@doc """
Calls the run create endpoint.
## Arguments
- `openai`: The OpenAI configuration.
- `run`: The run request, as a map with keys corresponding to the API fields.
## Returns
A map containing the API response.
See https://platform.openai.com/docs/api-reference/runs/createRun for more information.
"""
def create!(openai = %OpenaiEx{}, run = %{thread_id: _, assistant_id: _}, stream: true) do
openai |> create(run, stream: true) |> Http.bang_it!()
end
def create(openai = %OpenaiEx{}, run = %{thread_id: thread_id, assistant_id: _}, stream: true) do
json = run |> Map.take(@api_fields) |> Map.put(:stream, true)
openai |> OpenaiEx.with_assistants_beta() |> HttpSse.post(ep_url(thread_id), json: json)
end
def create!(openai = %OpenaiEx{}, run = %{thread_id: _, assistant_id: _}) do
openai |> create(run) |> Http.bang_it!()
end
def create(openai = %OpenaiEx{}, run = %{thread_id: thread_id, assistant_id: _}) do
json = run |> Map.take(@api_fields)
openai |> OpenaiEx.with_assistants_beta() |> Http.post(ep_url(thread_id), json: json)
end
@doc """
Calls the run retrieve endpoint.
## Arguments
- `openai`: The OpenAI configuration.
- `params`: Specification of the run to retrieve.
## Returns
A map containing the fields of the run retrieve response.
https://platform.openai.com/docs/api-reference/runs/getRun
"""
def retrieve!(openai = %OpenaiEx{}, params = %{thread_id: _, run_id: _}) do
openai |> retrieve(params) |> Http.bang_it!()
end
def retrieve(openai = %OpenaiEx{}, %{thread_id: thread_id, run_id: run_id}) do
openai |> OpenaiEx.with_assistants_beta() |> Http.get(ep_url(thread_id, run_id))
end
@doc """
Calls the run update endpoint.
## Arguments
- `openai`: The OpenAI configuration.
- `params`: run to update and new field values.
## Returns
A map containing the API response.
See https://platform.openai.com/docs/api-reference/assistants/modifyAssistant for more information.
"""
def update!(openai = %OpenaiEx{}, params = %{thread_id: _, run_id: _, metadata: _}) do
openai |> update(params) |> Http.bang_it!()
end
def update(openai = %OpenaiEx{}, %{thread_id: thread_id, run_id: run_id, metadata: metadata}) do
json = %{metadata: metadata}
openai |> OpenaiEx.with_assistants_beta() |> Http.post(ep_url(thread_id, run_id), json: json)
end
@doc """
Creates a new list runs request with the given arguments.
## Arguments
- `args`: A list of key-value pairs, or a map, representing the fields of the list runs request.
## Returns
A map containing the fields of the list runs request.
"""
def new_list(args = [_ | _]) do
args |> Enum.into(%{}) |> new_list()
end
def new_list(args = %{}) do
args
|> Map.take(OpenaiEx.list_query_fields())
end
@doc """
Returns a list of runs objects.
https://platform.openai.com/docs/api-reference/runs/listRuns
"""
def list!(openai = %OpenaiEx{}, thread_id, params = %{} \\ %{}) do
openai |> list(thread_id, params) |> Http.bang_it!()
end
def list(openai = %OpenaiEx{}, thread_id, params = %{} \\ %{}) do
qry_params = params |> Map.take(OpenaiEx.list_query_fields())
openai |> OpenaiEx.with_assistants_beta() |> Http.get(ep_url(thread_id), qry_params)
end
def submit_tool_outputs!(
openai = %OpenaiEx{},
params = %{thread_id: _, run_id: _, tool_outputs: _},
stream: true
) do
openai |> submit_tool_outputs(params, stream: true) |> Http.bang_it!()
end
def submit_tool_outputs(
openai = %OpenaiEx{},
%{thread_id: thread_id, run_id: run_id, tool_outputs: tool_outputs},
stream: true
) do
openai
|> OpenaiEx.with_assistants_beta()
|> HttpSse.post(
ep_url(thread_id, run_id, "submit_tool_outputs"),
json: %{tool_outputs: tool_outputs} |> Map.put(:stream, true)
)
end
def submit_tool_outputs!(
openai = %OpenaiEx{},
params = %{thread_id: _, run_id: _, tool_outputs: _}
) do
openai |> submit_tool_outputs(params) |> Http.bang_it!()
end
def submit_tool_outputs(
openai = %OpenaiEx{},
%{thread_id: thread_id, run_id: run_id, tool_outputs: tool_outputs}
) do
openai
|> OpenaiEx.with_assistants_beta()
|> Http.post(
ep_url(thread_id, run_id, "submit_tool_outputs"),
json: %{tool_outputs: tool_outputs}
)
end
def cancel!(openai = %OpenaiEx{}, params = %{thread_id: _, run_id: _}) do
openai |> cancel(params) |> Http.bang_it!()
end
def cancel(openai = %OpenaiEx{}, %{thread_id: thread_id, run_id: run_id}) do
openai |> OpenaiEx.with_assistants_beta() |> Http.post(ep_url(thread_id, run_id, "cancel"))
end
@car_fields [
:assistant_id,
:thread,
:model,
:instructions,
:tools,
:tool_resources,
:metadata,
:temperature,
:top_p,
:max_prompt_tokens,
:max_completion_tokens,
:truncation_strategy,
:tool_choice,
:response_format
]
def create_and_run!(openai = %OpenaiEx{}, params = %{assistant_id: _}, stream: true) do
openai |> create_and_run(params, stream: true) |> Http.bang_it!()
end
def create_and_run(openai = %OpenaiEx{}, params = %{assistant_id: _}, stream: true) do
openai
|> OpenaiEx.with_assistants_beta()
|> HttpSse.post(@ep_url,
json: params |> Map.take(@car_fields) |> Map.put(:stream, true)
)
end
def create_and_run!(openai = %OpenaiEx{}, params = %{assistant_id: _}) do
openai |> create_and_run(params) |> Http.bang_it!()
end
def create_and_run(openai = %OpenaiEx{}, params = %{assistant_id: _}) do
openai
|> OpenaiEx.with_assistants_beta()
|> Http.post(@ep_url, json: params |> Map.take(@car_fields))
end
end