Skip to contents

List engines

Source: R/list_engines.R
list_engines.Rd

[Deprecated]

Note: This endpoint is deprecated and soon will be removed. Please use its replacement, Models, instead. The replacement function in this package is list_models().

Lists available engines and provides basic information about such engines. See this page for details.

Usage

list_engines(
  openai_api_key = Sys.getenv("OPENAI_API_KEY"),
  openai_organization = NULL
)

Arguments

openai_api_key

required; defaults to Sys.getenv("OPENAI_API_KEY") (i.e., the value is retrieved from the .Renviron file); a length one character vector. Specifies OpenAI API key.

openai_organization

optional; defaults to NULL; a length one character vector. Specifies OpenAI organization.

Value

Returns a list, an element of which is a data frame containing information about engines.

Details

For arguments description please refer to the official documentation.

See also

Other engine functions: retrieve_engine()

Examples

if (FALSE) {
list_engines()
# ->
list_models()
}