Class: OpenAI::Conversations

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Conversations

Returns a new instance of Conversations.



3
4
5
 
# File 'lib/openai/conversations.rb', line 3

def initialize(client:)
  @client = client
end

Instance Method Details

#create(parameters: {}) ⇒ Object 



11
12
13
 
# File 'lib/openai/conversations.rb', line 11

def create(parameters: {})
  @client.json_post(path: "/conversations", parameters: parameters)
end

#create_items(conversation_id:, parameters: {}) ⇒ Object

Item operations within a conversation



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

def create_items(conversation_id:, parameters: {})
  @client.json_post(path: "/conversations/#{conversation_id}/items", parameters: parameters)
end

#delete(id:) ⇒ Object 



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

def delete(id:)
  @client.delete(path: "/conversations/#{id}")
end

#delete_item(conversation_id:, item_id:) ⇒ Object 



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

def delete_item(conversation_id:, item_id:)
  @client.delete(path: "/conversations/#{conversation_id}/items/#{item_id}")
end

#get_item(conversation_id:, item_id:) ⇒ Object 



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

def get_item(conversation_id:, item_id:)
  @client.get(path: "/conversations/#{conversation_id}/items/#{item_id}")
end

#list_items(conversation_id:, parameters: {}) ⇒ Object 



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

def list_items(conversation_id:, parameters: {})
  @client.get(path: "/conversations/#{conversation_id}/items", parameters: parameters)
end

#modify(id:, parameters: {}) ⇒ Object 



15
16
17
 
# File 'lib/openai/conversations.rb', line 15

def modify(id:, parameters: {})
  @client.json_post(path: "/conversations/#{id}", parameters: parameters)
end

#retrieve(id:) ⇒ Object 



7
8
9
 
# File 'lib/openai/conversations.rb', line 7

def retrieve(id:)
  @client.get(path: "/conversations/#{id}")
end