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

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Sessions

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 Sessions.

Parameters:



73
74
75
 
# File 'lib/openai/resources/beta/chatkit/sessions.rb', line 73

def initialize(client:)
  @client = client
end

Instance Method Details

#cancel(session_id, request_options: {}) ⇒ OpenAI::Models::Beta::ChatKit::ChatSession

Cancel an active ChatKit session and return its most recent metadata.

Cancelling prevents new requests from using the issued client secret.

Parameters:

  • session_id (String) —

    Unique identifier for the ChatKit session to cancel.

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

Returns:

See Also:



60
61
62
63
64
65
66
67
68
 
# File 'lib/openai/resources/beta/chatkit/sessions.rb', line 60

def cancel(session_id, params = {})
  @client.request(
    method: :post,
    path: ["chatkit/sessions/%1$s/cancel", session_id],
    model: OpenAI::Beta::ChatKit::ChatSession,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "chatkit_beta=v1"}, **params[:request_options].to_h}
  )
end

#create(user:, workflow:, chatkit_configuration: nil, expires_after: nil, rate_limits: nil, request_options: {}) ⇒ OpenAI::Models::Beta::ChatKit::ChatSession

Create a ChatKit session.

Parameters:

Returns:

See Also:



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/openai/resources/beta/chatkit/sessions.rb', line 34

def create(params)
  parsed, options = OpenAI::Beta::ChatKit::SessionCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "chatkit/sessions",
    body: parsed,
    model: OpenAI::Beta::ChatKit::ChatSession,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "chatkit_beta=v1"}, **options}
  )
end