OpenaiEx.Chat.Completions (openai_ex v0.9.4)

View Source

This module provides an implementation of the OpenAI chat completions API. The API reference can be found at https://platform.openai.com/docs/api-reference/chat/completions.

Summary

Functions

create(openai, chat_completion)
create(openai, chat_completion, list)
create!(openai, chat_completion)
create!(openai, chat_completion, list)

Calls the chat completion 'create' endpoint.

delete(openai, list)
delete!(openai, list)

Deletes a stored chat completion.

list(openai, opts \\ [])
list!(openai, opts \\ [])

Lists stored Chat Completions.

messages_list(openai, completion_id, opts \\ [])
messages_list!(openai, completion_id, opts \\ [])

Lists messages from a stored chat completion.

new(args)

Creates a new chat completion request

retrieve(openai, list)
retrieve!(openai, list)

Retrieves a stored chat completion by ID.

update(openai, list)
update!(openai, list)

Updates a stored chat completion.

Functions

create(openai, chat_completion)

create(openai, chat_completion, list)

create!(openai, chat_completion)

create!(openai, chat_completion, list)

Calls the chat completion 'create' endpoint.

See https://platform.openai.com/docs/api-reference/chat/completions/create for more information.

delete(openai, list)

delete!(openai, list)

Deletes a stored chat completion.

See https://platform.openai.com/docs/api-reference/chat/delete

list(openai, opts \\ [])

list!(openai, opts \\ [])

Lists stored Chat Completions.

See https://platform.openai.com/docs/api-reference/chat/list

messages_list(openai, completion_id, opts \\ [])

messages_list!(openai, completion_id, opts \\ [])

Lists messages from a stored chat completion.

See https://platform.openai.com/docs/api-reference/chat/getMessages

new(args)

Creates a new chat completion request

Example usage:

iex> _request = OpenaiEx.Chat.Completions.new(model: "davinci", messages: [OpenaiEx.ChatMessage.user("Hello, world!")])
%{messages: [%{content: "Hello, world!", role: "user"}], model: "davinci"}

iex> _request = OpenaiEx.Chat.Completions.new(%{model: "davinci", messages: [OpenaiEx.ChatMessage.user("Hello, world!")]})
%{messages: [%{content: "Hello, world!", role: "user"}], model: "davinci"}

retrieve(openai, list)

retrieve!(openai, list)

Retrieves a stored chat completion by ID.

See https://platform.openai.com/docs/api-reference/chat/get

update(openai, list)

update!(openai, list)

Updates a stored chat completion.

See https://platform.openai.com/docs/api-reference/chat/update