@babav/knowledge-core-client 0.40.0 → 0.42.0

package/dist/index.d.ts

@@ -211,7 +211,6 @@ export interface Corpus {
     name: string;
     description: string | null;
     custom_metadata: Record<string, unknown>;
-    profile_id: UUID | null;
 }
 /** Build-time knob bundle that DEFINES an index. Defaults are today's blessed config, so a
  *  profile created with no params is the blessed profile. Change any knob => different vectors
@@ -246,6 +245,27 @@ export interface IngestionProfileWrite {
     params?: Partial<IngestionProfileParams>;
     is_default?: boolean;
 }
+/** Config catalog for a profile UI (GET /v1/profiles/model-options) — build-side mirror of the
+ *  query model-options. `embedding_models` maps id → { provider, dimensions, label }; `fields`
+ *  gives each param its supported list / default / bounds; `standard_params` is the blessed default. */
+export interface IngestionProfileOptions {
+    embedding_models: Record<string, {
+        provider: string;
+        dimensions: number;
+        label: string;
+    }>;
+    chunkers: Record<string, {
+        label: string;
+    }>;
+    distances: string[];
+    quantizations: string[];
+    fields: Record<string, {
+        supported?: string[];
+        default?: unknown;
+        min?: number;
+    }>;
+    standard_params: IngestionProfileParams;
+}
 export interface Folder {
     id: UUID;
     corpus_id: UUID;
@@ -715,7 +735,6 @@ export declare class KnowledgeCoreClient extends HttpBase {
             name: string;
             description?: string;
             custom_metadata?: Record<string, unknown>;
-            profile_id?: UUID;
         }) => Promise<Corpus>;
         list: (q?: {
             limit?: number;
@@ -729,13 +748,11 @@ export declare class KnowledgeCoreClient extends HttpBase {
             cursor?: string;
         }) => Promise<Page<Corpus>>;
         get: (id: UUID) => Promise<Corpus>;
-        /** `custom_metadata` merges (provided keys upsert, a null value deletes a key). `profile_id`
-         *  reassigns the ingestion profile (does NOT re-index; applies on next (re)ingest). */
+        /** `custom_metadata` merges (provided keys upsert, a null value deletes a key). */
         update: (id: UUID, b: {
             name?: string;
             description?: string;
             custom_metadata?: Record<string, unknown>;
-            profile_id?: UUID | null;
         }) => Promise<Corpus>;
         delete: (id: UUID, confirmName: string) => Promise<void>;
         listFolders: (id: UUID) => Promise<Folder[]>;
@@ -985,9 +1002,11 @@ export declare class KnowledgeCoreClient extends HttpBase {
          *  capabilities (`supports_reasoning`), and mode↔model dependencies. */
         modelOptions: () => Promise<ModelOptions>;
     };
-    /** Ingestion profiles — the build-side config object (counterpart to `agents`). A profile
-     *  DEFINES an index (chunking + embedding + sparse + quant); its `fingerprint` is the physical
-     *  collection identity. Attach one to a corpus via `corpora.create/update({ profile_id })`. */
+    /** Ingestion profiles — the build-side config object (counterpart to `agents`): a tenant-owned,
+     *  named bundle of pipeline config (chunking + embedding + sparse + quant). Unlike an agent
+     *  (chosen per query), a profile binds at the TENANT/COLLECTION level — the tenant's one
+     *  `is_default` profile governs how ALL its documents are ingested; swapping it re-indexes.
+     *  A corpus's content is a RESULT of ingestion, so a corpus never selects a profile. */
     profiles: {
         /** List this tenant's ingestion profiles. */
         list: (q?: {
@@ -1001,8 +1020,12 @@ export declare class KnowledgeCoreClient extends HttpBase {
             name: string;
         }) => Promise<IngestionProfile>;
         update: (id: UUID, b: IngestionProfileWrite) => Promise<IngestionProfile>;
-        /** Delete a profile. 409 if any corpus still references it. */
+        /** Delete a profile. 409 when it's the tenant's active (default) profile. */
         delete: (id: UUID) => Promise<void>;
+        /** The config catalog for a profile UI: supported embedding models (+ provider/dims),
+         *  chunkers, distances, quantizations, per-field defaults/bounds, and the standard params.
+         *  Build-side mirror of `agents.modelOptions()`. */
+        modelOptions: () => Promise<IngestionProfileOptions>;
     };
     analytics: {
         /** Query-volume time series for a corpus (the denominator for everything). */

package/dist/index.js

@@ -268,8 +268,7 @@ export class KnowledgeCoreClient extends HttpBase {
         /** Filter corpora by custom_metadata using the same metadata filter as documents. */
         search: (b) => this.request("POST", "/v1/corpora/search", { json: b }),
         get: (id) => this.request("GET", `/v1/corpora/${id}`),
-        /** `custom_metadata` merges (provided keys upsert, a null value deletes a key). `profile_id`
-         *  reassigns the ingestion profile (does NOT re-index; applies on next (re)ingest). */
+        /** `custom_metadata` merges (provided keys upsert, a null value deletes a key). */
         update: (id, b) => this.request("PATCH", `/v1/corpora/${id}`, { json: b }),
         delete: (id, confirmName) => this.request("DELETE", `/v1/corpora/${id}`, { query: { confirm: confirmName } }),
         listFolders: (id) => this.pageAll(`/v1/corpora/${id}/folders`),
@@ -468,9 +467,11 @@ export class KnowledgeCoreClient extends HttpBase {
          *  capabilities (`supports_reasoning`), and mode↔model dependencies. */
         modelOptions: () => this.request("GET", "/v1/agents/model-options"),
     };
-    /** Ingestion profiles — the build-side config object (counterpart to `agents`). A profile
-     *  DEFINES an index (chunking + embedding + sparse + quant); its `fingerprint` is the physical
-     *  collection identity. Attach one to a corpus via `corpora.create/update({ profile_id })`. */
+    /** Ingestion profiles — the build-side config object (counterpart to `agents`): a tenant-owned,
+     *  named bundle of pipeline config (chunking + embedding + sparse + quant). Unlike an agent
+     *  (chosen per query), a profile binds at the TENANT/COLLECTION level — the tenant's one
+     *  `is_default` profile governs how ALL its documents are ingested; swapping it re-indexes.
+     *  A corpus's content is a RESULT of ingestion, so a corpus never selects a profile. */
     profiles = {
         /** List this tenant's ingestion profiles. */
         list: (q) => this.request("GET", "/v1/profiles", { query: q }),
@@ -479,8 +480,12 @@ export class KnowledgeCoreClient extends HttpBase {
         /** Create a profile owned by this tenant. Omit `params` for the blessed profile (all defaults). */
         create: (b) => this.request("POST", "/v1/profiles", { json: b }),
         update: (id, b) => this.request("PATCH", `/v1/profiles/${id}`, { json: b }),
-        /** Delete a profile. 409 if any corpus still references it. */
+        /** Delete a profile. 409 when it's the tenant's active (default) profile. */
         delete: (id) => this.request("DELETE", `/v1/profiles/${id}`),
+        /** The config catalog for a profile UI: supported embedding models (+ provider/dims),
+         *  chunkers, distances, quantizations, per-field defaults/bounds, and the standard params.
+         *  Build-side mirror of `agents.modelOptions()`. */
+        modelOptions: () => this.request("GET", "/v1/profiles/model-options"),
     };
     // --- retrieval analytics (read-only, tenant-scoped, aggregate-on-read) ---
     analytics = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@babav/knowledge-core-client",
-  "version": "0.40.0",
+  "version": "0.42.0",
   "description": "TypeScript client for the Babav Knowledge Core API (Deno + Node 18+, zero deps). Includes the babav.visual grammar TYPES at the ./visual subpath (types only; all visual rendering is server-side).",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -244,7 +244,7 @@ export interface Corpus {
   name: string;
   description: string | null;
   custom_metadata: Record<string, unknown>;
-  profile_id: UUID | null;   // ingestion profile the corpus is indexed under (null => tenant's blessed default)
+  // NB: the ingestion profile is TENANT-level (governs the whole collection), never per-corpus.
 }
 
 /** Build-time knob bundle that DEFINES an index. Defaults are today's blessed config, so a
@@ -282,6 +282,18 @@ export interface IngestionProfileWrite {
   params?: Partial<IngestionProfileParams>;
   is_default?: boolean;
 }
+
+/** Config catalog for a profile UI (GET /v1/profiles/model-options) — build-side mirror of the
+ *  query model-options. `embedding_models` maps id → { provider, dimensions, label }; `fields`
+ *  gives each param its supported list / default / bounds; `standard_params` is the blessed default. */
+export interface IngestionProfileOptions {
+  embedding_models: Record<string, { provider: string; dimensions: number; label: string }>;
+  chunkers: Record<string, { label: string }>;
+  distances: string[];
+  quantizations: string[];
+  fields: Record<string, { supported?: string[]; default?: unknown; min?: number }>;
+  standard_params: IngestionProfileParams;
+}
 export interface Folder {
   id: UUID;
   corpus_id: UUID;
@@ -856,7 +868,7 @@ export class KnowledgeCoreClient extends HttpBase {
 
   // --- corpora ---
   corpora = {
-    create: (b: { name: string; description?: string; custom_metadata?: Record<string, unknown>; profile_id?: UUID }) =>
+    create: (b: { name: string; description?: string; custom_metadata?: Record<string, unknown> }) =>
       this.request<Corpus>("POST", "/v1/corpora", { json: b }),
     list: (q?: { limit?: number; cursor?: string }) => this.request<Page<Corpus>>("GET", "/v1/corpora", { query: q }),
     listAll: () => this.pageAll<Corpus>("/v1/corpora"),
@@ -864,9 +876,8 @@ export class KnowledgeCoreClient extends HttpBase {
     search: (b: { filter?: MetadataFilter; limit?: number; cursor?: string }) =>
       this.request<Page<Corpus>>("POST", "/v1/corpora/search", { json: b }),
     get: (id: UUID) => this.request<Corpus>("GET", `/v1/corpora/${id}`),
-    /** `custom_metadata` merges (provided keys upsert, a null value deletes a key). `profile_id`
-     *  reassigns the ingestion profile (does NOT re-index; applies on next (re)ingest). */
-    update: (id: UUID, b: { name?: string; description?: string; custom_metadata?: Record<string, unknown>; profile_id?: UUID | null }) =>
+    /** `custom_metadata` merges (provided keys upsert, a null value deletes a key). */
+    update: (id: UUID, b: { name?: string; description?: string; custom_metadata?: Record<string, unknown> }) =>
       this.request<Corpus>("PATCH", `/v1/corpora/${id}`, { json: b }),
     delete: (id: UUID, confirmName: string) => this.request<void>("DELETE", `/v1/corpora/${id}`, { query: { confirm: confirmName } }),
     listFolders: (id: UUID) => this.pageAll<Folder>(`/v1/corpora/${id}/folders`),
@@ -1130,9 +1141,11 @@ export class KnowledgeCoreClient extends HttpBase {
     modelOptions: () => this.request<ModelOptions>("GET", "/v1/agents/model-options"),
   };
 
-  /** Ingestion profiles — the build-side config object (counterpart to `agents`). A profile
-   *  DEFINES an index (chunking + embedding + sparse + quant); its `fingerprint` is the physical
-   *  collection identity. Attach one to a corpus via `corpora.create/update({ profile_id })`. */
+  /** Ingestion profiles — the build-side config object (counterpart to `agents`): a tenant-owned,
+   *  named bundle of pipeline config (chunking + embedding + sparse + quant). Unlike an agent
+   *  (chosen per query), a profile binds at the TENANT/COLLECTION level — the tenant's one
+   *  `is_default` profile governs how ALL its documents are ingested; swapping it re-indexes.
+   *  A corpus's content is a RESULT of ingestion, so a corpus never selects a profile. */
   profiles = {
     /** List this tenant's ingestion profiles. */
     list: (q?: { limit?: number; cursor?: string }) =>
@@ -1144,8 +1157,12 @@ export class KnowledgeCoreClient extends HttpBase {
       this.request<IngestionProfile>("POST", "/v1/profiles", { json: b }),
     update: (id: UUID, b: IngestionProfileWrite) =>
       this.request<IngestionProfile>("PATCH", `/v1/profiles/${id}`, { json: b }),
-    /** Delete a profile. 409 if any corpus still references it. */
+    /** Delete a profile. 409 when it's the tenant's active (default) profile. */
     delete: (id: UUID) => this.request<void>("DELETE", `/v1/profiles/${id}`),
+    /** The config catalog for a profile UI: supported embedding models (+ provider/dims),
+     *  chunkers, distances, quantizations, per-field defaults/bounds, and the standard params.
+     *  Build-side mirror of `agents.modelOptions()`. */
+    modelOptions: () => this.request<IngestionProfileOptions>("GET", "/v1/profiles/model-options"),
   };
 
   // --- retrieval analytics (read-only, tenant-scoped, aggregate-on-read) ---