slidict 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9f6b8851999b92437addc0186d6a047c1c8317145940987514df479e02fabc2
-  data.tar.gz: fb42f714400e77cbc97931d105cef01a8b54776c0ce67db152ce6ce475136caf
+  metadata.gz: 829a5806efaa7c29d773818f0683fa3c0525bebfe883bd32261ba29f5a649a5e
+  data.tar.gz: e45e42541ba0940a883f470f7d03941df71b5825c0c9b93471fe3b1c991b0de5
 SHA512:
-  metadata.gz: 88ad47ca34c0e2d7bcf99f118905ba3b7b7f8df571aa4e118080552659564bc2bb7d79d007c3c67a9dc4ebd291e415e6cf423f93299f013485856737e54f7e77
-  data.tar.gz: 781cd459d6c82e62a29bbc8702bea3c7f9d4125d78341e2b13723608ded41e9131af456b87dbfc61525dbc7ebab91da9729fc4465e3b852c0298a96f1e277223
+  metadata.gz: ff04a4475b51083d1c8ed884ad10f924000bb6c47adb0947d6c365fa3dd81d83eb09b94b280794bed9d2ef1001b559589c9241d92b0ccc005a7969065a814eb1
+  data.tar.gz: a0385b86027802eb018c4c9bda5fc26ee8030df9eee449879bd5dc299faa32382df90e5b8c707b528c846018d1fa8f28b3861ce299ed8d58f7d5ad125bc29b15

data/.github/release-drafter.yml

@@ -1,4 +1,4 @@
-name-template: 'v$NEXT_PATCH_VERSION'
+name-template: 'Unreleased'
 tag-template: 'v$NEXT_PATCH_VERSION'
 template: |
   ## Changes

data/lib/slidict/cli/app.rb

@@ -28,6 +28,8 @@ module Slidict
         return lint(options[:args]) if options[:command] == "lint"
 
         config = build_config(options)
+        return print_available_models(config) if config.llm_enabled? && config.model.nil?
+
         client = llm_client_for(config)
         return 1 if client && !verify_connection(client)
 
@@ -155,6 +157,21 @@ module Slidict
         )
       end
 
+      def print_available_models(config)
+        client = Llm::Client.new(base_url: config.base_url, api_key: config.api_key, model: nil)
+        models = client.list_models
+        if models.empty?
+          @output.puts "No models available at #{config.base_url}"
+        else
+          @output.puts "Available models (specify one with --llm-model NAME or SLIDICT_LLM_MODEL=NAME):"
+          models.each { |m| @output.puts "  #{m}" }
+        end
+        0
+      rescue Llm::Client::Error => e
+        @output.puts "Error: LLM request failed (#{e.message})"
+        1
+      end
+
       def llm_client_for(config)
         return nil unless config.llm_enabled?
 
@@ -284,7 +301,7 @@ module Slidict
               --llm-base-url URL OpenAI Compatible API base URL (env: SLIDICT_LLM_BASE_URL).
                                  When omitted, the built-in slide template is used instead.
               --llm-api-key KEY  API key for the LLM endpoint (env: SLIDICT_LLM_API_KEY)
-              --llm-model NAME   Model name to request (env: SLIDICT_LLM_MODEL, default: gpt-4o-mini)
+              --llm-model NAME   Model name to request (env: SLIDICT_LLM_MODEL); omit to list available models
               --no-llm           Skip the LLM call and use the built-in slide template
               --publish          Publish the generated slides to slidict.io as a draft
                                  (requires `slidict auth`; creates a new slide, or edits

data/lib/slidict/cli/lint.rb

@@ -31,12 +31,13 @@ module Slidict
       def run_lint(options)
         config = build_config(options)
         return llm_required unless config.llm_enabled?
+        return print_available_models(config) if config.model.nil?
 
         print_findings(lint(options, config))
       end
 
       def lint(options, config)
-        @linter_factory.call(config).lint(File.read(options[:path]), format: format_for(options))
+        @linter_factory.call(config).lint(File.read(options[:path]), format: format_for(options), translate: options[:translate])
       end
 
       def print_usage_error(error)
@@ -70,6 +71,7 @@ module Slidict
           when "--llm-base-url" then options[:llm_base_url] = fetch_value!(args, arg)
           when "--llm-api-key" then options[:llm_api_key] = fetch_value!(args, arg)
           when "--llm-model" then options[:llm_model] = fetch_value!(args, arg)
+          when "--translate" then options[:translate] = fetch_value!(args, arg)
           else raise ArgumentError, "unknown option #{arg}"
           end
         end
@@ -111,6 +113,20 @@ module Slidict
         1
       end
 
+      def print_available_models(config)
+        client = Llm::Client.new(base_url: config.base_url, api_key: config.api_key, model: nil)
+        models = client.list_models
+        if models.empty?
+          @output.puts "No models available at #{config.base_url}"
+        else
+          @output.puts "Available models (specify one with --llm-model NAME or SLIDICT_LLM_MODEL=NAME):"
+          models.each { |m| @output.puts "  #{m}" }
+        end
+        0
+      rescue Llm::Client::Error => e
+        print_error(e)
+      end
+
       def llm_required
         @output.puts "Error: lint requires an LLM endpoint (--llm-base-url or SLIDICT_LLM_BASE_URL)"
         1
@@ -123,7 +139,8 @@ module Slidict
               --format FORMAT     markdown or asciidoc (default: auto-detected from extension)
               --llm-base-url URL  OpenAI Compatible API base URL (env: SLIDICT_LLM_BASE_URL)
               --llm-api-key KEY   API key for the LLM endpoint (env: SLIDICT_LLM_API_KEY)
-              --llm-model NAME    Model name to request (env: SLIDICT_LLM_MODEL, default: gpt-4o-mini)
+              --llm-model NAME    Model name to request (env: SLIDICT_LLM_MODEL); omit to list available models
+              --translate LANG    Translate findings into the given language (e.g. Japanese)
           -h, --help               Show this help
         HELP
         0

data/lib/slidict/config.rb

@@ -6,7 +6,7 @@ module Slidict
 
     attr_reader :base_url, :api_key, :model
 
-    def initialize(base_url: nil, api_key: nil, model: DEFAULT_MODEL, enabled: true)
+    def initialize(base_url: nil, api_key: nil, model: nil, enabled: true)
       @base_url = base_url
       @api_key = api_key
       @model = model
@@ -17,7 +17,7 @@ module Slidict
       new(
         base_url: env["SLIDICT_LLM_BASE_URL"],
         api_key: env["SLIDICT_LLM_API_KEY"],
-        model: env["SLIDICT_LLM_MODEL"] || DEFAULT_MODEL
+        model: env["SLIDICT_LLM_MODEL"]
       )
     end
 

data/lib/slidict/lint/linter.rb

@@ -11,11 +11,11 @@ module Slidict
         @client = client
       end
 
-      def lint(content, format: "markdown")
+      def lint(content, format: "markdown", translate: nil)
         slides = SlideParser.parse(content, format: format)
         raise Error, "no slides found in the given file" if slides.empty?
 
-        @client.lint_slides(slides)
+        @client.lint_slides(slides, translate: translate)
       end
     end
   end

data/lib/slidict/llm/client.rb

@@ -21,12 +21,18 @@ module Slidict
       # Checks that the endpoint is reachable before the (slower, more
       # expensive) chat completion request is made. Raises Error on failure.
       def verify_connection!
-        uri = endpoint_uri("models")
-        request = Net::HTTP::Get.new(uri)
-        request["Authorization"] = "Bearer #{@api_key}"
-        response = perform_request(uri, request)
+        response = get_models_response
+        raise Error, "#{response.code} #{response.message}" unless response.is_a?(Net::HTTPSuccess)
+      end
 
+      # Returns a sorted array of model IDs available at the endpoint.
+      def list_models
+        response = get_models_response
         raise Error, "#{response.code} #{response.message}" unless response.is_a?(Net::HTTPSuccess)
+
+        Array(JSON.parse(response.body)["data"]).map { |m| m["id"] }.sort
+      rescue JSON::ParserError => e
+        raise Error, "could not parse models response: #{e.message}"
       end
 
       def generate_slides(deck)
@@ -37,13 +43,20 @@ module Slidict
       # slide_texts is an array of slide bodies (1-indexed by position) as
       # produced by Slidict::Lint::SlideParser. Returns an array of
       # Slidict::Lint::Finding.
-      def lint_slides(slide_texts)
-        content = chat_completion(lint_prompt_for(slide_texts))
+      def lint_slides(slide_texts, translate: nil)
+        content = chat_completion(lint_prompt_for(slide_texts, translate: translate))
         findings_from(content)
       end
 
       private
 
+      def get_models_response
+        uri = endpoint_uri("models")
+        request = Net::HTTP::Get.new(uri)
+        request["Authorization"] = "Bearer #{@api_key}"
+        perform_request(uri, request)
+      end
+
       def prompt_for(deck)
         <<~PROMPT
           You are an assistant that designs presentation slide outlines.
@@ -93,9 +106,10 @@ module Slidict
         JSON array. Return an empty array [] if you find no issues.
       PROMPT
 
-      def lint_prompt_for(slide_texts)
+      def lint_prompt_for(slide_texts, translate: nil)
         numbered = slide_texts.each_with_index.map { |text, i| "--- Slide #{i + 1} ---\n#{text}" }.join("\n\n")
-        format(LINT_PROMPT_TEMPLATE, numbered: numbered)
+        prompt = format(LINT_PROMPT_TEMPLATE, numbered: numbered)
+        translate ? "#{prompt}\nWrite each message field in #{translate}." : prompt
       end
 
       def findings_from(content)
@@ -190,7 +204,7 @@ module Slidict
           return candidate if candidate
         end
 
-        raise Error, "no JSON array found in model response"
+        raise Error, "no JSON array found in model response\nThe model may be too small to follow the required output format. Try using a larger model."
       end
 
       def json_array_from(content, start)

data/lib/slidict/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Slidict
-  VERSION = "0.4.0"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slidict
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Yusuke Abe