api_config: api_config Class

In openaistream: Streaming Capabilities for 'OpenAI API' Interactions

api_config Class

Description

api_config Class

api_config Class

Details

A R6 class to manage config.

Methods

Public methods

• api_config$new()

• api_config$set_api_key()

• api_config$set_proxy()

• api_config$get_proxy()

• api_config$get_api_key()

• api_config$get_api_endpoints()

• api_config$clone()

---

Method new()

Initialize the api_config object

Usage

api_config$new()

---

Method set_api_key()

Configure the api_key settings.

Usage

api_config$set_api_key(api_key)

Arguments

api_key

your openai_key

---

Method set_proxy()

Configure the proxy settings.

Usage

api_config$set_proxy(proxy_ip, proxy_port)

Arguments

proxy_ip

character Required. The IP address of the proxy.

proxy_port

character Required. The port number of the proxy.

---

Method get_proxy()

Configure the proxy gettings.

Usage

api_config$get_proxy()

---

Method get_api_key()

Api key gettings.

Usage

api_config$get_api_key()

---

Method get_api_endpoints()

Endpoints gettings.

Usage

api_config$get_api_endpoints()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

api_config$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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