Class: OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/chatkit/chat_session_workflow_param.rb

Defined Under Namespace

Modules: StateVariable Classes: Tracing

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#id ⇒ String

Identifier for the workflow invoked by the session.

Returns:

  • (String) 


12
 
# File 'lib/openai/models/beta/chatkit/chat_session_workflow_param.rb', line 12

required :id, String

#state_variables ⇒ Hash{Symbol=>String, Boolean, Float}?

State variables forwarded to the workflow. Keys may be up to 64 characters, values must be primitive types, and the map defaults to an empty object.

Returns:

  • (Hash{Symbol=>String, Boolean, Float}, nil) 


19
20
 
# File 'lib/openai/models/beta/chatkit/chat_session_workflow_param.rb', line 19

optional :state_variables,
-> { OpenAI::Internal::Type::HashOf[union: OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::StateVariable] }

#tracing ⇒ OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam::Tracing?

Optional tracing overrides for the workflow invocation. When omitted, tracing is enabled by default.

Returns:



27
 
# File 'lib/openai/models/beta/chatkit/chat_session_workflow_param.rb', line 27

optional :tracing, -> { OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::Tracing }

#version ⇒ String?

Specific workflow version to run. Defaults to the latest deployed version.

Returns:

  • (String, nil) 


33
 
# File 'lib/openai/models/beta/chatkit/chat_session_workflow_param.rb', line 33

optional :version, String

Class Method Details

.variants ⇒ Array(String, Boolean, Float)

Returns:




# File 'lib/openai/models/beta/chatkit/chat_session_workflow_param.rb', line 58