Module: OpenAI::Models::Beta::ChatKitWorkflow::StateVariable

Extended by:
Internal::Type::Union
Defined in:
lib/openai/models/beta/chatkit_workflow.rb,
sig/openai/models/beta/chatkit_workflow.rbs

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants, variants

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

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

Instance Method Details

#initialize(id:, state_variables:, tracing:, version:) ⇒ Object

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

Workflow metadata and state returned for the session.

Parameters:

  • id (String) —

    Identifier of the workflow backing the session.

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

    State variable key-value pairs applied when invoking the workflow. Defaults to n

  • tracing (OpenAI::Models::Beta::ChatKitWorkflow::Tracing) —

    Tracing settings applied to the workflow.

  • version (String, nil) —

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



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/openai/models/beta/chatkit_workflow.rb', line 49

module StateVariable
  extend OpenAI::Internal::Type::Union

  variant String

  variant OpenAI::Internal::Type::Boolean

  variant Float

  # @!method self.variants
  #   @return [Array(String, Boolean, Float)]
end

#self?.variants ⇒ ::Array[OpenAI::Models::Beta::ChatKitWorkflow::state_variable]

Returns:

  • (::Array[OpenAI::Models::Beta::ChatKitWorkflow::state_variable]) 


40
 
# File 'sig/openai/models/beta/chatkit_workflow.rbs', line 40

def self?.variants: -> ::Array[OpenAI::Models::Beta::ChatKitWorkflow::state_variable]