Know

Preview

It's types and helpers, listed below.

Install

First time? Get started sets up the registry and theme. Or with shadcn directly: npx shadcn@latest add @candor/know

Brings in: chat, status

Types

KnowDoor

How knowledge came in: read from the environment's configuration or data, shared as a file or link, answered by a person, or a vendor's release notes.

"config" | "data" | "file" | "link" | "answer" | "release-notes"

KnowSource

{ id: string door: KnowDoor label: string /** Who added it, for files, links and answers. */ addedBy?: string | undefined addedAt?: string | undefined /** When it was last read; null if never. */ readAt: string | null /** How often it should be re-read, in hours, when it has a schedule. */ everyHours?: number | undefined status: RunStatus /** "214 objects", "38 pages" — only when counted. */ exten

Confidence

"high" | "medium" | "low" | "unknown"

RaciRole

"R" | "A" | "C" | "I"

RaciAssignment

{ role: RaciRole; who: string }

RetrievedPassage

{ id: string sourceId: string title: string excerpt: string /** Retrieval score 0–1; null when the retriever didn't score it (e.g. a pinned source). */ score: number | null /** Whether the answer actually cites it. */ cited: boolean /** Why it ranked where it did, when the retriever says. */ why?: string | undefined readAt: string | null }

Claim

A sentence in an answer and the passages it rests on.

{ id: string; text: string; evidence: string[] }

ModelVendor

"Anthropic" | "Google" | "OpenAI" | "xAI"

ModelOption

{ id: string vendor: ModelVendor name: string /** One line on what it's good for. */ note?: string | undefined /** Relative cost, 1 (cheapest) to 4. */ cost: 1 | 2 | 3 | 4 /** The vendor's zero-retention contract has been attested by an operator. */ zdr: "attested" | "not-attested" }

ReasoningEffort

"low" | "medium" | "high" | "max"

ModelSettingsValue

{ model: string reasoning: ReasoningEffort /** Most tool-calling steps per run before it stops and asks. */ stepLimit: number /** Used when the primary is unavailable; must also be attested. */ fallback?: string | undefined }

ToolPermission

"always" | "ask" | "never"

ToolSetting

{ id: string name: string description: string /** What the tool can do to the environment. */ effect: "read" | "write" | "deploy" | "outside" permission: ToolPermission /** Permissions this tool can't take, with why. */ locked?: Partial<Record<ToolPermission, string | undefined>> | undefined }

AgentConfig

{ agent: AgentIdentity enabled: boolean status: RunStatus model: string /** Runs per day for the last 14 days, oldest first. */ runs: { ok: number; failed: number }[] lastFailure?: string | undefined }

Memory

{ id: string text: string /** Who taught it: a person said so, or an agent inferred it. */ from: { person: string } | { agent: AgentIdentity } createdAt: string scope: "account" | "environment" environmentId?: string | undefined }

MemoryModeValue

Whether agents use memory: on, paused (kept and not used for now), or off.

"on" | "paused" | "off"

Version

{ id: string label: string state: "live" | "draft" | "past" at: string by: string note?: string | undefined }

ContextSegment

{ label: string tokens: number kind: "system" | "instructions" | "knowledge" | "thread" | "tools" | "files" }