genai.openai {GenAI}

OpenAI Object Creation

Description

This function establishes a connection to an OpenAI model by providing essential parameters.

Usage

genai.openai(api, model, version, proxy = FALSE, organization.id = NULL)

Arguments

api

A character string representing the API key required for accessing the model.

model

A character string representing the specific model.

version

A character string representing the version of the chosen model.

proxy

Optional. Default to FALSE. A boolean value indicating whether to use a proxy for accessing the API URL. If your local internet cannot access the API, set this parameter to TRUE.

organization.id

Optional. Default to NULL. A character string representing the organization ID.

Details

Providing accurate and valid information for each argument is crucial for successful text generation by the generative AI model. If any parameter is incorrect, the function responds with an error message based on the API feedback. To view all supported generative AI models, use the function available.models.

Please refer to https://platform.openai.com/api-keys for the API key. Moreover, please refer to https://platform.openai.com/account/organization for the optional organization ID.

The API proxy service is designed to address the needs of users who hold a valid API key but find themselves outside their home countries or regions due to reasons such as travel, work, or study in locations that may not be covered by certain Generative AI service providers.

Please be aware that although GenAI and its affiliated organization - GitData - do not gather user information through this service, the server providers for GenAI API proxy service and the Generative AI service providers may engage in such data collection. Furthermore, the proxy service cannot guarantee a consistent connection speed. Users are strongly encouraged to utilize this service with caution and at their own discretion.

Value

If successful, the function returns an OpenAI object. If the API response indicates an error, the function halts execution and provides an error message.

See Also

GenAI - R Package "GenAI" Documentation

GenAI - Generative Artificial Intelligence API Proxy Service

Live Demo in Colab

Examples

## Not run: 
# Please change YOUR_OPENAI_API to your own API key of OpenAI
Sys.setenv(OPENAI_API = "YOUR_OPENAI_API")

# Oprional. Please change YOUR_OPENAI_ORG to your own organization ID for OpenAI
Sys.setenv(OPENAI_ORG = "YOUR_OPENAI_ORG")

all.models = available.models() %>% print()

# Create an OpenAI object
openai = genai.openai(api = Sys.getenv("OPENAI_API"),
                      model = all.models$openai$model[1],
                      version = all.models$openai$version[1],
                      proxy = FALSE,
                      organization.id = Sys.getenv("OPENAI_ORG"))

## End(Not run)