vellum_ai 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a8a086ffb9bfe7ded5e6aea1f1b241992e42c47f30500677b842a2b03456afb
-  data.tar.gz: 497cc40f80a73cca17e21b9cc83aa0938139fe6708c04655196a0c6507dbc010
+  metadata.gz: e98468526aac99672cba57d3906ddb26843b306b8cca3a0a7f1311ab7309401f
+  data.tar.gz: d565f23d3e92118dff1457cb2f6ded023e8ef8cfcea7536e8ecf0d09c31066ef
 SHA512:
-  metadata.gz: ad9ea9e41a8bcb11c37bebcb11470cb96e43e4100aa7249731120dea482573a7f0ca0f7659af6691cf7d534451780a91cca5abae39c566018ce564e36e9ebd88
-  data.tar.gz: 9af2381c9f3dcfb4859e1e5794b60e2619a3a5540c7828000e7d84662866d93a24a65961cf4173bf16faea38e7aa177a0dc49f43c2f8e003c2582ccabde56ead
+  metadata.gz: 92aa63dada44b2a6ac38f36d57a216751950a7d1b19b0991b21f552a9076cf32155a7b20659f5d429a81946ce6d057d877b4e8df6f1c36f53bdd20133c654737
+  data.tar.gz: 87d055b4d7d15bf13d4676a05e949911e1adf0c071a80d948d9f124de8ec0dd931ad022add751f5ae1b43c0572f941b2ea0798e421e5ce2387aafbf70c5fb8d4

data/lib/requests.rb

@@ -56,7 +56,7 @@ end
     end
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.5.2' }
+      headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.5.3' }
       headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
  headers
     end
@@ -107,7 +107,7 @@ end
     end
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.5.2' }
+      headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.5.3' }
       headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
  headers
     end

data/lib/types_export.rb

@@ -255,10 +255,12 @@ require_relative "vellum_ai/types/image_vellum_value_request"
 require_relative "vellum_ai/types/open_ai_vectorizer_text_embedding_3_small"
 require_relative "vellum_ai/types/open_ai_vectorizer_text_embedding_3_large"
 require_relative "vellum_ai/types/open_ai_vectorizer_text_embedding_ada_002"
+require_relative "vellum_ai/types/private_vectorizer"
 require_relative "vellum_ai/types/indexing_config_vectorizer"
 require_relative "vellum_ai/types/open_ai_vectorizer_text_embedding_3_small_request"
 require_relative "vellum_ai/types/open_ai_vectorizer_text_embedding_3_large_request"
 require_relative "vellum_ai/types/open_ai_vectorizer_text_embedding_ada_002_request"
+require_relative "vellum_ai/types/private_vectorizer_request"
 require_relative "vellum_ai/types/indexing_config_vectorizer_request"
 require_relative "vellum_ai/types/indexing_state_enum"
 require_relative "vellum_ai/types/initiated_prompt_execution_meta"

data/lib/vellum_ai/document_indexes/client.rb

@@ -117,6 +117,7 @@ end
 # Used to retrieve a Document Index given its ID or name.
     #
     # @param id [String] Either the Document Index's ID or its unique name
+    # @param mask_indexing_config [Boolean] Whether to mask the indexing configuration in the response
     # @param request_options [Vellum::RequestOptions] 
     # @return [Vellum::DocumentIndexRead]
     # @example
@@ -126,7 +127,7 @@ end
 #    api_key: "YOUR_API_KEY"
 #  )
 #  api.document_indexes.retrieve(id: "id")
-    def retrieve(id:, request_options: nil)
+    def retrieve(id:, mask_indexing_config: nil, request_options: nil)
       response = @request_client.conn.get do | req |
   unless request_options&.timeout_in_seconds.nil?
     req.options.timeout = request_options.timeout_in_seconds
@@ -140,9 +141,7 @@ end
     req.headers["X-API-Version"] = "2025-07-30"
   end
   req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
-  unless request_options.nil? || request_options&.additional_query_parameters.nil?
-    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-  end
+  req.params = { **(request_options&.additional_query_parameters || {}), "mask_indexing_config": mask_indexing_config }.compact
   unless request_options.nil? || request_options&.additional_body_parameters.nil?
     req.body = { **(request_options&.additional_body_parameters || {}) }.compact
   end
@@ -443,6 +442,7 @@ end
 # Used to retrieve a Document Index given its ID or name.
     #
     # @param id [String] Either the Document Index's ID or its unique name
+    # @param mask_indexing_config [Boolean] Whether to mask the indexing configuration in the response
     # @param request_options [Vellum::RequestOptions] 
     # @return [Vellum::DocumentIndexRead]
     # @example
@@ -452,7 +452,7 @@ end
 #    api_key: "YOUR_API_KEY"
 #  )
 #  api.document_indexes.retrieve(id: "id")
-    def retrieve(id:, request_options: nil)
+    def retrieve(id:, mask_indexing_config: nil, request_options: nil)
       Async do
         response = @request_client.conn.get do | req |
   unless request_options&.timeout_in_seconds.nil?
@@ -467,9 +467,7 @@ end
     req.headers["X-API-Version"] = "2025-07-30"
   end
   req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
-  unless request_options.nil? || request_options&.additional_query_parameters.nil?
-    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-  end
+  req.params = { **(request_options&.additional_query_parameters || {}), "mask_indexing_config": mask_indexing_config }.compact
   unless request_options.nil? || request_options&.additional_body_parameters.nil?
     req.body = { **(request_options&.additional_body_parameters || {}) }.compact
   end

data/lib/vellum_ai/types/indexing_config_vectorizer.rb

@@ -11,6 +11,7 @@ require_relative "google_vertex_ai_vectorizer_text_embedding_004"
 require_relative "google_vertex_ai_vectorizer_text_multilingual_embedding_002"
 require_relative "google_vertex_ai_vectorizer_gemini_embedding_001"
 require_relative "fast_embed_vectorizer_baai_bge_small_en_v_15"
+require_relative "private_vectorizer"
 
 module Vellum
   class IndexingConfigVectorizer
@@ -128,6 +129,16 @@ end
   return Vellum::FastEmbedVectorizerBaaiBgeSmallEnV15.from_json(json_object: struct)
 else
   return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::PrivateVectorizer.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::PrivateVectorizer.from_json(json_object: struct)
+else
+  return nil
 end
       rescue StandardError
         # noop
@@ -196,6 +207,11 @@ end
       rescue StandardError
         # noop
       end
+      begin
+        return Vellum::PrivateVectorizer.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
       raise("Passed value matched no type within the union, validation failed.")
     end
   end

data/lib/vellum_ai/types/indexing_config_vectorizer_request.rb

@@ -11,6 +11,7 @@ require_relative "google_vertex_ai_vectorizer_text_embedding_004_request"
 require_relative "google_vertex_ai_vectorizer_text_multilingual_embedding_002_request"
 require_relative "google_vertex_ai_vectorizer_gemini_embedding_001_request"
 require_relative "fast_embed_vectorizer_baai_bge_small_en_v_15_request"
+require_relative "private_vectorizer_request"
 
 module Vellum
   class IndexingConfigVectorizerRequest
@@ -128,6 +129,16 @@ end
   return Vellum::FastEmbedVectorizerBaaiBgeSmallEnV15Request.from_json(json_object: struct)
 else
   return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::PrivateVectorizerRequest.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::PrivateVectorizerRequest.from_json(json_object: struct)
+else
+  return nil
 end
       rescue StandardError
         # noop
@@ -196,6 +207,11 @@ end
       rescue StandardError
         # noop
       end
+      begin
+        return Vellum::PrivateVectorizerRequest.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
       raise("Passed value matched no type within the union, validation failed.")
     end
   end

data/lib/vellum_ai/types/private_vectorizer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+# Serializer for private vectorizer.
+  class PrivateVectorizer
+  # @return [String] 
+    attr_reader :model_name
+  # @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 model_name [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::PrivateVectorizer]
+    def initialize(model_name:, additional_properties: nil)
+      @model_name = model_name
+      @additional_properties = additional_properties
+      @_field_set = { "model_name": model_name }
+    end
+# Deserialize a JSON object to an instance of PrivateVectorizer
+    #
+    # @param json_object [String] 
+    # @return [Vellum::PrivateVectorizer]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      model_name = parsed_json["model_name"]
+      new(model_name: model_name, additional_properties: struct)
+    end
+# Serialize an instance of PrivateVectorizer 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.model_name.is_a?(String) != false || raise("Passed value for field obj.model_name is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/private_vectorizer_request.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+# Serializer for private vectorizer.
+  class PrivateVectorizerRequest
+  # @return [String] 
+    attr_reader :model_name
+  # @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 model_name [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::PrivateVectorizerRequest]
+    def initialize(model_name:, additional_properties: nil)
+      @model_name = model_name
+      @additional_properties = additional_properties
+      @_field_set = { "model_name": model_name }
+    end
+# Deserialize a JSON object to an instance of PrivateVectorizerRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::PrivateVectorizerRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      model_name = parsed_json["model_name"]
+      new(model_name: model_name, additional_properties: struct)
+    end
+# Serialize an instance of PrivateVectorizerRequest 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.model_name.is_a?(String) != false || raise("Passed value for field obj.model_name is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/vellum_error_code_enum.rb

@@ -4,7 +4,7 @@ module Vellum
 # * `INVALID_REQUEST` - INVALID_REQUEST
 #  * `INVALID_INPUTS` - INVALID_INPUTS
 #  * `PROVIDER_ERROR` - PROVIDER_ERROR
-#  * `PROVIDER_CREDENTIALS_AVAILABLE` - PROVIDER_CREDENTIALS_UNAVAILABLE
+#  * `PROVIDER_CREDENTIALS_UNAVAILABLE` - PROVIDER_CREDENTIALS_UNAVAILABLE
 #  * `REQUEST_TIMEOUT` - REQUEST_TIMEOUT
 #  * `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR
 #  * `USER_DEFINED_ERROR` - USER_DEFINED_ERROR
@@ -14,7 +14,7 @@ module Vellum
     INVALID_REQUEST = "INVALID_REQUEST"
     INVALID_INPUTS = "INVALID_INPUTS"
     PROVIDER_ERROR = "PROVIDER_ERROR"
-    PROVIDER_CREDENTIALS_AVAILABLE = "PROVIDER_CREDENTIALS_AVAILABLE"
+    PROVIDER_CREDENTIALS_UNAVAILABLE = "PROVIDER_CREDENTIALS_UNAVAILABLE"
     REQUEST_TIMEOUT = "REQUEST_TIMEOUT"
     INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR"
     USER_DEFINED_ERROR = "USER_DEFINED_ERROR"

data/lib/vellum_ai/workflow_deployments/client.rb

@@ -109,6 +109,7 @@ end
     # @param filters [String] 
     # @param limit [Integer] Number of executions to return per page.
     # @param offset [Integer] The initial index from which to return the executions.
+    # @param ordering [String] 
     # @param request_options [Vellum::RequestOptions] 
     # @return [Vellum::WorkflowDeploymentEventExecutionsResponse]
     # @example
@@ -118,7 +119,7 @@ end
 #    api_key: "YOUR_API_KEY"
 #  )
 #  api.workflow_deployments.list_workflow_deployment_event_executions(id: "id")
-    def list_workflow_deployment_event_executions(id:, filters: nil, limit: nil, offset: nil, request_options: nil)
+    def list_workflow_deployment_event_executions(id:, filters: nil, limit: nil, offset: nil, ordering: nil, request_options: nil)
       response = @request_client.conn.get do | req |
   unless request_options&.timeout_in_seconds.nil?
     req.options.timeout = request_options.timeout_in_seconds
@@ -132,7 +133,7 @@ end
     req.headers["X-API-Version"] = "2025-07-30"
   end
   req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
-  req.params = { **(request_options&.additional_query_parameters || {}), "filters": filters, "limit": limit, "offset": offset }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "filters": filters, "limit": limit, "offset": offset, "ordering": ordering }.compact
   unless request_options.nil? || request_options&.additional_body_parameters.nil?
     req.body = { **(request_options&.additional_body_parameters || {}) }.compact
   end
@@ -463,6 +464,7 @@ end
     # @param filters [String] 
     # @param limit [Integer] Number of executions to return per page.
     # @param offset [Integer] The initial index from which to return the executions.
+    # @param ordering [String] 
     # @param request_options [Vellum::RequestOptions] 
     # @return [Vellum::WorkflowDeploymentEventExecutionsResponse]
     # @example
@@ -472,7 +474,7 @@ end
 #    api_key: "YOUR_API_KEY"
 #  )
 #  api.workflow_deployments.list_workflow_deployment_event_executions(id: "id")
-    def list_workflow_deployment_event_executions(id:, filters: nil, limit: nil, offset: nil, request_options: nil)
+    def list_workflow_deployment_event_executions(id:, filters: nil, limit: nil, offset: nil, ordering: nil, request_options: nil)
       Async do
         response = @request_client.conn.get do | req |
   unless request_options&.timeout_in_seconds.nil?
@@ -487,7 +489,7 @@ end
     req.headers["X-API-Version"] = "2025-07-30"
   end
   req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
-  req.params = { **(request_options&.additional_query_parameters || {}), "filters": filters, "limit": limit, "offset": offset }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "filters": filters, "limit": limit, "offset": offset, "ordering": ordering }.compact
   unless request_options.nil? || request_options&.additional_body_parameters.nil?
     req.body = { **(request_options&.additional_body_parameters || {}) }.compact
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vellum_ai
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - Vellum
@@ -497,6 +497,8 @@ files:
 - lib/vellum_ai/types/pdf_search_result_meta_source_request.rb
 - lib/vellum_ai/types/plain_text_prompt_block.rb
 - lib/vellum_ai/types/price.rb
+- lib/vellum_ai/types/private_vectorizer.rb
+- lib/vellum_ai/types/private_vectorizer_request.rb
 - lib/vellum_ai/types/processing_failure_reason_enum.rb
 - lib/vellum_ai/types/prompt_block.rb
 - lib/vellum_ai/types/prompt_block_state.rb