openlayer 0.3.0 → 0.4.0

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class InferencePipelines
+      class TestResults
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::InferencePipelines::TestResultListParams} for more details.
+        #
+        # List the latest test results for an inference pipeline.
+        #
+        # @overload list(inference_pipeline_id, page: nil, per_page: nil, status: nil, type: nil, request_options: {})
+        #
+        # @param inference_pipeline_id [String] The inference pipeline id (a UUID).
+        #
+        # @param page [Integer] The page to return in a paginated query.
+        #
+        # @param per_page [Integer] Maximum number of items to return per page.
+        #
+        # @param status [Symbol, Openlayer::Models::InferencePipelines::TestResultListParams::Status] Filter list of test results by status. Available statuses are `running`, `passin
+        #
+        # @param type [Symbol, Openlayer::Models::InferencePipelines::TestResultListParams::Type] Filter objects by test type. Available types are `integrity`, `consistency`, `pe
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::InferencePipelines::TestResultListResponse]
+        #
+        # @see Openlayer::Models::InferencePipelines::TestResultListParams
+        def list(inference_pipeline_id, params = {})
+          parsed, options = Openlayer::InferencePipelines::TestResultListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["inference-pipelines/%1$s/results", inference_pipeline_id],
+            query: parsed.transform_keys(per_page: "perPage"),
+            model: Openlayer::Models::InferencePipelines::TestResultListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/resources/inference_pipelines.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class InferencePipelines
+      # @return [Openlayer::Resources::InferencePipelines::Data]
+      attr_reader :data
+
+      # @return [Openlayer::Resources::InferencePipelines::Rows]
+      attr_reader :rows
+
+      # @return [Openlayer::Resources::InferencePipelines::TestResults]
+      attr_reader :test_results
+
+      # Retrieve inference pipeline.
+      #
+      # @overload retrieve(inference_pipeline_id, expand: nil, request_options: {})
+      #
+      # @param inference_pipeline_id [String] The inference pipeline id (a UUID).
+      #
+      # @param expand [Array<Symbol, Openlayer::Models::InferencePipelineRetrieveParams::Expand>] Expand specific nested objects.
+      #
+      # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Openlayer::Models::InferencePipelineRetrieveResponse]
+      #
+      # @see Openlayer::Models::InferencePipelineRetrieveParams
+      def retrieve(inference_pipeline_id, params = {})
+        parsed, options = Openlayer::InferencePipelineRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["inference-pipelines/%1$s", inference_pipeline_id],
+          query: parsed,
+          model: Openlayer::Models::InferencePipelineRetrieveResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Openlayer::Models::InferencePipelineUpdateParams} for more details.
+      #
+      # Update inference pipeline.
+      #
+      # @overload update(inference_pipeline_id, description: nil, name: nil, reference_dataset_uri: nil, request_options: {})
+      #
+      # @param inference_pipeline_id [String] The inference pipeline id (a UUID).
+      #
+      # @param description [String, nil] The inference pipeline description.
+      #
+      # @param name [String] The inference pipeline name.
+      #
+      # @param reference_dataset_uri [String, nil] The storage uri of your reference dataset. We recommend using the Python SDK or
+      #
+      # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Openlayer::Models::InferencePipelineUpdateResponse]
+      #
+      # @see Openlayer::Models::InferencePipelineUpdateParams
+      def update(inference_pipeline_id, params = {})
+        parsed, options = Openlayer::InferencePipelineUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["inference-pipelines/%1$s", inference_pipeline_id],
+          body: parsed,
+          model: Openlayer::Models::InferencePipelineUpdateResponse,
+          options: options
+        )
+      end
+
+      # Delete inference pipeline.
+      #
+      # @overload delete(inference_pipeline_id, request_options: {})
+      #
+      # @param inference_pipeline_id [String] The inference pipeline id (a UUID).
+      #
+      # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Openlayer::Models::InferencePipelineDeleteParams
+      def delete(inference_pipeline_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["inference-pipelines/%1$s", inference_pipeline_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Openlayer::Client]
+      def initialize(client:)
+        @client = client
+        @data = Openlayer::Resources::InferencePipelines::Data.new(client: client)
+        @rows = Openlayer::Resources::InferencePipelines::Rows.new(client: client)
+        @test_results = Openlayer::Resources::InferencePipelines::TestResults.new(client: client)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Projects
+      class Commits
+        # Create a new commit (project version) in a project.
+        #
+        # @overload create(project_id, commit:, storage_uri:, archived: nil, deployment_status: nil, request_options: {})
+        #
+        # @param project_id [String] The project id.
+        #
+        # @param commit [Openlayer::Models::Projects::CommitCreateParams::Commit] The details of a commit (project version).
+        #
+        # @param storage_uri [String] The storage URI where the commit bundle is stored.
+        #
+        # @param archived [Boolean, nil] Whether the commit is archived.
+        #
+        # @param deployment_status [String] The deployment status associated with the commit's model.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Projects::CommitCreateResponse]
+        #
+        # @see Openlayer::Models::Projects::CommitCreateParams
+        def create(project_id, params)
+          parsed, options = Openlayer::Projects::CommitCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["projects/%1$s/versions", project_id],
+            body: parsed,
+            model: Openlayer::Models::Projects::CommitCreateResponse,
+            options: options
+          )
+        end
+
+        # List the commits (project versions) in a project.
+        #
+        # @overload list(project_id, page: nil, per_page: nil, request_options: {})
+        #
+        # @param project_id [String] The project id.
+        #
+        # @param page [Integer] The page to return in a paginated query.
+        #
+        # @param per_page [Integer] Maximum number of items to return per page.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Projects::CommitListResponse]
+        #
+        # @see Openlayer::Models::Projects::CommitListParams
+        def list(project_id, params = {})
+          parsed, options = Openlayer::Projects::CommitListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["projects/%1$s/versions", project_id],
+            query: parsed.transform_keys(per_page: "perPage"),
+            model: Openlayer::Models::Projects::CommitListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Projects
+      class InferencePipelines
+        # Create an inference pipeline in a project.
+        #
+        # @overload create(project_id, description:, name:, project: nil, workspace: nil, request_options: {})
+        #
+        # @param project_id [String] The project id.
+        #
+        # @param description [String, nil] The inference pipeline description.
+        #
+        # @param name [String] The inference pipeline name.
+        #
+        # @param project [Openlayer::Models::Projects::InferencePipelineCreateParams::Project, nil]
+        #
+        # @param workspace [Openlayer::Models::Projects::InferencePipelineCreateParams::Workspace, nil]
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Projects::InferencePipelineCreateResponse]
+        #
+        # @see Openlayer::Models::Projects::InferencePipelineCreateParams
+        def create(project_id, params)
+          parsed, options = Openlayer::Projects::InferencePipelineCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["projects/%1$s/inference-pipelines", project_id],
+            body: parsed,
+            model: Openlayer::Models::Projects::InferencePipelineCreateResponse,
+            options: options
+          )
+        end
+
+        # List the inference pipelines in a project.
+        #
+        # @overload list(project_id, name: nil, page: nil, per_page: nil, request_options: {})
+        #
+        # @param project_id [String] The project id.
+        #
+        # @param name [String] Filter list of items by name.
+        #
+        # @param page [Integer] The page to return in a paginated query.
+        #
+        # @param per_page [Integer] Maximum number of items to return per page.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Projects::InferencePipelineListResponse]
+        #
+        # @see Openlayer::Models::Projects::InferencePipelineListParams
+        def list(project_id, params = {})
+          parsed, options = Openlayer::Projects::InferencePipelineListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["projects/%1$s/inference-pipelines", project_id],
+            query: parsed.transform_keys(per_page: "perPage"),
+            model: Openlayer::Models::Projects::InferencePipelineListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Projects
+      class Tests
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Projects::TestCreateParams} for more details.
+        #
+        # 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: {})
+        #
+        # @param project_id [String] The project id.
+        #
+        # @param description [Object, nil] The test description.
+        #
+        # @param name [String] The test name.
+        #
+        # @param subtype [Symbol, Openlayer::Models::Projects::TestCreateParams::Subtype] The test subtype.
+        #
+        # @param thresholds [Array<Openlayer::Models::Projects::TestCreateParams::Threshold>]
+        #
+        # @param type [Symbol, Openlayer::Models::Projects::TestCreateParams::Type] The test type.
+        #
+        # @param archived [Boolean] Whether the test is archived.
+        #
+        # @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 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).
+        #
+        # @param uses_reference_dataset [Boolean] Whether the test uses a reference dataset (monitoring mode only).
+        #
+        # @param uses_training_dataset [Boolean] Whether the test uses a training dataset.
+        #
+        # @param uses_validation_dataset [Boolean] Whether the test uses a validation dataset.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Projects::TestCreateResponse]
+        #
+        # @see Openlayer::Models::Projects::TestCreateParams
+        def create(project_id, params)
+          parsed, options = Openlayer::Projects::TestCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["projects/%1$s/tests", project_id],
+            body: parsed,
+            model: Openlayer::Models::Projects::TestCreateResponse,
+            options: options
+          )
+        end
+
+        # Update tests.
+        #
+        # @overload update(project_id, payloads:, request_options: {})
+        #
+        # @param project_id [String] The project id.
+        #
+        # @param payloads [Array<Openlayer::Models::Projects::TestUpdateParams::Payload>]
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Projects::TestUpdateResponse]
+        #
+        # @see Openlayer::Models::Projects::TestUpdateParams
+        def update(project_id, params)
+          parsed, options = Openlayer::Projects::TestUpdateParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["projects/%1$s/tests", project_id],
+            body: parsed,
+            model: Openlayer::Models::Projects::TestUpdateResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Projects::TestListParams} for more details.
+        #
+        # List tests under a project.
+        #
+        # @overload list(project_id, include_archived: nil, origin_version_id: nil, page: nil, per_page: nil, suggested: nil, type: nil, uses_production_data: nil, request_options: {})
+        #
+        # @param project_id [String] The project id.
+        #
+        # @param include_archived [Boolean] Filter for archived tests.
+        #
+        # @param origin_version_id [String, nil] Retrive tests created by a specific project version.
+        #
+        # @param page [Integer] The page to return in a paginated query.
+        #
+        # @param per_page [Integer] Maximum number of items to return per page.
+        #
+        # @param suggested [Boolean] Filter for suggested tests.
+        #
+        # @param type [Symbol, Openlayer::Models::Projects::TestListParams::Type] Filter objects by test type. Available types are `integrity`, `consistency`, `pe
+        #
+        # @param uses_production_data [Boolean, nil] Retrive tests with usesProductionData (monitoring).
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Projects::TestListResponse]
+        #
+        # @see Openlayer::Models::Projects::TestListParams
+        def list(project_id, params = {})
+          parsed, options = Openlayer::Projects::TestListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["projects/%1$s/tests", project_id],
+            query: parsed.transform_keys(
+              include_archived: "includeArchived",
+              origin_version_id: "originVersionId",
+              per_page: "perPage",
+              uses_production_data: "usesProductionData"
+            ),
+            model: Openlayer::Models::Projects::TestListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/resources/projects.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Projects
+      # @return [Openlayer::Resources::Projects::Commits]
+      attr_reader :commits
+
+      # @return [Openlayer::Resources::Projects::InferencePipelines]
+      attr_reader :inference_pipelines
+
+      # @return [Openlayer::Resources::Projects::Tests]
+      attr_reader :tests
+
+      # Create a project in your workspace.
+      #
+      # @overload create(name:, task_type:, description: nil, request_options: {})
+      #
+      # @param name [String] The project name.
+      #
+      # @param task_type [Symbol, Openlayer::Models::ProjectCreateParams::TaskType] The task type of the project.
+      #
+      # @param description [String, nil] The project description.
+      #
+      # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Openlayer::Models::ProjectCreateResponse]
+      #
+      # @see Openlayer::Models::ProjectCreateParams
+      def create(params)
+        parsed, options = Openlayer::ProjectCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "projects",
+          body: parsed,
+          model: Openlayer::Models::ProjectCreateResponse,
+          options: options
+        )
+      end
+
+      # List your workspace's projects.
+      #
+      # @overload list(name: nil, page: nil, per_page: nil, task_type: nil, request_options: {})
+      #
+      # @param name [String] Filter list of items by project name.
+      #
+      # @param page [Integer] The page to return in a paginated query.
+      #
+      # @param per_page [Integer] Maximum number of items to return per page.
+      #
+      # @param task_type [Symbol, Openlayer::Models::ProjectListParams::TaskType] Filter list of items by task type.
+      #
+      # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Openlayer::Models::ProjectListResponse]
+      #
+      # @see Openlayer::Models::ProjectListParams
+      def list(params = {})
+        parsed, options = Openlayer::ProjectListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "projects",
+          query: parsed.transform_keys(per_page: "perPage", task_type: "taskType"),
+          model: Openlayer::Models::ProjectListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Openlayer::Client]
+      def initialize(client:)
+        @client = client
+        @commits = Openlayer::Resources::Projects::Commits.new(client: client)
+        @inference_pipelines = Openlayer::Resources::Projects::InferencePipelines.new(client: client)
+        @tests = Openlayer::Resources::Projects::Tests.new(client: client)
+      end
+    end
+  end
+end

data/lib/openlayer/resources/storage/presigned_url.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Storage
+      class PresignedURL
+        # Retrieve a presigned url to post storage artifacts.
+        #
+        # @overload create(object_name:, request_options: {})
+        #
+        # @param object_name [String] The name of the object.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Storage::PresignedURLCreateResponse]
+        #
+        # @see Openlayer::Models::Storage::PresignedURLCreateParams
+        def create(params)
+          parsed, options = Openlayer::Storage::PresignedURLCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "storage/presigned-url",
+            query: parsed.transform_keys(object_name: "objectName"),
+            model: Openlayer::Models::Storage::PresignedURLCreateResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/resources/storage.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Storage
+      # @return [Openlayer::Resources::Storage::PresignedURL]
+      attr_reader :presigned_url
+
+      # @api private
+      #
+      # @param client [Openlayer::Client]
+      def initialize(client:)
+        @client = client
+        @presigned_url = Openlayer::Resources::Storage::PresignedURL.new(client: client)
+      end
+    end
+  end
+end

data/lib/openlayer/version.rb

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