vellum_ai 0.3.14 → 0.14.74

data/lib/vellum_ai/types/search_result.rb

@@ -1,66 +1,96 @@
 # frozen_string_literal: true
-
 require_relative "search_result_document"
+require_relative "search_result_meta"
+require "ostruct"
 require "json"
 
 module Vellum
   class SearchResult
-    attr_reader :text, :score, :keywords, :document, :additional_properties
+  # @return [String] The text of the chunk that matched the search query.
+    attr_reader :text
+  # @return [Float] A score representing how well the chunk matches the search query.
+    attr_reader :score
+  # @return [Array<String>] 
+    attr_reader :keywords
+  # @return [Vellum::SearchResultDocument] The document that contains the chunk that matched the search query.
+    attr_reader :document
+  # @return [Vellum::SearchResultMeta] Additional information about the search result.
+    attr_reader :meta
+  # @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 text [String] The text of the chunk that matched the search query.
     # @param score [Float] A score representing how well the chunk matches the search query.
-    # @param keywords [Array<String>]
-    # @param document [SearchResultDocument] The document that contains the chunk that matched the search query.
+    # @param keywords [Array<String>] 
+    # @param document [Vellum::SearchResultDocument] The document that contains the chunk that matched the search query.
+    # @param meta [Vellum::SearchResultMeta] Additional information about the search result.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [SearchResult]
-    def initialize(text:, score:, keywords:, document:, additional_properties: nil)
-      # @type [String] The text of the chunk that matched the search query.
+    # @return [Vellum::SearchResult]
+    def initialize(text:, score:, keywords:, document:, meta: OMIT, additional_properties: nil)
       @text = text
-      # @type [Float] A score representing how well the chunk matches the search query.
       @score = score
-      # @type [Array<String>]
       @keywords = keywords
-      # @type [SearchResultDocument] The document that contains the chunk that matched the search query.
       @document = document
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @meta = meta if meta != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "text": text, "score": score, "keywords": keywords, "document": document, "meta": meta }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of SearchResult
+# Deserialize a JSON object to an instance of SearchResult
     #
-    # @param json_object [JSON]
-    # @return [SearchResult]
+    # @param json_object [String] 
+    # @return [Vellum::SearchResult]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      text = struct.text
-      score = struct.score
-      keywords = struct.keywords
-      if parsed_json["document"].nil?
+      text = parsed_json["text"]
+      score = parsed_json["score"]
+      keywords = parsed_json["keywords"]
+      unless parsed_json["document"].nil?
+        document = parsed_json["document"].to_json
+        document = Vellum::SearchResultDocument.from_json(json_object: document)
+      else
         document = nil
+      end
+      unless parsed_json["meta"].nil?
+        meta = parsed_json["meta"].to_json
+        meta = Vellum::SearchResultMeta.from_json(json_object: meta)
       else
-        document = parsed_json["document"].to_json
-        document = SearchResultDocument.from_json(json_object: document)
+        meta = nil
       end
-      new(text: text, score: score, keywords: keywords, document: document, additional_properties: struct)
+      new(
+        text: text,
+        score: score,
+        keywords: keywords,
+        document: document,
+        meta: meta,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of SearchResult to a JSON object
+# Serialize an instance of SearchResult to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "text": @text, "score": @score, "keywords": @keywords, "document": @document }.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.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
       obj.score.is_a?(Float) != false || raise("Passed value for field obj.score is not the expected type, validation failed.")
       obj.keywords.is_a?(Array) != false || raise("Passed value for field obj.keywords is not the expected type, validation failed.")
-      SearchResultDocument.validate_raw(obj: obj.document)
+      Vellum::SearchResultDocument.validate_raw(obj: obj.document)
+      obj.meta.nil? || Vellum::SearchResultMeta.validate_raw(obj: obj.meta)
     end
   end
-end
+end

data/lib/vellum_ai/types/search_result_document.rb

@@ -1,60 +1,81 @@
 # frozen_string_literal: true
-
+require "ostruct"
 require "json"
 
 module Vellum
   class SearchResultDocument
-    attr_reader :id, :label, :external_id, :metadata, :additional_properties
+  # @return [String] The ID of the document.
+    attr_reader :id
+  # @return [String] The human-readable name for the document.
+    attr_reader :label
+  # @return [String] The unique ID of the document as represented in an external system and specified
+#  when it was originally uploaded.
+    attr_reader :external_id
+  # @return [Hash{String => Object}] A previously supplied JSON object containing metadata that can be filtered on
+#  when searching.
+    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 id [String] The ID of the document.
     # @param label [String] The human-readable name for the document.
-    # @param external_id [String] The unique ID of the document as represented in an external system and specified when it was originally uploaded.
-    # @param metadata [Hash{String => String}] A previously supplied JSON object containing metadata that can be filtered on when searching.
+    # @param external_id [String] The unique ID of the document as represented in an external system and specified
+#  when it was originally uploaded.
+    # @param metadata [Hash{String => Object}] A previously supplied JSON object containing metadata that can be filtered on
+#  when searching.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [SearchResultDocument]
-    def initialize(id:, label:, external_id: nil, metadata: nil, additional_properties: nil)
-      # @type [String] The ID of the document.
-      @id = id
-      # @type [String] The human-readable name for the document.
+    # @return [Vellum::SearchResultDocument]
+    def initialize(id: OMIT, label:, external_id: OMIT, metadata: OMIT, additional_properties: nil)
+      @id = id if id != OMIT
       @label = label
-      # @type [String] The unique ID of the document as represented in an external system and specified when it was originally uploaded.
-      @external_id = external_id
-      # @type [Hash{String => String}] A previously supplied JSON object containing metadata that can be filtered on when searching.
-      @metadata = metadata
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @external_id = external_id if external_id != OMIT
+      @metadata = metadata if metadata != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "id": id, "label": label, "external_id": external_id, "metadata": metadata }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of SearchResultDocument
+# Deserialize a JSON object to an instance of SearchResultDocument
     #
-    # @param json_object [JSON]
-    # @return [SearchResultDocument]
+    # @param json_object [String] 
+    # @return [Vellum::SearchResultDocument]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
-      JSON.parse(json_object)
-      id = struct.id
-      label = struct.label
-      external_id = struct.external_id
-      metadata = struct.metadata
-      new(id: id, label: label, external_id: external_id, metadata: metadata, additional_properties: struct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      label = parsed_json["label"]
+      external_id = parsed_json["external_id"]
+      metadata = parsed_json["metadata"]
+      new(
+        id: id,
+        label: label,
+        external_id: external_id,
+        metadata: metadata,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of SearchResultDocument to a JSON object
+# Serialize an instance of SearchResultDocument to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "id": @id, "label": @label, "external_id": @external_id, "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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       obj.label.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
       obj.external_id&.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
       obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/search_result_document_request.rb

@@ -1,55 +1,81 @@
 # frozen_string_literal: true
-
+require "ostruct"
 require "json"
 
 module Vellum
   class SearchResultDocumentRequest
-    attr_reader :label, :external_id, :metadata, :additional_properties
+  # @return [String] The ID of the document.
+    attr_reader :id
+  # @return [String] The human-readable name for the document.
+    attr_reader :label
+  # @return [String] The unique ID of the document as represented in an external system and specified
+#  when it was originally uploaded.
+    attr_reader :external_id
+  # @return [Hash{String => Object}] A previously supplied JSON object containing metadata that can be filtered on
+#  when searching.
+    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 id [String] The ID of the document.
     # @param label [String] The human-readable name for the document.
-    # @param external_id [String] The unique ID of the document as represented in an external system and specified when it was originally uploaded.
-    # @param metadata [Hash{String => String}] A previously supplied JSON object containing metadata that can be filtered on when searching.
+    # @param external_id [String] The unique ID of the document as represented in an external system and specified
+#  when it was originally uploaded.
+    # @param metadata [Hash{String => Object}] A previously supplied JSON object containing metadata that can be filtered on
+#  when searching.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [SearchResultDocumentRequest]
-    def initialize(label:, external_id: nil, metadata: nil, additional_properties: nil)
-      # @type [String] The human-readable name for the document.
+    # @return [Vellum::SearchResultDocumentRequest]
+    def initialize(id: OMIT, label:, external_id: OMIT, metadata: OMIT, additional_properties: nil)
+      @id = id if id != OMIT
       @label = label
-      # @type [String] The unique ID of the document as represented in an external system and specified when it was originally uploaded.
-      @external_id = external_id
-      # @type [Hash{String => String}] A previously supplied JSON object containing metadata that can be filtered on when searching.
-      @metadata = metadata
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @external_id = external_id if external_id != OMIT
+      @metadata = metadata if metadata != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "id": id, "label": label, "external_id": external_id, "metadata": metadata }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of SearchResultDocumentRequest
+# Deserialize a JSON object to an instance of SearchResultDocumentRequest
     #
-    # @param json_object [JSON]
-    # @return [SearchResultDocumentRequest]
+    # @param json_object [String] 
+    # @return [Vellum::SearchResultDocumentRequest]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
-      JSON.parse(json_object)
-      label = struct.label
-      external_id = struct.external_id
-      metadata = struct.metadata
-      new(label: label, external_id: external_id, metadata: metadata, additional_properties: struct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      label = parsed_json["label"]
+      external_id = parsed_json["external_id"]
+      metadata = parsed_json["metadata"]
+      new(
+        id: id,
+        label: label,
+        external_id: external_id,
+        metadata: metadata,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of SearchResultDocumentRequest to a JSON object
+# Serialize an instance of SearchResultDocumentRequest to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "label": @label, "external_id": @external_id, "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.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       obj.label.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
       obj.external_id&.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
       obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/search_result_merging_request.rb

@@ -1,45 +1,53 @@
 # frozen_string_literal: true
-
+require "ostruct"
 require "json"
 
 module Vellum
   class SearchResultMergingRequest
-    attr_reader :enabled, :additional_properties
+  # @return [Boolean] Whether to enable merging results
+    attr_reader :enabled
+  # @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 enabled [Boolean] Whether to enable merging results
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [SearchResultMergingRequest]
-    def initialize(enabled: nil, additional_properties: nil)
-      # @type [Boolean] Whether to enable merging results
-      @enabled = enabled
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::SearchResultMergingRequest]
+    def initialize(enabled: OMIT, additional_properties: nil)
+      @enabled = enabled if enabled != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "enabled": enabled }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of SearchResultMergingRequest
+# Deserialize a JSON object to an instance of SearchResultMergingRequest
     #
-    # @param json_object [JSON]
-    # @return [SearchResultMergingRequest]
+    # @param json_object [String] 
+    # @return [Vellum::SearchResultMergingRequest]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
-      JSON.parse(json_object)
-      enabled = struct.enabled
+      parsed_json = JSON.parse(json_object)
+      enabled = parsed_json["enabled"]
       new(enabled: enabled, additional_properties: struct)
     end
-
-    # Serialize an instance of SearchResultMergingRequest to a JSON object
+# Serialize an instance of SearchResultMergingRequest to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "enabled": @enabled }.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.enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/search_result_meta.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require_relative "components_schemas_pdf_search_result_meta_source"
+require "ostruct"
+require "json"
+require_relative "pdf_search_result_meta_source"
+
+module Vellum
+  class SearchResultMeta
+  # @return [Vellum::COMPONENTS_SCHEMAS_PDF_SEARCH_RESULT_META_SOURCE] 
+    attr_reader :source
+  # @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 source [Vellum::COMPONENTS_SCHEMAS_PDF_SEARCH_RESULT_META_SOURCE] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::SearchResultMeta]
+    def initialize(source: OMIT, additional_properties: nil)
+      @source = source if source != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "source": source }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of SearchResultMeta
+    #
+    # @param json_object [String] 
+    # @return [Vellum::SearchResultMeta]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      unless parsed_json["source"].nil?
+        source = parsed_json["source"].to_json
+        source = Vellum::PdfSearchResultMetaSource.from_json(json_object: source)
+      else
+        source = nil
+      end
+      new(source: source, additional_properties: struct)
+    end
+# Serialize an instance of SearchResultMeta to a JSON object
+    #
+    # @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.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.source.nil? || Vellum::PdfSearchResultMetaSource.validate_raw(obj: obj.source)
+    end
+  end
+end

data/lib/vellum_ai/types/search_result_meta_request.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require_relative "components_schemas_pdf_search_result_meta_source_request"
+require "ostruct"
+require "json"
+require_relative "pdf_search_result_meta_source_request"
+
+module Vellum
+  class SearchResultMetaRequest
+  # @return [Vellum::COMPONENTS_SCHEMAS_PDF_SEARCH_RESULT_META_SOURCE_REQUEST] 
+    attr_reader :source
+  # @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 source [Vellum::COMPONENTS_SCHEMAS_PDF_SEARCH_RESULT_META_SOURCE_REQUEST] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::SearchResultMetaRequest]
+    def initialize(source: OMIT, additional_properties: nil)
+      @source = source if source != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "source": source }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of SearchResultMetaRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::SearchResultMetaRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      unless parsed_json["source"].nil?
+        source = parsed_json["source"].to_json
+        source = Vellum::PdfSearchResultMetaSourceRequest.from_json(json_object: source)
+      else
+        source = nil
+      end
+      new(source: source, additional_properties: struct)
+    end
+# Serialize an instance of SearchResultMetaRequest to a JSON object
+    #
+    # @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.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.source.nil? || Vellum::PdfSearchResultMetaSourceRequest.validate_raw(obj: obj.source)
+    end
+  end
+end