class

OpenAI::ChatSessionResource

Inherits JSON::Serializable < Reference < Object

Represents a ChatKit session and its resolved configuration.

Constructors

new(pull : JSON::PullParser)

new(id : String = "", object : ChatSessionResourceObject = ChatSessionResourceObject::ChatkitSession, expires_at : Int64 = 0, client_secret : String = "", workflow : ChatkitWorkflow = ChatkitWorkflow.new, user : String = "", rate_limits : ChatSessionRateLimits = ChatSessionRateLimits.new, max_requests_per_1_minute : Int64 = 0, status : ChatSessionStatus = ChatSessionStatus::Active, chatkit_configuration : ChatSessionChatkitConfiguration = ChatSessionChatkitConfiguration.new)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

chatkit_configuration

Resolved ChatKit feature configuration for the session.

chatkit_configuration=(chatkit_configuration : ChatSessionChatkitConfiguration)

Resolved ChatKit feature configuration for the session.

client_secret

Ephemeral client secret that authenticates session requests.

client_secret=(client_secret : String)

Ephemeral client secret that authenticates session requests.

expires_at

Unix timestamp (in seconds) for when the session expires.

expires_at=(expires_at : Int64)

Unix timestamp (in seconds) for when the session expires.

id

Identifier for the ChatKit session.

id=(id : String)

Identifier for the ChatKit session.

max_requests_per_1_minute

Convenience copy of the per-minute request limit.

max_requests_per_1_minute=(max_requests_per_1_minute : Int64)

Convenience copy of the per-minute request limit.

object

Type discriminator that is always chatkit.session.

object=(object : ChatSessionResourceObject)

Type discriminator that is always chatkit.session.

rate_limits

Resolved rate limit values.

rate_limits=(rate_limits : ChatSessionRateLimits)

Resolved rate limit values.

status

Current lifecycle state of the session.

status=(status : ChatSessionStatus)

Current lifecycle state of the session.

user

User identifier associated with the session.

user=(user : String)

User identifier associated with the session.

workflow

Workflow metadata for the session.

workflow=(workflow : ChatkitWorkflow)

Workflow metadata for the session.