openlayer 0.15.0 → 0.17.0

data/lib/openlayer/resources/governance/rules.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Governance
+      class Rules
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Governance::RuleCreateParams} for more details.
+        #
+        # Create a rule in a workspace.
+        #
+        # @overload create(workspace_id, name:, scope:, type:, assignee_id: nil, automation_params: nil, automation_type: nil, deactivated: nil, description: nil, evidence_type: nil, renewal_cadence_days: nil, tag_ids: nil, request_options: {})
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param name [String] The rule name.
+        #
+        # @param scope [Symbol, Openlayer::Models::Governance::RuleCreateParams::Scope] Whether the rule is evaluated once for the whole workspace, or once per project
+        #
+        # @param type [Symbol, Openlayer::Models::Governance::RuleCreateParams::Type] `platform` rules are evaluated automatically from the state of your Openlayer wo
+        #
+        # @param assignee_id [String, nil] The user responsible for satisfying the rule.
+        #
+        # @param automation_params [Hash{Symbol=>Object}, nil] Configuration for the platform check, when the automation takes parameters. Omit
+        #
+        # @param automation_type [String, nil] Which workspace signal a platform rule checks, for example `monitoring_mode_enab
+        #
+        # @param deactivated [Boolean] Whether the rule is excluded from compliance calculations.
+        #
+        # @param description [String, nil] What the rule requires.
+        #
+        # @param evidence_type [Symbol, Openlayer::Models::Governance::RuleCreateParams::EvidenceType, nil] The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
+        #
+        # @param renewal_cadence_days [Integer, nil] How often evidence must be renewed, in days. Once evidence is older than this, t
+        #
+        # @param tag_ids [Array<String>, nil] The ids of the rule tags to associate with the rule. Replaces the rule's tags. R
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::RuleCreateResponse]
+        #
+        # @see Openlayer::Models::Governance::RuleCreateParams
+        def create(workspace_id, params)
+          parsed, options = Openlayer::Governance::RuleCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["workspaces/%1$s/rules", workspace_id],
+            body: parsed,
+            model: Openlayer::Models::Governance::RuleCreateResponse,
+            options: options
+          )
+        end
+
+        # Retrieve a rule with its frameworks and tags.
+        #
+        # @overload retrieve(rule_id, request_options: {})
+        #
+        # @param rule_id [String] The rule id.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::RuleRetrieveResponse]
+        #
+        # @see Openlayer::Models::Governance::RuleRetrieveParams
+        def retrieve(rule_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["rules/%1$s", rule_id],
+            model: Openlayer::Models::Governance::RuleRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Governance::RuleUpdateParams} for more details.
+        #
+        # Update a rule.
+        #
+        # @overload update(rule_id, assignee_id: nil, deactivated: nil, description: nil, name: nil, renewal_cadence_days: nil, tag_ids: nil, request_options: {})
+        #
+        # @param rule_id [String] The rule id.
+        #
+        # @param assignee_id [String, nil] The user responsible for satisfying the rule.
+        #
+        # @param deactivated [Boolean] Whether the rule is excluded from compliance calculations.
+        #
+        # @param description [String, nil] What the rule requires.
+        #
+        # @param name [String] The rule name.
+        #
+        # @param renewal_cadence_days [Integer, nil] How often evidence must be renewed, in days. Once evidence is older than this, t
+        #
+        # @param tag_ids [Array<String>, nil] The ids of the rule tags to associate with the rule. Replaces the rule's tags. R
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::RuleUpdateResponse]
+        #
+        # @see Openlayer::Models::Governance::RuleUpdateParams
+        def update(rule_id, params = {})
+          parsed, options = Openlayer::Governance::RuleUpdateParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["rules/%1$s", rule_id],
+            body: parsed,
+            model: Openlayer::Models::Governance::RuleUpdateResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Governance::RuleListParams} for more details.
+        #
+        # List the rules in a workspace.
+        #
+        # @overload list(workspace_id, asc: nil, assignee_id: nil, deactivated: nil, enabled_framework_only: nil, framework_id: nil, group: nil, include_results: nil, include_unframed: nil, page: nil, per_page: nil, project_id: nil, scope: nil, search_query: nil, sort_by: nil, status: nil, tags: nil, type: nil, request_options: {})
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param asc [Boolean] Whether to sort in ascending order.
+        #
+        # @param assignee_id [String] Only include rules assigned to this user.
+        #
+        # @param deactivated [Boolean] Only include rules that are deactivated (or active).
+        #
+        # @param enabled_framework_only [Boolean] Only include items belonging to at least one enabled framework.
+        #
+        # @param framework_id [String] Only include items belonging to this framework.
+        #
+        # @param group [Symbol, Openlayer::Models::Governance::RuleListParams::Group] Only include rules in one bucket of the compliance workflow. `open` covers rules
+        #
+        # @param include_results [Boolean] Whether to include each rule's results inline, in a `results` array.
+        #
+        # @param include_unframed [Boolean] Whether to include rules that are not part of any framework.
+        #
+        # @param page [Integer] The page to return in a paginated query.
+        #
+        # @param per_page [Integer] Maximum number of items to return per page.
+        #
+        # @param project_id [String] Only include items that apply to this project.
+        #
+        # @param scope [Symbol, Openlayer::Models::Governance::RuleListParams::Scope] Only include rules with this scope.
+        #
+        # @param search_query [String] Filter by a free-text search over names and descriptions.
+        #
+        # @param sort_by [Symbol, Openlayer::Models::Governance::RuleListParams::SortBy] The field to sort on.
+        #
+        # @param status [Symbol, Openlayer::Models::Governance::RuleListParams::Status] Only include items whose rule result has this compliance status.
+        #
+        # @param tags [Array<String>] Only include rules carrying all of these rule tags. Pass tag ids, which you can
+        #
+        # @param type [Symbol, Openlayer::Models::Governance::RuleListParams::Type] Only include rules of this type.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::RuleListResponse]
+        #
+        # @see Openlayer::Models::Governance::RuleListParams
+        def list(workspace_id, params = {})
+          parsed, options = Openlayer::Governance::RuleListParams.dump_request(params)
+          query = Openlayer::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["workspaces/%1$s/rules", workspace_id],
+            query: query.transform_keys(
+              assignee_id: "assigneeId",
+              enabled_framework_only: "enabledFrameworkOnly",
+              framework_id: "frameworkId",
+              include_results: "includeResults",
+              include_unframed: "includeUnframed",
+              per_page: "perPage",
+              project_id: "projectId",
+              search_query: "searchQuery",
+              sort_by: "sortBy"
+            ),
+            model: Openlayer::Models::Governance::RuleListResponse,
+            options: options
+          )
+        end
+
+        # Delete a rule and its results.
+        #
+        # @overload delete(rule_id, request_options: {})
+        #
+        # @param rule_id [String] The rule id.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Openlayer::Models::Governance::RuleDeleteParams
+        def delete(rule_id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["rules/%1$s", rule_id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/resources/governance.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Governance
+      # @return [Openlayer::Resources::Governance::Frameworks]
+      attr_reader :frameworks
+
+      # @return [Openlayer::Resources::Governance::Rules]
+      attr_reader :rules
+
+      # @return [Openlayer::Resources::Governance::RuleResults]
+      attr_reader :rule_results
+
+      # @return [Openlayer::Resources::Governance::RuleStats]
+      attr_reader :rule_stats
+
+      # @return [Openlayer::Resources::Governance::RuleTags]
+      attr_reader :rule_tags
+
+      # @api private
+      #
+      # @param client [Openlayer::Client]
+      def initialize(client:)
+        @client = client
+        @frameworks = Openlayer::Resources::Governance::Frameworks.new(client: client)
+        @rules = Openlayer::Resources::Governance::Rules.new(client: client)
+        @rule_results = Openlayer::Resources::Governance::RuleResults.new(client: client)
+        @rule_stats = Openlayer::Resources::Governance::RuleStats.new(client: client)
+        @rule_tags = Openlayer::Resources::Governance::RuleTags.new(client: client)
+      end
+    end
+  end
+end

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

@@ -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.
         #
         # @overload retrieve(inference_id, inference_pipeline_id:, request_options: {})
         #
@@ -31,7 +31,7 @@ module Openlayer
           )
         end
 
-        # Update an inference data point in an inference pipeline.
+        # Update a row in an inference pipeline.
         #
         # @overload update(inference_pipeline_id, inference_id:, row:, config: nil, request_options: {})
         #
@@ -62,7 +62,7 @@ module Openlayer
           )
         end
 
-        # A list of rows for an inference pipeline.
+        # List the rows in an inference pipeline.
         #
         # @overload list(inference_pipeline_id, asc: nil, page: nil, per_page: nil, sort_column: nil, column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil, request_options: {})
         #
@@ -109,8 +109,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.
         #
         # @overload delete(inference_id, inference_pipeline_id:, request_options: {})
         #

data/lib/openlayer/resources/inference_pipelines.rb

@@ -12,7 +12,7 @@ module Openlayer
       # @return [Openlayer::Resources::InferencePipelines::TestResults]
       attr_reader :test_results
 
-      # Retrieve inference pipeline.
+      # Retrieve an inference pipeline.
       #
       # @overload retrieve(inference_pipeline_id, expand: nil, request_options: {})
       #
@@ -40,7 +40,7 @@ module Openlayer
       # Some parameter documentations has been truncated, see
       # {Openlayer::Models::InferencePipelineUpdateParams} for more details.
       #
-      # Update inference pipeline.
+      # Update an inference pipeline.
       #
       # @overload update(inference_pipeline_id, description: nil, name: nil, reference_dataset_uri: nil, request_options: {})
       #
@@ -68,7 +68,7 @@ module Openlayer
         )
       end
 
-      # Delete inference pipeline.
+      # Delete an inference pipeline.
       #
       # @overload delete(inference_pipeline_id, request_options: {})
       #
@@ -88,12 +88,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.
       #
       # @overload retrieve_sessions(inference_pipeline_id, asc: nil, page: nil, per_page: nil, sort_column: nil, column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil, request_options: {})
       #
@@ -140,11 +135,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.
       #
       # @overload retrieve_users(inference_pipeline_id, asc: nil, page: nil, per_page: nil, sort_column: nil, column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil, request_options: {})
       #

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

@@ -7,7 +7,7 @@ module Openlayer
         # Some parameter documentations has been truncated, see
         # {Openlayer::Models::Projects::TestCreateParams} for more details.
         #
-        # Create a test.
+        # Create a test in a project.
         #
         # @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: {})
         #
@@ -63,7 +63,7 @@ module Openlayer
           )
         end
 
-        # Update tests.
+        # Update tests in a project.
         #
         # @overload update(project_id, payloads:, request_options: {})
         #
@@ -90,7 +90,7 @@ module Openlayer
         # Some parameter documentations has been truncated, see
         # {Openlayer::Models::Projects::TestListParams} for more details.
         #
-        # List tests under a project.
+        # List the tests in 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: {})
         #

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

@@ -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.
         #
         # @overload create(object_name:, request_options: {})
         #
@@ -27,6 +27,32 @@ module Openlayer
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Storage::PresignedURLRetrieveParams} for more details.
+        #
+        # Get a short-lived download url for a stored object.
+        #
+        # @overload retrieve(storage_uri:, request_options: {})
+        #
+        # @param storage_uri [String] The object's storage uri, for example `outputs.storageUri` from a framework expo
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Storage::PresignedURLRetrieveResponse]
+        #
+        # @see Openlayer::Models::Storage::PresignedURLRetrieveParams
+        def retrieve(params)
+          parsed, options = Openlayer::Storage::PresignedURLRetrieveParams.dump_request(params)
+          query = Openlayer::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "storage/presigned-url",
+            query: query.transform_keys(storage_uri: "storageUri"),
+            model: Openlayer::Models::Storage::PresignedURLRetrieveResponse,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [Openlayer::Client]

data/lib/openlayer/resources/tests.rb

@@ -6,10 +6,7 @@ module Openlayer
       # 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.
+      # Evaluate a test over a custom time range.
       #
       # @overload evaluate(test_id, end_timestamp:, start_timestamp:, inference_pipeline_id: nil, overwrite_results: nil, request_options: {})
       #

data/lib/openlayer/resources/workspaces/api_keys.rb

@@ -4,12 +4,17 @@ module Openlayer
   module Resources
     class Workspaces
       class APIKeys
-        # Create a new API key in a workspace.
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Workspaces::APIKeyCreateParams} for more details.
         #
-        # @overload create(workspace_id, name: nil, request_options: {})
+        # Create a new API key.
+        #
+        # @overload create(workspace_id, expires_at: nil, name: nil, request_options: {})
         #
         # @param workspace_id [String] The workspace id.
         #
+        # @param expires_at [Time, nil] When the key stops authenticating. `null` means the key never expires. Set when
+        #
         # @param name [String, nil] The API key name.
         #
         # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -28,6 +33,145 @@ module Openlayer
           )
         end
 
+        # Retrieve an API key.
+        #
+        # @overload retrieve(api_key_id, workspace_id:, request_options: {})
+        #
+        # @param api_key_id [String] The API key id.
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Workspaces::APIKeyRetrieveResponse]
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyRetrieveParams
+        def retrieve(api_key_id, params)
+          parsed, options = Openlayer::Workspaces::APIKeyRetrieveParams.dump_request(params)
+          workspace_id =
+            parsed.delete(:workspace_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["workspaces/%1$s/api-keys/%2$s", workspace_id, api_key_id],
+            model: Openlayer::Models::Workspaces::APIKeyRetrieveResponse,
+            options: options
+          )
+        end
+
+        # Rename an API key.
+        #
+        # @overload update(api_key_id, workspace_id:, name: nil, request_options: {})
+        #
+        # @param api_key_id [String] Path param: The API key id.
+        #
+        # @param workspace_id [String] Path param: The workspace id.
+        #
+        # @param name [String, nil] Body param: The API key name.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Workspaces::APIKeyUpdateResponse]
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyUpdateParams
+        def update(api_key_id, params)
+          parsed, options = Openlayer::Workspaces::APIKeyUpdateParams.dump_request(params)
+          workspace_id =
+            parsed.delete(:workspace_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["workspaces/%1$s/api-keys/%2$s", workspace_id, api_key_id],
+            body: parsed,
+            model: Openlayer::Models::Workspaces::APIKeyUpdateResponse,
+            options: options
+          )
+        end
+
+        # List your API keys in a workspace.
+        #
+        # @overload list(workspace_id, request_options: {})
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Openlayer::Models::Workspaces::APIKeyListResponseItem>]
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyListParams
+        def list(workspace_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["workspaces/%1$s/api-keys", workspace_id],
+            model: Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Workspaces::APIKeyListResponseItem],
+            options: params[:request_options]
+          )
+        end
+
+        # Delete an API key.
+        #
+        # @overload delete(api_key_id, workspace_id:, request_options: {})
+        #
+        # @param api_key_id [String] The API key id.
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyDeleteParams
+        def delete(api_key_id, params)
+          parsed, options = Openlayer::Workspaces::APIKeyDeleteParams.dump_request(params)
+          workspace_id =
+            parsed.delete(:workspace_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["workspaces/%1$s/api-keys/%2$s", workspace_id, api_key_id],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Workspaces::APIKeyRotateParams} for more details.
+        #
+        # Replace an API key's secret.
+        #
+        # @overload rotate(api_key_id, workspace_id:, expires_at: nil, grace_period_hours: nil, request_options: {})
+        #
+        # @param api_key_id [String] Path param: The API key id.
+        #
+        # @param workspace_id [String] Path param: The workspace id.
+        #
+        # @param expires_at [Time, nil] Body param: When the key stops authenticating. `null` means the key never expire
+        #
+        # @param grace_period_hours [Integer] Body param: Hours the previous secret keeps authenticating. The default of 0 ret
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Workspaces::APIKeyRotateResponse]
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyRotateParams
+        def rotate(api_key_id, params)
+          parsed, options = Openlayer::Workspaces::APIKeyRotateParams.dump_request(params)
+          workspace_id =
+            parsed.delete(:workspace_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["workspaces/%1$s/api-keys/%2$s/rotate", workspace_id, api_key_id],
+            body: parsed,
+            model: Openlayer::Models::Workspaces::APIKeyRotateResponse,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [Openlayer::Client]

data/lib/openlayer/resources/workspaces/invites.rb

@@ -30,7 +30,7 @@ module Openlayer
           )
         end
 
-        # Retrieve a list of invites in a workspace.
+        # List the invites in a workspace.
         #
         # @overload list(workspace_id, page: nil, per_page: nil, request_options: {})
         #

data/lib/openlayer/resources/workspaces.rb

@@ -9,7 +9,7 @@ module Openlayer
       # @return [Openlayer::Resources::Workspaces::APIKeys]
       attr_reader :api_keys
 
-      # Retrieve a workspace by its ID.
+      # Retrieve a workspace.
       #
       # @overload retrieve(workspace_id, request_options: {})
       #

data/lib/openlayer/version.rb

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