vellum_ai 0.3.14 → 0.14.74

data/lib/vellum_ai/types/streaming_execute_prompt_event.rb

@@ -1,85 +1,106 @@
 # frozen_string_literal: true
-
 require_relative "prompt_output"
 require_relative "streaming_prompt_execution_meta"
+require "ostruct"
 require "json"
 
 module Vellum
-  # The data returned for each delta during the prompt execution stream.
+# The data returned for each delta during the prompt execution stream.
   class StreamingExecutePromptEvent
-    attr_reader :output, :output_index, :execution_id, :meta, :raw, :additional_properties
+  # @return [String] 
+    attr_reader :state
+  # @return [Vellum::PromptOutput] 
+    attr_reader :output
+  # @return [Integer] 
+    attr_reader :output_index
+  # @return [String] 
+    attr_reader :execution_id
+  # @return [Vellum::StreamingPromptExecutionMeta] 
+    attr_reader :meta
+  # @return [Hash{String => Object}] The subset of the raw response from the model that the request opted into with
+#  `expand_raw`.
+    attr_reader :raw
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
 
-    # @param output [PromptOutput]
-    # @param output_index [Integer]
-    # @param execution_id [String]
-    # @param meta [StreamingPromptExecutionMeta]
-    # @param raw [Hash{String => String}] The subset of the raw response from the model that the request opted into with `expand_raw`.
+    # @param state [String] 
+    # @param output [Vellum::PromptOutput] 
+    # @param output_index [Integer] 
+    # @param execution_id [String] 
+    # @param meta [Vellum::StreamingPromptExecutionMeta] 
+    # @param raw [Hash{String => Object}] The subset of the raw response from the model that the request opted into with
+#  `expand_raw`.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [StreamingExecutePromptEvent]
-    def initialize(output:, output_index:, execution_id:, meta: nil, raw: nil, additional_properties: nil)
-      # @type [PromptOutput]
+    # @return [Vellum::StreamingExecutePromptEvent]
+    def initialize(state:, output:, output_index:, execution_id:, meta: OMIT, raw: OMIT, additional_properties: nil)
+      @state = state
       @output = output
-      # @type [Integer]
       @output_index = output_index
-      # @type [String]
       @execution_id = execution_id
-      # @type [StreamingPromptExecutionMeta]
-      @meta = meta
-      # @type [Hash{String => String}] The subset of the raw response from the model that the request opted into with `expand_raw`.
-      @raw = raw
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @meta = meta if meta != OMIT
+      @raw = raw if raw != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "state": state, "output": output, "output_index": output_index, "execution_id": execution_id, "meta": meta, "raw": raw }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of StreamingExecutePromptEvent
+# Deserialize a JSON object to an instance of StreamingExecutePromptEvent
     #
-    # @param json_object [JSON]
-    # @return [StreamingExecutePromptEvent]
+    # @param json_object [String] 
+    # @return [Vellum::StreamingExecutePromptEvent]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      if parsed_json["output"].nil?
-        output = nil
-      else
+      state = parsed_json["state"]
+      unless parsed_json["output"].nil?
         output = parsed_json["output"].to_json
-        output = PromptOutput.from_json(json_object: output)
-      end
-      output_index = struct.output_index
-      execution_id = struct.execution_id
-      if parsed_json["meta"].nil?
-        meta = nil
+        output = Vellum::PromptOutput.from_json(json_object: output)
       else
+        output = nil
+      end
+      output_index = parsed_json["output_index"]
+      execution_id = parsed_json["execution_id"]
+      unless parsed_json["meta"].nil?
         meta = parsed_json["meta"].to_json
-        meta = StreamingPromptExecutionMeta.from_json(json_object: meta)
+        meta = Vellum::StreamingPromptExecutionMeta.from_json(json_object: meta)
+      else
+        meta = nil
       end
-      raw = struct.raw
-      new(output: output, output_index: output_index, execution_id: execution_id, meta: meta, raw: raw,
-          additional_properties: struct)
+      raw = parsed_json["raw"]
+      new(
+        state: state,
+        output: output,
+        output_index: output_index,
+        execution_id: execution_id,
+        meta: meta,
+        raw: raw,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of StreamingExecutePromptEvent to a JSON object
+# Serialize an instance of StreamingExecutePromptEvent to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      {
-        "output": @output,
-        "output_index": @output_index,
-        "execution_id": @execution_id,
-        "meta": @meta,
-        "raw": @raw
-      }.to_json
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
     end
-
-    # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
     #
-    # @param obj [Object]
+    # @param obj [Object] 
     # @return [Void]
     def self.validate_raw(obj:)
-      PromptOutput.validate_raw(obj: obj.output)
+      obj.state.is_a?(String) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+      Vellum::PromptOutput.validate_raw(obj: obj.output)
       obj.output_index.is_a?(Integer) != false || raise("Passed value for field obj.output_index is not the expected type, validation failed.")
       obj.execution_id.is_a?(String) != false || raise("Passed value for field obj.execution_id is not the expected type, validation failed.")
-      obj.meta.nil? || StreamingPromptExecutionMeta.validate_raw(obj: obj.meta)
+      obj.meta.nil? || Vellum::StreamingPromptExecutionMeta.validate_raw(obj: obj.meta)
       obj.raw&.is_a?(Hash) != false || raise("Passed value for field obj.raw is not the expected type, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/streaming_prompt_execution_meta.rb

@@ -1,46 +1,55 @@
 # frozen_string_literal: true
-
+require "ostruct"
 require "json"
 
 module Vellum
-  # The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
+# The subset of the metadata tracked by Vellum during prompt execution that the
+#  request opted into with `expand_meta`.
   class StreamingPromptExecutionMeta
-    attr_reader :latency, :additional_properties
+  # @return [Integer] 
+    attr_reader :latency
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
 
-    # @param latency [Integer]
+    # @param latency [Integer] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [StreamingPromptExecutionMeta]
-    def initialize(latency: nil, additional_properties: nil)
-      # @type [Integer]
-      @latency = latency
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::StreamingPromptExecutionMeta]
+    def initialize(latency: OMIT, additional_properties: nil)
+      @latency = latency if latency != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "latency": latency }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of StreamingPromptExecutionMeta
+# Deserialize a JSON object to an instance of StreamingPromptExecutionMeta
     #
-    # @param json_object [JSON]
-    # @return [StreamingPromptExecutionMeta]
+    # @param json_object [String] 
+    # @return [Vellum::StreamingPromptExecutionMeta]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
-      JSON.parse(json_object)
-      latency = struct.latency
+      parsed_json = JSON.parse(json_object)
+      latency = parsed_json["latency"]
       new(latency: latency, additional_properties: struct)
     end
-
-    # Serialize an instance of StreamingPromptExecutionMeta to a JSON object
+# Serialize an instance of StreamingPromptExecutionMeta to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "latency": @latency }.to_json
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
     end
-
-    # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
     #
-    # @param obj [Object]
+    # @param obj [Object] 
     # @return [Void]
     def self.validate_raw(obj:)
       obj.latency&.is_a?(Integer) != false || raise("Passed value for field obj.latency is not the expected type, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/streaming_workflow_node_result_event.rb

@@ -1,106 +1,130 @@
 # frozen_string_literal: true
-
 require "date"
 require_relative "workflow_node_result_data"
 require_relative "node_output_compiled_value"
+require "ostruct"
 require "json"
 
 module Vellum
-  # An event that indicates that the node has execution is in progress.
+# An event that indicates that the node has execution is in progress.
   class StreamingWorkflowNodeResultEvent
-    attr_reader :id, :node_id, :node_result_id, :ts, :data, :source_execution_id, :output, :output_index,
-                :additional_properties
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :node_id
+  # @return [String] 
+    attr_reader :node_result_id
+  # @return [String] 
+    attr_reader :state
+  # @return [DateTime] 
+    attr_reader :ts
+  # @return [Vellum::WorkflowNodeResultData] 
+    attr_reader :data
+  # @return [String] 
+    attr_reader :source_execution_id
+  # @return [Vellum::NodeOutputCompiledValue] 
+    attr_reader :output
+  # @return [Integer] 
+    attr_reader :output_index
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
 
-    # @param id [String]
-    # @param node_id [String]
-    # @param node_result_id [String]
-    # @param ts [DateTime]
-    # @param data [WorkflowNodeResultData]
-    # @param source_execution_id [String]
-    # @param output [NodeOutputCompiledValue]
-    # @param output_index [Integer]
+    # @param id [String] 
+    # @param node_id [String] 
+    # @param node_result_id [String] 
+    # @param state [String] 
+    # @param ts [DateTime] 
+    # @param data [Vellum::WorkflowNodeResultData] 
+    # @param source_execution_id [String] 
+    # @param output [Vellum::NodeOutputCompiledValue] 
+    # @param output_index [Integer] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [StreamingWorkflowNodeResultEvent]
-    def initialize(id:, node_id:, node_result_id:, ts: nil, data: nil, source_execution_id: nil, output: nil,
-                   output_index: nil, additional_properties: nil)
-      # @type [String]
+    # @return [Vellum::StreamingWorkflowNodeResultEvent]
+    def initialize(id:, node_id:, node_result_id:, state:, ts: OMIT, data: OMIT, source_execution_id: OMIT, output: OMIT, output_index: OMIT, additional_properties: nil)
       @id = id
-      # @type [String]
       @node_id = node_id
-      # @type [String]
       @node_result_id = node_result_id
-      # @type [DateTime]
-      @ts = ts
-      # @type [WorkflowNodeResultData]
-      @data = data
-      # @type [String]
-      @source_execution_id = source_execution_id
-      # @type [NodeOutputCompiledValue]
-      @output = output
-      # @type [Integer]
-      @output_index = output_index
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @state = state
+      @ts = ts if ts != OMIT
+      @data = data if data != OMIT
+      @source_execution_id = source_execution_id if source_execution_id != OMIT
+      @output = output if output != OMIT
+      @output_index = output_index if output_index != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "id": id, "node_id": node_id, "node_result_id": node_result_id, "state": state, "ts": ts, "data": data, "source_execution_id": source_execution_id, "output": output, "output_index": output_index }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of StreamingWorkflowNodeResultEvent
+# Deserialize a JSON object to an instance of StreamingWorkflowNodeResultEvent
     #
-    # @param json_object [JSON]
-    # @return [StreamingWorkflowNodeResultEvent]
+    # @param json_object [String] 
+    # @return [Vellum::StreamingWorkflowNodeResultEvent]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      id = struct.id
-      node_id = struct.node_id
-      node_result_id = struct.node_result_id
-      ts = DateTime.parse(parsed_json["ts"])
-      if parsed_json["data"].nil?
-        data = nil
-      else
+      id = parsed_json["id"]
+      node_id = parsed_json["node_id"]
+      node_result_id = parsed_json["node_result_id"]
+      state = parsed_json["state"]
+      ts = unless parsed_json["ts"].nil?
+  DateTime.parse(parsed_json["ts"])
+else
+  nil
+end
+      unless parsed_json["data"].nil?
         data = parsed_json["data"].to_json
-        data = WorkflowNodeResultData.from_json(json_object: data)
-      end
-      source_execution_id = struct.source_execution_id
-      if parsed_json["output"].nil?
-        output = nil
+        data = Vellum::WorkflowNodeResultData.from_json(json_object: data)
       else
+        data = nil
+      end
+      source_execution_id = parsed_json["source_execution_id"]
+      unless parsed_json["output"].nil?
         output = parsed_json["output"].to_json
-        output = NodeOutputCompiledValue.from_json(json_object: output)
+        output = Vellum::NodeOutputCompiledValue.from_json(json_object: output)
+      else
+        output = nil
       end
-      output_index = struct.output_index
-      new(id: id, node_id: node_id, node_result_id: node_result_id, ts: ts, data: data,
-          source_execution_id: source_execution_id, output: output, output_index: output_index, additional_properties: struct)
+      output_index = parsed_json["output_index"]
+      new(
+        id: id,
+        node_id: node_id,
+        node_result_id: node_result_id,
+        state: state,
+        ts: ts,
+        data: data,
+        source_execution_id: source_execution_id,
+        output: output,
+        output_index: output_index,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of StreamingWorkflowNodeResultEvent to a JSON object
+# Serialize an instance of StreamingWorkflowNodeResultEvent to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      {
-        "id": @id,
-        "node_id": @node_id,
-        "node_result_id": @node_result_id,
-        "ts": @ts,
-        "data": @data,
-        "source_execution_id": @source_execution_id,
-        "output": @output,
-        "output_index": @output_index
-      }.to_json
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
     end
-
-    # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
     #
-    # @param obj [Object]
+    # @param obj [Object] 
     # @return [Void]
     def self.validate_raw(obj:)
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
       obj.node_result_id.is_a?(String) != false || raise("Passed value for field obj.node_result_id is not the expected type, validation failed.")
+      obj.state.is_a?(String) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
       obj.ts&.is_a?(DateTime) != false || raise("Passed value for field obj.ts is not the expected type, validation failed.")
-      obj.data.nil? || WorkflowNodeResultData.validate_raw(obj: obj.data)
+      obj.data.nil? || Vellum::WorkflowNodeResultData.validate_raw(obj: obj.data)
       obj.source_execution_id&.is_a?(String) != false || raise("Passed value for field obj.source_execution_id is not the expected type, validation failed.")
-      obj.output.nil? || NodeOutputCompiledValue.validate_raw(obj: obj.output)
+      obj.output.nil? || Vellum::NodeOutputCompiledValue.validate_raw(obj: obj.output)
       obj.output_index&.is_a?(Integer) != false || raise("Passed value for field obj.output_index is not the expected type, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/string_chat_message_content.rb

@@ -1,46 +1,62 @@
 # frozen_string_literal: true
-
+require "ostruct"
 require "json"
 
 module Vellum
-  # A string value that is used in a chat message.
+# A string value that is used in a chat message.
   class StringChatMessageContent
-    attr_reader :value, :additional_properties
+  # @return [String] 
+    attr_reader :type
+  # @return [String] 
+    attr_reader :value
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
 
-    # @param value [String]
+    # @param type [String] 
+    # @param value [String] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [StringChatMessageContent]
-    def initialize(value:, additional_properties: nil)
-      # @type [String]
+    # @return [Vellum::StringChatMessageContent]
+    def initialize(type:, value:, additional_properties: nil)
+      @type = type
       @value = value
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value }
     end
-
-    # Deserialize a JSON object to an instance of StringChatMessageContent
+# Deserialize a JSON object to an instance of StringChatMessageContent
     #
-    # @param json_object [JSON]
-    # @return [StringChatMessageContent]
+    # @param json_object [String] 
+    # @return [Vellum::StringChatMessageContent]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
-      JSON.parse(json_object)
-      value = struct.value
-      new(value: value, additional_properties: struct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      value = parsed_json["value"]
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of StringChatMessageContent to a JSON object
+# Serialize an instance of StringChatMessageContent to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "value": @value }.to_json
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
     end
-
-    # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
     #
-    # @param obj [Object]
+    # @param obj [Object] 
     # @return [Void]
     def self.validate_raw(obj:)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/string_chat_message_content_request.rb

@@ -1,46 +1,62 @@
 # frozen_string_literal: true
-
+require "ostruct"
 require "json"
 
 module Vellum
-  # A string value that is used in a chat message.
+# A string value that is used in a chat message.
   class StringChatMessageContentRequest
-    attr_reader :value, :additional_properties
+  # @return [String] 
+    attr_reader :type
+  # @return [String] 
+    attr_reader :value
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
 
-    # @param value [String]
+    # @param type [String] 
+    # @param value [String] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [StringChatMessageContentRequest]
-    def initialize(value:, additional_properties: nil)
-      # @type [String]
+    # @return [Vellum::StringChatMessageContentRequest]
+    def initialize(type:, value:, additional_properties: nil)
+      @type = type
       @value = value
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value }
     end
-
-    # Deserialize a JSON object to an instance of StringChatMessageContentRequest
+# Deserialize a JSON object to an instance of StringChatMessageContentRequest
     #
-    # @param json_object [JSON]
-    # @return [StringChatMessageContentRequest]
+    # @param json_object [String] 
+    # @return [Vellum::StringChatMessageContentRequest]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
-      JSON.parse(json_object)
-      value = struct.value
-      new(value: value, additional_properties: struct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      value = parsed_json["value"]
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of StringChatMessageContentRequest to a JSON object
+# Serialize an instance of StringChatMessageContentRequest to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "value": @value }.to_json
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
     end
-
-    # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
     #
-    # @param obj [Object]
+    # @param obj [Object] 
     # @return [Void]
     def self.validate_raw(obj:)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
     end
   end
-end
+end