OpenaiEx.Containers (openai_ex v0.9.18)

View Source

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

Summary

Functions

create(openai, request)
create!(openai, request)

Creates a new container.

delete(openai, container_id)
delete!(openai, container_id)

Deletes a container.

list(openai, params \\ %{})
list!(openai, params \\ %{})

Lists all containers that belong to the user's organization.

new(args)

Creates a new container request with the given arguments.

retrieve(openai, container_id)
retrieve!(openai, container_id)

Retrieves a specific container by ID.

Functions

create(openai, request)

create!(openai, request)

Creates a new container.

See https://platform.openai.com/docs/api-reference/containers/createContainers

delete(openai, container_id)

delete!(openai, container_id)

Deletes a container.

See https://platform.openai.com/docs/api-reference/containers/deleteContainer

list(openai, params \\ %{})

list!(openai, params \\ %{})

Lists all containers that belong to the user's organization.

See https://platform.openai.com/docs/api-reference/containers/listContainers

new(args)

Creates a new container request with the given arguments.

Examples

iex> OpenaiEx.Containers.new(name: "My Container")
%{name: "My Container"}

iex> OpenaiEx.Containers.new(name: "Test Container", expires_after: %{anchor: "last_active_at", minutes: 30})
%{name: "Test Container", expires_after: %{anchor: "last_active_at", minutes: 30}}

iex> OpenaiEx.Containers.new(name: "File Container", file_ids: ["file-123", "file-456"])
%{name: "File Container", file_ids: ["file-123", "file-456"]}

retrieve(openai, container_id)

retrieve!(openai, container_id)

Retrieves a specific container by ID.

See https://platform.openai.com/docs/api-reference/containers/retrieveContainer