mirror of
https://github.com/discourse/discourse-ai.git
synced 2025-06-29 19:12:15 +00:00
fdf0ff8a25
Introduces a persistent, user-scoped key-value storage system for
AI Artifacts, enabling them to be stateful and interactive. This
transforms artifacts from static content into mini-applications that can
save user input, preferences, and other data.
The core components of this feature are:
1. **Model and API**:
- A new `AiArtifactKeyValue` model and corresponding database table to
store data associated with a user and an artifact.
- A new `ArtifactKeyValuesController` provides a RESTful API for
CRUD operations (`index`, `set`, `destroy`) on the key-value data.
- Permissions are enforced: users can only modify their own data but
can view public data from other users.
2. **Secure JavaScript Bridge**:
- A `postMessage` communication bridge is established between the
sandboxed artifact `iframe` and the parent Discourse window.
- A JavaScript API is exposed to the artifact as `window.discourseArtifact`
with async methods: `get(key)`, `set(key, value, options)`,
`delete(key)`, and `index(filter)`.
- The parent window handles these requests, makes authenticated calls to the
new controller, and returns the results to the iframe. This ensures
security by keeping untrusted JS isolated.
3. **AI Tool Integration**:
- The `create_artifact` tool is updated with a `requires_storage`
boolean parameter.
- If an artifact requires storage, its metadata is flagged, and the
system prompt for the code-generating AI is augmented with detailed
documentation for the new storage API.
4. **Configuration**:
- Adds hidden site settings `ai_artifact_kv_value_max_length` and
`ai_artifact_max_keys_per_user_per_artifact` for throttling.
This also includes a minor fix to use `jsonb_set` when updating
artifact metadata, ensuring other metadata fields are preserved.
57 lines
1.6 KiB
Ruby
57 lines
1.6 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
class AiArtifactKeyValue < ActiveRecord::Base
|
|
belongs_to :ai_artifact
|
|
belongs_to :user
|
|
|
|
validates :key, presence: true, length: { maximum: 50 }
|
|
validates :value,
|
|
presence: true,
|
|
length: {
|
|
maximum: ->(_) { SiteSetting.ai_artifact_kv_value_max_length },
|
|
}
|
|
attribute :public, :boolean, default: false
|
|
validates :ai_artifact, presence: true
|
|
validates :user, presence: true
|
|
validates :key, uniqueness: { scope: %i[ai_artifact_id user_id] }
|
|
|
|
validate :validate_max_keys_per_user_per_artifact
|
|
|
|
private
|
|
|
|
def validate_max_keys_per_user_per_artifact
|
|
return unless ai_artifact_id && user_id
|
|
|
|
max_keys = SiteSetting.ai_artifact_max_keys_per_user_per_artifact
|
|
existing_count = self.class.where(ai_artifact_id: ai_artifact_id, user_id: user_id).count
|
|
|
|
# Don't count the current record if it's being updated
|
|
existing_count -= 1 if persisted?
|
|
|
|
if existing_count >= max_keys
|
|
errors.add(
|
|
:base,
|
|
I18n.t("discourse_ai.ai_artifact.errors.max_keys_exceeded", count: max_keys),
|
|
)
|
|
end
|
|
end
|
|
end
|
|
|
|
# == Schema Information
|
|
#
|
|
# Table name: ai_artifact_key_values
|
|
#
|
|
# id :bigint not null, primary key
|
|
# ai_artifact_id :bigint not null
|
|
# user_id :integer not null
|
|
# key :string(50) not null
|
|
# value :string(20000) not null
|
|
# public :boolean default(FALSE), not null
|
|
# created_at :datetime not null
|
|
# updated_at :datetime not null
|
|
#
|
|
# Indexes
|
|
#
|
|
# index_ai_artifact_kv_unique (ai_artifact_id,user_id,key) UNIQUE
|
|
#
|