completion-kit 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 285fba79d665c4fe077b42f0e8ce888ce84a314b95698a561eea9fb48c75b045
-  data.tar.gz: a984971e294bda341824e3696cab11662f82fcee2c50974798356754ba55126c
+  metadata.gz: 4625f4e3f1afceb34f7603ee7a5025c78cb2499f6c2c287d83a9d02397f407b2
+  data.tar.gz: 740fecb69351c418aaececb19b9cfe3579bf9124a5df52a23d6db5851ce63fce
 SHA512:
-  metadata.gz: 1a12beaf77a9d8071949bede78336910eb8da43598609ac6307e09493d1c088a82cc3056ccaf63b3ae4eeb4ea022d19c182a05c0f037bc8a31ba21246cc5bd56
-  data.tar.gz: e007e6eeb9f7e89f3aa5ba8397338ce19778b5040f184b8cb6c012faf3f6ea464f6c3d5423fd7f7b36882494fbb90d70e068da7fe15bb76e67e9992585ba80c6
+  metadata.gz: 548cc9666d2cf744babbe6a62047f2c4a44f79fe63490b795d84017742f3db4baff9313dfa4392e4b09c740645224493787d6af4208994d43a02a6610275e3c7
+  data.tar.gz: d8f405649cc42b70e4849f5e0fb9bfe733507baf91e47fdd3650c1ca1b3cab0099a337b038777799853a74cca8bc767baa6cf90107fd737eb519678d0dd4bdd0

data/app/assets/stylesheets/completion_kit/application.css

@@ -298,6 +298,11 @@ form.button_to {
   margin-right: 0.75rem;
 }
 
+.ck-title--sm {
+  font-size: clamp(1.1rem, 1.6vw, 1.4rem);
+  line-height: 1.25;
+}
+
 .ck-section-title {
   font-size: 1.35rem;
 }
@@ -6029,13 +6034,16 @@ a.tag-mark {
 }
 .ck-starter-grid {
   display: grid;
-  grid-template-columns: repeat(4, 1fr);
+  grid-template-columns: repeat(5, 1fr);
   gap: 12px;
 }
-@media (max-width: 1000px) {
+@media (max-width: 1100px) {
+  .ck-starter-grid { grid-template-columns: repeat(3, 1fr); }
+}
+@media (max-width: 700px) {
   .ck-starter-grid { grid-template-columns: repeat(2, 1fr); }
 }
-@media (max-width: 600px) {
+@media (max-width: 500px) {
   .ck-starter-grid { grid-template-columns: 1fr; }
 }
 .ck-starter-card {

data/app/controllers/completion_kit/api/v1/base_controller.rb

@@ -3,26 +3,36 @@ module CompletionKit
     module V1
       class BaseController < ActionController::API
         rate_limit to: CompletionKit.config.api_rate_limit, within: 1.minute,
-                   with: -> { render json: {error: "Rate limit exceeded"}, status: :too_many_requests }
+                   with: -> { render_error("Rate limit exceeded", status: :too_many_requests) }
         before_action :authenticate_api!
 
         private
 
+        def render_error(message, status:, details: nil)
+          payload = { error: message }
+          payload[:details] = details if details.present?
+          render json: payload, status: status
+        end
+
+        def render_validation_errors(record, status: :unprocessable_entity)
+          render_error("Validation failed", status: status, details: record.errors.as_json)
+        end
+
         def authenticate_api!
           token = CompletionKit.config.api_token
           unless token
-            render json: {error: "API token not configured"}, status: :unauthorized
+            render_error("API token not configured", status: :unauthorized)
             return
           end
 
           provided = request.headers["Authorization"]&.match(/\ABearer (.+)\z/)&.[](1)
           unless provided && ActiveSupport::SecurityUtils.secure_compare(provided, token)
-            render json: {error: "Unauthorized"}, status: :unauthorized
+            render_error("Unauthorized", status: :unauthorized)
           end
         end
 
         def not_found
-          render json: {error: "Record not found"}, status: :not_found
+          render_error("Record not found", status: :not_found)
         end
 
         PAGINATION_DEFAULT_LIMIT = 50

data/app/controllers/completion_kit/api/v1/calibrations_controller.rb

@@ -30,7 +30,7 @@ module CompletionKit
           if calibration.save
             render json: calibration, status: calibration.previously_new_record? ? :created : :ok
           else
-            render json: { errors: calibration.errors }, status: :unprocessable_entity
+            render_validation_errors(calibration)
           end
         end
 
@@ -42,7 +42,7 @@ module CompletionKit
         private
 
         def ensure_calibration_enabled
-          render(json: { error: "Calibration disabled" }, status: :not_found) unless CompletionKit.config.judge_calibration_enabled
+          render_error("Calibration disabled", status: :not_found) unless CompletionKit.config.judge_calibration_enabled
         end
 
         def set_nested_scope

data/app/controllers/completion_kit/api/v1/datasets_controller.rb

@@ -19,7 +19,7 @@ module CompletionKit
           if dataset.save
             render json: dataset, status: :created
           else
-            render json: {errors: dataset.errors}, status: :unprocessable_entity
+            render_validation_errors(dataset)
           end
         end
 
@@ -27,7 +27,7 @@ module CompletionKit
           if @dataset.update(dataset_params)
             render json: @dataset
           else
-            render json: {errors: @dataset.errors}, status: :unprocessable_entity
+            render_validation_errors(@dataset)
           end
         end
 

data/app/controllers/completion_kit/api/v1/metric_groups_controller.rb

@@ -20,7 +20,7 @@ module CompletionKit
             metric_group.replace_metrics!(params[:metric_ids]) if params.key?(:metric_ids)
             render json: metric_group.reload, status: :created
           else
-            render json: {errors: metric_group.errors}, status: :unprocessable_entity
+            render_validation_errors(metric_group)
           end
         end
 
@@ -29,7 +29,7 @@ module CompletionKit
             @metric_group.replace_metrics!(params[:metric_ids]) if params.key?(:metric_ids)
             render json: @metric_group.reload
           else
-            render json: {errors: @metric_group.errors}, status: :unprocessable_entity
+            render_validation_errors(@metric_group)
           end
         end
 

data/app/controllers/completion_kit/api/v1/metric_versions_controller.rb

@@ -25,7 +25,7 @@ module CompletionKit
 
         def destroy
           if @version.published?
-            render json: { error: "Cannot dismiss a published version. Publish a different version as current instead." }, status: :conflict
+            render_error("Cannot dismiss a published version. Publish a different version as current instead.", status: :conflict)
             return
           end
           @version.destroy!

data/app/controllers/completion_kit/api/v1/metrics_controller.rb

@@ -19,7 +19,7 @@ module CompletionKit
           if metric.save
             render json: metric, status: :created
           else
-            render json: {errors: metric.errors}, status: :unprocessable_entity
+            render_validation_errors(metric)
           end
         end
 
@@ -27,7 +27,7 @@ module CompletionKit
           if @metric.update(metric_params)
             render json: @metric
           else
-            render json: {errors: @metric.errors}, status: :unprocessable_entity
+            render_validation_errors(@metric)
           end
         end
 
@@ -39,7 +39,7 @@ module CompletionKit
         def suggest_variants
           disagreement_count = Calibration.where(metric_id: @metric.id, verdict: "disagree").count
           if disagreement_count.zero?
-            render json: { error: "Mark at least one case as Disagree before asking the model to suggest a change." }, status: :unprocessable_entity
+            render_error("Mark at least one case as Disagree before asking the model to suggest a change.", status: :unprocessable_entity)
             return
           end
 
@@ -47,7 +47,7 @@ module CompletionKit
           generator = MetricVariantGenerator.new(@metric, count: params[:count].to_i, model: params[:model])
           variants = generator.call
           if variants.empty?
-            render json: { error: "The model returned no usable variants. Try again with a different model." }, status: :unprocessable_entity
+            render_error("The model returned no usable variants. Try again with a different model.", status: :unprocessable_entity)
             return
           end
           versions = generator.persist!(variants)
@@ -71,7 +71,7 @@ module CompletionKit
           @metric.update!(few_shot_examples: examples)
           render json: @metric.reload
         rescue ActiveRecord::RecordNotFound
-          render json: { error: "Calibration not found or not a disagree on this metric." }, status: :not_found
+          render_error("Calibration not found or not a disagree on this metric.", status: :not_found)
         end
 
         def remove_few_shot

data/app/controllers/completion_kit/api/v1/prompts_controller.rb

@@ -19,7 +19,7 @@ module CompletionKit
           if prompt.save
             render json: prompt, status: :created
           else
-            render json: {errors: prompt.errors}, status: :unprocessable_entity
+            render_validation_errors(prompt)
           end
         end
 
@@ -32,7 +32,7 @@ module CompletionKit
           elsif @prompt.update(prompt_params)
             render json: @prompt
           else
-            render json: {errors: @prompt.errors}, status: :unprocessable_entity
+            render_validation_errors(@prompt)
           end
         end
 

data/app/controllers/completion_kit/api/v1/provider_credentials_controller.rb

@@ -17,7 +17,7 @@ module CompletionKit
           if credential.save
             render json: credential, status: :created
           else
-            render json: {errors: credential.errors}, status: :unprocessable_entity
+            render_validation_errors(credential)
           end
         end
 
@@ -25,7 +25,7 @@ module CompletionKit
           if @credential.update(credential_params)
             render json: @credential
           else
-            render json: {errors: @credential.errors}, status: :unprocessable_entity
+            render_validation_errors(@credential)
           end
         end
 

data/app/controllers/completion_kit/api/v1/runs_controller.rb

@@ -23,7 +23,7 @@ module CompletionKit
             run.replace_metrics!(params[:metric_ids])
             render json: run.reload, status: :created
           else
-            render json: {errors: run.errors}, status: :unprocessable_entity
+            render_validation_errors(run)
           end
         end
 
@@ -32,7 +32,7 @@ module CompletionKit
             @run.replace_metrics!(params[:metric_ids]) if params.key?(:metric_ids)
             render json: @run.reload
           else
-            render json: {errors: @run.errors}, status: :unprocessable_entity
+            render_validation_errors(@run)
           end
         end
 
@@ -45,13 +45,13 @@ module CompletionKit
           if @run.start!
             render json: @run.reload, status: :accepted
           else
-            render json: { errors: [@run.failure_summary || @run.errors.full_messages.to_sentence] }, status: :unprocessable_entity
+            render_error(@run.failure_summary || @run.errors.full_messages.to_sentence, status: :unprocessable_entity)
           end
         end
 
         def retry_failures
           if @run.stale_review_summary.any?
-            return render(json: { error: "Judge has changed since this run executed. Retry would mix versions in the same run; use POST /api/v1/runs/:id/rerun instead." }, status: :conflict)
+            return render_error("Judge has changed since this run executed. Retry would mix versions in the same run; use POST /api/v1/runs/:id/rerun instead.", status: :conflict)
           end
 
           scope = @run.responses.where(status: "failed")
@@ -90,7 +90,7 @@ module CompletionKit
           if new_run.start!
             render json: new_run.reload, status: :accepted
           else
-            render json: { errors: [new_run.failure_summary || "Could not start the new run."] }, status: :unprocessable_entity
+            render_error(new_run.failure_summary || "Could not start the new run.", status: :unprocessable_entity)
           end
         end
 
@@ -98,7 +98,7 @@ module CompletionKit
           if @run.regrade!
             render json: @run.reload, status: :accepted
           else
-            render json: { error: "Nothing to re-grade. The run has no succeeded responses or no metrics attached." }, status: :unprocessable_entity
+            render_error("Nothing to re-grade. The run has no succeeded responses or no metrics attached.", status: :unprocessable_entity)
           end
         end
 
@@ -107,7 +107,7 @@ module CompletionKit
           comparison = build_run_comparison(@run, other)
           render json: { left_run_id: @run.id, right_run_id: other.id, metric_ids: comparison[:metric_ids], rows: comparison[:rows] }
         rescue ActiveRecord::RecordNotFound
-          render json: { error: "Other run not found. Pass ?with=<run_id>." }, status: :not_found
+          render_error("Other run not found. Pass ?with=<run_id>.", status: :not_found)
         end
 
         private

data/app/controllers/completion_kit/api/v1/tags_controller.rb

@@ -17,7 +17,7 @@ module CompletionKit
           if tag.save
             render json: tag, status: :created
           else
-            render json: {errors: tag.errors}, status: :unprocessable_entity
+            render_validation_errors(tag)
           end
         end
 
@@ -25,7 +25,7 @@ module CompletionKit
           if @tag.update(tag_params)
             render json: @tag
           else
-            render json: {errors: @tag.errors}, status: :unprocessable_entity
+            render_validation_errors(@tag)
           end
         end
 

data/app/jobs/completion_kit/generate_row_job.rb

@@ -80,8 +80,7 @@ module CompletionKit
     end
 
     def record_terminal_failure!(error)
-      response_id = @response_id || arguments.last
-      response = Response.find_by(id: response_id)
+      response = Response.find_by(id: @response_id)
       return unless response
 
       response.update!(
@@ -98,8 +97,7 @@ module CompletionKit
     end
 
     def enqueue_completion_check
-      run_id = @run_id || arguments.first
-      RunCompletionCheckJob.perform_later(run_id)
+      RunCompletionCheckJob.perform_later(@run_id)
     end
   end
 end

data/app/jobs/completion_kit/judge_review_job.rb

@@ -91,14 +91,12 @@ module CompletionKit
     end
 
     def record_terminal_failure!(error)
-      response_id = @response_id || arguments.first
-      metric_id = @metric_id || arguments.last
-      response = Response.find_by(id: response_id)
+      response = Response.find_by(id: @response_id)
       return unless response
 
-      review = response.reviews.find_or_initialize_by(metric_id: metric_id)
+      review = response.reviews.find_or_initialize_by(metric_id: @metric_id)
       review.assign_attributes(
-        metric_name: review.metric_name || Metric.find_by(id: metric_id)&.name || "(deleted metric)",
+        metric_name: review.metric_name || Metric.find_by(id: @metric_id)&.name || "(deleted metric)",
         status: "failed",
         error_provider: provider_for(response),
         error_class: error.class.name,
@@ -115,8 +113,7 @@ module CompletionKit
     end
 
     def enqueue_completion_check
-      response_id = @response_id || arguments.first
-      response = Response.find_by(id: response_id)
+      response = Response.find_by(id: @response_id)
       RunCompletionCheckJob.perform_later(response.run_id) if response
     end
 

data/app/models/completion_kit/run.rb

@@ -290,7 +290,6 @@ module CompletionKit
         target: "run_status_panel",
         html: render_engine_partial("completion_kit/runs/status_panel", run: self)
       )
-      broadcast_status_header
     end
 
     def broadcast_status_header

data/app/views/completion_kit/api_reference/index.html.erb

@@ -20,6 +20,10 @@
         <p class="ck-kicker">Tag filtering</p>
         <p class="ck-meta-copy">Prompts, runs, metrics, datasets, and metric groups accept <code>?tag[]=name</code> (repeat for OR semantics).</p>
       </div>
+      <div>
+        <p class="ck-kicker">Error shape</p>
+        <p class="ck-meta-copy">Every error response carries a top-level <code>error</code> string. Validation failures (422) add a <code>details</code> object keyed by field: <code>{ "error": "Validation failed", "details": { "name": ["can't be blank"] } }</code>.</p>
+      </div>
     </div>
   </div>
 </div>

data/lib/completion_kit/version.rb

@@ -1,3 +1,3 @@
 module CompletionKit
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: completion-kit
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Damien Bastin