Class: OpenAI::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/openai.rb

Constant Summary collapse

DEFAULT_API_VERSION =
"v1".freeze
DEFAULT_URI_BASE =
"https://api.openai.com/".freeze
DEFAULT_REQUEST_TIMEOUT =
120

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfiguration

Returns a new instance of Configuration.



24
25
26
27
28
29
30
# File 'lib/openai.rb', line 24

def initialize
  @access_token = nil
  @api_version = DEFAULT_API_VERSION
  @organization_id = nil
  @uri_base = DEFAULT_URI_BASE
  @request_timeout = DEFAULT_REQUEST_TIMEOUT
end

Instance Attribute Details

#access_tokenObject

Raises:



32
33
34
35
36
37
# File 'lib/openai.rb', line 32

def access_token
  return @access_token if @access_token

  error_text = "OpenAI access token missing! See https://github.com/alexrudall/ruby-openai#usage"
  raise ConfigurationError, error_text
end

#api_versionObject

Returns the value of attribute api_version.



18
19
20
# File 'lib/openai.rb', line 18

def api_version
  @api_version
end

#organization_idObject

Returns the value of attribute organization_id.



18
19
20
# File 'lib/openai.rb', line 18

def organization_id
  @organization_id
end

#request_timeoutObject

Returns the value of attribute request_timeout.



18
19
20
# File 'lib/openai.rb', line 18

def request_timeout
  @request_timeout
end

#uri_baseObject

Returns the value of attribute uri_base.



18
19
20
# File 'lib/openai.rb', line 18

def uri_base
  @uri_base
end