Class: OpenAI::Models::Beta::ChatKit::SessionCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::ChatKit::SessionCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/beta/chatkit/session_create_params.rb

Overview

See Also:

• Resources::Beta::ChatKit::Sessions#create

Instance Attribute Summary

• #chatkit_configuration ⇒ OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam^?

  Optional overrides for ChatKit runtime configuration features.

• #expires_after ⇒ OpenAI::Models::Beta::ChatKit::ChatSessionExpiresAfterParam^?

  Optional override for session expiration timing in seconds from creation.

• #rate_limits ⇒ OpenAI::Models::Beta::ChatKit::ChatSessionRateLimitsParam^?

  Optional override for per-minute request limits.

• #user ⇒ String

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

• #workflow ⇒ OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam

  Workflow that powers the session.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(user:, workflow:, chatkit_configuration: nil, expires_after: nil, rate_limits: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see SessionCreateParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(user:, workflow:, chatkit_configuration: nil, expires_after: nil, rate_limits: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::ChatKit::SessionCreateParams for more details.

Parameters:

• user (String) —

  A free-form string that identifies your end user; ensures this Session can acces

• workflow (OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam) —

  Workflow that powers the session.

• chatkit_configuration (OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam) (defaults to: nil) —

  Optional overrides for ChatKit runtime configuration features

• expires_after (OpenAI::Models::Beta::ChatKit::ChatSessionExpiresAfterParam) (defaults to: nil) —

  Optional override for session expiration timing in seconds from creation. Defaul

• rate_limits (OpenAI::Models::Beta::ChatKit::ChatSessionRateLimitsParam) (defaults to: nil) —

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

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

# File 'lib/openai/models/beta/chatkit/session_create_params.rb', line 44

Instance Attribute Details

#chatkit_configuration ⇒ OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam^?

Optional overrides for ChatKit runtime configuration features

Returns:

• (OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam, nil)

# File 'lib/openai/models/beta/chatkit/session_create_params.rb', line 29

optional :chatkit_configuration, -> { OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam }

#expires_after ⇒ OpenAI::Models::Beta::ChatKit::ChatSessionExpiresAfterParam^?

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

Returns:

• (OpenAI::Models::Beta::ChatKit::ChatSessionExpiresAfterParam, nil)

# File 'lib/openai/models/beta/chatkit/session_create_params.rb', line 36

optional :expires_after, -> { OpenAI::Beta::ChatKit::ChatSessionExpiresAfterParam }

#rate_limits ⇒ OpenAI::Models::Beta::ChatKit::ChatSessionRateLimitsParam^?

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

Returns:

• (OpenAI::Models::Beta::ChatKit::ChatSessionRateLimitsParam, nil)

# File 'lib/openai/models/beta/chatkit/session_create_params.rb', line 42

optional :rate_limits, -> { OpenAI::Beta::ChatKit::ChatSessionRateLimitsParam }

#user ⇒ String

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

Returns:

• (String)

# File 'lib/openai/models/beta/chatkit/session_create_params.rb', line 17

required :user, String

#workflow ⇒ OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam

Workflow that powers the session.

Returns:

• (OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam)

# File 'lib/openai/models/beta/chatkit/session_create_params.rb', line 23

required :workflow, -> { OpenAI::Beta::ChatKit::ChatSessionWorkflowParam }