Class: OpenAI::Client

Inherits:
Internal::Transport::BaseClient show all
Defined in:
lib/openai/client.rb

Constant Summary collapse

DEFAULT_MAX_RETRIES =

Default max number of retries to attempt after a failed retryable request.

2
DEFAULT_TIMEOUT_IN_SECONDS =

Default per-request timeout.

600.0
DEFAULT_INITIAL_RETRY_DELAY =

Default initial retry delay in seconds. Overall delay is calculated using exponential backoff + jitter.

0.5
DEFAULT_MAX_RETRY_DELAY =

Default max retry delay in seconds.

8.0

Constants inherited from Internal::Transport::BaseClient

Internal::Transport::BaseClient::MAX_REDIRECTS, Internal::Transport::BaseClient::PLATFORM_HEADERS

Instance Attribute Summary collapse

Attributes inherited from Internal::Transport::BaseClient

#base_url, #headers, #idempotency_header, #initial_retry_delay, #max_retries, #max_retry_delay, #requester, #timeout

Instance Method Summary collapse

Methods inherited from Internal::Transport::BaseClient

follow_redirect, #inspect, reap_connection!, #request, should_retry?, validate!

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(api_key: ENV["OPENAI_API_KEY"], organization: ENV["OPENAI_ORG_ID"], project: ENV["OPENAI_PROJECT_ID"], webhook_secret: ENV["OPENAI_WEBHOOK_SECRET"], base_url: ENV["OPENAI_BASE_URL"], max_retries: self.class::DEFAULT_MAX_RETRIES, timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS, initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY, max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY) ⇒ Client

Creates and returns a new client for interacting with the API.

"https://api.example.com/v2/". Defaults to ENV["OPENAI_BASE_URL"]

Parameters:

  • api_key (String, nil) (defaults to: ENV["OPENAI_API_KEY"]) —

    Defaults to ENV["OPENAI_API_KEY"]

  • organization (String, nil) (defaults to: ENV["OPENAI_ORG_ID"]) —

    Defaults to ENV["OPENAI_ORG_ID"]

  • project (String, nil) (defaults to: ENV["OPENAI_PROJECT_ID"]) —

    Defaults to ENV["OPENAI_PROJECT_ID"]

  • webhook_secret (String, nil) (defaults to: ENV["OPENAI_WEBHOOK_SECRET"]) —

    Defaults to ENV["OPENAI_WEBHOOK_SECRET"]

  • base_url (String, nil) (defaults to: ENV["OPENAI_BASE_URL"]) —

    Override the default base URL for the API, e.g.,

  • max_retries (Integer) (defaults to: self.class::DEFAULT_MAX_RETRIES) —

    Max number of retries to attempt after a failed retryable request.

  • timeout (Float) (defaults to: self.class::DEFAULT_TIMEOUT_IN_SECONDS)
  • initial_retry_delay (Float) (defaults to: self.class::DEFAULT_INITIAL_RETRY_DELAY)
  • max_retry_delay (Float) (defaults to: self.class::DEFAULT_MAX_RETRY_DELAY) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/openai/client.rb', line 113

def initialize(
  api_key: ENV["OPENAI_API_KEY"],
  organization: ENV["OPENAI_ORG_ID"],
  project: ENV["OPENAI_PROJECT_ID"],
  webhook_secret: ENV["OPENAI_WEBHOOK_SECRET"],
  base_url: ENV["OPENAI_BASE_URL"],
  max_retries: self.class::DEFAULT_MAX_RETRIES,
  timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
  initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
  max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
)
  base_url ||= "https://api.openai.com/v1"

  if api_key.nil?
    raise ArgumentError.new("api_key is required, and can be set via environ: \"OPENAI_API_KEY\"")
  end

  headers = {
    "openai-organization" => (@organization = organization&.to_s),
    "openai-project" => (@project = project&.to_s)
  }

  @api_key = api_key.to_s
  @webhook_secret = webhook_secret&.to_s

  super(
    base_url: base_url,
    timeout: timeout,
    max_retries: max_retries,
    initial_retry_delay: initial_retry_delay,
    max_retry_delay: max_retry_delay,
    headers: headers
  )

  @completions = OpenAI::Resources::Completions.new(client: self)
  @chat = OpenAI::Resources::Chat.new(client: self)
  @embeddings = OpenAI::Resources::Embeddings.new(client: self)
  @files = OpenAI::Resources::Files.new(client: self)
  @images = OpenAI::Resources::Images.new(client: self)
  @audio = OpenAI::Resources::Audio.new(client: self)
  @moderations = OpenAI::Resources::Moderations.new(client: self)
  @models = OpenAI::Resources::Models.new(client: self)
  @fine_tuning = OpenAI::Resources::FineTuning.new(client: self)
  @graders = OpenAI::Resources::Graders.new(client: self)
  @vector_stores = OpenAI::Resources::VectorStores.new(client: self)
  @webhooks = OpenAI::Resources::Webhooks.new(client: self)
  @beta = OpenAI::Resources::Beta.new(client: self)
  @batches = OpenAI::Resources::Batches.new(client: self)
  @uploads = OpenAI::Resources::Uploads.new(client: self)
  @responses = OpenAI::Resources::Responses.new(client: self)
  @evals = OpenAI::Resources::Evals.new(client: self)
  @containers = OpenAI::Resources::Containers.new(client: self)
end

Instance Attribute Details

#api_key ⇒ String (readonly)

Returns:

  • (String) 


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

def api_key
  @api_key
end

#audio ⇒ OpenAI::Resources::Audio (readonly)

Returns:



46
47
48
 
# File 'lib/openai/client.rb', line 46

def audio
  @audio
end

#batches ⇒ OpenAI::Resources::Batches (readonly)

Returns:



70
71
72
 
# File 'lib/openai/client.rb', line 70

def batches
  @batches
end

#beta ⇒ OpenAI::Resources::Beta (readonly)

Returns:



67
68
69
 
# File 'lib/openai/client.rb', line 67

def beta
  @beta
end

#chat ⇒ OpenAI::Resources::Chat (readonly)

Returns:



34
35
36
 
# File 'lib/openai/client.rb', line 34

def chat
  @chat
end

#completions ⇒ OpenAI::Resources::Completions (readonly)

Returns:



31
32
33
 
# File 'lib/openai/client.rb', line 31

def completions
  @completions
end

#containers ⇒ OpenAI::Resources::Containers (readonly)

Returns:



82
83
84
 
# File 'lib/openai/client.rb', line 82

def containers
  @containers
end

#embeddings ⇒ OpenAI::Resources::Embeddings (readonly)

Returns:



37
38
39
 
# File 'lib/openai/client.rb', line 37

def embeddings
  @embeddings
end

#evals ⇒ OpenAI::Resources::Evals (readonly)

Returns:



79
80
81
 
# File 'lib/openai/client.rb', line 79

def evals
  @evals
end

#files ⇒ OpenAI::Resources::Files (readonly)

Returns:



40
41
42
 
# File 'lib/openai/client.rb', line 40

def files
  @files
end

#fine_tuning ⇒ OpenAI::Resources::FineTuning (readonly)

Returns:



55
56
57
 
# File 'lib/openai/client.rb', line 55

def fine_tuning
  @fine_tuning
end

#graders ⇒ OpenAI::Resources::Graders (readonly)

Returns:



58
59
60
 
# File 'lib/openai/client.rb', line 58

def graders
  @graders
end

#images ⇒ OpenAI::Resources::Images (readonly)

Returns:



43
44
45
 
# File 'lib/openai/client.rb', line 43

def images
  @images
end

#models ⇒ OpenAI::Resources::Models (readonly)

Returns:



52
53
54
 
# File 'lib/openai/client.rb', line 52

def models
  @models
end

#moderations ⇒ OpenAI::Resources::Moderations (readonly)

Returns:



49
50
51
 
# File 'lib/openai/client.rb', line 49

def moderations
  @moderations
end

#organization ⇒ String? (readonly)

Returns:

  • (String, nil) 


22
23
24
 
# File 'lib/openai/client.rb', line 22

def organization
  @organization
end

#project ⇒ String? (readonly)

Returns:

  • (String, nil) 


25
26
27
 
# File 'lib/openai/client.rb', line 25

def project
  @project
end

#responses ⇒ OpenAI::Resources::Responses (readonly)

Returns:



76
77
78
 
# File 'lib/openai/client.rb', line 76

def responses
  @responses
end

#uploads ⇒ OpenAI::Resources::Uploads (readonly)

Returns:



73
74
75
 
# File 'lib/openai/client.rb', line 73

def uploads
  @uploads
end

#vector_stores ⇒ OpenAI::Resources::VectorStores (readonly)

Returns:



61
62
63
 
# File 'lib/openai/client.rb', line 61

def vector_stores
  @vector_stores
end

#webhook_secret ⇒ String? (readonly)

Returns:

  • (String, nil) 


28
29
30
 
# File 'lib/openai/client.rb', line 28

def webhook_secret
  @webhook_secret
end

#webhooks ⇒ OpenAI::Resources::Webhooks (readonly)

Returns:



64
65
66
 
# File 'lib/openai/client.rb', line 64

def webhooks
  @webhooks
end