Class: OpenAI::Client

Inherits:
Object
  • Object
show all
Extended by:
HTTP
Defined in:
lib/openai/client.rb

Instance Method Summary collapse

Methods included from HTTP

delete, get, json_post, multipart_post

Constructor Details

#initialize(access_token: nil, organization_id: nil, uri_base: nil, request_timeout: nil) ⇒ Client

Returns a new instance of Client.



5
6
7
8
9
10
 
# File 'lib/openai/client.rb', line 5

def initialize(access_token: nil, organization_id: nil, uri_base: nil, request_timeout: nil)
  OpenAI.configuration.access_token = access_token if access_token
  OpenAI.configuration.organization_id = organization_id if organization_id
  OpenAI.configuration.uri_base = uri_base if uri_base
  OpenAI.configuration.request_timeout = request_timeout if request_timeout
end

Instance Method Details

#chat(parameters: {}) ⇒ Object 



12
13
14
 
# File 'lib/openai/client.rb', line 12

def chat(parameters: {})
  OpenAI::Client.json_post(path: "/chat/completions", parameters: parameters)
end

#completions(parameters: {}) ⇒ Object 



16
17
18
 
# File 'lib/openai/client.rb', line 16

def completions(parameters: {})
  OpenAI::Client.json_post(path: "/completions", parameters: parameters)
end

#edits(parameters: {}) ⇒ Object 



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

def edits(parameters: {})
  OpenAI::Client.json_post(path: "/edits", parameters: parameters)
end

#embeddings(parameters: {}) ⇒ Object 



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

def embeddings(parameters: {})
  OpenAI::Client.json_post(path: "/embeddings", parameters: parameters)
end

#files ⇒ Object 



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

def files
  @files ||= OpenAI::Files.new
end

#finetunes ⇒ Object 



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

def finetunes
  @finetunes ||= OpenAI::Finetunes.new
end

#images ⇒ Object 



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

def images
  @images ||= OpenAI::Images.new
end

#models ⇒ Object 



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

def models
  @models ||= OpenAI::Models.new
end

#moderations(parameters: {}) ⇒ Object 



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

def moderations(parameters: {})
  OpenAI::Client.json_post(path: "/moderations", parameters: parameters)
end

#transcribe(parameters: {}) ⇒ Object 



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

def transcribe(parameters: {})
  OpenAI::Client.multipart_post(path: "/audio/transcriptions", parameters: parameters)
end

#translate(parameters: {}) ⇒ Object 



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

def translate(parameters: {})
  OpenAI::Client.multipart_post(path: "/audio/translations", parameters: parameters)
end