vellum_ai 0.3.4

data/lib/vellum_ai/types/search_response.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "search_result"
+require "json"
+
+module Vellum
+  class SearchResponse
+    attr_reader :results, :additional_properties
+
+    # @param results [Array<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]
+    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
+    end
+
+    # Deserialize a JSON object to an instance of SearchResponse
+    #
+    # @param json_object [JSON]
+    # @return [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
+      new(results: results, additional_properties: struct)
+    end
+
+    # Serialize an instance of SearchResponse to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "results": @results }.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.results.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/search_result.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "search_result_document"
+require "json"
+
+module Vellum
+  class SearchResult
+    attr_reader :text, :score, :keywords, :document, :additional_properties
+
+    # @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 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.
+      @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
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of SearchResult
+    #
+    # @param json_object [JSON]
+    # @return [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?
+        document = nil
+      else
+        document = parsed_json["document"].to_json
+        document = SearchResultDocument.from_json(json_object: document)
+      end
+      new(text: text, score: score, keywords: keywords, document: document, additional_properties: struct)
+    end
+
+    # 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
+    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.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)
+    end
+  end
+end

data/lib/vellum_ai/types/search_result_document.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  class SearchResultDocument
+    attr_reader :id, :label, :external_id, :metadata, :additional_properties
+
+    # @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 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.
+      @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
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of SearchResultDocument
+    #
+    # @param json_object [JSON]
+    # @return [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)
+    end
+
+    # 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
+    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.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

data/lib/vellum_ai/types/search_result_document_request.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  class SearchResultDocumentRequest
+    attr_reader :label, :external_id, :metadata, :additional_properties
+
+    # @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 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.
+      @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
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of SearchResultDocumentRequest
+    #
+    # @param json_object [JSON]
+    # @return [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)
+    end
+
+    # 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
+    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.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

data/lib/vellum_ai/types/search_result_merging_request.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  class SearchResultMergingRequest
+    attr_reader :enabled, :additional_properties
+
+    # @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
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of SearchResultMergingRequest
+    #
+    # @param json_object [JSON]
+    # @return [SearchResultMergingRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      JSON.parse(json_object)
+      enabled = struct.enabled
+      new(enabled: enabled, additional_properties: struct)
+    end
+
+    # Serialize an instance of SearchResultMergingRequest to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "enabled": @enabled }.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.enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/search_result_request.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "search_result_document_request"
+require "json"
+
+module Vellum
+  class SearchResultRequest
+    attr_reader :text, :score, :keywords, :document, :additional_properties
+
+    # @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 [SearchResultDocumentRequest] The document that contains the chunk that matched the search query.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [SearchResultRequest]
+    def initialize(text:, score:, keywords:, document:, additional_properties: nil)
+      # @type [String] The text of the chunk that matched the search query.
+      @text = text
+      # @type [Float] A score representing how well the chunk matches the search query.
+      @score = score
+      # @type [Array<String>]
+      @keywords = keywords
+      # @type [SearchResultDocumentRequest] The document that contains the chunk that matched the search query.
+      @document = document
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of SearchResultRequest
+    #
+    # @param json_object [JSON]
+    # @return [SearchResultRequest]
+    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?
+        document = nil
+      else
+        document = parsed_json["document"].to_json
+        document = SearchResultDocumentRequest.from_json(json_object: document)
+      end
+      new(text: text, score: score, keywords: keywords, document: document, additional_properties: struct)
+    end
+
+    # Serialize an instance of SearchResultRequest to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "text": @text, "score": @score, "keywords": @keywords, "document": @document }.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.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.")
+      SearchResultDocumentRequest.validate_raw(obj: obj.document)
+    end
+  end
+end

data/lib/vellum_ai/types/search_results_enum.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vellum
+  SEARCH_RESULTS_ENUM = String
+end

data/lib/vellum_ai/types/search_weights_request.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  class SearchWeightsRequest
+    attr_reader :semantic_similarity, :keywords, :additional_properties
+
+    # @param semantic_similarity [Float] The relative weight to give to semantic similarity
+    # @param keywords [Float] The relative weight to give to keywords
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [SearchWeightsRequest]
+    def initialize(semantic_similarity: nil, keywords: nil, additional_properties: nil)
+      # @type [Float] The relative weight to give to semantic similarity
+      @semantic_similarity = semantic_similarity
+      # @type [Float] The relative weight to give to keywords
+      @keywords = keywords
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of SearchWeightsRequest
+    #
+    # @param json_object [JSON]
+    # @return [SearchWeightsRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      JSON.parse(json_object)
+      semantic_similarity = struct.semantic_similarity
+      keywords = struct.keywords
+      new(semantic_similarity: semantic_similarity, keywords: keywords, additional_properties: struct)
+    end
+
+    # Serialize an instance of SearchWeightsRequest to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "semantic_similarity": @semantic_similarity, "keywords": @keywords }.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.semantic_similarity&.is_a?(Float) != false || raise("Passed value for field obj.semantic_similarity is not the expected type, validation failed.")
+      obj.keywords&.is_a?(Float) != false || raise("Passed value for field obj.keywords is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/slim_deployment_read.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "entity_status"
+require_relative "environment_enum"
+require_relative "vellum_variable"
+require "json"
+
+module Vellum
+  class SlimDeploymentRead
+    attr_reader :id, :created, :label, :name, :status, :environment, :last_deployed_on, :input_variables,
+                :additional_properties
+
+    # @param id [String]
+    # @param created [DateTime]
+    # @param label [String] A human-readable label for the deployment
+    # @param name [String] A name that uniquely identifies this deployment within its workspace
+    # @param status [ENTITY_STATUS] The current status of the deployment
+    #   - `ACTIVE` - Active
+    #   - `ARCHIVED` - Archived
+    # @param environment [ENVIRONMENT_ENUM] The environment this deployment is used in
+    #   - `DEVELOPMENT` - Development
+    #   - `STAGING` - Staging
+    #   - `PRODUCTION` - Production
+    # @param last_deployed_on [DateTime]
+    # @param input_variables [Array<VellumVariable>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [SlimDeploymentRead]
+    def initialize(id:, created:, label:, name:, last_deployed_on:, input_variables:, status: nil, environment: nil,
+                   additional_properties: nil)
+      # @type [String]
+      @id = id
+      # @type [DateTime]
+      @created = created
+      # @type [String] A human-readable label for the deployment
+      @label = label
+      # @type [String] A name that uniquely identifies this deployment within its workspace
+      @name = name
+      # @type [ENTITY_STATUS] The current status of the deployment
+      #   - `ACTIVE` - Active
+      #   - `ARCHIVED` - Archived
+      @status = status
+      # @type [ENVIRONMENT_ENUM] The environment this deployment is used in
+      #   - `DEVELOPMENT` - Development
+      #   - `STAGING` - Staging
+      #   - `PRODUCTION` - Production
+      @environment = environment
+      # @type [DateTime]
+      @last_deployed_on = last_deployed_on
+      # @type [Array<VellumVariable>]
+      @input_variables = input_variables
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of SlimDeploymentRead
+    #
+    # @param json_object [JSON]
+    # @return [SlimDeploymentRead]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = struct.id
+      created = DateTime.parse(parsed_json["created"])
+      label = struct.label
+      name = struct.name
+      status = ENTITY_STATUS.key(parsed_json["status"]) || parsed_json["status"]
+      environment = ENVIRONMENT_ENUM.key(parsed_json["environment"]) || parsed_json["environment"]
+      last_deployed_on = DateTime.parse(parsed_json["last_deployed_on"])
+      input_variables = parsed_json["input_variables"].map do |v|
+        v = v.to_json
+        VellumVariable.from_json(json_object: v)
+      end
+      new(id: id, created: created, label: label, name: name, status: status, environment: environment,
+          last_deployed_on: last_deployed_on, input_variables: input_variables, additional_properties: struct)
+    end
+
+    # Serialize an instance of SlimDeploymentRead to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      {
+        "id": @id,
+        "created": @created,
+        "label": @label,
+        "name": @name,
+        "status": ENTITY_STATUS[@status] || @status,
+        "environment": ENVIRONMENT_ENUM[@environment] || @environment,
+        "last_deployed_on": @last_deployed_on,
+        "input_variables": @input_variables
+      }.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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.status&.is_a?(ENTITY_STATUS) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.environment&.is_a?(ENVIRONMENT_ENUM) != false || raise("Passed value for field obj.environment is not the expected type, validation failed.")
+      obj.last_deployed_on.is_a?(DateTime) != false || raise("Passed value for field obj.last_deployed_on is not the expected type, validation failed.")
+      obj.input_variables.is_a?(Array) != false || raise("Passed value for field obj.input_variables is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/slim_document.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "processing_state_enum"
+require_relative "processing_failure_reason_enum"
+require_relative "document_status"
+require_relative "document_document_to_document_index"
+require "json"
+
+module Vellum
+  class SlimDocument
+    attr_reader :id, :external_id, :last_uploaded_at, :label, :processing_state, :processing_failure_reason, :status,
+                :keywords, :metadata, :document_to_document_indexes, :additional_properties
+
+    # @param id [String] Vellum-generated ID that uniquely identifies this document.
+    # @param external_id [String] The external ID that was originally provided when uploading the document.
+    # @param last_uploaded_at [DateTime] A timestamp representing when this document was most recently uploaded.
+    # @param label [String] Human-friendly name for this document.
+    # @param processing_state [PROCESSING_STATE_ENUM] An enum value representing where this document is along its processing lifecycle. Note that this is different than its indexing lifecycle.
+    #   - `QUEUED` - Queued
+    #   - `PROCESSING` - Processing
+    #   - `PROCESSED` - Processed
+    #   - `FAILED` - Failed
+    # @param processing_failure_reason [PROCESSING_FAILURE_REASON_ENUM] An enum value representing why the document could not be processed. Is null unless processing_state is FAILED.
+    #   - `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit
+    #   - `INVALID_FILE` - Invalid File
+    # @param status [DOCUMENT_STATUS] The document's current status.
+    #   - `ACTIVE` - Active
+    # @param keywords [Array<String>] A list of keywords associated with this document. Originally provided when uploading the document.
+    # @param metadata [Hash{String => String}] A previously supplied JSON object containing metadata that can be filtered on when searching.
+    # @param document_to_document_indexes [Array<DocumentDocumentToDocumentIndex>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [SlimDocument]
+    def initialize(id:, last_uploaded_at:, label:, document_to_document_indexes:, external_id: nil, processing_state: nil,
+                   processing_failure_reason: nil, status: nil, keywords: nil, metadata: nil, additional_properties: nil)
+      # @type [String] Vellum-generated ID that uniquely identifies this document.
+      @id = id
+      # @type [String] The external ID that was originally provided when uploading the document.
+      @external_id = external_id
+      # @type [DateTime] A timestamp representing when this document was most recently uploaded.
+      @last_uploaded_at = last_uploaded_at
+      # @type [String] Human-friendly name for this document.
+      @label = label
+      # @type [PROCESSING_STATE_ENUM] An enum value representing where this document is along its processing lifecycle. Note that this is different than its indexing lifecycle.
+      #   - `QUEUED` - Queued
+      #   - `PROCESSING` - Processing
+      #   - `PROCESSED` - Processed
+      #   - `FAILED` - Failed
+      @processing_state = processing_state
+      # @type [PROCESSING_FAILURE_REASON_ENUM] An enum value representing why the document could not be processed. Is null unless processing_state is FAILED.
+      #   - `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit
+      #   - `INVALID_FILE` - Invalid File
+      @processing_failure_reason = processing_failure_reason
+      # @type [DOCUMENT_STATUS] The document's current status.
+      #   - `ACTIVE` - Active
+      @status = status
+      # @type [Array<String>] A list of keywords associated with this document. Originally provided when uploading the document.
+      @keywords = keywords
+      # @type [Hash{String => String}] A previously supplied JSON object containing metadata that can be filtered on when searching.
+      @metadata = metadata
+      # @type [Array<DocumentDocumentToDocumentIndex>]
+      @document_to_document_indexes = document_to_document_indexes
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of SlimDocument
+    #
+    # @param json_object [JSON]
+    # @return [SlimDocument]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = struct.id
+      external_id = struct.external_id
+      last_uploaded_at = DateTime.parse(parsed_json["last_uploaded_at"])
+      label = struct.label
+      processing_state = PROCESSING_STATE_ENUM.key(parsed_json["processing_state"]) || parsed_json["processing_state"]
+      processing_failure_reason = PROCESSING_FAILURE_REASON_ENUM.key(parsed_json["processing_failure_reason"]) || parsed_json["processing_failure_reason"]
+      status = struct.status
+      keywords = struct.keywords
+      metadata = struct.metadata
+      document_to_document_indexes = parsed_json["document_to_document_indexes"].map do |v|
+        v = v.to_json
+        DocumentDocumentToDocumentIndex.from_json(json_object: v)
+      end
+      new(id: id, external_id: external_id, last_uploaded_at: last_uploaded_at, label: label,
+          processing_state: processing_state, processing_failure_reason: processing_failure_reason, status: status, keywords: keywords, metadata: metadata, document_to_document_indexes: document_to_document_indexes, additional_properties: struct)
+    end
+
+    # Serialize an instance of SlimDocument to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      {
+        "id": @id,
+        "external_id": @external_id,
+        "last_uploaded_at": @last_uploaded_at,
+        "label": @label,
+        "processing_state": PROCESSING_STATE_ENUM[@processing_state] || @processing_state,
+        "processing_failure_reason": PROCESSING_FAILURE_REASON_ENUM[@processing_failure_reason] || @processing_failure_reason,
+        "status": @status,
+        "keywords": @keywords,
+        "metadata": @metadata,
+        "document_to_document_indexes": @document_to_document_indexes
+      }.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.id.is_a?(String) != false || raise("Passed value for field obj.id 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.last_uploaded_at.is_a?(DateTime) != false || raise("Passed value for field obj.last_uploaded_at 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.processing_state&.is_a?(PROCESSING_STATE_ENUM) != false || raise("Passed value for field obj.processing_state is not the expected type, validation failed.")
+      obj.processing_failure_reason&.is_a?(PROCESSING_FAILURE_REASON_ENUM) != false || raise("Passed value for field obj.processing_failure_reason is not the expected type, validation failed.")
+      obj.status&.is_a?(String) != false || raise("Passed value for field obj.status 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.")
+      obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+      obj.document_to_document_indexes.is_a?(Array) != false || raise("Passed value for field obj.document_to_document_indexes is not the expected type, validation failed.")
+    end
+  end
+end