improve progress story for artifact rendering

Author: SamSaffron

lib/ai_bot/artifact_update_strategies/base.rb

@@ -16,17 +16,20 @@ def initialize(llm:, post:, user:, artifact:, artifact_version:, instructions:)
           @instructions = instructions
         end
 
-        def apply
-          changes = generate_changes
+        def apply(&progress)
+          changes = generate_changes(&progress)
           parsed_changes = parse_changes(changes)
           apply_changes(parsed_changes)
         end
 
         private
 
-        def generate_changes
+        def generate_changes(&progress)
           response = +""
-          llm.generate(build_prompt, user: user) { |partial| response << partial }
+          llm.generate(build_prompt, user: user) do |partial|
+            progress.call(partial) if progress
+            response << partial
+          end
           response
         end
 

lib/ai_bot/bot.rb

@@ -220,8 +220,11 @@ def invoke_tool(tool, llm, cancel, context, &update_blk)
         update_blk.call("", cancel, build_placeholder(tool.summary, "")) if show_placeholder
 
         result =
-          tool.invoke do |progress|
-            if show_placeholder
+          tool.invoke do |progress, render_raw|
+            if render_raw
+              update_blk.call("", cancel, tool.custom_raw, :partial_invoke)
+              show_placeholder = false
+            elsif show_placeholder
               placeholder = build_placeholder(tool.summary, progress)
               update_blk.call("", cancel, placeholder)
             end

lib/ai_bot/playground.rb

@@ -479,7 +479,9 @@ def reply_to(post, custom_instructions: nil, &blk)
             raw = reply.dup
             raw << "\n\n" << placeholder if placeholder.present?
 
-            blk.call(partial) if blk && type != :tool_details && type != :partial_tool
+            if blk && type != :tool_details && type != :partial_tool && type != :partial_invoke
+              blk.call(partial)
+            end
 
             if stream_reply && !Discourse.redis.get(redis_stream_key)
               cancel&.call

lib/ai_bot/tools/create_artifact.rb

@@ -42,6 +42,7 @@ def self.specification_description
             - List any specific libraries or frameworks to use/avoid
             - Describe error states and edge cases
             - Include accessibility requirements
+            - Include code snippets to help ground the specification
           DESC
         end
 
@@ -66,54 +67,56 @@ def self.signature
           }
         end
 
-        def self.inject_prompt(prompt:, context:, persona:)
-          return if persona.options["echo_artifact"] != "true"
-          # we inject the current artifact content into the last user message
-          if topic_id = context[:topic_id]
-            posts = Post.where(topic_id: topic_id)
-            artifact = AiArtifact.order("id desc").where(post: posts).first
-            if artifact
-              latest_version = artifact.versions.order(version_number: :desc).first
-              current = latest_version || artifact
-
-              artifact_source = <<~MSG
-                Current Artifact:
-
-                ### HTML
-                ```html
-                #{current.html}
-                ```
-
-                ### CSS
-                ```css
-                #{current.css}
-                ```
-
-                ### JavaScript
-                ```javascript
-                #{current.js}
-                ```
-
-              MSG
-
-              last_message = prompt.messages.last
-              last_message[:content] = "#{artifact_source}\n\n#{last_message[:content]}"
-            end
+        def self.accepted_options
+          [option(:creator_llm, type: :llm)]
+        end
+
+        def self.allow_partial_tool_calls?
+          true
+        end
+
+        def partial_invoke
+          if parameters[:specification].present?
+            in_progress(specification: parameters[:specification])
           end
         end
 
-        def self.accepted_options
-          [option(:creator_llm, type: :llm), option(:echo_artifact, type: :boolean)]
+        def in_progress(specification:, source: nil)
+          source = (<<~HTML) if source.present?
+            ### Source
+
+            ````
+            #{source}
+            ````
+          HTML
+
+          self.custom_raw = <<~HTML
+            <details>
+              <summary>Thinking...</summary>
+
+
+            ### Specification
+            ````
+            #{specification}
+            ````
+
+            #{source}
+
+            </details>
+          HTML
         end
 
         def invoke
-          name = parameters[:name] || "New Artifact"
-          yield "#{name}\n\n" + parameters[:specification].to_s
-
           post = Post.find_by(id: context[:post_id])
           return error_response("No post context found") unless post
 
-          artifact_code = generate_artifact_code(post: post, user: post.user)
+          partial_response = +""
+          artifact_code =
+            generate_artifact_code(post: post, user: post.user) do |partial|
+              partial_response << partial
+              in_progress(specification: parameters[:specification], source: partial_response)
+              yield nil, true
+            end
           return error_response(artifact_code[:error]) if artifact_code[:error]
 
           artifact = create_artifact(post, artifact_code)
@@ -122,6 +125,7 @@ def invoke
             update_custom_html(artifact)
             success_response(artifact)
           else
+            self.custom_raw = self.custom_raw + "\n\n###Error creating artifact..."
             error_response(artifact.errors.full_messages.join(", "))
           end
         end
@@ -148,6 +152,7 @@ def generate_artifact_code(post:, user:)
 
           llm.generate(prompt, user: user, feature_name: "create_artifact") do |partial_response|
             response << partial_response
+            yield partial_response
           end
 
           sections = parse_sections(response)

lib/ai_bot/tools/update_artifact.rb

@@ -37,16 +37,83 @@ def self.signature
           }
         end
 
+        def self.inject_prompt(prompt:, context:, persona:)
+          return if persona.options["echo_artifact"].to_s == "false"
+          # we inject the current artifact content into the last user message
+          if topic_id = context[:topic_id]
+            posts = Post.where(topic_id: topic_id)
+            artifact = AiArtifact.order("id desc").where(post: posts).first
+            if artifact
+              latest_version = artifact.versions.order(version_number: :desc).first
+              current = latest_version || artifact
+
+              artifact_source = <<~MSG
+                Current Artifact:
+
+                ### HTML
+                ```html
+                #{current.html}
+                ```
+
+                ### CSS
+                ```css
+                #{current.css}
+                ```
+
+                ### JavaScript
+                ```javascript
+                #{current.js}
+                ```
+
+              MSG
+
+              last_message = prompt.messages.last
+              last_message[:content] = "#{artifact_source}\n\n#{last_message[:content]}"
+            end
+          end
+        end
+
         def self.accepted_options
           [
             option(:editor_llm, type: :llm),
             option(:update_algorithm, type: :enum, values: %w[full diff], default: "full"),
+            option(:echo_artifact, type: :boolean, default: true),
           ]
         end
 
-        def invoke
-          yield "Updating Artifact\n#{parameters[:instructions]}\n\n"
+        def self.allow_partial_tool_calls?
+          true
+        end
+
+        def partial_invoke
+          in_progress(instructions: parameters[:instructions]) if parameters[:instructions].present?
+        end
+
+        def in_progress(instructions:, source: nil)
+          source = (<<~HTML) if source.present?
+            ### Source
+
+            ````
+            #{source}
+            ````
+          HTML
+
+          self.custom_raw = <<~HTML
+            <details>
+              <summary>Thinking...</summary>
 
+              ### Instructions
+              ````
+              #{instructions}
+              ````
+
+              #{source}
+
+            </details>
+          HTML
+        end
+
+        def invoke
           post = Post.find_by(id: context[:post_id])
           return error_response("No post context found") unless post
 
@@ -81,15 +148,23 @@ def invoke
             )
 
           begin
+            partial_response = +""
             new_version =
-              strategy.new(
-                llm: llm,
-                post: post,
-                user: post.user,
-                artifact: artifact,
-                artifact_version: artifact_version,
-                instructions: parameters[:instructions],
-              ).apply
+              strategy
+                .new(
+                  llm: llm,
+                  post: post,
+                  user: post.user,
+                  artifact: artifact,
+                  artifact_version: artifact_version,
+                  instructions: parameters[:instructions],
+                )
+                .apply do |progress|
+                  partial_response << progress
+                  in_progress(instructions: parameters[:instructions], source: partial_response)
+                  # force in progress to render
+                  yield nil, true
+                end
 
             update_custom_html(
               artifact: artifact,

lib/completions/endpoints/open_ai.rb

@@ -123,7 +123,7 @@ def decode_chunk(chunk)
         end
 
         def decode_chunk_finish
-          @processor.finish
+          processor.finish
         end
 
         def xml_tools_enabled?