class

OpenAI::CreateChatSessionBody

Inherits JSON::Serializable < Reference < Object

Parameters for provisioning a new ChatKit session.

Constructors

new(pull : JSON::PullParser)
Source
new(workflow : WorkflowParam = WorkflowParam.new, user : String = "", expires_after : ExpiresAfterParam | Nil = nil, rate_limits : RateLimitsParam | Nil = nil, chatkit_configuration : ChatkitConfigurationParam | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

chatkit_configuration

Optional overrides for ChatKit runtime configuration features

Source
chatkit_configuration=(chatkit_configuration : ChatkitConfigurationParam | Nil)

Optional overrides for ChatKit runtime configuration features

Source
expires_after

Optional override for session expiration timing in seconds from creation. Defaults to 10 minutes.

Source
expires_after=(expires_after : ExpiresAfterParam | Nil)

Optional override for session expiration timing in seconds from creation. Defaults to 10 minutes.

Source
rate_limits

Optional override for per-minute request limits. When omitted, defaults to 10.

Source
rate_limits=(rate_limits : RateLimitsParam | Nil)

Optional override for per-minute request limits. When omitted, defaults to 10.

Source
user

A free-form string that identifies your end user; ensures this Session can access other objects that have the same user scope.

Source
user=(user : String)

A free-form string that identifies your end user; ensures this Session can access other objects that have the same user scope.

Source
validate!
Source
workflow

Workflow that powers the session.

Source
workflow=(workflow : WorkflowParam)

Workflow that powers the session.

Source