OpenaiEx.Beta.Threads.Runs (openai_ex v0.9.4)

View Source

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.

Summary

Functions

cancel(openai, map)
cancel!(openai, params)
create(openai, run)
create(openai, run, list)
create!(openai, run)
create!(openai, run, list)

Calls the run create endpoint.

create_and_run(openai, params)
create_and_run(openai, params, list)
create_and_run!(openai, params)
create_and_run!(openai, params, list)
list(openai, opts)
list!(openai, opts)

Returns a list of runs objects.

new(args)

Creates a new run request

new_list(args)

Creates a new list runs request

retrieve(openai, map)
retrieve!(openai, params)

Calls the run retrieve endpoint.

submit_tool_outputs(openai, map)
submit_tool_outputs(openai, map, list)
submit_tool_outputs!(openai, params)
submit_tool_outputs!(openai, params, list)
update(openai, map)
update!(openai, params)

Calls the run update endpoint.

Functions

cancel(openai, map)

cancel!(openai, params)

create(openai, run)

create(openai, run, list)

create!(openai, run)

create!(openai, run, list)

Calls the run create endpoint.

See https://platform.openai.com/docs/api-reference/runs/createRun for more information.

create_and_run(openai, params)

create_and_run(openai, params, list)

create_and_run!(openai, params)

create_and_run!(openai, params, list)

list(openai, opts)

list!(openai, opts)

Returns a list of runs objects.

https://platform.openai.com/docs/api-reference/runs/listRuns

new(args)

Creates a new run request

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"}

new_list(args)

Creates a new list runs request

retrieve(openai, map)

retrieve!(openai, params)

Calls the run retrieve endpoint.

https://platform.openai.com/docs/api-reference/runs/getRun

submit_tool_outputs(openai, map)

submit_tool_outputs(openai, map, list)

submit_tool_outputs!(openai, params)

submit_tool_outputs!(openai, params, list)

update(openai, map)

update!(openai, params)

Calls the run update endpoint.

See https://platform.openai.com/docs/api-reference/assistants/modifyAssistant for more information.