openlayer 0.15.0 → 0.17.0

data/rbi/openlayer/resources/governance.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Governance
+      sig { returns(Openlayer::Resources::Governance::Frameworks) }
+      attr_reader :frameworks
+
+      sig { returns(Openlayer::Resources::Governance::Rules) }
+      attr_reader :rules
+
+      sig { returns(Openlayer::Resources::Governance::RuleResults) }
+      attr_reader :rule_results
+
+      sig { returns(Openlayer::Resources::Governance::RuleStats) }
+      attr_reader :rule_stats
+
+      sig { returns(Openlayer::Resources::Governance::RuleTags) }
+      attr_reader :rule_tags
+
+      # @api private
+      sig { params(client: Openlayer::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/openlayer/resources/inference_pipelines/rows.rbi

@@ -4,7 +4,7 @@ module Openlayer
   module Resources
     class InferencePipelines
       class Rows
-        # Fetch a single inference pipeline row by inference ID, including OTel steps.
+        # Retrieve a row by inference ID, including OTel steps.
         sig do
           params(
             inference_id: String,
@@ -20,7 +20,7 @@ module Openlayer
         )
         end
 
-        # Update an inference data point in an inference pipeline.
+        # Update a row in an inference pipeline.
         sig do
           params(
             inference_pipeline_id: String,
@@ -46,7 +46,7 @@ module Openlayer
         )
         end
 
-        # A list of rows for an inference pipeline.
+        # List the rows in an inference pipeline.
         sig do
           params(
             inference_pipeline_id: String,
@@ -102,8 +102,7 @@ module Openlayer
         )
         end
 
-        # Delete a single inference pipeline row by inference ID. Only project admins can
-        # perform this action.
+        # Delete a row by inference ID.
         sig do
           params(
             inference_id: String,

data/rbi/openlayer/resources/inference_pipelines.rbi

@@ -12,7 +12,7 @@ module Openlayer
       sig { returns(Openlayer::Resources::InferencePipelines::TestResults) }
       attr_reader :test_results
 
-      # Retrieve inference pipeline.
+      # Retrieve an inference pipeline.
       sig do
         params(
           inference_pipeline_id: String,
@@ -32,7 +32,7 @@ module Openlayer
       )
       end
 
-      # Update inference pipeline.
+      # Update an inference pipeline.
       sig do
         params(
           inference_pipeline_id: String,
@@ -56,7 +56,7 @@ module Openlayer
       )
       end
 
-      # Delete inference pipeline.
+      # Delete an inference pipeline.
       sig do
         params(
           inference_pipeline_id: String,
@@ -70,12 +70,7 @@ module Openlayer
       )
       end
 
-      # Get aggregated session data for an inference pipeline with pagination and
-      # metadata.
-      #
-      # Returns a list of sessions for the inference pipeline, including activity
-      # statistics such as record counts, token usage, cost, latency, and the first and
-      # last records.
+      # List the sessions in an inference pipeline, with their stats.
       sig do
         params(
           inference_pipeline_id: String,
@@ -131,11 +126,7 @@ module Openlayer
       )
       end
 
-      # Get aggregated user data for an inference pipeline with pagination and metadata.
-      #
-      # Returns a list of users who have interacted with the inference pipeline,
-      # including their activity statistics such as session counts, record counts, token
-      # usage, and costs.
+      # List the users of an inference pipeline, with their stats.
       sig do
         params(
           inference_pipeline_id: String,

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

@@ -4,7 +4,7 @@ module Openlayer
   module Resources
     class Projects
       class Tests
-        # Create a test.
+        # Create a test in a project.
         sig do
           params(
             project_id: String,
@@ -76,7 +76,7 @@ module Openlayer
         )
         end
 
-        # Update tests.
+        # Update tests in a project.
         sig do
           params(
             project_id: String,
@@ -93,7 +93,7 @@ module Openlayer
         )
         end
 
-        # List tests under a project.
+        # List the tests in a project.
         sig do
           params(
             project_id: String,

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

@@ -4,7 +4,7 @@ module Openlayer
   module Resources
     class Storage
       class PresignedURL
-        # Retrieve a presigned url to post storage artifacts.
+        # Get a presigned url to upload a file.
         sig do
           params(
             object_name: String,
@@ -18,6 +18,21 @@ module Openlayer
         )
         end
 
+        # Get a short-lived download url for a stored object.
+        sig do
+          params(
+            storage_uri: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Storage::PresignedURLRetrieveResponse)
+        end
+        def retrieve(
+          # The object's storage uri, for example `outputs.storageUri` from a framework
+          # export's background task.
+          storage_uri:,
+          request_options: {}
+        )
+        end
+
         # @api private
         sig { params(client: Openlayer::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/openlayer/resources/tests.rbi

@@ -3,10 +3,7 @@
 module Openlayer
   module Resources
     class Tests
-      # 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.
+      # Evaluate a test over a custom time range.
       sig do
         params(
           test_id: String,

data/rbi/openlayer/resources/workspaces/api_keys.rbi

@@ -4,10 +4,11 @@ module Openlayer
   module Resources
     class Workspaces
       class APIKeys
-        # Create a new API key in a workspace.
+        # Create a new API key.
         sig do
           params(
             workspace_id: String,
+            expires_at: T.nilable(Time),
             name: T.nilable(String),
             request_options: Openlayer::RequestOptions::OrHash
           ).returns(Openlayer::Models::Workspaces::APIKeyCreateResponse)
@@ -15,12 +16,120 @@ module Openlayer
         def create(
           # The workspace id.
           workspace_id,
+          # When the key stops authenticating. `null` means the key never expires. Set when
+          # the key is created or rotated, and must be in the future. When the request is
+          # authenticated with an API key that expires, the result can't be later than that
+          # key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
+          # keep the current one. It can't be changed with an update; rotate the key
+          # instead.
+          expires_at: nil,
           # The API key name.
           name: nil,
           request_options: {}
         )
         end
 
+        # Retrieve an API key.
+        sig do
+          params(
+            api_key_id: String,
+            workspace_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Workspaces::APIKeyRetrieveResponse)
+        end
+        def retrieve(
+          # The API key id.
+          api_key_id,
+          # The workspace id.
+          workspace_id:,
+          request_options: {}
+        )
+        end
+
+        # Rename an API key.
+        sig do
+          params(
+            api_key_id: String,
+            workspace_id: String,
+            name: T.nilable(String),
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Workspaces::APIKeyUpdateResponse)
+        end
+        def update(
+          # Path param: The API key id.
+          api_key_id,
+          # Path param: The workspace id.
+          workspace_id:,
+          # Body param: The API key name.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        # List your API keys in a workspace.
+        sig do
+          params(
+            workspace_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(
+            T::Array[Openlayer::Models::Workspaces::APIKeyListResponseItem]
+          )
+        end
+        def list(
+          # The workspace id.
+          workspace_id,
+          request_options: {}
+        )
+        end
+
+        # Delete an API key.
+        sig do
+          params(
+            api_key_id: String,
+            workspace_id: String,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # The API key id.
+          api_key_id,
+          # The workspace id.
+          workspace_id:,
+          request_options: {}
+        )
+        end
+
+        # Replace an API key's secret.
+        sig do
+          params(
+            api_key_id: String,
+            workspace_id: String,
+            expires_at: T.nilable(Time),
+            grace_period_hours: Integer,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(Openlayer::Models::Workspaces::APIKeyRotateResponse)
+        end
+        def rotate(
+          # Path param: The API key id.
+          api_key_id,
+          # Path param: The workspace id.
+          workspace_id:,
+          # Body param: When the key stops authenticating. `null` means the key never
+          # expires. Set when the key is created or rotated, and must be in the future. When
+          # the request is authenticated with an API key that expires, the result can't be
+          # later than that key's expiry. On create, omit it to inherit that expiry. On
+          # rotate, omit it to keep the current one. It can't be changed with an update;
+          # rotate the key instead.
+          expires_at: nil,
+          # Body param: Hours the previous secret keeps authenticating. The default of 0
+          # retires it immediately. It never outlives `expiresAt`. Only one previous secret
+          # is kept, so rotating again during a grace period retires the older one
+          # immediately.
+          grace_period_hours: nil,
+          request_options: {}
+        )
+        end
+
         # @api private
         sig { params(client: Openlayer::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/openlayer/resources/workspaces/invites.rbi

@@ -23,7 +23,7 @@ module Openlayer
         )
         end
 
-        # Retrieve a list of invites in a workspace.
+        # List the invites in a workspace.
         sig do
           params(
             workspace_id: String,

data/rbi/openlayer/resources/workspaces.rbi

@@ -9,7 +9,7 @@ module Openlayer
       sig { returns(Openlayer::Resources::Workspaces::APIKeys) }
       attr_reader :api_keys
 
-      # Retrieve a workspace by its ID.
+      # Retrieve a workspace.
       sig do
         params(
           workspace_id: String,

data/sig/openlayer/client.rbs

@@ -22,6 +22,10 @@ module Openlayer
 
     attr_reader tests: Openlayer::Resources::Tests
 
+    attr_reader background_tasks: Openlayer::Resources::BackgroundTasks
+
+    attr_reader governance: Openlayer::Resources::Governance
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/openlayer/models/background_task_retrieve_params.rbs

@@ -0,0 +1,23 @@
+module Openlayer
+  module Models
+    type background_task_retrieve_params =
+      { task_id: String } & Openlayer::Internal::Type::request_parameters
+
+    class BackgroundTaskRetrieveParams < Openlayer::Internal::Type::BaseModel
+      extend Openlayer::Internal::Type::RequestParameters::Converter
+      include Openlayer::Internal::Type::RequestParameters
+
+      attr_accessor task_id: String
+
+      def initialize: (
+        task_id: String,
+        ?request_options: Openlayer::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        task_id: String,
+        request_options: Openlayer::RequestOptions
+      }
+    end
+  end
+end

data/sig/openlayer/models/background_task_retrieve_response.rbs

@@ -0,0 +1,55 @@
+module Openlayer
+  module Models
+    type background_task_retrieve_response =
+      {
+        id: String,
+        complete: bool,
+        date_created: Time,
+        date_updated: Time,
+        name: String,
+        progress: Float,
+        error: String?,
+        outputs: top?
+      }
+
+    class BackgroundTaskRetrieveResponse < Openlayer::Internal::Type::BaseModel
+      attr_accessor complete: bool
+
+      attr_accessor progress: Float
+
+      attr_accessor error: String?
+
+      attr_accessor outputs: top?
+
+      attr_accessor id: String
+
+      attr_accessor date_created: Time
+
+      attr_accessor date_updated: Time
+
+      attr_accessor name: String
+
+      def initialize: (
+        id: String,
+        complete: bool,
+        date_created: Time,
+        date_updated: Time,
+        name: String,
+        progress: Float,
+        ?error: String?,
+        ?outputs: top?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        complete: bool,
+        date_created: Time,
+        date_updated: Time,
+        name: String,
+        progress: Float,
+        error: String?,
+        outputs: top?
+      }
+    end
+  end
+end

data/sig/openlayer/models/governance/framework_create_params.rbs

@@ -0,0 +1,124 @@
+module Openlayer
+  module Models
+    module Governance
+      type framework_create_params =
+        {
+          workspace_id: String,
+          name: String,
+          description: String?,
+          enabled: bool,
+          project_selector: Openlayer::Governance::FrameworkCreateParams::ProjectSelector?,
+          tags: ::Array[String]
+        }
+        & Openlayer::Internal::Type::request_parameters
+
+      class FrameworkCreateParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        attr_accessor workspace_id: String
+
+        attr_accessor name: String
+
+        attr_accessor description: String?
+
+        attr_reader enabled: bool?
+
+        def enabled=: (bool) -> bool
+
+        attr_accessor project_selector: Openlayer::Governance::FrameworkCreateParams::ProjectSelector?
+
+        attr_reader tags: ::Array[String]?
+
+        def tags=: (::Array[String]) -> ::Array[String]
+
+        def initialize: (
+          workspace_id: String,
+          name: String,
+          ?description: String?,
+          ?enabled: bool,
+          ?project_selector: Openlayer::Governance::FrameworkCreateParams::ProjectSelector?,
+          ?tags: ::Array[String],
+          ?request_options: Openlayer::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          workspace_id: String,
+          name: String,
+          description: String?,
+          enabled: bool,
+          project_selector: Openlayer::Governance::FrameworkCreateParams::ProjectSelector?,
+          tags: ::Array[String],
+          request_options: Openlayer::RequestOptions
+        }
+
+        type project_selector =
+          {
+            match: ::Array[Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match]?
+          }
+
+        class ProjectSelector < Openlayer::Internal::Type::BaseModel
+          attr_accessor match: ::Array[Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match]?
+
+          def initialize: (
+            ?match: ::Array[Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match]?
+          ) -> void
+
+          def to_hash: -> {
+            match: ::Array[Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match]?
+          }
+
+          type match =
+            {
+              property: Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector::Match::property,
+              value: top,
+              operator: String
+            }
+
+          class Match < Openlayer::Internal::Type::BaseModel
+            attr_accessor property: Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector::Match::property
+
+            attr_accessor value: top
+
+            attr_reader operator: String?
+
+            def operator=: (String) -> String
+
+            def initialize: (
+              property: Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector::Match::property,
+              value: top,
+              ?operator: String
+            ) -> void
+
+            def to_hash: -> {
+              property: Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector::Match::property,
+              value: top,
+              operator: String
+            }
+
+            type property =
+              :taskType
+              | :riskLevel
+              | :riskTotalScore
+              | :name
+              | :ownerId
+              | :modelTypes
+
+            module Property
+              extend Openlayer::Internal::Type::Enum
+
+              TASK_TYPE: :taskType
+              RISK_LEVEL: :riskLevel
+              RISK_TOTAL_SCORE: :riskTotalScore
+              NAME: :name
+              OWNER_ID: :ownerId
+              MODEL_TYPES: :modelTypes
+
+              def self?.values: -> ::Array[Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector::Match::property]
+            end
+          end
+        end
+      end
+    end
+  end
+end