openlayer 0.3.0 → 0.4.0

data/rbi/openlayer/resources/projects/tests.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Projects
+      class Tests
+        # Create a test.
+        sig do
+          params(
+            project_id: String,
+            description: T.nilable(T.anything),
+            name: String,
+            subtype: Openlayer::Projects::TestCreateParams::Subtype::OrSymbol,
+            thresholds:
+              T::Array[
+                Openlayer::Projects::TestCreateParams::Threshold::OrHash
+              ],
+            type: Openlayer::Projects::TestCreateParams::Type::OrSymbol,
+            archived: T::Boolean,
+            delay_window: T.nilable(Float),
+            evaluation_window: T.nilable(Float),
+            uses_ml_model: T::Boolean,
+            uses_production_data: T::Boolean,
+            uses_reference_dataset: T::Boolean,
+            uses_training_dataset: T::Boolean,
+            uses_validation_dataset: T::Boolean,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Projects::TestCreateResponse)
+        end
+        def create(
+          # The project id.
+          project_id,
+          # The test description.
+          description:,
+          # The test name.
+          name:,
+          # The test subtype.
+          subtype:,
+          thresholds:,
+          # The test type.
+          type:,
+          # Whether the test is archived.
+          archived: nil,
+          # The delay window in seconds. Only applies to tests that use production data.
+          delay_window: nil,
+          # The evaluation window in seconds. Only applies to tests that use production
+          # data.
+          evaluation_window: nil,
+          # Whether the test uses an ML model.
+          uses_ml_model: nil,
+          # Whether the test uses production data (monitoring mode only).
+          uses_production_data: nil,
+          # Whether the test uses a reference dataset (monitoring mode only).
+          uses_reference_dataset: nil,
+          # Whether the test uses a training dataset.
+          uses_training_dataset: nil,
+          # Whether the test uses a validation dataset.
+          uses_validation_dataset: nil,
+          request_options: {}
+        )
+        end
+
+        # Update tests.
+        sig do
+          params(
+            project_id: String,
+            payloads:
+              T::Array[Openlayer::Projects::TestUpdateParams::Payload::OrHash],
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Projects::TestUpdateResponse)
+        end
+        def update(
+          # The project id.
+          project_id,
+          payloads:,
+          request_options: {}
+        )
+        end
+
+        # List tests under a project.
+        sig do
+          params(
+            project_id: String,
+            include_archived: T::Boolean,
+            origin_version_id: T.nilable(String),
+            page: Integer,
+            per_page: Integer,
+            suggested: T::Boolean,
+            type: Openlayer::Projects::TestListParams::Type::OrSymbol,
+            uses_production_data: T.nilable(T::Boolean),
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Projects::TestListResponse)
+        end
+        def list(
+          # The project id.
+          project_id,
+          # Filter for archived tests.
+          include_archived: nil,
+          # Retrive tests created by a specific project version.
+          origin_version_id: nil,
+          # The page to return in a paginated query.
+          page: nil,
+          # Maximum number of items to return per page.
+          per_page: nil,
+          # Filter for suggested tests.
+          suggested: nil,
+          # Filter objects by test type. Available types are `integrity`, `consistency`,
+          # `performance`, `fairness`, and `robustness`.
+          type: nil,
+          # Retrive tests with usesProductionData (monitoring).
+          uses_production_data: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Openlayer::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/resources/projects.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Projects
+      sig { returns(Openlayer::Resources::Projects::Commits) }
+      attr_reader :commits
+
+      sig { returns(Openlayer::Resources::Projects::InferencePipelines) }
+      attr_reader :inference_pipelines
+
+      sig { returns(Openlayer::Resources::Projects::Tests) }
+      attr_reader :tests
+
+      # Create a project in your workspace.
+      sig do
+        params(
+          name: String,
+          task_type: Openlayer::ProjectCreateParams::TaskType::OrSymbol,
+          description: T.nilable(String),
+          request_options: Openlayer::RequestOptions::OrHash
+        ).returns(Openlayer::Models::ProjectCreateResponse)
+      end
+      def create(
+        # The project name.
+        name:,
+        # The task type of the project.
+        task_type:,
+        # The project description.
+        description: nil,
+        request_options: {}
+      )
+      end
+
+      # List your workspace's projects.
+      sig do
+        params(
+          name: String,
+          page: Integer,
+          per_page: Integer,
+          task_type: Openlayer::ProjectListParams::TaskType::OrSymbol,
+          request_options: Openlayer::RequestOptions::OrHash
+        ).returns(Openlayer::Models::ProjectListResponse)
+      end
+      def list(
+        # Filter list of items by project name.
+        name: nil,
+        # The page to return in a paginated query.
+        page: nil,
+        # Maximum number of items to return per page.
+        per_page: nil,
+        # Filter list of items by task type.
+        task_type: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Openlayer::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/openlayer/resources/storage/presigned_url.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Storage
+      class PresignedURL
+        # Retrieve a presigned url to post storage artifacts.
+        sig do
+          params(
+            object_name: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Storage::PresignedURLCreateResponse)
+        end
+        def create(
+          # The name of the object.
+          object_name:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Openlayer::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/resources/storage.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Storage
+      sig { returns(Openlayer::Resources::Storage::PresignedURL) }
+      attr_reader :presigned_url
+
+      # @api private
+      sig { params(client: Openlayer::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/openlayer/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module Openlayer
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/openlayer/client.rbs

@@ -0,0 +1,32 @@
+module Openlayer
+  class Client < Openlayer::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_key: String?
+
+    attr_reader projects: Openlayer::Resources::Projects
+
+    attr_reader commits: Openlayer::Resources::Commits
+
+    attr_reader inference_pipelines: Openlayer::Resources::InferencePipelines
+
+    attr_reader storage: Openlayer::Resources::Storage
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_key: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/openlayer/errors.rbs

@@ -0,0 +1,117 @@
+module Openlayer
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < Openlayer::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
+    end
+
+    class APIError < Openlayer::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor headers: ::Hash[String, String]?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < Openlayer::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < Openlayer::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < Openlayer::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class BadRequestError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end

data/sig/openlayer/file_part.rbs

@@ -0,0 +1,21 @@
+module Openlayer
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: (Pathname | String)?,
+      ?content_type: String?
+    ) -> void
+  end
+end

data/sig/openlayer/internal/transport/base_client.rbs

@@ -0,0 +1,131 @@
+module Openlayer
+  module Internal
+    module Transport
+      class BaseClient
+        extend Openlayer::Internal::Util::SorbetRuntimeSupport
+
+        type request_components =
+          {
+            method: Symbol,
+            path: String | ::Array[String],
+            query: ::Hash[String, (::Array[String] | String)?]?,
+            headers: ::Hash[String, (String
+            | Integer
+            | ::Array[(String | Integer)?])?]?,
+            body: top?,
+            unwrap: (Symbol
+            | Integer
+            | ::Array[(Symbol | Integer)]
+            | (^(top arg0) -> top))?,
+            page: Class?,
+            stream: Class?,
+            model: Openlayer::Internal::Type::Converter::input?,
+            options: Openlayer::request_opts?
+          }
+        type request_input =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            max_retries: Integer,
+            timeout: Float
+          }
+
+        MAX_REDIRECTS: 20
+
+        PLATFORM_HEADERS: ::Hash[String, String]
+
+        def self.validate!: (
+          Openlayer::Internal::Transport::BaseClient::request_components req
+        ) -> void
+
+        def self.should_retry?: (
+          Integer status,
+          headers: ::Hash[String, String]
+        ) -> bool
+
+        def self.follow_redirect: (
+          Openlayer::Internal::Transport::BaseClient::request_input request,
+          status: Integer,
+          response_headers: ::Hash[String, String]
+        ) -> Openlayer::Internal::Transport::BaseClient::request_input
+
+        def self.reap_connection!: (
+          Integer | Openlayer::Errors::APIConnectionError status,
+          stream: Enumerable[String]?
+        ) -> void
+
+        attr_reader base_url: URI::Generic
+
+        attr_reader timeout: Float
+
+        attr_reader max_retries: Integer
+
+        attr_reader initial_retry_delay: Float
+
+        attr_reader max_retry_delay: Float
+
+        attr_reader headers: ::Hash[String, String]
+
+        attr_reader idempotency_header: String?
+
+        # @api private
+        attr_reader requester: Openlayer::Internal::Transport::PooledNetRequester
+
+        def initialize: (
+          base_url: String,
+          ?timeout: Float,
+          ?max_retries: Integer,
+          ?initial_retry_delay: Float,
+          ?max_retry_delay: Float,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?],
+          ?idempotency_header: String?
+        ) -> void
+
+        private def auth_headers: -> ::Hash[String, String]
+
+        private def generate_idempotency_key: -> String
+
+        private def build_request: (
+          Openlayer::Internal::Transport::BaseClient::request_components req,
+          Openlayer::request_options opts
+        ) -> Openlayer::Internal::Transport::BaseClient::request_input
+
+        private def retry_delay: (
+          ::Hash[String, String] headers,
+          retry_count: Integer
+        ) -> Float
+
+        def send_request: (
+          Openlayer::Internal::Transport::BaseClient::request_input request,
+          redirect_count: Integer,
+          retry_count: Integer,
+          send_retry_header: bool
+        ) -> [Integer, top, Enumerable[String]]
+
+        def request: (
+          Symbol method,
+          String | ::Array[String] path,
+          ?query: ::Hash[String, (::Array[String] | String)?]?,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?]?,
+          ?body: top?,
+          ?unwrap: (Symbol
+          | Integer
+          | ::Array[(Symbol | Integer)]
+          | (^(top arg0) -> top))?,
+          ?page: Class?,
+          ?stream: Class?,
+          ?model: Openlayer::Internal::Type::Converter::input?,
+          ?options: Openlayer::request_opts?
+        ) -> top
+
+        def inspect: -> String
+      end
+    end
+  end
+end

data/sig/openlayer/internal/transport/pooled_net_requester.rbs

@@ -0,0 +1,45 @@
+module Openlayer
+  module Internal
+    module Transport
+      class PooledNetRequester
+        extend Openlayer::Internal::Util::SorbetRuntimeSupport
+
+        type request =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            deadline: Float
+          }
+
+        KEEP_ALIVE_TIMEOUT: 30
+
+        DEFAULT_MAX_CONNECTIONS: Integer
+
+        def self.connect: (URI::Generic url) -> top
+
+        def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
+
+        def self.build_request: (
+          Openlayer::Internal::Transport::PooledNetRequester::request request
+        ) {
+          (String arg0) -> void
+        } -> [top, (^-> void)]
+
+        private def with_pool: (
+          URI::Generic url,
+          deadline: Float
+        ) {
+          (top arg0) -> void
+        } -> void
+
+        def execute: (
+          Openlayer::Internal::Transport::PooledNetRequester::request request
+        ) -> [Integer, top, Enumerable[String]]
+
+        def initialize: (?size: Integer) -> void
+      end
+    end
+  end
+end

data/sig/openlayer/internal/type/array_of.rbs

@@ -0,0 +1,48 @@
+module Openlayer
+  module Internal
+    module Type
+      class ArrayOf[Elem]
+        include Openlayer::Internal::Type::Converter
+        include Openlayer::Internal::Util::SorbetRuntimeSupport
+
+        def self.[]: (
+          ::Hash[Symbol, top]
+          | ^-> Openlayer::Internal::Type::Converter::input
+          | Openlayer::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> instance
+
+        def ===: (top other) -> bool
+
+        def ==: (top other) -> bool
+
+        def hash: -> Integer
+
+        def coerce: (
+          ::Array[top] | top value,
+          state: Openlayer::Internal::Type::Converter::coerce_state
+        ) -> (::Array[top] | top)
+
+        def dump: (
+          ::Array[top] | top value,
+          state: Openlayer::Internal::Type::Converter::dump_state
+        ) -> (::Array[top] | top)
+
+        def to_sorbet_type: -> top
+
+        def item_type: -> Elem
+
+        def nilable?: -> bool
+
+        def initialize: (
+          ::Hash[Symbol, top]
+          | ^-> Openlayer::Internal::Type::Converter::input
+          | Openlayer::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def inspect: (?depth: Integer) -> String
+      end
+    end
+  end
+end