models

The models module facilitates the retrieval, listing, and deletion of models on the OpenAI platform and supports both synchronous and asynchronous operations.

The module enables developers to interact with models, providing functionalities like fetching detailed information about a specific model, listing all available models, and deleting fine-tuned models.

Classes:

Name	Description
AsyncModels
AsyncModelsWithRawResponse
AsyncModelsWithStreamingResponse
Models
ModelsWithRawResponse
ModelsWithStreamingResponse

AsyncModels

AsyncModels(client: AsyncOpenAI)

Methods:

Name	Description
delete	Delete a fine-tuned model.
list	Lists the currently available models, and provides basic information about each
retrieve	Retrieves a model instance, providing basic information about the model such as
with_raw_response
with_streaming_response

delete async

delete(
    model: str,
    *,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | Timeout | None | NotGiven = NOT_GIVEN
) -> ModelDeleted

Delete a fine-tuned model.

You must have the Owner role in your organization to delete a model.

Parameters:

Name	Type	Description	Default
extra_headers	Headers | None	Send extra headers	None
extra_query	Query | None	Add additional query parameters to the request	None
extra_body	Body | None	Add additional JSON properties to the request	None
timeout	float | Timeout | None | NotGiven	Override the client-level default timeout for this request, in seconds	NOT_GIVEN

list

list(
    *,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | Timeout | None | NotGiven = NOT_GIVEN
) -> AsyncPaginator[Model, AsyncPage[Model]]

Lists the currently available models, and provides basic information about each one such as the owner and availability.

retrieve async

retrieve(
    model: str,
    *,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | Timeout | None | NotGiven = NOT_GIVEN
) -> Model

Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

Parameters:

Name	Type	Description	Default
extra_headers	Headers | None	Send extra headers	None
extra_query	Query | None	Add additional query parameters to the request	None
extra_body	Body | None	Add additional JSON properties to the request	None
timeout	float | Timeout | None | NotGiven	Override the client-level default timeout for this request, in seconds	NOT_GIVEN

with_raw_response

with_raw_response() -> AsyncModelsWithRawResponse

with_streaming_response

with_streaming_response() -> (
    AsyncModelsWithStreamingResponse
)

AsyncModelsWithRawResponse

AsyncModelsWithRawResponse(models: AsyncModels)

Attributes:

Name	Type	Description
delete
list
retrieve

delete instance-attribute

delete = async_to_raw_response_wrapper(delete)

list instance-attribute

list = async_to_raw_response_wrapper(list)

retrieve instance-attribute

retrieve = async_to_raw_response_wrapper(retrieve)

AsyncModelsWithStreamingResponse

AsyncModelsWithStreamingResponse(models: AsyncModels)

Attributes:

Name	Type	Description
delete
list
retrieve

delete instance-attribute

delete = async_to_streamed_response_wrapper(delete)

list instance-attribute

list = async_to_streamed_response_wrapper(list)

retrieve instance-attribute

retrieve = async_to_streamed_response_wrapper(retrieve)

Models

Models(client: OpenAI)

Methods:

Name	Description
delete	Delete a fine-tuned model.
list	Lists the currently available models, and provides basic information about each
retrieve	Retrieves a model instance, providing basic information about the model such as
with_raw_response
with_streaming_response

delete

delete(
    model: str,
    *,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | Timeout | None | NotGiven = NOT_GIVEN
) -> ModelDeleted

Delete a fine-tuned model.

You must have the Owner role in your organization to delete a model.

Parameters:

Name	Type	Description	Default
extra_headers	Headers | None	Send extra headers	None
extra_query	Query | None	Add additional query parameters to the request	None
extra_body	Body | None	Add additional JSON properties to the request	None
timeout	float | Timeout | None | NotGiven	Override the client-level default timeout for this request, in seconds	NOT_GIVEN

list

list(
    *,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | Timeout | None | NotGiven = NOT_GIVEN
) -> SyncPage[Model]

Lists the currently available models, and provides basic information about each one such as the owner and availability.

retrieve

retrieve(
    model: str,
    *,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | Timeout | None | NotGiven = NOT_GIVEN
) -> Model

Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

Parameters:

Name	Type	Description	Default
extra_headers	Headers | None	Send extra headers	None
extra_query	Query | None	Add additional query parameters to the request	None
extra_body	Body | None	Add additional JSON properties to the request	None
timeout	float | Timeout | None | NotGiven	Override the client-level default timeout for this request, in seconds	NOT_GIVEN

with_raw_response

with_raw_response() -> ModelsWithRawResponse

with_streaming_response

with_streaming_response() -> ModelsWithStreamingResponse

ModelsWithRawResponse

ModelsWithRawResponse(models: Models)

Attributes:

Name	Type	Description
delete
list
retrieve

delete instance-attribute

delete = to_raw_response_wrapper(delete)

list instance-attribute

list = to_raw_response_wrapper(list)

retrieve instance-attribute

retrieve = to_raw_response_wrapper(retrieve)

ModelsWithStreamingResponse

ModelsWithStreamingResponse(models: Models)

Attributes:

Name	Type	Description
delete
list
retrieve

delete instance-attribute

delete = to_streamed_response_wrapper(delete)

list instance-attribute

list = to_streamed_response_wrapper(list)

retrieve instance-attribute

retrieve = to_streamed_response_wrapper(retrieve)