openlayer 0.14.1 → 0.16.0

data/lib/openlayer/models/project_update_response.rb

@@ -0,0 +1,297 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    # @see Openlayer::Resources::Projects#update
+    class ProjectUpdateResponse < 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::ProjectUpdateResponse::TaskType]
+      required :task_type, enum: -> { Openlayer::Models::ProjectUpdateResponse::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::ProjectUpdateResponse::Links]
+        required :links, -> { Openlayer::Models::ProjectUpdateResponse::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::ProjectUpdateResponse::Source, nil]
+        required :source, enum: -> { Openlayer::Models::ProjectUpdateResponse::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::ProjectUpdateResponse::GitRepo, nil]
+        optional :git_repo,
+                 -> { Openlayer::Models::ProjectUpdateResponse::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::ProjectUpdateResponse} 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::ProjectUpdateResponse::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::ProjectUpdateResponse::Source, nil] The source of the project.
+      #
+      #   @param task_type [Symbol, Openlayer::Models::ProjectUpdateResponse::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::ProjectUpdateResponse::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::ProjectUpdateResponse#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::ProjectUpdateResponse#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::ProjectUpdateResponse#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::ProjectUpdateResponse#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

data/lib/openlayer/models/projects/inference_pipeline_create_params.rb

@@ -671,18 +671,55 @@ module Openlayer
                    enum: -> { Openlayer::Projects::InferencePipelineCreateParams::Project::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
 
-          # @!method initialize(name:, task_type:, description: nil)
+          # @!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
+
+          # @!method initialize(name:, task_type:, data_retention_days: nil, description: nil, model_developer: nil, model_types: nil, purpose: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Openlayer::Models::Projects::InferencePipelineCreateParams::Project} for more
+          #   details.
+          #
           #   @param name [String] The project name.
           #
           #   @param task_type [Symbol, Openlayer::Models::Projects::InferencePipelineCreateParams::Project::TaskType] The task type of the project.
           #
+          #   @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 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::Projects::InferencePipelineCreateParams::Project#links
           class Links < Openlayer::Internal::Type::BaseModel
@@ -705,7 +742,6 @@ module Openlayer
 
             WEB = :web
             API = :api
-            NULL = :null
 
             # @!method self.values
             #   @return [Array<Symbol>]

data/lib/openlayer/models/projects/inference_pipeline_create_response.rb

@@ -703,12 +703,37 @@ module Openlayer
                    enum: -> { Openlayer::Models::Projects::InferencePipelineCreateResponse::Project::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.
@@ -793,7 +818,11 @@ module Openlayer
                      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:, description: nil, git_repo: nil)
+          # @!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::Projects::InferencePipelineCreateResponse::Project} for more
+          #   details.
+          #
           #   @param id [String] The project id.
           #
           #   @param creator_id [String, nil] The project creator id.
@@ -822,9 +851,17 @@ module Openlayer
           #
           #   @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::Projects::InferencePipelineCreateResponse::Project::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::Projects::InferencePipelineCreateResponse::Project#links
           class Links < Openlayer::Internal::Type::BaseModel
@@ -847,7 +884,6 @@ module Openlayer
 
             WEB = :web
             API = :api
-            NULL = :null
 
             # @!method self.values
             #   @return [Array<Symbol>]

data/lib/openlayer/models/projects/inference_pipeline_list_response.rb

@@ -713,12 +713,40 @@ module Openlayer
                      enum: -> { Openlayer::Models::Projects::InferencePipelineListResponse::Item::Project::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.
@@ -803,7 +831,11 @@ module Openlayer
                        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:, description: nil, git_repo: nil)
+            # @!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::Projects::InferencePipelineListResponse::Item::Project} for
+            #   more details.
+            #
             #   @param id [String] The project id.
             #
             #   @param creator_id [String, nil] The project creator id.
@@ -832,9 +864,17 @@ module Openlayer
             #
             #   @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::Projects::InferencePipelineListResponse::Item::Project::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::Projects::InferencePipelineListResponse::Item::Project#links
             class Links < Openlayer::Internal::Type::BaseModel
@@ -857,7 +897,6 @@ module Openlayer
 
               WEB = :web
               API = :api
-              NULL = :null
 
               # @!method self.values
               #   @return [Array<Symbol>]

data/lib/openlayer/models/storage/presigned_url_retrieve_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Storage
+      # @see Openlayer::Resources::Storage::PresignedURL#retrieve
+      class PresignedURLRetrieveParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        # @!attribute storage_uri
+        #   The object's storage uri.
+        #
+        #   @return [String]
+        required :storage_uri, String
+
+        # @!method initialize(storage_uri:, request_options: {})
+        #   @param storage_uri [String] The object's storage uri.
+        #
+        #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/openlayer/models/storage/presigned_url_retrieve_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Storage
+      # @see Openlayer::Resources::Storage::PresignedURL#retrieve
+      class PresignedURLRetrieveResponse < Openlayer::Internal::Type::BaseModel
+        # @!attribute url
+        #   The presigned url. Short-lived -- download promptly.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(url:)
+        #   @param url [String] The presigned url. Short-lived -- download promptly.
+      end
+    end
+  end
+end

data/lib/openlayer/models.rb

@@ -39,10 +39,14 @@ module Openlayer
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  BackgroundTaskRetrieveParams = Openlayer::Models::BackgroundTaskRetrieveParams
+
   CommitRetrieveParams = Openlayer::Models::CommitRetrieveParams
 
   Commits = Openlayer::Models::Commits
 
+  Governance = Openlayer::Models::Governance
+
   InferencePipelineDeleteParams = Openlayer::Models::InferencePipelineDeleteParams
 
   InferencePipelineRetrieveParams = Openlayer::Models::InferencePipelineRetrieveParams
@@ -63,6 +67,8 @@ module Openlayer
 
   Projects = Openlayer::Models::Projects
 
+  ProjectUpdateParams = Openlayer::Models::ProjectUpdateParams
+
   Storage = Openlayer::Models::Storage
 
   TestEvaluateParams = Openlayer::Models::TestEvaluateParams

data/lib/openlayer/resources/background_tasks.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class BackgroundTasks
+      # Retrieve a background task's status, progress and results.
+      #
+      # Endpoints that cannot answer within one request queue a task and hand back its
+      # id -- for example `POST /frameworks/{frameworkId}/export`. Poll this endpoint
+      # until `complete` is `true`, then read what the task produced from `outputs`.
+      #
+      # @overload retrieve(task_id, request_options: {})
+      #
+      # @param task_id [String] The background task id.
+      #
+      # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Openlayer::Models::BackgroundTaskRetrieveResponse]
+      #
+      # @see Openlayer::Models::BackgroundTaskRetrieveParams
+      def retrieve(task_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["background-tasks/%1$s", task_id],
+          model: Openlayer::Models::BackgroundTaskRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Openlayer::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end