vellum_ai 0.3.15 → 0.14.75

data/lib/vellum_ai/types/document_chat_message_content.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require_relative "vellum_document"
+require "ostruct"
+require "json"
+
+module Vellum
+# A document value that is used in a chat message.
+  class DocumentChatMessageContent
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::VellumDocument] 
+    attr_reader :value
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param type [String] 
+    # @param value [Vellum::VellumDocument] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::DocumentChatMessageContent]
+    def initialize(type:, value:, additional_properties: nil)
+      @type = type
+      @value = value
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value }
+    end
+# Deserialize a JSON object to an instance of DocumentChatMessageContent
+    #
+    # @param json_object [String] 
+    # @return [Vellum::DocumentChatMessageContent]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      unless parsed_json["value"].nil?
+        value = parsed_json["value"].to_json
+        value = Vellum::VellumDocument.from_json(json_object: value)
+      else
+        value = nil
+      end
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of DocumentChatMessageContent 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::VellumDocument.validate_raw(obj: obj.value)
+    end
+  end
+end

data/lib/vellum_ai/types/document_chat_message_content_request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require_relative "vellum_document_request"
+require "ostruct"
+require "json"
+
+module Vellum
+# A document value that is used in a chat message.
+  class DocumentChatMessageContentRequest
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::VellumDocumentRequest] 
+    attr_reader :value
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param type [String] 
+    # @param value [Vellum::VellumDocumentRequest] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::DocumentChatMessageContentRequest]
+    def initialize(type:, value:, additional_properties: nil)
+      @type = type
+      @value = value
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value }
+    end
+# Deserialize a JSON object to an instance of DocumentChatMessageContentRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::DocumentChatMessageContentRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      unless parsed_json["value"].nil?
+        value = parsed_json["value"].to_json
+        value = Vellum::VellumDocumentRequest.from_json(json_object: value)
+      else
+        value = nil
+      end
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of DocumentChatMessageContentRequest 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::VellumDocumentRequest.validate_raw(obj: obj.value)
+    end
+  end
+end

data/lib/vellum_ai/types/document_document_to_document_index.rb

@@ -1,70 +1,103 @@
 # frozen_string_literal: true
-
 require_relative "indexing_state_enum"
+require "ostruct"
 require "json"
 
 module Vellum
+# A detailed representation of the link between a Document and a Document Index
+#  it's a member of.
   class DocumentDocumentToDocumentIndex
-    attr_reader :id, :document_index_id, :indexing_state, :additional_properties
+  # @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 [String] 
+    attr_reader :extracted_text_file_url
+  # @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 document_index_id [String] Vellum-generated ID that uniquely identifies the index this document is included in.
-    # @param indexing_state [INDEXING_STATE_ENUM] 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 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 extracted_text_file_url [String] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [DocumentDocumentToDocumentIndex]
-    def initialize(id:, document_index_id:, indexing_state: nil, additional_properties: nil)
-      # @type [String] Vellum-generated ID that uniquely identifies this link.
+    # @return [Vellum::DocumentDocumentToDocumentIndex]
+    def initialize(id:, environment_document_index_id:, document_index_id:, indexing_state: OMIT, extracted_text_file_url: OMIT, additional_properties: nil)
       @id = id
-      # @type [String] Vellum-generated ID that uniquely identifies the index this document is included in.
+      @environment_document_index_id = environment_document_index_id
       @document_index_id = document_index_id
-      # @type [INDEXING_STATE_ENUM] 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
-      @indexing_state = indexing_state
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @indexing_state = indexing_state if indexing_state != OMIT
+      @extracted_text_file_url = extracted_text_file_url if extracted_text_file_url != 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, "extracted_text_file_url": extracted_text_file_url }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of DocumentDocumentToDocumentIndex
+# Deserialize a JSON object to an instance of DocumentDocumentToDocumentIndex
     #
-    # @param json_object [JSON]
-    # @return [DocumentDocumentToDocumentIndex]
+    # @param json_object [String] 
+    # @return [Vellum::DocumentDocumentToDocumentIndex]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      id = struct.id
-      document_index_id = struct.document_index_id
-      indexing_state = INDEXING_STATE_ENUM.key(parsed_json["indexing_state"]) || parsed_json["indexing_state"]
-      new(id: id, document_index_id: document_index_id, indexing_state: indexing_state, additional_properties: struct)
+      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"]
+      extracted_text_file_url = parsed_json["extracted_text_file_url"]
+      new(
+        id: id,
+        environment_document_index_id: environment_document_index_id,
+        document_index_id: document_index_id,
+        indexing_state: indexing_state,
+        extracted_text_file_url: extracted_text_file_url,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of DocumentDocumentToDocumentIndex to a JSON object
+# Serialize an instance of DocumentDocumentToDocumentIndex to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      {
-        "id": @id,
-        "document_index_id": @document_index_id,
-        "indexing_state": INDEXING_STATE_ENUM[@indexing_state] || @indexing_state
-      }.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.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?(INDEXING_STATE_ENUM) != false || raise("Passed value for field obj.indexing_state 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.")
+      obj.extracted_text_file_url&.is_a?(String) != false || raise("Passed value for field obj.extracted_text_file_url is not the expected type, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/document_index_chunking.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+require "json"
+require_relative "reducto_chunking"
+require_relative "sentence_chunking"
+require_relative "token_overlapping_window_chunking"
+
+module Vellum
+  class DocumentIndexChunking
+
+
+# Deserialize a JSON object to an instance of DocumentIndexChunking
+    #
+    # @param json_object [String] 
+    # @return [Vellum::DocumentIndexChunking]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vellum::ReductoChunking.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ReductoChunking.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::SentenceChunking.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::SentenceChunking.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::TokenOverlappingWindowChunking.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::TokenOverlappingWindowChunking.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+ return struct
+    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:)
+      begin
+        return Vellum::ReductoChunking.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::SentenceChunking.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::TokenOverlappingWindowChunking.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/document_index_chunking_request.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+require "json"
+require_relative "reducto_chunking_request"
+require_relative "sentence_chunking_request"
+require_relative "token_overlapping_window_chunking_request"
+
+module Vellum
+  class DocumentIndexChunkingRequest
+
+
+# Deserialize a JSON object to an instance of DocumentIndexChunkingRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::DocumentIndexChunkingRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vellum::ReductoChunkingRequest.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ReductoChunkingRequest.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::SentenceChunkingRequest.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::SentenceChunkingRequest.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::TokenOverlappingWindowChunkingRequest.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::TokenOverlappingWindowChunkingRequest.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+ return struct
+    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:)
+      begin
+        return Vellum::ReductoChunkingRequest.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::SentenceChunkingRequest.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::TokenOverlappingWindowChunkingRequest.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/document_index_indexing_config.rb

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

data/lib/vellum_ai/types/document_index_indexing_config_request.rb

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