Skip to contents

Retrieve engine

Source: R/retrieve_engine.R
retrieve_engine.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 retrieve_model().

Provides information about a specified engine. See this page for details.

Usage

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

Arguments

engine_id

required; a length one character vector.

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, elements of which contain information about the engine.

Details

For arguments description please refer to the official documentation.

See also

Other engine functions: list_engines()

Examples

if (FALSE) { # \dontrun{
retrieve_engine("text-davinci-002")
# ->
retrieve_model("text-davinci-002")
} # }