@dbx-tools/search 0.6.108 → 0.6.112
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +96 -110
- package/index.ts +6 -2
- package/lib/index.d.ts +6 -2
- package/lib/index.js +4 -1
- package/lib/src/client.d.ts +23 -43
- package/lib/src/client.js +51 -114
- package/lib/src/lakebase-plugin.d.ts +73 -0
- package/lib/src/lakebase-plugin.js +191 -0
- package/lib/src/lakebase.d.ts +6 -4
- package/lib/src/lakebase.js +45 -13
- package/lib/src/native.d.ts +18 -0
- package/lib/src/native.js +79 -0
- package/lib/src/plugin.d.ts +31 -59
- package/lib/src/plugin.js +63 -130
- package/lib/src/query.d.ts +1 -57
- package/lib/src/query.js +2 -93
- package/lib/src/runtime.d.ts +4 -11
- package/lib/src/runtime.js +3 -7
- package/lib/src/schema.d.ts +1 -1
- package/lib/src/tool.d.ts +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +9 -9
- package/src/client.ts +69 -137
- package/src/lakebase-plugin.ts +258 -0
- package/src/lakebase.ts +56 -15
- package/src/native.ts +117 -0
- package/src/plugin.ts +63 -148
- package/src/query.ts +1 -109
- package/src/runtime.ts +6 -16
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Adapter from AppKit's native AI Search provider to the dbx-tools extension
|
|
3
|
+
* contract used by federated search and agent tools.
|
|
4
|
+
*
|
|
5
|
+
* @module
|
|
6
|
+
*/
|
|
7
|
+
import { ValidationError } from "@databricks/appkit";
|
|
8
|
+
import { search as sharedSearch, } from "@dbx-tools/shared-search";
|
|
9
|
+
import { string } from "@dbx-tools/shared-core";
|
|
10
|
+
import { indexConfigFor } from "./config.js";
|
|
11
|
+
function filters(value) {
|
|
12
|
+
if (!value)
|
|
13
|
+
return undefined;
|
|
14
|
+
const result = {};
|
|
15
|
+
for (const [key, item] of Object.entries(value)) {
|
|
16
|
+
if (typeof item === "string" ||
|
|
17
|
+
typeof item === "number" ||
|
|
18
|
+
typeof item === "boolean" ||
|
|
19
|
+
(Array.isArray(item) &&
|
|
20
|
+
item.every((entry) => typeof entry === "string" || typeof entry === "number"))) {
|
|
21
|
+
result[key] = item;
|
|
22
|
+
continue;
|
|
23
|
+
}
|
|
24
|
+
throw new ValidationError(`AI Search filter "${key}" must be a string, number, boolean, or string/number array`);
|
|
25
|
+
}
|
|
26
|
+
return result;
|
|
27
|
+
}
|
|
28
|
+
function hitId(data, primaryKey, index) {
|
|
29
|
+
const value = data[primaryKey ?? "id"] ?? Object.values(data)[0] ?? index;
|
|
30
|
+
return String(value);
|
|
31
|
+
}
|
|
32
|
+
function aliasFor(index, config) {
|
|
33
|
+
const alias = indexConfigFor(config, index)?.alias ?? string.trimToNull(index);
|
|
34
|
+
if (!alias)
|
|
35
|
+
throw new ValidationError("AI Search requires a configured index alias");
|
|
36
|
+
return alias;
|
|
37
|
+
}
|
|
38
|
+
/** Build a read backend that delegates every Vector Search query to AppKit. */
|
|
39
|
+
export function nativeAiSearchBackend(provider, config) {
|
|
40
|
+
const backend = {
|
|
41
|
+
supportsLifecycle: provider.providerKind !== "lakebase",
|
|
42
|
+
async search(index, query, options = {}) {
|
|
43
|
+
options.signal?.throwIfAborted();
|
|
44
|
+
const known = indexConfigFor(config, index);
|
|
45
|
+
const alias = aliasFor(index, config);
|
|
46
|
+
const resolvedQueryType = sharedSearch.toAiSearchQueryType(options.mode);
|
|
47
|
+
const resolvedFilters = filters(options.filter);
|
|
48
|
+
const response = await provider.query(alias, {
|
|
49
|
+
queryText: query,
|
|
50
|
+
numResults: options.limit ?? config.pageSize,
|
|
51
|
+
...(options.columns ? { columns: [...options.columns] } : {}),
|
|
52
|
+
...(resolvedQueryType ? { queryType: resolvedQueryType } : {}),
|
|
53
|
+
...(resolvedFilters ? { filters: resolvedFilters } : {}),
|
|
54
|
+
});
|
|
55
|
+
options.signal?.throwIfAborted();
|
|
56
|
+
const hits = response.results
|
|
57
|
+
.map((result, resultIndex) => ({
|
|
58
|
+
id: hitId(result.data, known?.primaryKey, resultIndex),
|
|
59
|
+
score: result.score,
|
|
60
|
+
fields: result.data,
|
|
61
|
+
}))
|
|
62
|
+
.filter((hit) => options.scoreThreshold === undefined || hit.score >= options.scoreThreshold);
|
|
63
|
+
return { query, index, hits, count: hits.length };
|
|
64
|
+
},
|
|
65
|
+
};
|
|
66
|
+
const addDocuments = provider.addDocuments?.bind(provider);
|
|
67
|
+
if (!addDocuments)
|
|
68
|
+
return backend;
|
|
69
|
+
return {
|
|
70
|
+
...backend,
|
|
71
|
+
async addDocuments(index, documents, signal) {
|
|
72
|
+
signal?.throwIfAborted();
|
|
73
|
+
const result = await addDocuments(aliasFor(index, config), documents);
|
|
74
|
+
signal?.throwIfAborted();
|
|
75
|
+
return result;
|
|
76
|
+
},
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"native.js","sourceRoot":"","sources":["../../src/native.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAMrD,OAAO,EACL,MAAM,IAAI,YAAY,GAMvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAEhD,OAAO,EAAE,cAAc,EAA6B,MAAM,aAAa,CAAC;AASxE,SAAS,OAAO,CAAC,KAAuC;IACtD,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChD,IACE,OAAO,IAAI,KAAK,QAAQ;YACxB,OAAO,IAAI,KAAK,QAAQ;YACxB,OAAO,IAAI,KAAK,SAAS;YACzB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;gBAClB,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,EAChF,CAAC;YACD,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;YACnB,SAAS;QACX,CAAC;QACD,MAAM,IAAI,eAAe,CACvB,qBAAqB,GAAG,6DAA6D,CACtF,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,KAAK,CACZ,IAA6B,EAC7B,UAA8B,EAC9B,KAAa;IAEb,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC;IAC1E,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED,SAAS,QAAQ,CAAC,KAAa,EAAE,MAA4B;IAC3D,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAC/E,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,eAAe,CAAC,6CAA6C,CAAC,CAAC;IACrF,OAAO,KAAK,CAAC;AACf,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,qBAAqB,CACnC,QAA0B,EAC1B,MAA4B;IAE5B,MAAM,OAAO,GAAsB;QACjC,iBAAiB,EAAE,QAAQ,CAAC,YAAY,KAAK,UAAU;QACvD,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,KAAa,EAAE,UAAyB,EAAE;YACpE,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACtC,MAAM,iBAAiB,GAAG,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACzE,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChD,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE;gBAC3C,SAAS,EAAE,KAAK;gBAChB,UAAU,EAAE,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,QAAQ;gBAC5C,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7D,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC9D,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACzD,CAAC,CAAC;YACH,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;YACjC,MAAM,IAAI,GAAgB,QAAQ,CAAC,OAAO;iBACvC,GAAG,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;gBAC7B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,CAAC;gBACtD,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;aACpB,CAAC,CAAC;iBACF,MAAM,CACL,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,KAAK,SAAS,IAAI,GAAG,CAAC,KAAK,IAAI,OAAO,CAAC,cAAc,CACrF,CAAC;YACJ,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;QACpD,CAAC;KACF,CAAC;IACF,MAAM,YAAY,GAAG,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3D,IAAI,CAAC,YAAY;QAAE,OAAO,OAAO,CAAC;IAClC,OAAO;QACL,GAAG,OAAO;QACV,KAAK,CAAC,YAAY,CAChB,KAAa,EACb,SAA2B,EAC3B,MAAoB;YAEpB,MAAM,EAAE,cAAc,EAAE,CAAC;YACzB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;YACtE,MAAM,EAAE,cAAc,EAAE,CAAC;YACzB,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Adapter from AppKit's native AI Search provider to the dbx-tools extension\n * contract used by federated search and agent tools.\n *\n * @module\n */\n\nimport { ValidationError } from \"@databricks/appkit\";\nimport type {\n  SearchFilters as AppKitSearchFilters,\n  SearchRequest as AppKitSearchRequest,\n  SearchResponse as AppKitSearchResponse,\n} from \"@databricks/appkit/beta\";\nimport {\n  search as sharedSearch,\n  type SearchDocument,\n  type SearchHit,\n  type SearchRequest as ExtensionSearchRequest,\n  type SearchResult,\n  type UpsertResult,\n} from \"@dbx-tools/shared-search\";\nimport { string } from \"@dbx-tools/shared-core\";\nimport type { SearchOptions, SearchReadBackend } from \"./client.ts\";\nimport { indexConfigFor, type ResolvedSearchConfig } from \"./config.ts\";\n\n/** Minimal query surface exposed by AppKit's native `aiSearch` plugin. */\nexport interface AiSearchProvider {\n  providerKind?: \"lakebase\";\n  query(alias: string, request: AppKitSearchRequest): Promise<AppKitSearchResponse>;\n  addDocuments?(alias: string, documents: SearchDocument[]): Promise<UpsertResult>;\n}\n\nfunction filters(value: ExtensionSearchRequest[\"filter\"]): AppKitSearchFilters | undefined {\n  if (!value) return undefined;\n  const result: AppKitSearchFilters = {};\n  for (const [key, item] of Object.entries(value)) {\n    if (\n      typeof item === \"string\" ||\n      typeof item === \"number\" ||\n      typeof item === \"boolean\" ||\n      (Array.isArray(item) &&\n        item.every((entry) => typeof entry === \"string\" || typeof entry === \"number\"))\n    ) {\n      result[key] = item;\n      continue;\n    }\n    throw new ValidationError(\n      `AI Search filter \"${key}\" must be a string, number, boolean, or string/number array`,\n    );\n  }\n  return result;\n}\n\nfunction hitId(\n  data: Record<string, unknown>,\n  primaryKey: string | undefined,\n  index: number,\n): string {\n  const value = data[primaryKey ?? \"id\"] ?? Object.values(data)[0] ?? index;\n  return String(value);\n}\n\nfunction aliasFor(index: string, config: ResolvedSearchConfig): string {\n  const alias = indexConfigFor(config, index)?.alias ?? string.trimToNull(index);\n  if (!alias) throw new ValidationError(\"AI Search requires a configured index alias\");\n  return alias;\n}\n\n/** Build a read backend that delegates every Vector Search query to AppKit. */\nexport function nativeAiSearchBackend(\n  provider: AiSearchProvider,\n  config: ResolvedSearchConfig,\n): SearchReadBackend {\n  const backend: SearchReadBackend = {\n    supportsLifecycle: provider.providerKind !== \"lakebase\",\n    async search(index: string, query: string, options: SearchOptions = {}): Promise<SearchResult> {\n      options.signal?.throwIfAborted();\n      const known = indexConfigFor(config, index);\n      const alias = aliasFor(index, config);\n      const resolvedQueryType = sharedSearch.toAiSearchQueryType(options.mode);\n      const resolvedFilters = filters(options.filter);\n      const response = await provider.query(alias, {\n        queryText: query,\n        numResults: options.limit ?? config.pageSize,\n        ...(options.columns ? { columns: [...options.columns] } : {}),\n        ...(resolvedQueryType ? { queryType: resolvedQueryType } : {}),\n        ...(resolvedFilters ? { filters: resolvedFilters } : {}),\n      });\n      options.signal?.throwIfAborted();\n      const hits: SearchHit[] = response.results\n        .map((result, resultIndex) => ({\n          id: hitId(result.data, known?.primaryKey, resultIndex),\n          score: result.score,\n          fields: result.data,\n        }))\n        .filter(\n          (hit) => options.scoreThreshold === undefined || hit.score >= options.scoreThreshold,\n        );\n      return { query, index, hits, count: hits.length };\n    },\n  };\n  const addDocuments = provider.addDocuments?.bind(provider);\n  if (!addDocuments) return backend;\n  return {\n    ...backend,\n    async addDocuments(\n      index: string,\n      documents: SearchDocument[],\n      signal?: AbortSignal,\n    ): Promise<UpsertResult> {\n      signal?.throwIfAborted();\n      const result = await addDocuments(aliasFor(index, config), documents);\n      signal?.throwIfAborted();\n      return result;\n    },\n  };\n}\n"]}
|
package/lib/src/plugin.d.ts
CHANGED
|
@@ -1,51 +1,55 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* AppKit plugin (registered name: `search`)
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
2
|
+
* AppKit extension plugin (registered name: `search`) around a sibling
|
|
3
|
+
* `aiSearch` provider. Native AppKit owns Vector Search query execution; this
|
|
4
|
+
* plugin adds the surfaces that remain useful across native and Lakebase
|
|
5
|
+
* providers:
|
|
6
6
|
*
|
|
7
7
|
* - a `search` / `universal_search` / (opt-in) `add_documents` tool set for
|
|
8
8
|
* both Mastra and AppKit agents (autocomplete is a small-`limit` search);
|
|
9
|
-
* -
|
|
9
|
+
* - compatibility and extension routes under `/api/search`
|
|
10
10
|
* (`POST /` search, `POST /universal` federated, `GET /indexes` catalogue,
|
|
11
11
|
* and `POST /documents` when writes are enabled);
|
|
12
12
|
* - a `clientConfig()` payload so a UI knows the indexes, default, and page
|
|
13
13
|
* size at boot with no round-trip;
|
|
14
14
|
* - `exports()` so app code can `appkit.search.search(...)` directly.
|
|
15
15
|
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
* first search.
|
|
16
|
+
* Vector Search reads delegate to the registered native AppKit `aiSearch`
|
|
17
|
+
* plugin, preserving its OBO, caching, reranking, and response handling. The
|
|
18
|
+
* alternative `lakebaseAiSearch` provider supplies the same query contract
|
|
19
|
+
* over PostgreSQL full-text search.
|
|
21
20
|
*
|
|
22
21
|
* @module
|
|
23
22
|
*/
|
|
24
|
-
import { Plugin,
|
|
23
|
+
import { Plugin, type IAppRouter } from "@databricks/appkit";
|
|
25
24
|
import { type AgentToolDefinition, type ToolProvider } from "@databricks/appkit/beta";
|
|
26
25
|
import { search as sharedSearch } from "@dbx-tools/shared-search";
|
|
27
26
|
import { type SearchPluginConfig } from "./config.ts";
|
|
28
27
|
/**
|
|
29
|
-
* AppKit plugin
|
|
30
|
-
*
|
|
28
|
+
* AppKit extension plugin for agent tools, federated search, and optional
|
|
29
|
+
* Vector Search lifecycle operations. Register `aiSearch()` or
|
|
30
|
+
* `lakebaseAiSearch()` before this plugin.
|
|
31
31
|
*
|
|
32
32
|
* @example
|
|
33
33
|
* ```ts
|
|
34
34
|
* import { createApp, server } from "@databricks/appkit";
|
|
35
|
+
* import { aiSearch } from "@databricks/appkit/beta";
|
|
35
36
|
* import { plugin as searchPlugin } from "@dbx-tools/search";
|
|
36
37
|
*
|
|
37
38
|
* await createApp({
|
|
38
39
|
* plugins: [
|
|
39
40
|
* server(),
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
41
|
+
* aiSearch({
|
|
42
|
+
* indexes: {
|
|
43
|
+
* docs: {
|
|
44
|
+
* indexName: "main.support.docs",
|
|
45
|
+
* columns: ["id", "title", "body"],
|
|
46
|
+
* },
|
|
47
|
+
* },
|
|
48
|
+
* }),
|
|
49
|
+
* searchPlugin.search({
|
|
50
|
+
* index: "main.support.docs",
|
|
51
|
+
* indexes: [{ name: "main.support.docs", alias: "docs" }],
|
|
52
|
+
* }),
|
|
49
53
|
* ],
|
|
50
54
|
* });
|
|
51
55
|
* ```
|
|
@@ -58,24 +62,7 @@ export declare class SearchPlugin extends Plugin<SearchPluginConfig> implements
|
|
|
58
62
|
stability: "beta";
|
|
59
63
|
resources: {
|
|
60
64
|
required: never[];
|
|
61
|
-
optional:
|
|
62
|
-
type: ResourceType.VECTOR_SEARCH_INDEX;
|
|
63
|
-
alias: string;
|
|
64
|
-
resourceKey: string;
|
|
65
|
-
description: string;
|
|
66
|
-
permission: "SELECT";
|
|
67
|
-
fields: {
|
|
68
|
-
name: {
|
|
69
|
-
env: string;
|
|
70
|
-
description: string;
|
|
71
|
-
discovery: {
|
|
72
|
-
type: "cli";
|
|
73
|
-
cliCommand: string;
|
|
74
|
-
selectField: string;
|
|
75
|
-
};
|
|
76
|
-
};
|
|
77
|
-
};
|
|
78
|
-
}[];
|
|
65
|
+
optional: never[];
|
|
79
66
|
};
|
|
80
67
|
config: {
|
|
81
68
|
schema: import("json-schema").JSONSchema7;
|
|
@@ -83,11 +70,6 @@ export declare class SearchPlugin extends Plugin<SearchPluginConfig> implements
|
|
|
83
70
|
};
|
|
84
71
|
/** The base path AppKit mounts this plugin's routes under. */
|
|
85
72
|
private get basePath();
|
|
86
|
-
/**
|
|
87
|
-
* Promote the index to a required resource once a deployment pins a default,
|
|
88
|
-
* through plugin config or either environment name.
|
|
89
|
-
*/
|
|
90
|
-
static getResourceRequirements(config: SearchPluginConfig): ResourceRequirement[];
|
|
91
73
|
/**
|
|
92
74
|
* The tools this plugin offers to an AppKit agent. `search` /
|
|
93
75
|
* `universal_search` are reads; `add_documents` / `create_index` /
|
|
@@ -98,16 +80,8 @@ export declare class SearchPlugin extends Plugin<SearchPluginConfig> implements
|
|
|
98
80
|
private get tools();
|
|
99
81
|
/** Prime the shared runtime from config and log the effective policy at boot. */
|
|
100
82
|
setup(): Promise<void>;
|
|
101
|
-
/**
|
|
102
|
-
|
|
103
|
-
* Search should be used. Falls back only when there is NO Vector Search
|
|
104
|
-
* endpoint configured (plugin config or `SEARCH_ENDPOINT` /
|
|
105
|
-
* `DATABRICKS_VECTOR_SEARCH_ENDPOINT`) AND the sibling AppKit `lakebase`
|
|
106
|
-
* plugin is registered. The pg pool is built from that plugin's
|
|
107
|
-
* service-principal config exactly like `@dbx-tools/appkit-mastra`'s memory
|
|
108
|
-
* pool - no auth is re-implemented here.
|
|
109
|
-
*/
|
|
110
|
-
private resolveLakebaseBackend;
|
|
83
|
+
/** Resolve the registered AppKit-compatible AI Search provider. */
|
|
84
|
+
private resolveProviderBackend;
|
|
111
85
|
/**
|
|
112
86
|
* Ensure the endpoint + index exist and seed them, honoring `ensureOnSetup`.
|
|
113
87
|
* Uses boot-time SDK auth (env / config profile) via the client's
|
|
@@ -121,10 +95,8 @@ export declare class SearchPlugin extends Plugin<SearchPluginConfig> implements
|
|
|
121
95
|
shutdown(): Promise<void>;
|
|
122
96
|
abortActiveOperations(): void;
|
|
123
97
|
/**
|
|
124
|
-
* Mount
|
|
125
|
-
*
|
|
126
|
-
* Unity Catalog ACLs apply. `GET /indexes` needs no user scope - it just
|
|
127
|
-
* echoes the configured catalogue.
|
|
98
|
+
* Mount extension routes under `/api/search`. Single-index queries stay on
|
|
99
|
+
* the provider's native `/api/ai-search/:alias/query` surface.
|
|
128
100
|
*/
|
|
129
101
|
injectRoutes(router: IAppRouter): void;
|
|
130
102
|
/**
|