mirror of
https://github.com/discourse/discourse-ai.git
synced 2025-03-06 17:30:20 +00:00
a7d032fa28
### Why
This pull request fundamentally restructures how AI bots create and update web artifacts to address critical limitations in the previous approach:
1. **Improved Artifact Context for LLMs**: Previously, artifact creation and update tools included the *entire* artifact source code directly in the tool arguments. This overloaded the Language Model (LLM) with raw code, making it difficult for the LLM to maintain a clear understanding of the artifact's current state when applying changes. The LLM would struggle to differentiate between the base artifact and the requested modifications, leading to confusion and less effective updates.
2. **Reduced Token Usage and History Bloat**: Including the full artifact source code in every tool interaction was extremely token-inefficient. As conversations progressed, this redundant code in the history consumed a significant number of tokens unnecessarily. This not only increased costs but also diluted the context for the LLM with less relevant historical information.
3. **Enabling Updates for Large Artifacts**: The lack of a practical diff or targeted update mechanism made it nearly impossible to efficiently update larger web artifacts. Sending the entire source code for every minor change was both computationally expensive and prone to errors, effectively blocking the use of AI bots for meaningful modifications of complex artifacts.
**This pull request addresses these core issues by**:
* Introducing methods for the AI bot to explicitly *read* and understand the current state of an artifact.
* Implementing efficient update strategies that send *targeted* changes rather than the entire artifact source code.
* Providing options to control the level of artifact context included in LLM prompts, optimizing token usage.
### What
The main changes implemented in this PR to resolve the above issues are:
1. **`Read Artifact` Tool for Contextual Awareness**:
- A new `read_artifact` tool is introduced, enabling AI bots to fetch and process the current content of a web artifact from a given URL (local or external).
- This provides the LLM with a clear and up-to-date representation of the artifact's HTML, CSS, and JavaScript, improving its understanding of the base to be modified.
- By cloning local artifacts, it allows the bot to work with a fresh copy, further enhancing context and control.
2. **Refactored `Update Artifact` Tool with Efficient Strategies**:
- The `update_artifact` tool is redesigned to employ more efficient update strategies, minimizing token usage and improving update precision:
- **`diff` strategy**: Utilizes a search-and-replace diff algorithm to apply only the necessary, targeted changes to the artifact's code. This significantly reduces the amount of code sent to the LLM and focuses its attention on the specific modifications.
- **`full` strategy**: Provides the option to replace the entire content sections (HTML, CSS, JavaScript) when a complete rewrite is required.
- Tool options enhance the control over the update process:
- `editor_llm`: Allows selection of a specific LLM for artifact updates, potentially optimizing for code editing tasks.
- `update_algorithm`: Enables choosing between `diff` and `full` update strategies based on the nature of the required changes.
- `do_not_echo_artifact`: Defaults to true, and by *not* echoing the artifact in prompts, it further reduces token consumption in scenarios where the LLM might not need the full artifact context for every update step (though effectiveness might be slightly reduced in certain update scenarios).
3. **System and General Persona Tool Option Visibility and Customization**:
- Tool options, including those for system personas, are made visible and editable in the admin UI. This allows administrators to fine-tune the behavior of all personas and their tools, including setting specific LLMs or update algorithms. This was previously limited or hidden for system personas.
4. **Centralized and Improved Content Security Policy (CSP) Management**:
- The CSP for AI artifacts is consolidated and made more maintainable through the `ALLOWED_CDN_SOURCES` constant. This improves code organization and future updates to the allowed CDN list, while maintaining the existing security posture.
5. **Codebase Improvements**:
- Refactoring of diff utilities, introduction of strategy classes, enhanced error handling, new locales, and comprehensive testing all contribute to a more robust, efficient, and maintainable artifact management system.
By addressing the issues of LLM context confusion, token inefficiency, and the limitations of updating large artifacts, this pull request significantly improves the practicality and effectiveness of AI bots in managing web artifacts within Discourse.
103 lines
2.8 KiB
Ruby
103 lines
2.8 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
class AiArtifact < ActiveRecord::Base
|
|
has_many :versions, class_name: "AiArtifactVersion", dependent: :destroy
|
|
belongs_to :user
|
|
belongs_to :post
|
|
validates :html, length: { maximum: 65_535 }
|
|
validates :css, length: { maximum: 65_535 }
|
|
validates :js, length: { maximum: 65_535 }
|
|
|
|
ALLOWED_CDN_SOURCES = %w[
|
|
https://cdn.jsdelivr.net
|
|
https://cdnjs.cloudflare.com
|
|
https://unpkg.com
|
|
https://ajax.googleapis.com
|
|
https://d3js.org
|
|
https://code.jquery.com
|
|
]
|
|
|
|
def self.iframe_for(id, version = nil)
|
|
<<~HTML
|
|
<div class='ai-artifact'>
|
|
<iframe src='#{url(id, version)}' frameborder="0" height="100%" width="100%"></iframe>
|
|
<a href='#{url(id, version)}' target='_blank'>#{I18n.t("discourse_ai.ai_artifact.link")}</a>
|
|
</div>
|
|
HTML
|
|
end
|
|
|
|
def self.url(id, version = nil)
|
|
url = Discourse.base_url + "/discourse-ai/ai-bot/artifacts/#{id}"
|
|
if version
|
|
"#{url}/#{version}"
|
|
else
|
|
url
|
|
end
|
|
end
|
|
|
|
def self.share_publicly(id:, post:)
|
|
artifact = AiArtifact.find_by(id: id)
|
|
artifact.update!(metadata: { public: true }) if artifact&.post&.topic&.id == post.topic.id
|
|
end
|
|
|
|
def self.unshare_publicly(id:)
|
|
artifact = AiArtifact.find_by(id: id)
|
|
artifact&.update!(metadata: { public: false })
|
|
end
|
|
|
|
def url
|
|
self.class.url(id)
|
|
end
|
|
|
|
def apply_diff(html_diff: nil, css_diff: nil, js_diff: nil, change_description: nil)
|
|
differ = DiscourseAi::Utils::DiffUtils
|
|
|
|
html = html_diff ? differ.apply_hunk(self.html, html_diff) : self.html
|
|
css = css_diff ? differ.apply_hunk(self.css, css_diff) : self.css
|
|
js = js_diff ? differ.apply_hunk(self.js, js_diff) : self.js
|
|
|
|
create_new_version(html: html, css: css, js: js, change_description: change_description)
|
|
end
|
|
|
|
def create_new_version(html: nil, css: nil, js: nil, change_description: nil)
|
|
latest_version = versions.order(version_number: :desc).first
|
|
new_version_number = latest_version ? latest_version.version_number + 1 : 1
|
|
version = nil
|
|
|
|
transaction do
|
|
# Create the version record
|
|
version =
|
|
versions.create!(
|
|
version_number: new_version_number,
|
|
html: html || self.html,
|
|
css: css || self.css,
|
|
js: js || self.js,
|
|
change_description: change_description,
|
|
)
|
|
save!
|
|
end
|
|
|
|
version
|
|
end
|
|
|
|
def public?
|
|
!!metadata&.dig("public")
|
|
end
|
|
end
|
|
|
|
# == Schema Information
|
|
#
|
|
# Table name: ai_artifacts
|
|
#
|
|
# id :bigint not null, primary key
|
|
# user_id :integer not null
|
|
# post_id :integer not null
|
|
# name :string(255) not null
|
|
# html :string(65535)
|
|
# css :string(65535)
|
|
# js :string(65535)
|
|
# metadata :jsonb
|
|
# created_at :datetime not null
|
|
# updated_at :datetime not null
|
|
#
|