Class: OpenAI::Models::Beta::ChatKitWorkflow

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/chatkit_workflow.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 of the workflow backing the session.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/beta/chatkit_workflow.rb', line 11

required :id, String

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

State variable key-value pairs applied when invoking the workflow. Defaults to null when no overrides were provided.

Returns:

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


18
19
20
 
# File 'lib/openai/models/beta/chatkit_workflow.rb', line 18

required :state_variables,
-> { OpenAI::Internal::Type::HashOf[union: OpenAI::Beta::ChatKitWorkflow::StateVariable] },
nil?: true

#tracing ⇒ OpenAI::Models::Beta::ChatKitWorkflow::Tracing

Tracing settings applied to the workflow.

Returns:



26
 
# File 'lib/openai/models/beta/chatkit_workflow.rb', line 26

required :tracing, -> { OpenAI::Beta::ChatKitWorkflow::Tracing }

#version ⇒ String?

Specific workflow version used for the session. Defaults to null when using the latest deployment.

Returns:

  • (String, nil) 


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

required :version, String, nil?: true

Class Method Details

.variants ⇒ Array(String, Boolean, Float)

Returns:




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