openlayer 0.4.1 → 0.6.0

data/lib/openlayer/models/projects/test_create_response.rb

@@ -41,6 +41,16 @@ module Openlayer
         #   @return [Boolean, nil]
         optional :archived, Openlayer::Internal::Type::Boolean
 
+        # @!attribute default_to_all_pipelines
+        #   Whether to apply the test to all pipelines (data sources) or to a specific set
+        #   of pipelines. Only applies to tests that use production data.
+        #
+        #   @return [Boolean, nil]
+        optional :default_to_all_pipelines,
+                 Openlayer::Internal::Type::Boolean,
+                 api_name: :defaultToAllPipelines,
+                 nil?: true
+
         # @!attribute delay_window
         #   The delay window in seconds. Only applies to tests that use production data.
         #
@@ -54,6 +64,36 @@ module Openlayer
         #   @return [Float, nil]
         optional :evaluation_window, Float, api_name: :evaluationWindow, nil?: true
 
+        # @!attribute exclude_pipelines
+        #   Array of pipelines (data sources) to which the test should not be applied. Only
+        #   applies to tests that use production data.
+        #
+        #   @return [Array<String>, nil]
+        optional :exclude_pipelines,
+                 Openlayer::Internal::Type::ArrayOf[String],
+                 api_name: :excludePipelines,
+                 nil?: true
+
+        # @!attribute include_historical_data
+        #   Whether to include historical data in the test result. Only applies to tests
+        #   that use production data.
+        #
+        #   @return [Boolean, nil]
+        optional :include_historical_data,
+                 Openlayer::Internal::Type::Boolean,
+                 api_name: :includeHistoricalData,
+                 nil?: true
+
+        # @!attribute include_pipelines
+        #   Array of pipelines (data sources) to which the test should be applied. Only
+        #   applies to tests that use production data.
+        #
+        #   @return [Array<String>, nil]
+        optional :include_pipelines,
+                 Openlayer::Internal::Type::ArrayOf[String],
+                 api_name: :includePipelines,
+                 nil?: true
+
         # @!attribute uses_ml_model
         #   Whether the test uses an ML model.
         #
@@ -142,7 +182,7 @@ module Openlayer
           required :suggested, Openlayer::Internal::Type::Boolean
         end
 
-        # @!method initialize(id:, comment_count:, creator_id:, date_archived:, date_created:, date_updated:, description:, name:, number:, origin_project_version_id:, subtype:, suggested:, thresholds:, type:, archived: nil, delay_window: nil, evaluation_window: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil)
+        # @!method initialize(id:, comment_count:, creator_id:, date_archived:, date_created:, date_updated:, description:, name:, number:, origin_project_version_id:, subtype:, suggested:, thresholds:, type:, archived: nil, default_to_all_pipelines: nil, delay_window: nil, evaluation_window: nil, exclude_pipelines: nil, include_historical_data: nil, include_pipelines: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil)
         #   Some parameter documentations has been truncated, see
         #   {Openlayer::Models::Projects::TestCreateResponse} for more details.
         #
@@ -176,10 +216,18 @@ module Openlayer
         #
         #   @param archived [Boolean] Whether the test is archived.
         #
+        #   @param default_to_all_pipelines [Boolean, nil] Whether to apply the test to all pipelines (data sources) or to a specific set o
+        #
         #   @param delay_window [Float, nil] The delay window in seconds. Only applies to tests that use production data.
         #
         #   @param evaluation_window [Float, nil] The evaluation window in seconds. Only applies to tests that use production data
         #
+        #   @param exclude_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should not be applied. Only
+        #
+        #   @param include_historical_data [Boolean, nil] Whether to include historical data in the test result. Only applies to tests tha
+        #
+        #   @param include_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should be applied. Only appl
+        #
         #   @param uses_ml_model [Boolean] Whether the test uses an ML model.
         #
         #   @param uses_production_data [Boolean] Whether the test uses production data (monitoring mode only).

data/lib/openlayer/models/projects/test_list_response.rb

@@ -51,6 +51,16 @@ module Openlayer
           #   @return [Boolean, nil]
           optional :archived, Openlayer::Internal::Type::Boolean
 
+          # @!attribute default_to_all_pipelines
+          #   Whether to apply the test to all pipelines (data sources) or to a specific set
+          #   of pipelines. Only applies to tests that use production data.
+          #
+          #   @return [Boolean, nil]
+          optional :default_to_all_pipelines,
+                   Openlayer::Internal::Type::Boolean,
+                   api_name: :defaultToAllPipelines,
+                   nil?: true
+
           # @!attribute delay_window
           #   The delay window in seconds. Only applies to tests that use production data.
           #
@@ -64,6 +74,36 @@ module Openlayer
           #   @return [Float, nil]
           optional :evaluation_window, Float, api_name: :evaluationWindow, nil?: true
 
+          # @!attribute exclude_pipelines
+          #   Array of pipelines (data sources) to which the test should not be applied. Only
+          #   applies to tests that use production data.
+          #
+          #   @return [Array<String>, nil]
+          optional :exclude_pipelines,
+                   Openlayer::Internal::Type::ArrayOf[String],
+                   api_name: :excludePipelines,
+                   nil?: true
+
+          # @!attribute include_historical_data
+          #   Whether to include historical data in the test result. Only applies to tests
+          #   that use production data.
+          #
+          #   @return [Boolean, nil]
+          optional :include_historical_data,
+                   Openlayer::Internal::Type::Boolean,
+                   api_name: :includeHistoricalData,
+                   nil?: true
+
+          # @!attribute include_pipelines
+          #   Array of pipelines (data sources) to which the test should be applied. Only
+          #   applies to tests that use production data.
+          #
+          #   @return [Array<String>, nil]
+          optional :include_pipelines,
+                   Openlayer::Internal::Type::ArrayOf[String],
+                   api_name: :includePipelines,
+                   nil?: true
+
           # @!attribute uses_ml_model
           #   Whether the test uses an ML model.
           #
@@ -154,7 +194,7 @@ module Openlayer
             required :suggested, Openlayer::Internal::Type::Boolean
           end
 
-          # @!method initialize(id:, comment_count:, creator_id:, date_archived:, date_created:, date_updated:, description:, name:, number:, origin_project_version_id:, subtype:, suggested:, thresholds:, type:, archived: nil, delay_window: nil, evaluation_window: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil)
+          # @!method initialize(id:, comment_count:, creator_id:, date_archived:, date_created:, date_updated:, description:, name:, number:, origin_project_version_id:, subtype:, suggested:, thresholds:, type:, archived: nil, default_to_all_pipelines: nil, delay_window: nil, evaluation_window: nil, exclude_pipelines: nil, include_historical_data: nil, include_pipelines: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil)
           #   Some parameter documentations has been truncated, see
           #   {Openlayer::Models::Projects::TestListResponse::Item} for more details.
           #
@@ -188,10 +228,18 @@ module Openlayer
           #
           #   @param archived [Boolean] Whether the test is archived.
           #
+          #   @param default_to_all_pipelines [Boolean, nil] Whether to apply the test to all pipelines (data sources) or to a specific set o
+          #
           #   @param delay_window [Float, nil] The delay window in seconds. Only applies to tests that use production data.
           #
           #   @param evaluation_window [Float, nil] The evaluation window in seconds. Only applies to tests that use production data
           #
+          #   @param exclude_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should not be applied. Only
+          #
+          #   @param include_historical_data [Boolean, nil] Whether to include historical data in the test result. Only applies to tests tha
+          #
+          #   @param include_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should be applied. Only appl
+          #
           #   @param uses_ml_model [Boolean] Whether the test uses an ML model.
           #
           #   @param uses_production_data [Boolean] Whether the test uses production data (monitoring mode only).

data/lib/openlayer/models/test_evaluate_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    # @see Openlayer::Resources::Tests#evaluate
+    class TestEvaluateParams < Openlayer::Internal::Type::BaseModel
+      extend Openlayer::Internal::Type::RequestParameters::Converter
+      include Openlayer::Internal::Type::RequestParameters
+
+      # @!attribute end_timestamp
+      #   End timestamp in seconds (Unix epoch)
+      #
+      #   @return [Integer]
+      required :end_timestamp, Integer, api_name: :endTimestamp
+
+      # @!attribute start_timestamp
+      #   Start timestamp in seconds (Unix epoch)
+      #
+      #   @return [Integer]
+      required :start_timestamp, Integer, api_name: :startTimestamp
+
+      # @!attribute inference_pipeline_id
+      #   ID of the inference pipeline to evaluate. If not provided, all inference
+      #   pipelines the test applies to will be evaluated.
+      #
+      #   @return [String, nil]
+      optional :inference_pipeline_id, String, api_name: :inferencePipelineId
+
+      # @!attribute overwrite_results
+      #   Whether to overwrite existing test results
+      #
+      #   @return [Boolean, nil]
+      optional :overwrite_results, Openlayer::Internal::Type::Boolean, api_name: :overwriteResults
+
+      # @!method initialize(end_timestamp:, start_timestamp:, inference_pipeline_id: nil, overwrite_results: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Openlayer::Models::TestEvaluateParams} for more details.
+      #
+      #   @param end_timestamp [Integer] End timestamp in seconds (Unix epoch)
+      #
+      #   @param start_timestamp [Integer] Start timestamp in seconds (Unix epoch)
+      #
+      #   @param inference_pipeline_id [String] ID of the inference pipeline to evaluate. If not provided, all inference pipelin
+      #
+      #   @param overwrite_results [Boolean] Whether to overwrite existing test results
+      #
+      #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/openlayer/models/test_evaluate_response.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    # @see Openlayer::Resources::Tests#evaluate
+    class TestEvaluateResponse < Openlayer::Internal::Type::BaseModel
+      # @!attribute message
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute pipeline_count
+      #   Number of inference pipelines the test was queued for evaluation on
+      #
+      #   @return [Integer]
+      required :pipeline_count, Integer, api_name: :pipelineCount
+
+      # @!attribute requested_end_timestamp
+      #   The end timestamp you requested (in seconds)
+      #
+      #   @return [Integer]
+      required :requested_end_timestamp, Integer, api_name: :requestedEndTimestamp
+
+      # @!attribute requested_start_timestamp
+      #   The start timestamp you requested (in seconds)
+      #
+      #   @return [Integer]
+      required :requested_start_timestamp, Integer, api_name: :requestedStartTimestamp
+
+      # @!attribute tasks
+      #   Array of background task information for each pipeline evaluation
+      #
+      #   @return [Array<Openlayer::Models::TestEvaluateResponse::Task>]
+      required :tasks, -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::TestEvaluateResponse::Task] }
+
+      # @!method initialize(message:, pipeline_count:, requested_end_timestamp:, requested_start_timestamp:, tasks:)
+      #   @param message [String]
+      #
+      #   @param pipeline_count [Integer] Number of inference pipelines the test was queued for evaluation on
+      #
+      #   @param requested_end_timestamp [Integer] The end timestamp you requested (in seconds)
+      #
+      #   @param requested_start_timestamp [Integer] The start timestamp you requested (in seconds)
+      #
+      #   @param tasks [Array<Openlayer::Models::TestEvaluateResponse::Task>] Array of background task information for each pipeline evaluation
+
+      class Task < Openlayer::Internal::Type::BaseModel
+        # @!attribute pipeline_id
+        #   ID of the inference pipeline this task is for
+        #
+        #   @return [String]
+        required :pipeline_id, String, api_name: :pipelineId
+
+        # @!attribute task_result_id
+        #   ID of the background task
+        #
+        #   @return [String]
+        required :task_result_id, String, api_name: :taskResultId
+
+        # @!attribute task_result_url
+        #   URL to check the status of this background task
+        #
+        #   @return [String]
+        required :task_result_url, String, api_name: :taskResultUrl
+
+        # @!method initialize(pipeline_id:, task_result_id:, task_result_url:)
+        #   @param pipeline_id [String] ID of the inference pipeline this task is for
+        #
+        #   @param task_result_id [String] ID of the background task
+        #
+        #   @param task_result_url [String] URL to check the status of this background task
+      end
+    end
+  end
+end

data/lib/openlayer/models.rb

@@ -58,4 +58,6 @@ module Openlayer
   Projects = Openlayer::Models::Projects
 
   Storage = Openlayer::Models::Storage
+
+  TestEvaluateParams = Openlayer::Models::TestEvaluateParams
 end

data/lib/openlayer/resources/projects/inference_pipelines.rb

@@ -6,7 +6,7 @@ module Openlayer
       class InferencePipelines
         # Create an inference pipeline in a project.
         #
-        # @overload create(project_id, description:, name:, project: nil, workspace: nil, request_options: {})
+        # @overload create(project_id, description:, name:, data_backend: nil, project: nil, workspace: nil, request_options: {})
         #
         # @param project_id [String] The project id.
         #
@@ -14,6 +14,8 @@ module Openlayer
         #
         # @param name [String] The inference pipeline name.
         #
+        # @param data_backend [Openlayer::Models::Projects::InferencePipelineCreateParams::DataBackend::UnionMember0, Openlayer::Models::Projects::InferencePipelineCreateParams::DataBackend::BackendType, Openlayer::Models::Projects::InferencePipelineCreateParams::DataBackend::UnionMember2, Openlayer::Models::Projects::InferencePipelineCreateParams::DataBackend::UnionMember3, Openlayer::Models::Projects::InferencePipelineCreateParams::DataBackend::UnionMember4, Openlayer::Models::Projects::InferencePipelineCreateParams::DataBackend::UnionMember5, nil]
+        #
         # @param project [Openlayer::Models::Projects::InferencePipelineCreateParams::Project, nil]
         #
         # @param workspace [Openlayer::Models::Projects::InferencePipelineCreateParams::Workspace, nil]

data/lib/openlayer/resources/projects/tests.rb

@@ -9,7 +9,7 @@ module Openlayer
         #
         # Create a test.
         #
-        # @overload create(project_id, description:, name:, subtype:, thresholds:, type:, archived: nil, delay_window: nil, evaluation_window: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil, request_options: {})
+        # @overload create(project_id, description:, name:, subtype:, thresholds:, type:, archived: nil, default_to_all_pipelines: nil, delay_window: nil, evaluation_window: nil, exclude_pipelines: nil, include_historical_data: nil, include_pipelines: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil, request_options: {})
         #
         # @param project_id [String] The project id.
         #
@@ -25,10 +25,18 @@ module Openlayer
         #
         # @param archived [Boolean] Whether the test is archived.
         #
+        # @param default_to_all_pipelines [Boolean, nil] Whether to apply the test to all pipelines (data sources) or to a specific set o
+        #
         # @param delay_window [Float, nil] The delay window in seconds. Only applies to tests that use production data.
         #
         # @param evaluation_window [Float, nil] The evaluation window in seconds. Only applies to tests that use production data
         #
+        # @param exclude_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should not be applied. Only
+        #
+        # @param include_historical_data [Boolean, nil] Whether to include historical data in the test result. Only applies to tests tha
+        #
+        # @param include_pipelines [Array<String>, nil] Array of pipelines (data sources) to which the test should be applied. Only appl
+        #
         # @param uses_ml_model [Boolean] Whether the test uses an ML model.
         #
         # @param uses_production_data [Boolean] Whether the test uses production data (monitoring mode only).

data/lib/openlayer/resources/tests.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Tests
+      # Some parameter documentations has been truncated, see
+      # {Openlayer::Models::TestEvaluateParams} for more details.
+      #
+      # Triggers one-off evaluation of a specific monitoring test for a custom timestamp
+      # range. This allows evaluating tests for historical data or custom time periods
+      # outside the regular evaluation window schedule. It also allows overwriting the
+      # existing test results.
+      #
+      # @overload evaluate(test_id, end_timestamp:, start_timestamp:, inference_pipeline_id: nil, overwrite_results: nil, request_options: {})
+      #
+      # @param test_id [String] The test id.
+      #
+      # @param end_timestamp [Integer] End timestamp in seconds (Unix epoch)
+      #
+      # @param start_timestamp [Integer] Start timestamp in seconds (Unix epoch)
+      #
+      # @param inference_pipeline_id [String] ID of the inference pipeline to evaluate. If not provided, all inference pipelin
+      #
+      # @param overwrite_results [Boolean] Whether to overwrite existing test results
+      #
+      # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Openlayer::Models::TestEvaluateResponse]
+      #
+      # @see Openlayer::Models::TestEvaluateParams
+      def evaluate(test_id, params)
+        parsed, options = Openlayer::TestEvaluateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["tests/%1$s/evaluate", test_id],
+          body: parsed,
+          model: Openlayer::Models::TestEvaluateResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Openlayer::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/openlayer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openlayer
-  VERSION = "0.4.1"
+  VERSION = "0.6.0"
 end

data/lib/openlayer.rb

@@ -3,12 +3,14 @@
 # Standard libraries.
 # rubocop:disable Lint/RedundantRequireStatement
 require "English"
+require "base64"
 require "cgi"
 require "date"
 require "erb"
 require "etc"
 require "json"
 require "net/http"
+require "openssl"
 require "pathname"
 require "rbconfig"
 require "securerandom"
@@ -85,6 +87,8 @@ require_relative "openlayer/models/projects/test_update_params"
 require_relative "openlayer/models/projects/test_update_response"
 require_relative "openlayer/models/storage/presigned_url_create_params"
 require_relative "openlayer/models/storage/presigned_url_create_response"
+require_relative "openlayer/models/test_evaluate_params"
+require_relative "openlayer/models/test_evaluate_response"
 require_relative "openlayer/models"
 require_relative "openlayer/resources/commits"
 require_relative "openlayer/resources/commits/test_results"
@@ -98,3 +102,4 @@ require_relative "openlayer/resources/projects/inference_pipelines"
 require_relative "openlayer/resources/projects/tests"
 require_relative "openlayer/resources/storage"
 require_relative "openlayer/resources/storage/presigned_url"
+require_relative "openlayer/resources/tests"

data/manifest.yaml

@@ -1,11 +1,13 @@
 dependencies:
   - English
+  - base64
   - cgi
   - date
   - erb
   - etc
   - json
   - net/http
+  - openssl
   - pathname
   - rbconfig
   - securerandom

data/rbi/openlayer/client.rbi

@@ -25,6 +25,9 @@ module Openlayer
     sig { returns(Openlayer::Resources::Storage) }
     attr_reader :storage
 
+    sig { returns(Openlayer::Resources::Tests) }
+    attr_reader :tests
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/openlayer/internal/transport/base_client.rbi

@@ -176,6 +176,11 @@ module Openlayer
         private def auth_headers
         end
 
+        # @api private
+        sig { returns(String) }
+        private def user_agent
+        end
+
         # @api private
         sig { returns(String) }
         private def generate_idempotency_key

data/rbi/openlayer/internal/transport/pooled_net_requester.rbi

@@ -26,8 +26,12 @@ module Openlayer
 
         class << self
           # @api private
-          sig { params(url: URI::Generic).returns(Net::HTTP) }
-          def connect(url)
+          sig do
+            params(cert_store: OpenSSL::X509::Store, url: URI::Generic).returns(
+              Net::HTTP
+            )
+          end
+          def connect(cert_store:, url:)
           end
 
           # @api private

data/rbi/openlayer/internal/type/base_model.rbi

@@ -31,7 +31,7 @@ module Openlayer
           #
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
-          sig { params(child: T.self_type).void }
+          sig { params(child: Openlayer::Internal::Type::BaseModel).void }
           def inherited(child)
           end
 
@@ -276,9 +276,13 @@ module Openlayer
 
         # Create a new instance of a model.
         sig do
-          params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(
-            T.attached_class
-          )
+          params(
+            data:
+              T.any(
+                T::Hash[Symbol, T.anything],
+                Openlayer::Internal::Type::BaseModel
+              )
+          ).returns(T.attached_class)
         end
         def self.new(data = {})
         end