class

OpenAI::WorkflowParam

Inherits JSON::Serializable < Reference < Object

Workflow reference and overrides applied to the chat session.

Constructors

new(pull : JSON::PullParser)
Source
new(id : String = "", version : String | Nil = nil, state_variables : Hash(String, Hash(String, JSON::Any)) | Nil = nil, tracing : WorkflowTracingParam | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

id

Identifier for the workflow invoked by the session.

Source
id=(id : String)

Identifier for the workflow invoked by the session.

Source
state_variables

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.

Source
state_variables=(state_variables : Hash(String, Hash(String, JSON::Any)) | Nil)

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.

Source
tracing

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

Source
tracing=(tracing : WorkflowTracingParam | Nil)

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

Source
version

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

Source
version=(version : String | Nil)

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

Source