networknt / networknt/light-fabric

Unified Platform Embedding Registry Contract

Open
#314 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1
Forks
1
Avg merge
1h 43m
Merged PRs (30d)
2

Description

Summary

Different AI services in the platform can still define embedding compatibility in separate places. This creates coordination risk and can lead to incompatible model configurations being deployed without a single source of truth.

Details

Current state mixes multiple sources of embedding contract truth:

  • Gateway alias declarations in alias capabilities
  • Knowledge-scoped profile model in Portal DB
  • Service-level config fields in Knowledge runtime

Evidence from schema and docs:

-- Alias-level embedding contract shape
required_capabilities->'embeddingSpace'
-- Knowledge-scoped embedding profile model
CREATE TABLE IF NOT EXISTS knowledge_embedding_profile_t (
    expected_space_id VARCHAR(255) NOT NULL,
    expected_space_revision BIGINT NOT NULL,
    dimension INTEGER NOT NULL,
    normalization VARCHAR(16) NOT NULL,
    distance_metric VARCHAR(24) NOT NULL,
    document_input_transform_version VARCHAR(255) NOT NULL,
    query_input_transform_version VARCHAR(255) NOT NULL
)
// Knowledge service config fields
pub embedding_space_id: String,
pub embedding_space_revision: u64,
pub embedding_dimension: usize,

The gap is no single platform-wide contract/API that all consumers must use.

Recomendations

  • Define one canonical embedding registry contract used by all services.
  • Standardize publication-time validation against that contract.
  • Define ownership and lifecycle policy (versioning, deprecation, migration).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the embedding contract sources named in the issue: alias capabilities, the Portal DB knowledge_embedding_profile_t schema, and Knowledge runtime configuration. Define completion as a single documented registry contract with publication-time validation and explicit ownership, versioning, deprecation, and migration policies across the consumers.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust, sql
Domain
backend-api-design, distributed-systems
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.