Class: OpenAI::Resources::Beta::ChatKit

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/beta/chatkit.rb,
lib/openai/resources/beta/chatkit/threads.rb,
lib/openai/resources/beta/chatkit/sessions.rb

Defined Under Namespace

Classes: Sessions, Threads

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ChatKit

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ChatKit.

Parameters:



42
43
44
45
46
 
# File 'lib/openai/resources/beta/chatkit.rb', line 42

def initialize(client:)
  @client = client
  @sessions = OpenAI::Resources::Beta::ChatKit::Sessions.new(client: client)
  @threads = OpenAI::Resources::Beta::ChatKit::Threads.new(client: client)
end

Instance Attribute Details

#sessions ⇒ OpenAI::Resources::Beta::ChatKit::Sessions (readonly)

Returns:



8
9
10
 
# File 'lib/openai/resources/beta/chatkit.rb', line 8

def sessions
  @sessions
end

#threads ⇒ OpenAI::Resources::Beta::ChatKit::Threads (readonly)

Returns:



11
12
13
 
# File 'lib/openai/resources/beta/chatkit.rb', line 11

def threads
  @threads
end

Instance Method Details

#upload_file(file: , request_options: {}) ⇒ OpenAI::Models::Beta::FilePart, OpenAI::Models::Beta::ImagePart

Some parameter documentations has been truncated, see Models::Beta::ChatKitUploadFileParams for more details.

Upload a ChatKit file

Parameters:

  • file (Pathname, StringIO, IO, String, OpenAI::FilePart) —

    Binary file contents to store with the ChatKit session. Supports PDFs and PNG, J

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/openai/resources/beta/chatkit.rb', line 27

def upload_file(params)
  parsed, options = OpenAI::Beta::ChatKitUploadFileParams.dump_request(params)
  @client.request(
    method: :post,
    path: "chatkit/files",
    headers: {"content-type" => "multipart/form-data"},
    body: parsed,
    model: OpenAI::Models::Beta::ChatKitUploadFileResponse,
    options: {extra_headers: {"OpenAI-Beta" => "chatkit_beta=v1"}, **options}
  )
end