models: Models Class

In openaistream: Streaming Capabilities for 'OpenAI API' Interactions

Models Class

Description

Models Class

Models Class

Super class

openaistream::openai -> models

Methods

Public methods

• models$list()

• models$retrieve()

• models$delete()

• models$clone()

Inherited methods

• openaistream::openai$initialize()

---

Method list()

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

Usage

models$list(verbosity = 0)

Arguments

verbosity

numeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).

Returns

A list of model objects.

---

Method retrieve()

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

Usage

models$retrieve(model, verbosity = 0)

Arguments

model

character Required. The ID of the model to use for this request

verbosity

numeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).

Returns

The model object matching the specified ID.

---

Method delete()

Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.

Usage

models$delete(model, verbosity = 0)

Arguments

model

character Required. The model to delete

verbosity

numeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).

Returns

Deletion status.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

models$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

openaistream documentation built on June 22, 2024, 9:55 a.m.