vellum_ai 0.3.9 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72a042dfa14e5c853594fed021ab79235d7493790da8e34280f66c6f448fb1db
-  data.tar.gz: 25ddfca2df59cc444d7e4c63cf221f8bb3274a660253183a165c5741ed4de8b4
+  metadata.gz: 7ee15857c4f6d078afa21d87b58baf72fa919289417db31edd4d749d76616dac
+  data.tar.gz: 2b3ef152052326857531cfcea45ee4baa5ec17285aeceab9f1e1fb42719e08f7
 SHA512:
-  metadata.gz: b0de23219672cbb8def515bc8fa00b31e0209b3914ca4284f103fbb21a9022d51830ff802d1b924599bbd8443ff40b7de721d9e265d1792acb8d736c58c5150e
-  data.tar.gz: a7cd6b831b2937bd112d934bb6d9a1d57a20594cc567296568bd3271632b29ab082c25d2b11e2fe872579f26b26e2a1c0067ae6d6f5a754f089ba0a15b0b5593
+  metadata.gz: 46b1deb69aee31554a0fef8440a43de43027687f2be4d39c39491a3b0221852961a00759ad42837ce6d2ad16a0aea89ecd2a7671e387e70fa3ac91c1093c7879
+  data.tar.gz: d9325756359ce00b83ba6fa59f6ae988e801c04e420645ae653e43f592a5ae702caac0ccc00c58e026c2ce4f92bd0490c99a6cf25c1865e689e3295d47a5440e

data/lib/requests.rb

@@ -20,7 +20,7 @@ module Vellum
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "Vellum",
-        "X-Fern-SDK-Version": "0.3.9",
+        "X-Fern-SDK-Version": "0.3.10",
         "X_API_KEY": api_key.to_s
       }
       @conn = Faraday.new(headers: @headers) do |faraday|
@@ -46,7 +46,7 @@ module Vellum
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "Vellum",
-        "X-Fern-SDK-Version": "0.3.9",
+        "X-Fern-SDK-Version": "0.3.10",
         "X_API_KEY": api_key.to_s
       }
       @conn = Faraday.new(headers: @headers) do |faraday|

data/lib/types_export.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "vellum_ai/deployments/types/deployments_list_request_status"
+require_relative "vellum_ai/document_indexes/types/document_indexes_list_request_status"
 require_relative "vellum_ai/workflow_deployments/types/workflow_deployments_list_request_status"
 require_relative "vellum_ai/types/api_node_result"
 require_relative "vellum_ai/types/api_node_result_data"
@@ -123,6 +124,7 @@ require_relative "vellum_ai/types/normalized_log_probs"
 require_relative "vellum_ai/types/normalized_token_log_probs"
 require_relative "vellum_ai/types/number_enum"
 require_relative "vellum_ai/types/number_variable_value"
+require_relative "vellum_ai/types/paginated_document_index_read_list"
 require_relative "vellum_ai/types/paginated_slim_deployment_read_list"
 require_relative "vellum_ai/types/paginated_slim_document_list"
 require_relative "vellum_ai/types/paginated_slim_workflow_deployment_list"

data/lib/vellum_ai/document_indexes/client.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
+require_relative "types/document_indexes_list_request_status"
+require_relative "../types/paginated_document_index_read_list"
 require_relative "../types/entity_status"
 require_relative "../types/environment_enum"
 require_relative "../types/document_index_read"
@@ -17,6 +19,33 @@ module Vellum
       @request_client = request_client
     end
 
+    # Used to retrieve a list of Document Indexes.
+    #
+    # @param limit [Integer] Number of results to return per page.
+    # @param offset [Integer] The initial index from which to return the results.
+    # @param ordering [String] Which field to use when ordering the results.
+    # @param status [DOCUMENT_INDEXES_LIST_REQUEST_STATUS] The current status of the document index
+    #   - `ACTIVE` - Active
+    #   - `ARCHIVED` - Archived
+    # @param request_options [RequestOptions]
+    # @return [PaginatedDocumentIndexReadList]
+    def list(limit: nil, offset: nil, ordering: nil, status: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "limit": limit,
+          "offset": offset,
+          "ordering": ordering,
+          "status": status
+        }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/document-indexes"
+      end
+      PaginatedDocumentIndexReadList.from_json(json_object: response.body)
+    end
+
     # Creates a new document index.
     #
     # @param label [String] A human-readable label for the document index
@@ -78,6 +107,35 @@ module Vellum
       @request_client = request_client
     end
 
+    # Used to retrieve a list of Document Indexes.
+    #
+    # @param limit [Integer] Number of results to return per page.
+    # @param offset [Integer] The initial index from which to return the results.
+    # @param ordering [String] Which field to use when ordering the results.
+    # @param status [DOCUMENT_INDEXES_LIST_REQUEST_STATUS] The current status of the document index
+    #   - `ACTIVE` - Active
+    #   - `ARCHIVED` - Archived
+    # @param request_options [RequestOptions]
+    # @return [PaginatedDocumentIndexReadList]
+    def list(limit: nil, offset: nil, ordering: nil, status: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "limit": limit,
+            "offset": offset,
+            "ordering": ordering,
+            "status": status
+          }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/document-indexes"
+        end
+        PaginatedDocumentIndexReadList.from_json(json_object: response.body)
+      end
+    end
+
     # Creates a new document index.
     #
     # @param label [String] A human-readable label for the document index

data/lib/vellum_ai/document_indexes/types/document_indexes_list_request_status.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vellum
+  module DocumentIndexes
+    # @type [DOCUMENT_INDEXES_LIST_REQUEST_STATUS]
+    DOCUMENT_INDEXES_LIST_REQUEST_STATUS = { active: "ACTIVE", archived: "ARCHIVED" }.freeze
+  end
+end

data/lib/vellum_ai/types/paginated_document_index_read_list.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "document_index_read"
+require "json"
+
+module Vellum
+  class PaginatedDocumentIndexReadList
+    attr_reader :count, :next_, :previous, :results, :additional_properties
+
+    # @param count [Integer]
+    # @param next_ [String]
+    # @param previous [String]
+    # @param results [Array<DocumentIndexRead>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [PaginatedDocumentIndexReadList]
+    def initialize(count: nil, next_: nil, previous: nil, results: nil, additional_properties: nil)
+      # @type [Integer]
+      @count = count
+      # @type [String]
+      @next_ = next_
+      # @type [String]
+      @previous = previous
+      # @type [Array<DocumentIndexRead>]
+      @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 PaginatedDocumentIndexReadList
+    #
+    # @param json_object [JSON]
+    # @return [PaginatedDocumentIndexReadList]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      count = struct.count
+      next_ = struct.next
+      previous = struct.previous
+      results = parsed_json["results"].map do |v|
+        v = v.to_json
+        DocumentIndexRead.from_json(json_object: v)
+      end
+      new(count: count, next_: next_, previous: previous, results: results, additional_properties: struct)
+    end
+
+    # Serialize an instance of PaginatedDocumentIndexReadList to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "count": @count, "next": @next_, "previous": @previous, "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.count&.is_a?(Integer) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
+      obj.next_&.is_a?(String) != false || raise("Passed value for field obj.next_ is not the expected type, validation failed.")
+      obj.previous&.is_a?(String) != false || raise("Passed value for field obj.previous is not the expected type, validation failed.")
+      obj.results&.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vellum_ai
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.10
 platform: ruby
 authors:
 - Vellum
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -95,6 +95,7 @@ files:
 - lib/vellum_ai/deployments/client.rb
 - lib/vellum_ai/deployments/types/deployments_list_request_status.rb
 - lib/vellum_ai/document_indexes/client.rb
+- lib/vellum_ai/document_indexes/types/document_indexes_list_request_status.rb
 - lib/vellum_ai/documents/client.rb
 - lib/vellum_ai/folder_entities/client.rb
 - lib/vellum_ai/model_versions/client.rb
@@ -222,6 +223,7 @@ files:
 - lib/vellum_ai/types/normalized_token_log_probs.rb
 - lib/vellum_ai/types/number_enum.rb
 - lib/vellum_ai/types/number_variable_value.rb
+- lib/vellum_ai/types/paginated_document_index_read_list.rb
 - lib/vellum_ai/types/paginated_slim_deployment_read_list.rb
 - lib/vellum_ai/types/paginated_slim_document_list.rb
 - lib/vellum_ai/types/paginated_slim_workflow_deployment_list.rb