View Source OpenaiEx.Beta.Assistant.File (openai_ex v0.5.4)

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

API Fields

The following fields can be used as parameters for the assistant files API:

  • :assistant_id
  • :file_id

Summary

Functions

Calls the assistant file create endpoint.

Calls the assistant file delete endpoint.

Creates a new assistant file request with the given arguments.

Lists the files that belong to the specified assistant.

Calls the assistant file retrieve endpoint.

Functions

Calls the assistant file create endpoint.

Arguments

  • openai: The OpenAI configuration.
  • params: A map containing the fields of the assistant file create request.

Returns

A map containing the fields of the created assistant file object.

https://platform.openai.com/docs/api-reference/assistants/createAssistantFile

Calls the assistant file delete endpoint.

Arguments

  • openai: The OpenAI configuration.
  • params: A map containing the fields of the assistant file delete request.

Returns

A map containing the fields of the assistant file delete response.

https://platform.openai.com/docs/api-reference/assistants/deleteAssistantFile

Creates a new assistant file request with the given arguments.

Arguments

  • args: A list of key-value pairs, or a map, representing the fields of the assistant file request.

Returns

A map containing the fields of the assistant file request.

Lists the files that belong to the specified assistant.

https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles

Link to this function

retrieve(openai, params)

View Source

Calls the assistant file retrieve endpoint.

Arguments

  • openai: The OpenAI configuration.
  • params: A map containing the fields of the assistant file retrieve request.

Returns

A map containing the fields of the specificied assistant file object.

https://platform.openai.com/docs/api-reference/assistants/getAssistantFile