Skip to content

docs(rfc): propose Artifact plugin framework - #2175

Merged
hidb4ai merged 3 commits into
oceanbase:masterfrom
Junkrat77:codex/artifact-plugin-rfc
Oct 23, 2026
Merged

hidb4ai merged 3 commits into
oceanbase:masterfrom
Junkrat77:codex/artifact-plugin-rfc

Conversation

@Junkrat77

@Junkrat77 Junkrat77 commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Which issue or RFC does this PR close?

This PR proposes a new RFC. Related: Source plugin RFC #2012. It does not close an issue.

Rationale for this change

Applications need to generate and retrieve domain-specific Artifacts without adding a built-in Artifact family for each use case. This RFC defines an Artifact plugin framework that reuses the existing Supervisor and Worker execution model.

What changes are included in this PR?

Add matching English and Chinese RFCs covering:

  • Plugin declarations, deployment, lifecycle management, and responsibilities across the Server, Worker, plugin, and application.
  • Generation workflows, evidence traceability, data consistency, and upgrade behavior.
  • Optional text/vector/hybrid search, index declarations and maintenance, and read availability during rebuilds.

Are there any user-facing changes?

Documentation only. This PR proposes contracts and capability boundaries; it does not change runtime behavior, public APIs, or persisted data.

How was this change tested?

  • make docs-test
  • uv run --locked prek run --files docs/en/rfcs/2175-artifact-plugin-system.md docs/zh/rfcs/2175-artifact-plugin-system.md

AI usage statement

OpenAI Codex assisted with drafting and revising the bilingual RFCs. A separate subagent reviewed bilingual consistency and implementation alignment, with a final LGTM verdict. The author reviewed the design and directed the revisions.

Comment on lines +548 to +549
text vectors can be re-encoded from original text. When changing models for plugin-owned vectors, the plugin must save
recomputed content revisions while search is stopped; the framework accepts only vectors compatible with the target space.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] Define a migration path for plugin-owned vector model changes

In a Scope whose Source cursor is already caught up, this rewrite has no defined execution path: Section 5 skips generate without accepted Source input, Section 6 preserves cursors across reloads, historical replay is out of scope, and registration exposes no write API by default. Existing heads therefore retain vectors from the old model, preventing the new build from completing and keeping even text-only search at 503 under Section 8.3. Please define a bounded, recoverable migration path that runs without new Sources, or explicitly reject these changes before accepting the target and disabling search.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For v1, index definitions and schema identity are fixed at registration. Changes are rejected before they affect existing search. Reloads can still update query policies, such as defaults and ranking weights, without rebuilding indexes. Vector migration is out of scope.

@AlexStocks AlexStocks added the 1.4.1 v1.4.1 release tracking label Oct 21, 2026

@hidb4ai hidb4ai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hidb4ai
hidb4ai merged commit 5a57a05 into oceanbase:master Oct 23, 2026
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1.4.1 v1.4.1 release tracking

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants