OpenaiEx.Responses (openai_ex v0.9.22)

Copy Markdown View Source

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

Summary

Functions

cancel(openai, list)

cancel!(openai, list)

Cancels a background response.

Only responses created with background: true can be cancelled.

https://platform.openai.com/docs/api-reference/responses/cancel

compact(openai, params)

compact!(openai, params)

Compacts a response, carrying prior state forward in fewer tokens.

https://platform.openai.com/docs/api-reference/responses/compact

create(openai, params)

create(openai, params, list)

create!(openai, params)

create!(openai, params, list)

Creates a new response.

https://platform.openai.com/docs/api-reference/responses/create

delete(openai, list)

delete!(openai, list)

Deletes a response.

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

input_items_list(openai, opts)

input_items_list!(openai, opts)

Lists input items from a response. See https://platform.openai.com/docs/api-reference/responses/input-items

input_tokens(openai, params)

input_tokens!(openai, params)

Returns the input token counts for a hypothetical response.

https://platform.openai.com/docs/api-reference/responses/input_tokens

retrieve(openai, opts)

retrieve!(openai, opts)

Retrieves a response.

https://platform.openai.com/docs/api-reference/responses/retrieve