vellum_ai 0.3.15 → 0.14.75

data/lib/vellum_ai/types/sentence_chunking_request.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require_relative "sentence_chunker_config_request"
+require "ostruct"
+require "json"
+
+module Vellum
+# Sentence chunking
+  class SentenceChunkingRequest
+  # @return [String] 
+    attr_reader :chunker_name
+  # @return [Vellum::SentenceChunkerConfigRequest] 
+    attr_reader :chunker_config
+  # @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 chunker_name [String] 
+    # @param chunker_config [Vellum::SentenceChunkerConfigRequest] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::SentenceChunkingRequest]
+    def initialize(chunker_name:, chunker_config: OMIT, additional_properties: nil)
+      @chunker_name = chunker_name
+      @chunker_config = chunker_config if chunker_config != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "chunker_name": chunker_name, "chunker_config": chunker_config }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of SentenceChunkingRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::SentenceChunkingRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      chunker_name = parsed_json["chunker_name"]
+      unless parsed_json["chunker_config"].nil?
+        chunker_config = parsed_json["chunker_config"].to_json
+        chunker_config = Vellum::SentenceChunkerConfigRequest.from_json(json_object: chunker_config)
+      else
+        chunker_config = nil
+      end
+      new(
+        chunker_name: chunker_name,
+        chunker_config: chunker_config,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of SentenceChunkingRequest 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.chunker_name.is_a?(String) != false || raise("Passed value for field obj.chunker_name is not the expected type, validation failed.")
+      obj.chunker_config.nil? || Vellum::SentenceChunkerConfigRequest.validate_raw(obj: obj.chunker_config)
+    end
+  end
+end

data/lib/vellum_ai/types/slim_deployment_read.rb

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

data/lib/vellum_ai/types/slim_document.rb

@@ -1,126 +1,143 @@
 # frozen_string_literal: true
-
 require "date"
-require_relative "processing_state_enum"
+require_relative "document_processing_state"
 require_relative "processing_failure_reason_enum"
 require_relative "document_status"
-require_relative "document_document_to_document_index"
+require_relative "slim_document_document_to_document_index"
+require "ostruct"
 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
+  # @return [String] Vellum-generated ID that uniquely identifies this document.
+    attr_reader :id
+  # @return [String] The external ID that was originally provided when uploading the document.
+    attr_reader :external_id
+  # @return [DateTime] A timestamp representing when this document was most recently uploaded.
+    attr_reader :last_uploaded_at
+  # @return [String] Human-friendly name for this document.
+    attr_reader :label
+  # @return [Vellum::DocumentProcessingState] 
+    attr_reader :processing_state
+  # @return [Vellum::ProcessingFailureReasonEnum] 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
+    attr_reader :processing_failure_reason
+  # @return [Vellum::DOCUMENT_STATUS] The document's current status.
+#  * `ACTIVE` - Active
+    attr_reader :status
+  # @return [Array<String>] A list of keywords associated with this document. Originally provided when
+#  uploading the document.
+    attr_reader :keywords
+  # @return [Hash{String => Object}] A previously supplied JSON object containing metadata that can be filtered on
+#  when searching.
+    attr_reader :metadata
+  # @return [Array<Vellum::SlimDocumentDocumentToDocumentIndex>] 
+    attr_reader :document_to_document_indexes
+  # @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] 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 processing_state [Vellum::DocumentProcessingState] 
+    # @param processing_failure_reason [Vellum::ProcessingFailureReasonEnum] 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 [Vellum::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 => Object}] A previously supplied JSON object containing metadata that can be filtered on
+#  when searching.
+    # @param document_to_document_indexes [Array<Vellum::SlimDocumentDocumentToDocumentIndex>] 
     # @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.
+    # @return [Vellum::SlimDocument]
+    def initialize(id:, external_id: OMIT, last_uploaded_at:, label:, processing_state:, processing_failure_reason: OMIT, status: OMIT, keywords: OMIT, metadata: OMIT, document_to_document_indexes:, additional_properties: nil)
       @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.
+      @external_id = external_id if external_id != OMIT
       @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>]
+      @processing_failure_reason = processing_failure_reason if processing_failure_reason != OMIT
+      @status = status if status != OMIT
+      @keywords = keywords if keywords != OMIT
+      @metadata = metadata if metadata != OMIT
       @document_to_document_indexes = document_to_document_indexes
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
+      @_field_set = { "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 }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of SlimDocument
+# Deserialize a JSON object to an instance of SlimDocument
     #
-    # @param json_object [JSON]
-    # @return [SlimDocument]
+    # @param json_object [String] 
+    # @return [Vellum::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)
+      id = parsed_json["id"]
+      external_id = parsed_json["external_id"]
+      last_uploaded_at = unless parsed_json["last_uploaded_at"].nil?
+  DateTime.parse(parsed_json["last_uploaded_at"])
+else
+  nil
+end
+      label = parsed_json["label"]
+      processing_state = parsed_json["processing_state"]
+      processing_failure_reason = parsed_json["processing_failure_reason"]
+      status = parsed_json["status"]
+      keywords = parsed_json["keywords"]
+      metadata = parsed_json["metadata"]
+      document_to_document_indexes = parsed_json["document_to_document_indexes"]&.map do | item |
+  item = item.to_json
+  Vellum::SlimDocumentDocumentToDocumentIndex.from_json(json_object: item)
+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
+# 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
+    # @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.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.processing_state.is_a?(Vellum::DocumentProcessingState) != false || raise("Passed value for field obj.processing_state is not the expected type, validation failed.")
+      obj.processing_failure_reason&.is_a?(Vellum::ProcessingFailureReasonEnum) != 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
+end

data/lib/vellum_ai/types/slim_document_document_to_document_index.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+require_relative "indexing_state_enum"
+require "ostruct"
+require "json"
+
+module Vellum
+# A slim representation of the link between a Document and a Document Index it's a
+#  member of.
+  class SlimDocumentDocumentToDocumentIndex
+  # @return [String] Vellum-generated ID that uniquely identifies this link.
+    attr_reader :id
+  # @return [String] Vellum-generated ID that uniquely identifies the environment index this document
+#  is included in.
+    attr_reader :environment_document_index_id
+  # @return [String] Vellum-generated ID that uniquely identifies the index this document is included
+#  in.
+    attr_reader :document_index_id
+  # @return [Vellum::IndexingStateEnum] An enum value representing where this document is along its indexing lifecycle
+#  for this index.
+#  * `AWAITING_PROCESSING` - Awaiting Processing
+#  * `QUEUED` - Queued
+#  * `INDEXING` - Indexing
+#  * `INDEXED` - Indexed
+#  * `FAILED` - Failed
+    attr_reader :indexing_state
+  # @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] Vellum-generated ID that uniquely identifies this link.
+    # @param environment_document_index_id [String] Vellum-generated ID that uniquely identifies the environment index this document
+#  is included in.
+    # @param document_index_id [String] Vellum-generated ID that uniquely identifies the index this document is included
+#  in.
+    # @param indexing_state [Vellum::IndexingStateEnum] An enum value representing where this document is along its indexing lifecycle
+#  for this index.
+#  * `AWAITING_PROCESSING` - Awaiting Processing
+#  * `QUEUED` - Queued
+#  * `INDEXING` - Indexing
+#  * `INDEXED` - Indexed
+#  * `FAILED` - Failed
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::SlimDocumentDocumentToDocumentIndex]
+    def initialize(id:, environment_document_index_id:, document_index_id:, indexing_state: OMIT, additional_properties: nil)
+      @id = id
+      @environment_document_index_id = environment_document_index_id
+      @document_index_id = document_index_id
+      @indexing_state = indexing_state if indexing_state != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "environment_document_index_id": environment_document_index_id, "document_index_id": document_index_id, "indexing_state": indexing_state }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of SlimDocumentDocumentToDocumentIndex
+    #
+    # @param json_object [String] 
+    # @return [Vellum::SlimDocumentDocumentToDocumentIndex]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      environment_document_index_id = parsed_json["environment_document_index_id"]
+      document_index_id = parsed_json["document_index_id"]
+      indexing_state = parsed_json["indexing_state"]
+      new(
+        id: id,
+        environment_document_index_id: environment_document_index_id,
+        document_index_id: document_index_id,
+        indexing_state: indexing_state,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of SlimDocumentDocumentToDocumentIndex 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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.environment_document_index_id.is_a?(String) != false || raise("Passed value for field obj.environment_document_index_id is not the expected type, validation failed.")
+      obj.document_index_id.is_a?(String) != false || raise("Passed value for field obj.document_index_id is not the expected type, validation failed.")
+      obj.indexing_state&.is_a?(Vellum::IndexingStateEnum) != false || raise("Passed value for field obj.indexing_state is not the expected type, validation failed.")
+    end
+  end
+end