openlayer 0.14.1 → 0.16.0

data/lib/openlayer/models/governance/framework_list_project_rule_stats_response.rb

@@ -0,0 +1,277 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Governance
+      # @see Openlayer::Resources::Governance::Frameworks#list_project_rule_stats
+      class FrameworkListProjectRuleStatsResponse < Openlayer::Internal::Type::BaseModel
+        # @!attribute items
+        #
+        #   @return [Array<Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item>]
+        required :items,
+                 -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item] }
+
+        # @!method initialize(items:)
+        #   @param items [Array<Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item>]
+
+        class Item < Openlayer::Internal::Type::BaseModel
+          # @!attribute project_id
+          #   The project id.
+          #
+          #   @return [String]
+          required :project_id, String, api_name: :projectId
+
+          # @!attribute project_name
+          #   The project name.
+          #
+          #   @return [String]
+          required :project_name, String, api_name: :projectName
+
+          # @!attribute task_type
+          #   The project's task type.
+          #
+          #   @return [String]
+          required :task_type, String, api_name: :taskType
+
+          # @!attribute total
+          #   The total number of rule results.
+          #
+          #   @return [Integer]
+          required :total, Integer
+
+          # @!attribute total_due_soon
+          #   The number of rule results whose evidence is about to expire.
+          #
+          #   @return [Integer]
+          required :total_due_soon, Integer, api_name: :totalDueSoon
+
+          # @!attribute total_error
+          #   The number of rule results that errored during evaluation.
+          #
+          #   @return [Integer]
+          required :total_error, Integer, api_name: :totalError
+
+          # @!attribute total_failing
+          #   The number of failing rule results.
+          #
+          #   @return [Integer]
+          required :total_failing, Integer, api_name: :totalFailing
+
+          # @!attribute total_passing
+          #   The number of passing rule results.
+          #
+          #   @return [Integer]
+          required :total_passing, Integer, api_name: :totalPassing
+
+          # @!attribute total_pending
+          #   The number of rule results that have not been satisfied yet.
+          #
+          #   @return [Integer]
+          required :total_pending, Integer, api_name: :totalPending
+
+          # @!attribute total_running
+          #   The number of rule results currently being evaluated.
+          #
+          #   @return [Integer]
+          required :total_running, Integer, api_name: :totalRunning
+
+          # @!attribute total_skipped
+          #   The number of skipped rule results.
+          #
+          #   @return [Integer]
+          required :total_skipped, Integer, api_name: :totalSkipped
+
+          # @!attribute by_rule_type
+          #   The same counts, broken down by the type of the rule each result belongs to.
+          #
+          #   @return [Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item::ByRuleType, nil]
+          optional :by_rule_type,
+                   -> { Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item::ByRuleType },
+                   api_name: :byRuleType
+
+          # @!method initialize(project_id:, project_name:, task_type:, total:, total_due_soon:, total_error:, total_failing:, total_passing:, total_pending:, total_running:, total_skipped:, by_rule_type: nil)
+          #   @param project_id [String] The project id.
+          #
+          #   @param project_name [String] The project name.
+          #
+          #   @param task_type [String] The project's task type.
+          #
+          #   @param total [Integer] The total number of rule results.
+          #
+          #   @param total_due_soon [Integer] The number of rule results whose evidence is about to expire.
+          #
+          #   @param total_error [Integer] The number of rule results that errored during evaluation.
+          #
+          #   @param total_failing [Integer] The number of failing rule results.
+          #
+          #   @param total_passing [Integer] The number of passing rule results.
+          #
+          #   @param total_pending [Integer] The number of rule results that have not been satisfied yet.
+          #
+          #   @param total_running [Integer] The number of rule results currently being evaluated.
+          #
+          #   @param total_skipped [Integer] The number of skipped rule results.
+          #
+          #   @param by_rule_type [Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item::ByRuleType] The same counts, broken down by the type of the rule each result belongs to.
+
+          # @see Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item#by_rule_type
+          class ByRuleType < Openlayer::Internal::Type::BaseModel
+            # @!attribute evidence
+            #
+            #   @return [Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item::ByRuleType::Evidence, nil]
+            optional :evidence,
+                     -> { Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item::ByRuleType::Evidence }
+
+            # @!attribute platform
+            #
+            #   @return [Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item::ByRuleType::Platform, nil]
+            optional :platform,
+                     -> { Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item::ByRuleType::Platform }
+
+            # @!method initialize(evidence: nil, platform: nil)
+            #   The same counts, broken down by the type of the rule each result belongs to.
+            #
+            #   @param evidence [Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item::ByRuleType::Evidence]
+            #   @param platform [Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item::ByRuleType::Platform]
+
+            # @see Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item::ByRuleType#evidence
+            class Evidence < Openlayer::Internal::Type::BaseModel
+              # @!attribute total
+              #   The total number of rule results.
+              #
+              #   @return [Integer]
+              required :total, Integer
+
+              # @!attribute total_due_soon
+              #   The number of rule results whose evidence is about to expire.
+              #
+              #   @return [Integer]
+              required :total_due_soon, Integer, api_name: :totalDueSoon
+
+              # @!attribute total_error
+              #   The number of rule results that errored during evaluation.
+              #
+              #   @return [Integer]
+              required :total_error, Integer, api_name: :totalError
+
+              # @!attribute total_failing
+              #   The number of failing rule results.
+              #
+              #   @return [Integer]
+              required :total_failing, Integer, api_name: :totalFailing
+
+              # @!attribute total_passing
+              #   The number of passing rule results.
+              #
+              #   @return [Integer]
+              required :total_passing, Integer, api_name: :totalPassing
+
+              # @!attribute total_pending
+              #   The number of rule results that have not been satisfied yet.
+              #
+              #   @return [Integer]
+              required :total_pending, Integer, api_name: :totalPending
+
+              # @!attribute total_running
+              #   The number of rule results currently being evaluated.
+              #
+              #   @return [Integer]
+              required :total_running, Integer, api_name: :totalRunning
+
+              # @!attribute total_skipped
+              #   The number of skipped rule results.
+              #
+              #   @return [Integer]
+              required :total_skipped, Integer, api_name: :totalSkipped
+
+              # @!method initialize(total:, total_due_soon:, total_error:, total_failing:, total_passing:, total_pending:, total_running:, total_skipped:)
+              #   @param total [Integer] The total number of rule results.
+              #
+              #   @param total_due_soon [Integer] The number of rule results whose evidence is about to expire.
+              #
+              #   @param total_error [Integer] The number of rule results that errored during evaluation.
+              #
+              #   @param total_failing [Integer] The number of failing rule results.
+              #
+              #   @param total_passing [Integer] The number of passing rule results.
+              #
+              #   @param total_pending [Integer] The number of rule results that have not been satisfied yet.
+              #
+              #   @param total_running [Integer] The number of rule results currently being evaluated.
+              #
+              #   @param total_skipped [Integer] The number of skipped rule results.
+            end
+
+            # @see Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse::Item::ByRuleType#platform
+            class Platform < Openlayer::Internal::Type::BaseModel
+              # @!attribute total
+              #   The total number of rule results.
+              #
+              #   @return [Integer]
+              required :total, Integer
+
+              # @!attribute total_due_soon
+              #   The number of rule results whose evidence is about to expire.
+              #
+              #   @return [Integer]
+              required :total_due_soon, Integer, api_name: :totalDueSoon
+
+              # @!attribute total_error
+              #   The number of rule results that errored during evaluation.
+              #
+              #   @return [Integer]
+              required :total_error, Integer, api_name: :totalError
+
+              # @!attribute total_failing
+              #   The number of failing rule results.
+              #
+              #   @return [Integer]
+              required :total_failing, Integer, api_name: :totalFailing
+
+              # @!attribute total_passing
+              #   The number of passing rule results.
+              #
+              #   @return [Integer]
+              required :total_passing, Integer, api_name: :totalPassing
+
+              # @!attribute total_pending
+              #   The number of rule results that have not been satisfied yet.
+              #
+              #   @return [Integer]
+              required :total_pending, Integer, api_name: :totalPending
+
+              # @!attribute total_running
+              #   The number of rule results currently being evaluated.
+              #
+              #   @return [Integer]
+              required :total_running, Integer, api_name: :totalRunning
+
+              # @!attribute total_skipped
+              #   The number of skipped rule results.
+              #
+              #   @return [Integer]
+              required :total_skipped, Integer, api_name: :totalSkipped
+
+              # @!method initialize(total:, total_due_soon:, total_error:, total_failing:, total_passing:, total_pending:, total_running:, total_skipped:)
+              #   @param total [Integer] The total number of rule results.
+              #
+              #   @param total_due_soon [Integer] The number of rule results whose evidence is about to expire.
+              #
+              #   @param total_error [Integer] The number of rule results that errored during evaluation.
+              #
+              #   @param total_failing [Integer] The number of failing rule results.
+              #
+              #   @param total_passing [Integer] The number of passing rule results.
+              #
+              #   @param total_pending [Integer] The number of rule results that have not been satisfied yet.
+              #
+              #   @param total_running [Integer] The number of rule results currently being evaluated.
+              #
+              #   @param total_skipped [Integer] The number of skipped rule results.
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/models/governance/framework_list_projects_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Governance
+      # @see Openlayer::Resources::Governance::Frameworks#list_projects
+      class FrameworkListProjectsParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        # @!attribute framework_id
+        #
+        #   @return [String]
+        required :framework_id, String
+
+        # @!attribute page
+        #   The page to return in a paginated query.
+        #
+        #   @return [Integer, nil]
+        optional :page, Integer
+
+        # @!attribute per_page
+        #   Maximum number of items to return per page.
+        #
+        #   @return [Integer, nil]
+        optional :per_page, Integer
+
+        # @!method initialize(framework_id:, page: nil, per_page: nil, request_options: {})
+        #   @param framework_id [String]
+        #
+        #   @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}]
+      end
+    end
+  end
+end

data/lib/openlayer/models/governance/framework_list_projects_response.rb

@@ -0,0 +1,315 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Governance
+      # @see Openlayer::Resources::Governance::Frameworks#list_projects
+      class FrameworkListProjectsResponse < Openlayer::Internal::Type::BaseModel
+        # @!attribute items
+        #
+        #   @return [Array<Openlayer::Models::Governance::FrameworkListProjectsResponse::Item>]
+        required :items,
+                 -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::FrameworkListProjectsResponse::Item] }
+
+        # @!method initialize(items:)
+        #   @param items [Array<Openlayer::Models::Governance::FrameworkListProjectsResponse::Item>]
+
+        class Item < Openlayer::Internal::Type::BaseModel
+          # @!attribute name
+          #   The project name.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute task_type
+          #   The task type of the project.
+          #
+          #   @return [Symbol, Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::TaskType]
+          required :task_type,
+                   enum: -> { Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::TaskType },
+                   api_name: :taskType
+
+          # @!attribute data_retention_days
+          #   Number of days to retain monitoring data for this project. Null means data is
+          #   retained indefinitely.
+          #
+          #   @return [Integer, nil]
+          optional :data_retention_days, Integer, api_name: :dataRetentionDays, nil?: true
+
+          # @!attribute description
+          #   The project description.
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!attribute model_developer
+          #   Who developed the model used in this project.
+          #
+          #   @return [String, nil]
+          optional :model_developer, String, api_name: :modelDeveloper, nil?: true
+
+          # @!attribute model_types
+          #   The kinds of model used in this project.
+          #
+          #   @return [Array<String>, nil]
+          optional :model_types, Openlayer::Internal::Type::ArrayOf[String], api_name: :modelTypes, nil?: true
+
+          # @!attribute purpose
+          #   What the system in this project is intended to do.
+          #
+          #   @return [String, nil]
+          optional :purpose, String, nil?: true
+
+          response_only do
+            # @!attribute id
+            #   The project id.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute creator_id
+            #   The project creator id.
+            #
+            #   @return [String, nil]
+            required :creator_id, String, api_name: :creatorId, nil?: true
+
+            # @!attribute date_created
+            #   The project creation date.
+            #
+            #   @return [Time]
+            required :date_created, Time, api_name: :dateCreated
+
+            # @!attribute date_updated
+            #   The project last updated date.
+            #
+            #   @return [Time]
+            required :date_updated, Time, api_name: :dateUpdated
+
+            # @!attribute development_goal_count
+            #   The number of tests in the development mode of the project.
+            #
+            #   @return [Integer]
+            required :development_goal_count, Integer, api_name: :developmentGoalCount
+
+            # @!attribute goal_count
+            #   The total number of tests in the project.
+            #
+            #   @return [Integer]
+            required :goal_count, Integer, api_name: :goalCount
+
+            # @!attribute inference_pipeline_count
+            #   The number of inference pipelines in the project.
+            #
+            #   @return [Integer]
+            required :inference_pipeline_count, Integer, api_name: :inferencePipelineCount
+
+            # @!attribute links
+            #   Links to the project.
+            #
+            #   @return [Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::Links]
+            required :links, -> { Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::Links }
+
+            # @!attribute monitoring_goal_count
+            #   The number of tests in the monitoring mode of the project.
+            #
+            #   @return [Integer]
+            required :monitoring_goal_count, Integer, api_name: :monitoringGoalCount
+
+            # @!attribute source
+            #   The source of the project.
+            #
+            #   @return [Symbol, Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::Source, nil]
+            required :source,
+                     enum: -> { Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::Source },
+                     nil?: true
+
+            # @!attribute version_count
+            #   The number of versions (commits) in the project.
+            #
+            #   @return [Integer]
+            required :version_count, Integer, api_name: :versionCount
+
+            # @!attribute workspace_id
+            #   The workspace id.
+            #
+            #   @return [String, nil]
+            required :workspace_id, String, api_name: :workspaceId, nil?: true
+
+            # @!attribute git_repo
+            #
+            #   @return [Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::GitRepo, nil]
+            optional :git_repo,
+                     -> { Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::GitRepo },
+                     api_name: :gitRepo,
+                     nil?: true
+          end
+
+          # @!method initialize(id:, creator_id:, date_created:, date_updated:, development_goal_count:, goal_count:, inference_pipeline_count:, links:, monitoring_goal_count:, name:, source:, task_type:, version_count:, workspace_id:, data_retention_days: nil, description: nil, git_repo: nil, model_developer: nil, model_types: nil, purpose: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Openlayer::Models::Governance::FrameworkListProjectsResponse::Item} for more
+          #   details.
+          #
+          #   @param id [String] The project id.
+          #
+          #   @param creator_id [String, nil] The project creator id.
+          #
+          #   @param date_created [Time] The project creation date.
+          #
+          #   @param date_updated [Time] The project last updated date.
+          #
+          #   @param development_goal_count [Integer] The number of tests in the development mode of the project.
+          #
+          #   @param goal_count [Integer] The total number of tests in the project.
+          #
+          #   @param inference_pipeline_count [Integer] The number of inference pipelines in the project.
+          #
+          #   @param links [Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::Links] Links to the project.
+          #
+          #   @param monitoring_goal_count [Integer] The number of tests in the monitoring mode of the project.
+          #
+          #   @param name [String] The project name.
+          #
+          #   @param source [Symbol, Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::Source, nil] The source of the project.
+          #
+          #   @param task_type [Symbol, Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::TaskType] The task type of the project.
+          #
+          #   @param version_count [Integer] The number of versions (commits) in the project.
+          #
+          #   @param workspace_id [String, nil] The workspace id.
+          #
+          #   @param data_retention_days [Integer, nil] Number of days to retain monitoring data for this project. Null means data is re
+          #
+          #   @param description [String, nil] The project description.
+          #
+          #   @param git_repo [Openlayer::Models::Governance::FrameworkListProjectsResponse::Item::GitRepo, nil]
+          #
+          #   @param model_developer [String, nil] Who developed the model used in this project.
+          #
+          #   @param model_types [Array<String>, nil] The kinds of model used in this project.
+          #
+          #   @param purpose [String, nil] What the system in this project is intended to do.
+
+          # @see Openlayer::Models::Governance::FrameworkListProjectsResponse::Item#links
+          class Links < Openlayer::Internal::Type::BaseModel
+            # @!attribute app
+            #
+            #   @return [String]
+            required :app, String
+
+            # @!method initialize(app:)
+            #   Links to the project.
+            #
+            #   @param app [String]
+          end
+
+          # The source of the project.
+          #
+          # @see Openlayer::Models::Governance::FrameworkListProjectsResponse::Item#source
+          module Source
+            extend Openlayer::Internal::Type::Enum
+
+            WEB = :web
+            API = :api
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The task type of the project.
+          #
+          # @see Openlayer::Models::Governance::FrameworkListProjectsResponse::Item#task_type
+          module TaskType
+            extend Openlayer::Internal::Type::Enum
+
+            LLM_BASE = :"llm-base"
+            TABULAR_CLASSIFICATION = :"tabular-classification"
+            TABULAR_REGRESSION = :"tabular-regression"
+            TEXT_CLASSIFICATION = :"text-classification"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Openlayer::Models::Governance::FrameworkListProjectsResponse::Item#git_repo
+          class GitRepo < Openlayer::Internal::Type::BaseModel
+            # @!attribute git_account_id
+            #
+            #   @return [String]
+            required :git_account_id, String, api_name: :gitAccountId
+
+            # @!attribute git_id
+            #
+            #   @return [Integer]
+            required :git_id, Integer, api_name: :gitId
+
+            # @!attribute branch
+            #
+            #   @return [String, nil]
+            optional :branch, String
+
+            # @!attribute root_dir
+            #
+            #   @return [String, nil]
+            optional :root_dir, String, api_name: :rootDir
+
+            response_only do
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute date_connected
+              #
+              #   @return [Time]
+              required :date_connected, Time, api_name: :dateConnected
+
+              # @!attribute date_updated
+              #
+              #   @return [Time]
+              required :date_updated, Time, api_name: :dateUpdated
+
+              # @!attribute name
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute private
+              #
+              #   @return [Boolean]
+              required :private, Openlayer::Internal::Type::Boolean
+
+              # @!attribute project_id
+              #
+              #   @return [String]
+              required :project_id, String, api_name: :projectId
+
+              # @!attribute slug
+              #
+              #   @return [String]
+              required :slug, String
+
+              # @!attribute url
+              #
+              #   @return [String]
+              required :url, String
+            end
+
+            # @!method initialize(id:, date_connected:, date_updated:, git_account_id:, git_id:, name:, private:, project_id:, slug:, url:, branch: nil, root_dir: nil)
+            #   @param id [String]
+            #   @param date_connected [Time]
+            #   @param date_updated [Time]
+            #   @param git_account_id [String]
+            #   @param git_id [Integer]
+            #   @param name [String]
+            #   @param private [Boolean]
+            #   @param project_id [String]
+            #   @param slug [String]
+            #   @param url [String]
+            #   @param branch [String]
+            #   @param root_dir [String]
+          end
+        end
+      end
+    end
+  end
+end