vellum_ai 0.3.15 → 0.14.74

data/lib/vellum_ai/types/search_filters_request.rb

@@ -1,56 +1,69 @@
 # frozen_string_literal: true
-
-require_relative "metadata_filter_config_request"
+require_relative "metadata_filters_request"
+require "ostruct"
 require "json"
 
 module Vellum
   class SearchFiltersRequest
-    attr_reader :external_ids, :metadata, :additional_properties
+  # @return [Array<String>] The document external IDs to filter by
+    attr_reader :external_ids
+  # @return [Vellum::MetadataFiltersRequest] The metadata filters to apply to the search
+    attr_reader :metadata
+  # @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 external_ids [Array<String>] The document external IDs to filter by
-    # @param metadata [MetadataFilterConfigRequest] The metadata filters to apply to the search
+    # @param metadata [Vellum::MetadataFiltersRequest] The metadata filters to apply to the search
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [SearchFiltersRequest]
-    def initialize(external_ids: nil, metadata: nil, additional_properties: nil)
-      # @type [Array<String>] The document external IDs to filter by
-      @external_ids = external_ids
-      # @type [MetadataFilterConfigRequest] The metadata filters to apply to the search
-      @metadata = metadata
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::SearchFiltersRequest]
+    def initialize(external_ids: OMIT, metadata: OMIT, additional_properties: nil)
+      @external_ids = external_ids if external_ids != OMIT
+      @metadata = metadata if metadata != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "external_ids": external_ids, "metadata": metadata }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of SearchFiltersRequest
+# Deserialize a JSON object to an instance of SearchFiltersRequest
     #
-    # @param json_object [JSON]
-    # @return [SearchFiltersRequest]
+    # @param json_object [String] 
+    # @return [Vellum::SearchFiltersRequest]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      external_ids = struct.external_ids
-      if parsed_json["metadata"].nil?
-        metadata = nil
-      else
+      external_ids = parsed_json["external_ids"]
+      unless parsed_json["metadata"].nil?
         metadata = parsed_json["metadata"].to_json
-        metadata = MetadataFilterConfigRequest.from_json(json_object: metadata)
+        metadata = Vellum::MetadataFiltersRequest.from_json(json_object: metadata)
+      else
+        metadata = nil
       end
-      new(external_ids: external_ids, metadata: metadata, additional_properties: struct)
+      new(
+        external_ids: external_ids,
+        metadata: metadata,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of SearchFiltersRequest to a JSON object
+# Serialize an instance of SearchFiltersRequest to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "external_ids": @external_ids, "metadata": @metadata }.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.external_ids&.is_a?(Array) != false || raise("Passed value for field obj.external_ids is not the expected type, validation failed.")
-      obj.metadata.nil? || MetadataFilterConfigRequest.validate_raw(obj: obj.metadata)
+      obj.metadata.nil? || Vellum::MetadataFiltersRequest.validate_raw(obj: obj.metadata)
     end
   end
-end
+end

data/lib/vellum_ai/types/search_node_result.rb

@@ -1,52 +1,68 @@
 # frozen_string_literal: true
-
 require_relative "search_node_result_data"
+require "ostruct"
 require "json"
 
 module Vellum
-  # A Node Result Event emitted from a Search Node.
+# A Node Result Event emitted from a Search Node.
   class SearchNodeResult
-    attr_reader :data, :additional_properties
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::SearchNodeResultData] 
+    attr_reader :data
+  # @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 data [SearchNodeResultData]
+    # @param type [String] 
+    # @param data [Vellum::SearchNodeResultData] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [SearchNodeResult]
-    def initialize(data:, additional_properties: nil)
-      # @type [SearchNodeResultData]
+    # @return [Vellum::SearchNodeResult]
+    def initialize(type:, data:, additional_properties: nil)
+      @type = type
       @data = data
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
+      @_field_set = { "type": type, "data": data }
     end
-
-    # Deserialize a JSON object to an instance of SearchNodeResult
+# Deserialize a JSON object to an instance of SearchNodeResult
     #
-    # @param json_object [JSON]
-    # @return [SearchNodeResult]
+    # @param json_object [String] 
+    # @return [Vellum::SearchNodeResult]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      if parsed_json["data"].nil?
-        data = nil
-      else
+      type = parsed_json["type"]
+      unless parsed_json["data"].nil?
         data = parsed_json["data"].to_json
-        data = SearchNodeResultData.from_json(json_object: data)
+        data = Vellum::SearchNodeResultData.from_json(json_object: data)
+      else
+        data = nil
       end
-      new(data: data, additional_properties: struct)
+      new(
+        type: type,
+        data: data,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of SearchNodeResult to a JSON object
+# Serialize an instance of SearchNodeResult to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "data": @data }.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:)
-      SearchNodeResultData.validate_raw(obj: obj.data)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::SearchNodeResultData.validate_raw(obj: obj.data)
     end
   end
-end
+end

data/lib/vellum_ai/types/search_node_result_data.rb

@@ -1,64 +1,77 @@
 # frozen_string_literal: true
-
 require_relative "search_result"
+require "ostruct"
 require "json"
 
 module Vellum
   class SearchNodeResultData
-    attr_reader :results_output_id, :results, :text_output_id, :text, :additional_properties
+  # @return [String] 
+    attr_reader :results_output_id
+  # @return [Array<Vellum::SearchResult>] The results of the search. Each result represents a chunk that matches the
+#  search query.
+    attr_reader :results
+  # @return [String] 
+    attr_reader :text_output_id
+  # @return [String] 
+    attr_reader :text
+  # @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 results_output_id [String]
-    # @param results [Array<SearchResult>] The results of the search. Each result represents a chunk that matches the search query.
-    # @param text_output_id [String]
-    # @param text [String]
+    # @param results_output_id [String] 
+    # @param results [Array<Vellum::SearchResult>] The results of the search. Each result represents a chunk that matches the
+#  search query.
+    # @param text_output_id [String] 
+    # @param text [String] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [SearchNodeResultData]
-    def initialize(results_output_id:, results:, text_output_id:, text: nil, additional_properties: nil)
-      # @type [String]
+    # @return [Vellum::SearchNodeResultData]
+    def initialize(results_output_id:, results:, text_output_id:, text: OMIT, additional_properties: nil)
       @results_output_id = results_output_id
-      # @type [Array<SearchResult>] The results of the search. Each result represents a chunk that matches the search query.
       @results = results
-      # @type [String]
       @text_output_id = text_output_id
-      # @type [String]
-      @text = text
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @text = text if text != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "results_output_id": results_output_id, "results": results, "text_output_id": text_output_id, "text": text }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of SearchNodeResultData
+# Deserialize a JSON object to an instance of SearchNodeResultData
     #
-    # @param json_object [JSON]
-    # @return [SearchNodeResultData]
+    # @param json_object [String] 
+    # @return [Vellum::SearchNodeResultData]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      results_output_id = struct.results_output_id
-      results = parsed_json["results"].map do |v|
-        v = v.to_json
-        SearchResult.from_json(json_object: v)
-      end
-      text_output_id = struct.text_output_id
-      text = struct.text
-      new(results_output_id: results_output_id, results: results, text_output_id: text_output_id, text: text,
-          additional_properties: struct)
+      results_output_id = parsed_json["results_output_id"]
+      results = parsed_json["results"]&.map do | item |
+  item = item.to_json
+  Vellum::SearchResult.from_json(json_object: item)
+end
+      text_output_id = parsed_json["text_output_id"]
+      text = parsed_json["text"]
+      new(
+        results_output_id: results_output_id,
+        results: results,
+        text_output_id: text_output_id,
+        text: text,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of SearchNodeResultData to a JSON object
+# Serialize an instance of SearchNodeResultData to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      {
-        "results_output_id": @results_output_id,
-        "results": @results,
-        "text_output_id": @text_output_id,
-        "text": @text
-      }.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.results_output_id.is_a?(String) != false || raise("Passed value for field obj.results_output_id is not the expected type, validation failed.")
@@ -67,4 +80,4 @@ module Vellum
       obj.text&.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/search_request_options_request.rb

@@ -1,79 +1,95 @@
 # frozen_string_literal: true
-
 require_relative "search_weights_request"
 require_relative "search_result_merging_request"
 require_relative "search_filters_request"
+require "ostruct"
 require "json"
 
 module Vellum
   class SearchRequestOptionsRequest
-    attr_reader :limit, :weights, :result_merging, :filters, :additional_properties
+  # @return [Integer] The maximum number of results to return.
+    attr_reader :limit
+  # @return [Vellum::SearchWeightsRequest] The weights to use for the search. Must add up to 1.0.
+    attr_reader :weights
+  # @return [Vellum::SearchResultMergingRequest] The configuration for merging results.
+    attr_reader :result_merging
+  # @return [Vellum::SearchFiltersRequest] The filters to apply to the search.
+    attr_reader :filters
+  # @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 limit [Integer] The maximum number of results to return.
-    # @param weights [SearchWeightsRequest] The weights to use for the search. Must add up to 1.0.
-    # @param result_merging [SearchResultMergingRequest] The configuration for merging results.
-    # @param filters [SearchFiltersRequest] The filters to apply to the search.
+    # @param weights [Vellum::SearchWeightsRequest] The weights to use for the search. Must add up to 1.0.
+    # @param result_merging [Vellum::SearchResultMergingRequest] The configuration for merging results.
+    # @param filters [Vellum::SearchFiltersRequest] The filters to apply to the search.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [SearchRequestOptionsRequest]
-    def initialize(limit: nil, weights: nil, result_merging: nil, filters: nil, additional_properties: nil)
-      # @type [Integer] The maximum number of results to return.
-      @limit = limit
-      # @type [SearchWeightsRequest] The weights to use for the search. Must add up to 1.0.
-      @weights = weights
-      # @type [SearchResultMergingRequest] The configuration for merging results.
-      @result_merging = result_merging
-      # @type [SearchFiltersRequest] The filters to apply to the search.
-      @filters = filters
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::SearchRequestOptionsRequest]
+    def initialize(limit: OMIT, weights: OMIT, result_merging: OMIT, filters: OMIT, additional_properties: nil)
+      @limit = limit if limit != OMIT
+      @weights = weights if weights != OMIT
+      @result_merging = result_merging if result_merging != OMIT
+      @filters = filters if filters != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "limit": limit, "weights": weights, "result_merging": result_merging, "filters": filters }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of SearchRequestOptionsRequest
+# Deserialize a JSON object to an instance of SearchRequestOptionsRequest
     #
-    # @param json_object [JSON]
-    # @return [SearchRequestOptionsRequest]
+    # @param json_object [String] 
+    # @return [Vellum::SearchRequestOptionsRequest]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      limit = struct.limit
-      if parsed_json["weights"].nil?
-        weights = nil
-      else
+      limit = parsed_json["limit"]
+      unless parsed_json["weights"].nil?
         weights = parsed_json["weights"].to_json
-        weights = SearchWeightsRequest.from_json(json_object: weights)
-      end
-      if parsed_json["result_merging"].nil?
-        result_merging = nil
+        weights = Vellum::SearchWeightsRequest.from_json(json_object: weights)
       else
-        result_merging = parsed_json["result_merging"].to_json
-        result_merging = SearchResultMergingRequest.from_json(json_object: result_merging)
+        weights = nil
       end
-      if parsed_json["filters"].nil?
-        filters = nil
+      unless parsed_json["result_merging"].nil?
+        result_merging = parsed_json["result_merging"].to_json
+        result_merging = Vellum::SearchResultMergingRequest.from_json(json_object: result_merging)
       else
+        result_merging = nil
+      end
+      unless parsed_json["filters"].nil?
         filters = parsed_json["filters"].to_json
-        filters = SearchFiltersRequest.from_json(json_object: filters)
+        filters = Vellum::SearchFiltersRequest.from_json(json_object: filters)
+      else
+        filters = nil
       end
-      new(limit: limit, weights: weights, result_merging: result_merging, filters: filters,
-          additional_properties: struct)
+      new(
+        limit: limit,
+        weights: weights,
+        result_merging: result_merging,
+        filters: filters,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of SearchRequestOptionsRequest to a JSON object
+# Serialize an instance of SearchRequestOptionsRequest to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "limit": @limit, "weights": @weights, "result_merging": @result_merging, "filters": @filters }.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.limit&.is_a?(Integer) != false || raise("Passed value for field obj.limit is not the expected type, validation failed.")
-      obj.weights.nil? || SearchWeightsRequest.validate_raw(obj: obj.weights)
-      obj.result_merging.nil? || SearchResultMergingRequest.validate_raw(obj: obj.result_merging)
-      obj.filters.nil? || SearchFiltersRequest.validate_raw(obj: obj.filters)
+      obj.weights.nil? || Vellum::SearchWeightsRequest.validate_raw(obj: obj.weights)
+      obj.result_merging.nil? || Vellum::SearchResultMergingRequest.validate_raw(obj: obj.result_merging)
+      obj.filters.nil? || Vellum::SearchFiltersRequest.validate_raw(obj: obj.filters)
     end
   end
-end
+end

data/lib/vellum_ai/types/search_response.rb

@@ -1,49 +1,57 @@
 # frozen_string_literal: true
-
 require_relative "search_result"
+require "ostruct"
 require "json"
 
 module Vellum
   class SearchResponse
-    attr_reader :results, :additional_properties
+  # @return [Array<Vellum::SearchResult>] The results of the search. Each result represents a chunk that matches the
+#  search query.
+    attr_reader :results
+  # @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 results [Array<SearchResult>] The results of the search. Each result represents a chunk that matches the search query.
+    # @param results [Array<Vellum::SearchResult>] The results of the search. Each result represents a chunk that matches the
+#  search query.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [SearchResponse]
+    # @return [Vellum::SearchResponse]
     def initialize(results:, additional_properties: nil)
-      # @type [Array<SearchResult>] The results of the search. Each result represents a chunk that matches the search query.
       @results = results
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
+      @_field_set = { "results": results }
     end
-
-    # Deserialize a JSON object to an instance of SearchResponse
+# Deserialize a JSON object to an instance of SearchResponse
     #
-    # @param json_object [JSON]
-    # @return [SearchResponse]
+    # @param json_object [String] 
+    # @return [Vellum::SearchResponse]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      results = parsed_json["results"].map do |v|
-        v = v.to_json
-        SearchResult.from_json(json_object: v)
-      end
+      results = parsed_json["results"]&.map do | item |
+  item = item.to_json
+  Vellum::SearchResult.from_json(json_object: item)
+end
       new(results: results, additional_properties: struct)
     end
-
-    # Serialize an instance of SearchResponse to a JSON object
+# Serialize an instance of SearchResponse to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "results": @results }.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.results.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
     end
   end
-end
+end