View Source OpenaiEx (openai_ex v0.8.6)

OpenaiEx is an Elixir library that provides a community-maintained client for the OpenAI API.

The library closely follows the structure of the official OpenAI API client libraries for Python making it easy to understand and reuse existing documentation and code.

Summary

Functions

new(token, organization \\ nil, project \\ nil)

Creates a new OpenaiEx struct with the specified token and organization.

new_file(list)

Create file parameter struct for use in multipart requests.

with_additional_headers(openai, additional_headers)

with_base_url(openai, base_url)

with_finch_name(openai, finch_name)

with_receive_timeout(openai, timeout)

with_stream_timeout(openai, timeout)

Functions

new(token, organization \\ nil, project \\ nil)

Creates a new OpenaiEx struct with the specified token and organization.

See https://platform.openai.com/docs/api-reference/authentication for details.

new_file(list)

Create file parameter struct for use in multipart requests.

OpenAI API has endpoints which need a file parameter, such as Files and Audio. This function creates a file parameter given a name (optional) and content or a local file path.