Open-source LLM knowledge platform: turn raw documents into a queryable RAG, an autonomous reasoning agent, and a self-maintaining Wiki.
Go agentagenticaichatbotdsh-pluginembeddingsevaluationgenerative-aigolangknowledge-basellmmulti-tenantollamaopenaiquestion-answeringragrerankingsemantic-searchvector-searchwiki
export type WeKnoraEntityKind = 'kb' | 'doc' | 'chunk'
export interface WeKnoraEntityRef {
kind: WeKnoraEntityKind
id: string
}
export type WeKnoraEntityLinkLabels = Record<WeKnoraEntityKind, string>
export const WEKNORA_ENTITY_LINK_CLASS = 'weknora-entity-link'
const URI_BODY = '(kb|doc|chunk)/([0-9A-Za-z][0-9A-Za-z_-]*)'
const URI_EXACT_RE = new RegExp(`^weknora://${URI_BODY}$`, 'i')
const URI_IN_TEXT_RE = new RegExp(`weknora://${URI_BODY}`, 'gi')
const HREF_RE = /\bhref\s*=\s*(?:"([^"]*)"|'([^']*)')/i
const SKIPPED_TAGS = new Set(['code', 'pre', 'a', 'button', 'svg', 'math'])
/** Parses a `weknora://kb|doc|chunk/<id>` durable URI emitted by the model-context codec. */
export function parseWeKnoraEntityURI(value: string | null | undefined): WeKnoraEntityRef | null {
const match = URI_EXACT_RE.exec((value || '').trim())
if (!match) return null
return { kind: match[1].toLowerCase() as WeKnoraEntityKind, id: match[2] }
}
function escapeHtml(text: string): string {
return text.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"')
}
function entityOpenTag(ref: WeKnoraEntityRef, labels: WeKnoraEntityLinkLabels): string {
return `<span class="${WEKNORA_ENTITY_LINK_CLASS}" role="link" tabindex="0" ` +
`title="${escapeHtml(labels[ref.kind])}" data-entity-kind="${ref.kind}" data-entity-id="${ref.id}">`
}
/**
* Turns `weknora://` URIs in rendered chat HTML into clickable entity chips.
* Markdown links keep their text; bare URIs in prose show the real ID, since
* the model writes them where an ID is meant. The kind label is the tooltip.
* Text inside code, pre and ordinary links is left alone. Must run before
* DOMPurify, whose URI allowlist would otherwise strip the `weknora:` scheme.
*/
export function renderWeKnoraEntityLinks(html: string, labels: WeKnoraEntityLinkLabels): string {
if (!html || !/weknora:\/\//i.test(html)) return html
const parts = html.split(/(<[^>]*>)/)
const skipDepth = new Map<string, number>()
let skipping = 0
let entityAnchorOpen = false
for (let i = 0; i < parts.length; i++) {
const part = parts[i]
if (!part) continue
if (part.startsWith('<')) {
const tag = /^<\s*(\/?)\s*([a-zA-Z][\w-]*)/.exec(part)
if (!tag) continue
const closing = tag[1] === '/'
const name = tag[2].toLowerCase()
if (name === 'a' && closing && entityAnchorOpen) {
parts[i] = '</span>'
entityAnchorOpen = false
continue
}
if (name === 'a' && !closing && skipping === 0) {
const hrefMatch = HREF_RE.exec(part)
const ref = parseWeKnoraEntityURI(hrefMatch?.[1] ?? hrefMatch?.[2])
if (ref) {
parts[i] = entityOpenTag(ref, labels)
entityAnchorOpen = true
continue
}
}
if (!SKIPPED_TAGS.has(name) || part.endsWith('/>')) continue
const depth = skipDepth.get(name) || 0
if (closing) {
if (depth > 0) {
skipDepth.set(name, depth - 1)
skipping--
}
} else {
skipDepth.set(name, depth + 1)
skipping++
}
continue
}
if (skipping > 0 || entityAnchorOpen) continue
parts[i] = part.replace(URI_IN_TEXT_RE, (_m, kind: string, id: string) => {
const ref = { kind: kind.toLowerCase() as WeKnoraEntityKind, id }
return `${entityOpenTag(ref, labels)}${id}</span>`
})
}
return parts.join('')
}