-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathplugin.ts
More file actions
1211 lines (1137 loc) · 52.8 KB
/
Copy pathplugin.ts
File metadata and controls
1211 lines (1137 loc) · 52.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
import type { Plugin, PluginContext } from '@objectstack/core';
import { readEnvWithDeprecation } from '@objectstack/types';
import type { IAIService, IAIConversationService, IAutomationService, IDataEngine, IEmbedder, IMetadataService, LLMAdapter } from '@objectstack/spec/contracts';
import { EMBEDDER_SERVICE } from '@objectstack/spec/contracts';
import type * as AI from '@objectstack/spec/ai';
import { AIService } from './ai-service.js';
import type { AIServiceConfig } from './ai-service.js';
import { buildAIRoutes } from './routes/ai-routes.js';
import { buildAgentRoutes } from './routes/agent-routes.js';
import { buildAssistantRoutes } from './routes/assistant-routes.js';
import { buildToolRoutes } from './routes/tool-routes.js';
import { buildPendingActionRoutes } from './routes/pending-action-routes.js';
import { buildEvalRoutes } from './routes/eval-routes.js';
import { ObjectQLConversationService } from './conversation/objectql-conversation-service.js';
import { AiConversationObject, AiMessageObject, AiPendingActionObject, AiTraceObject, AiEvalCaseObject, AiEvalRunObject } from './objects/index.js';
import { AiTraceView, AiMessageView, AiPendingActionView, AiEvalCaseView, AiEvalRunView } from './views/index.js';
import { EvalRunner } from './eval/index.js';
import { registerDataTools } from './tools/data-tools.js';
import { registerQueryDataTool } from './tools/query-data.tool.js';
import { registerActionsAsTools } from './tools/action-tools.js';
import { AgentRuntime } from './agent-runtime.js';
import { SkillRegistry } from './skill-registry.js';
import { DATA_CHAT_AGENT } from './agents/index.js';
import { DATA_EXPLORER_SKILL, ACTIONS_EXECUTOR_SKILL } from './skills/index.js';
import { VercelLLMAdapter } from './adapters/vercel-adapter.js';
import { MemoryLLMAdapter } from './adapters/memory-adapter.js';
import { ModelRegistry } from './model-registry.js';
import { ObjectQLTraceRecorder, type TraceRecorder } from './trace-recorder.js';
/**
* Configuration options for the AIServicePlugin.
*/
export interface AIServicePluginOptions {
/** LLM adapter to use (defaults to MemoryLLMAdapter). */
adapter?: LLMAdapter;
/** Enable debug logging. */
debug?: boolean;
/** Explicit conversation service override. When set, auto-detection is skipped. */
conversationService?: IAIConversationService;
/**
* Models to register in the runtime {@link ModelRegistry}.
*
* Used for default-model resolution and cost attribution in traces.
* If omitted, the registry starts empty and trace `cost_*` fields are null.
*/
models?: AI.ModelConfig[];
/** Default model id (must appear in `models`). */
defaultModelId?: string;
/**
* Vercel AI Gateway model id (e.g. `anthropic/claude-haiku-4-5`) for this
* plugin instance. Takes precedence over the `AI_GATEWAY_MODEL` env var so a
* host can select the model per kernel — e.g. a multi-tenant runtime routing
* by plan. When omitted, falls back to `AI_GATEWAY_MODEL` (unchanged
* behavior). Pairs with the gateway adapter only; ignored by other providers.
*/
gatewayModel?: string;
/**
* Whether to mount this plugin's HTTP routes (fire the `ai:routes` hook).
* Defaults to `true`. Set `false` for an AIService on a host/routing-shell
* kernel in a multi-tenant runtime: the host should NOT serve concrete AI
* routes (they would shadow the dispatcher's `/ai/*` wildcard, which resolves
* the request's environment and dispatches to the per-environment kernel's
* AIService). Route definitions are still cached on the kernel (`__aiRoutes`)
* so the dispatcher can match them per-env. Single-env runtimes leave this on.
*/
registerRoutes?: boolean;
/**
* Explicit trace recorder override. When set, auto-detection
* of {@link ObjectQLTraceRecorder} is skipped.
*
* Set to `null` to disable tracing entirely.
*/
/**
* Explicit trace recorder override. When set, auto-detection
* of {@link ObjectQLTraceRecorder} is skipped.
*
* Set to `null` to disable tracing entirely.
*/
traceRecorder?: TraceRecorder | null;
/**
* Base URL prepended to relative `target` paths for `type:'api'`
* actions invoked by the AI tool runtime. When unset, falls back to
* `process.env.OS_AI_ACTION_API_BASE_URL`. If neither is set, api
* actions are skipped at registration with a clear reason.
*/
apiActionBaseUrl?: string;
/**
* Extra HTTP headers (e.g. `{ Authorization: 'Bearer ...' }`) applied
* to every `type:'api'` action dispatch. Useful for forwarding the
* caller's session token so server-side authorization still applies.
*/
apiActionHeaders?: Record<string, string>;
/**
* Opt into Human-In-The-Loop approval for dangerous actions exposed
* as AI tools. When `true`, actions with `confirmText`, `mode:'delete'`,
* or `variant:'danger'` are still registered as tools — but invoking
* them enqueues an `ai_pending_actions` row and returns
* `{ status: 'pending_approval' }` instead of running. A human
* operator approves via Studio's pending-actions inbox to execute.
*
* Defaults to `false` (safer: dangerous actions stay invisible to LLM
* until an operator explicitly enables this routing).
*/
enableActionApproval?: boolean;
/**
* Bind to the `ai` settings namespace and rebuild the LLM adapter on
* every `settings:changed` event. When enabled (default), operators
* can edit provider/credentials/model via the Setup app and the
* change applies live without restart. Disable to lock the adapter
* to whatever was resolved at boot (constructor option or env var).
*/
bindToSettings?: boolean;
}
/**
* AIServicePlugin — Kernel plugin for the unified AI capability service.
*
* Lifecycle:
* 1. **init** — Creates {@link AIService}, registers as `'ai'` service.
* If an existing AI service is already registered, it is replaced.
* 2. **start** — Triggers `'ai:ready'` hook so other plugins can register
* tools or extend the service. Registers REST/SSE routes.
* 3. **destroy** — Cleans up references.
*
* @example
* ```ts
* import { LiteKernel } from '@objectstack/core';
* import { AIServicePlugin } from '@objectstack/service-ai';
*
* const kernel = new LiteKernel();
* kernel.use(new AIServicePlugin());
* await kernel.bootstrap();
*
* const ai = kernel.getService<IAIService>('ai');
* const result = await ai.chat([{ role: 'user', content: 'Hello' }]);
* ```
*/
export class AIServicePlugin implements Plugin {
name = 'com.objectstack.service-ai';
version = '1.0.0';
type = 'standard' as const;
dependencies: string[] = ['com.objectstack.engine.objectql']; // manifest service required
private service?: AIService;
private readonly options: AIServicePluginOptions;
constructor(options: AIServicePluginOptions = {}) {
this.options = options;
}
/**
* OpenAI-compatible preset providers — these all expose `/v1/chat/completions`
* in OpenAI shape, so we re-use the `@ai-sdk/openai` SDK with a preset
* base URL. Centralising the mapping here keeps the settings UI ergonomic
* (operators pick "DeepSeek", not "openai" + a base URL they have to look up)
* without bloating buildAdapterFromValues with a switch per provider.
*/
private static readonly OPENAI_COMPATIBLE_PRESETS: Record<string, { baseURL: string; defaultModel: string }> = {
deepseek: { baseURL: 'https://api.deepseek.com', defaultModel: 'deepseek-chat' },
dashscope: { baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1', defaultModel: 'qwen-plus' },
siliconflow: { baseURL: 'https://api.siliconflow.cn/v1', defaultModel: 'Qwen/Qwen2.5-7B-Instruct' },
openrouter: { baseURL: 'https://openrouter.ai/api/v1', defaultModel: 'openai/gpt-4o-mini' },
};
/**
* Normalise OpenAI-compatible preset providers (DeepSeek / DashScope /
* Cloudflare / SiliconFlow / OpenRouter) into the `provider=openai` shape
* with the appropriate base URL pre-filled. Returns the rewritten values
* map; non-preset providers pass through unchanged.
*/
private normalisePresetProvider(values: Record<string, unknown>): Record<string, unknown> {
const provider = String(values.provider ?? 'memory');
// Cloudflare /compat: assemble the URL from account_id + gateway_id and
// forward the cfut_ token via openai_api_key. Model id stays in
// provider/model form because /compat dispatches on the prefix.
if (provider === 'cloudflare') {
const accountId = String(values.cloudflare_account_id ?? '').trim();
const gatewayId = String(values.cloudflare_gateway_id ?? 'default').trim() || 'default';
if (!accountId) return values; // surfaces "missing key" downstream
return {
...values,
provider: 'openai',
openai_api_key: values.cloudflare_api_key,
openai_base_url: `https://gateway.ai.cloudflare.com/v1/${accountId}/${gatewayId}/compat`,
openai_model: values.cloudflare_model ?? 'openai/gpt-4o-mini',
};
}
const preset = AIServicePlugin.OPENAI_COMPATIBLE_PRESETS[provider];
if (!preset) return values;
return {
...values,
provider: 'openai',
openai_api_key: values[`${provider}_api_key`],
openai_base_url: preset.baseURL,
openai_model: values[`${provider}_model`] ?? preset.defaultModel,
};
}
/**
* Build an LLM adapter from a provider/key/model triple. Used both
* by the boot-time auto-detect path and by the live `settings:changed`
* rebuild path. Returns `null` if the requested provider cannot be
* loaded or required credentials are missing.
*/
private async buildAdapterFromValues(
ctx: PluginContext,
rawValues: Record<string, unknown>,
): Promise<{ adapter: LLMAdapter; description: string } | null> {
const values = this.normalisePresetProvider(rawValues);
const provider = String(values.provider ?? 'memory');
if (provider === 'memory') {
return { adapter: new MemoryLLMAdapter(), description: 'MemoryLLMAdapter (echo mode)' };
}
if (provider === 'gateway') {
// Fall back to AI_GATEWAY_MODEL env var when the form has no model —
// mirrors detectAdapter() so operators who only configured env vars
// can still validate the connection from the UI.
const gatewayModel =
String(values.gateway_model ?? '').trim() ||
String(process.env.AI_GATEWAY_MODEL ?? '').trim();
if (!gatewayModel) return null;
// API key precedence: form value → AI_GATEWAY_API_KEY env. The default
// `gateway` export only reads the env var, so when the form supplies a
// key we must build a configured instance via `createGateway`.
const gatewayApiKey =
String(values.gateway_api_key ?? '').trim() ||
String(process.env.AI_GATEWAY_API_KEY ?? '').trim();
try {
const gatewayPkg = '@ai-sdk/gateway';
const mod = await import(/* webpackIgnore: true */ gatewayPkg);
const gw = gatewayApiKey
? mod.createGateway({ apiKey: gatewayApiKey })
: mod.gateway;
return {
adapter: new VercelLLMAdapter({ model: gw(gatewayModel) }),
description: `Vercel AI Gateway (model: ${gatewayModel})`,
};
} catch (err) {
ctx.logger.warn(
`[AI] Failed to load @ai-sdk/gateway for provider=gateway`,
err instanceof Error ? { error: err.message } : undefined,
);
return null;
}
}
const providerSpecs: Record<string, { pkg: string; factory: string; createFactory: string; defaultModel: string; displayName: string }> = {
openai: { pkg: '@ai-sdk/openai', factory: 'openai', createFactory: 'createOpenAI', defaultModel: 'gpt-4o', displayName: 'OpenAI' },
anthropic: { pkg: '@ai-sdk/anthropic', factory: 'anthropic', createFactory: 'createAnthropic', defaultModel: 'claude-sonnet-4-20250514', displayName: 'Anthropic' },
google: { pkg: '@ai-sdk/google', factory: 'google', createFactory: 'createGoogleGenerativeAI', defaultModel: 'gemini-2.0-flash', displayName: 'Google' },
};
const spec = providerSpecs[provider];
if (!spec) return null;
const apiKey =
String(values[`${provider}_api_key`] ?? '').trim() ||
// Fall back to the corresponding env var so operators who only
// configured env credentials (and didn't paste the key into the
// settings form) can still validate the connection.
String(
process.env[
provider === 'openai' ? 'OPENAI_API_KEY'
: provider === 'anthropic' ? 'ANTHROPIC_API_KEY'
: 'GOOGLE_GENERATIVE_AI_API_KEY'
] ?? '',
).trim();
if (!apiKey) return null;
// The Vercel-style provider SDKs read credentials from environment
// variables. To honor the settings-supplied key without forcing the
// operator to also set the env var, mirror it onto process.env for
// the duration of the adapter construction.
const envKey =
provider === 'openai' ? 'OPENAI_API_KEY'
: provider === 'anthropic' ? 'ANTHROPIC_API_KEY'
: 'GOOGLE_GENERATIVE_AI_API_KEY';
process.env[envKey] = apiKey;
// Honour an optional `${provider}_base_url` override so operators can
// point the SDK at a self-hosted gateway, Azure proxy, or local mock.
// We pass it via the SDK's `createX({ baseURL })` factory rather than
// relying on env vars, since `@ai-sdk/openai`'s `OPENAI_BASE_URL` env
// pickup is version-dependent.
const baseUrl = String(values[`${provider}_base_url`] ?? '').trim() || undefined;
try {
const mod = await import(/* webpackIgnore: true */ spec.pkg);
let factory = mod[spec.factory] ?? mod.default;
if (baseUrl) {
const createFn = mod[spec.createFactory];
if (typeof createFn === 'function') {
factory = createFn({ apiKey, baseURL: baseUrl });
} else {
ctx.logger.warn(`[AI] ${spec.pkg} has no ${spec.createFactory}; baseURL override ignored.`);
}
}
if (typeof factory !== 'function') return null;
const modelId = String(values[`${provider}_model`] ?? '').trim() || spec.defaultModel;
// For OpenAI, prefer the Chat Completions API. See note in detectAdapter().
const useChatApi = provider === 'openai' && typeof (factory as any).chat === 'function';
const model = useChatApi ? (factory as any).chat(modelId) : factory(modelId);
const apiSuffix = useChatApi ? ' [chat-completions]' : '';
const baseSuffix = baseUrl ? ` @ ${baseUrl}` : '';
return {
adapter: new VercelLLMAdapter({ model }),
description: `${spec.displayName} (model: ${modelId})${apiSuffix}${baseSuffix}`,
};
} catch (err) {
ctx.logger.warn(
`[AI] Failed to load ${spec.pkg} for provider=${provider}`,
err instanceof Error ? { error: err.message } : undefined,
);
return null;
}
}
/**
* Build an `IEmbedder` instance from embedder settings values
* (`embedder_provider`, `embedder_api_key`, …) by dynamically
* importing `@objectstack/embedder-openai`. Returns `null` for
* `none` (embedder disabled) or when required credentials are
* missing / the package isn't installed.
*
* The OpenAI-compatible plugin covers OpenAI, Azure, 阿里通义,
* 智谱, 硅基流动, 火山 Doubao, MiniMax, Ollama, and any custom
* OpenAI-shape endpoint via `embedder_base_url`.
*/
private async buildEmbedderFromValues(
ctx: PluginContext,
values: Record<string, unknown>,
): Promise<{ embedder: IEmbedder; description: string } | null> {
const provider = String(values.embedder_provider ?? 'none').trim();
if (!provider || provider === 'none') return null;
const apiKey = String(values.embedder_api_key ?? '').trim();
const model = String(values.embedder_model ?? '').trim() || undefined;
const baseUrlOverride = String(values.embedder_base_url ?? '').trim() || undefined;
const dimensions =
values.embedder_dimensions != null && values.embedder_dimensions !== ''
? Number(values.embedder_dimensions)
: undefined;
// ollama and custom typically run unauthenticated. Other providers
// require an api key.
if (!apiKey && provider !== 'ollama') {
ctx.logger.warn(
`[AI] Embedder provider=${provider} requires embedder_api_key — embedder unchanged.`,
);
return null;
}
if ((provider === 'custom' || provider === 'azure') && !baseUrlOverride) {
ctx.logger.warn(
`[AI] Embedder provider=${provider} requires embedder_base_url — embedder unchanged.`,
);
return null;
}
try {
const pkg = '@objectstack/embedder-openai';
const mod = await import(/* webpackIgnore: true */ pkg);
const create = mod.createOpenAIEmbedder ?? mod.default?.createOpenAIEmbedder;
if (typeof create !== 'function') {
ctx.logger.warn(
`[AI] ${pkg} did not export createOpenAIEmbedder — embedder unchanged.`,
);
return null;
}
const embedder = create({
preset: provider === 'custom' ? undefined : provider,
baseUrl: baseUrlOverride,
apiKey: apiKey || 'ollama',
model,
dimensions: Number.isFinite(dimensions) ? dimensions : undefined,
id: provider,
}) as IEmbedder;
const dimsLabel = embedder.dimensions ? `dims=${embedder.dimensions}` : 'dims=?';
return {
embedder,
description: `OpenAI-compatible embedder (provider=${provider}${model ? `, model=${model}` : ''}, ${dimsLabel})`,
};
} catch (err) {
ctx.logger.warn(
`[AI] Failed to load @objectstack/embedder-openai for embedder provider=${provider}`,
err instanceof Error ? { error: err.message } : undefined,
);
return null;
}
}
/**
* Auto-detect LLM provider from environment variables.
*
* Priority order:
* 1. AI_GATEWAY_MODEL → Vercel AI Gateway
* 2. OPENAI_API_KEY → OpenAI
* 3. ANTHROPIC_API_KEY → Anthropic
* 4. GOOGLE_GENERATIVE_AI_API_KEY → Google
* 5. Fallback → MemoryLLMAdapter
*
* Returns the adapter and a description for logging.
*/
private async detectAdapter(ctx: PluginContext): Promise<{ adapter: LLMAdapter; description: string }> {
// 1. Vercel AI Gateway — works with any provider via gateway('provider/model').
// A per-instance `gatewayModel` option wins over the process-wide env var
// so a multi-tenant host can route the model per kernel (e.g. by plan).
const gatewayModel = this.options.gatewayModel ?? process.env.AI_GATEWAY_MODEL;
if (gatewayModel) {
try {
const gatewayPkg = '@ai-sdk/gateway';
const { gateway } = await import(/* webpackIgnore: true */ gatewayPkg);
const adapter = new VercelLLMAdapter({ model: gateway(gatewayModel) });
return { adapter, description: `Vercel AI Gateway (model: ${gatewayModel})` };
} catch (err) {
ctx.logger.warn(
`[AI] Failed to load @ai-sdk/gateway for model=${gatewayModel}, trying next provider`,
err instanceof Error ? { error: err.message } : undefined
);
}
}
// 2. Direct provider SDKs
const providerConfigs: Array<{
envKey: string;
pkg: string;
factory: string;
defaultModel: string;
displayName: string;
}> = [
{
envKey: 'OPENAI_API_KEY',
pkg: '@ai-sdk/openai',
factory: 'openai',
defaultModel: 'gpt-4o',
displayName: 'OpenAI'
},
{
envKey: 'ANTHROPIC_API_KEY',
pkg: '@ai-sdk/anthropic',
factory: 'anthropic',
defaultModel: 'claude-sonnet-4-20250514',
displayName: 'Anthropic'
},
{
envKey: 'GOOGLE_GENERATIVE_AI_API_KEY',
pkg: '@ai-sdk/google',
factory: 'google',
defaultModel: 'gemini-2.0-flash',
displayName: 'Google'
},
];
for (const { envKey, pkg, factory, defaultModel, displayName } of providerConfigs) {
if (process.env[envKey]) {
try {
const mod = await import(/* webpackIgnore: true */ pkg);
const provider = mod[factory] ?? mod.default;
if (typeof provider === 'function') {
const modelId = readEnvWithDeprecation('OS_AI_MODEL', 'AI_MODEL') ?? defaultModel;
// For OpenAI, prefer the Chat Completions API (`openai.chat(...)`)
// over the new Responses API. The Responses endpoint
// (`/v1/responses`) is not supported by common reverse proxies
// such as the Vercel AI Gateway, Cloudflare AI Gateway, or
// Azure-style OpenAI deployments — calling it returns 403
// Forbidden and the chat completion silently fails. The Chat
// Completions endpoint (`/v1/chat/completions`) is the
// industry-standard contract every gateway supports.
const useChatApi = factory === 'openai' && typeof (provider as any).chat === 'function';
const model = useChatApi
? (provider as any).chat(modelId)
: provider(modelId);
const adapter = new VercelLLMAdapter({ model });
const apiSuffix = useChatApi ? ' [chat-completions]' : '';
return { adapter, description: `${displayName} (model: ${modelId})${apiSuffix}` };
}
} catch (err) {
ctx.logger.warn(
`[AI] Failed to load ${pkg} for ${envKey}, trying next provider`,
err instanceof Error ? { error: err.message } : undefined
);
}
}
}
// 3. Fallback to MemoryLLMAdapter
ctx.logger.warn('[AI] No LLM provider configured via environment variables. Falling back to MemoryLLMAdapter (echo mode). Set AI_GATEWAY_MODEL, OPENAI_API_KEY, ANTHROPIC_API_KEY, or GOOGLE_GENERATIVE_AI_API_KEY to use a real LLM.');
return { adapter: new MemoryLLMAdapter(), description: 'MemoryLLMAdapter (echo mode - for testing only)' };
}
async init(ctx: PluginContext): Promise<void> {
// Check if there is an existing AI service (e.g. from dev-plugin)
let hasExisting = false;
try {
const existing = ctx.getService<IAIService>('ai');
if (existing && typeof existing.chat === 'function') {
hasExisting = true;
ctx.logger.debug('[AI] Found existing AI service, replacing');
}
} catch {
// No existing service — that's fine
}
// Determine conversation service: explicit > auto-detect IDataEngine > InMemory fallback
let conversationService: IAIConversationService | undefined = this.options.conversationService;
if (!conversationService) {
try {
const engine = ctx.getService<IDataEngine>('data');
if (engine && typeof engine.find === 'function') {
conversationService = new ObjectQLConversationService(engine);
ctx.logger.info('[AI] Using ObjectQLConversationService (IDataEngine detected)');
}
} catch {
// No data engine — fall back to InMemory
}
}
// Determine LLM adapter: explicit > auto-detect from env > MemoryLLMAdapter fallback
let adapter: LLMAdapter;
let adapterDescription: string;
if (this.options.adapter) {
// User provided an explicit adapter
adapter = this.options.adapter;
adapterDescription = `${adapter.name} (explicitly configured)`;
} else {
// Auto-detect from environment variables
const detected = await this.detectAdapter(ctx);
adapter = detected.adapter;
adapterDescription = detected.description;
}
// Log the selected adapter
ctx.logger.info(`[AI] Using LLM adapter: ${adapterDescription}`);
// Model registry — empty by default; populated from plugin options.
const modelRegistry = new ModelRegistry({
models: this.options.models,
defaultModelId: this.options.defaultModelId,
});
if (modelRegistry.size > 0) {
ctx.logger.info(`[AI] ModelRegistry initialised with ${modelRegistry.size} model(s)`);
}
// Trace recorder — explicit > auto-detect IDataEngine > NullTraceRecorder
let traceRecorder: TraceRecorder | undefined;
let dataEngine: IDataEngine | undefined;
try {
const engine = ctx.getService<IDataEngine>('data');
if (engine && typeof engine.insert === 'function') {
dataEngine = engine;
}
} catch {
// No data engine — pending-action queue will be a no-op.
}
if (this.options.traceRecorder === null) {
// Explicit opt-out
ctx.logger.debug('[AI] Tracing disabled (traceRecorder=null)');
} else if (this.options.traceRecorder) {
traceRecorder = this.options.traceRecorder;
} else if (dataEngine) {
traceRecorder = new ObjectQLTraceRecorder(dataEngine, { logger: ctx.logger });
ctx.logger.info('[AI] Using ObjectQLTraceRecorder (IDataEngine detected)');
}
const config: AIServiceConfig = {
adapter,
logger: ctx.logger,
conversationService,
modelRegistry,
traceRecorder,
dataEngine,
};
this.service = new AIService(config);
// Register or replace the AI service
if (hasExisting) {
ctx.replaceService('ai', this.service);
} else {
ctx.registerService('ai', this.service);
}
// Register AI system objects via the manifest service.
ctx.getService<{ register(m: any): void }>('manifest').register({
id: 'com.objectstack.service-ai',
name: 'AI Service',
version: '1.0.0',
type: 'plugin',
scope: 'system',
namespace: 'ai',
objects: [AiConversationObject, AiMessageObject, AiTraceObject, AiPendingActionObject, AiEvalCaseObject, AiEvalRunObject],
views: [AiTraceView, AiMessageView, AiPendingActionView, AiEvalCaseView, AiEvalRunView],
});
if (this.options.debug) {
ctx.hook('ai:beforeChat', async (messages: unknown) => {
ctx.logger.debug('[AI] Before chat', { messages });
});
}
ctx.logger.info('[AI] Service initialized');
}
async start(ctx: PluginContext): Promise<void> {
if (!this.service) return;
// ── Auto-register built-in tools & agents when services are available ──
let metadataService: IMetadataService | undefined;
// Helper: race a promise against a timeout, resolving null on timeout
const withTimeout = <T>(promise: Promise<T>, ms = 2000): Promise<T | null> =>
Promise.race([promise, new Promise<null>(resolve => setTimeout(() => resolve(null), ms))]);
try {
metadataService = ctx.getService<IMetadataService>('metadata');
console.log('[AI Plugin] Retrieved metadata service:', !!metadataService, 'has getRegisteredTypes:', typeof (metadataService as any)?.getRegisteredTypes);
} catch (e: any) {
console.log('[AI] Metadata service not available:', e.message);
ctx.logger.debug('[AI] Metadata service not available');
}
// Probe metadata service reachability with a short timeout.
// If the backing store (e.g. Turso) is unreachable, exists() will hang.
// A single probe determines whether persistence is available for all subsequent calls.
if (metadataService && typeof metadataService.exists === 'function') {
const probeResult = await withTimeout(metadataService.exists('tool', '__probe__'), 3000);
if (probeResult === null) {
ctx.logger.warn('[AI] Metadata service unreachable (timed out) — AI tools/agents will work but Studio visibility unavailable');
metadataService = undefined; // disable persistence for this boot
}
}
// Resolve protocol shim once — used by data, metadata, and query_data
// tools so they can see ObjectQL SchemaRegistry items (sys_user, etc.)
// in addition to MetadataManager registry items.
let protocolService: { getMetaItems(req: { type: string; packageId?: string; organizationId?: string }): Promise<unknown[]> } | undefined;
try {
const p = ctx.getService<any>('protocol');
if (p && typeof p.getMetaItems === 'function') protocolService = p;
} catch {
protocolService = undefined;
}
// Data tools require only the data engine. When metadata service is
// wired we also pass it (+ protocol) so the tools can validate
// field references at runtime and reject hallucinated field names
// with a structured error instead of silently returning empty data.
try {
const dataEngine = ctx.getService<IDataEngine>('data');
if (dataEngine) {
registerDataTools(this.service.toolRegistry, {
dataEngine,
metadataService,
protocol: protocolService,
});
ctx.logger.info('[AI] Built-in data tools registered');
// Register query_data tool when metadata service is also available —
// it composes AI + Metadata + Data into a single NL-to-records call.
if (metadataService) {
registerQueryDataTool(this.service.toolRegistry, {
ai: this.service,
metadata: metadataService,
dataEngine,
protocol: protocolService,
});
ctx.logger.info('[AI] query_data tool registered');
// Register actions-as-tools: enumerate every object's actions[]
// and surface the script-type ones as `action_<name>` tools.
// This is what gives agents the ability to *do things* (mark
// task complete, clone record, ...) — the write-side counterpart
// to query_data.
try {
// Resolve automation service (optional — flow actions get
// skipped gracefully if unavailable).
let automation: IAutomationService | undefined;
try {
automation = ctx.getService<IAutomationService>('automation');
} catch {
automation = undefined;
}
const apiBaseUrl =
this.options.apiActionBaseUrl ?? process.env.OS_AI_ACTION_API_BASE_URL;
const apiHeaders = this.options.apiActionHeaders;
const { registered, skipped, warnings } = await registerActionsAsTools(
this.service.toolRegistry,
{
metadata: metadataService,
dataEngine,
automation,
apiBaseUrl,
apiHeaders,
enableActionApproval: this.options.enableActionApproval ?? false,
aiService: this.service,
},
);
if (registered.length > 0) {
ctx.logger.info(
`[AI] ${registered.length} action tool(s) registered: ${registered.join(', ')}`,
);
}
if (skipped.length > 0) {
ctx.logger.debug(
`[AI] Skipped ${skipped.length} action(s) for AI exposure`,
{ skipped },
);
}
for (const w of warnings) {
ctx.logger.warn(`[AI] action '${w.action}': ${w.warning}`);
}
} catch (err) {
ctx.logger.warn(
'[AI] Failed to register action tools',
err instanceof Error ? { error: err.message } : { error: String(err) },
);
}
}
// Register data tools as metadata (for Studio visibility)
if (metadataService) {
const { DATA_TOOL_DEFINITIONS } = await import('./tools/data-tools.js');
for (const toolDef of DATA_TOOL_DEFINITIONS) {
const toolExists =
typeof metadataService.exists === 'function'
? await withTimeout(metadataService.exists('tool', toolDef.name))
: false;
if (toolExists === null) {
ctx.logger.warn('[AI] Metadata service timed out checking tool existence (non-fatal), skipping persistence');
break;
}
if (!toolExists) {
try {
// `ToolSchema` requires a `label`; the bare `AIToolDefinition`
// used for LLM function-calling may omit it. Fall back to a
// name-derived label so persisted tool metadata always validates.
const label = toolDef.label ?? toToolLabel(toolDef.name);
await withTimeout(metadataService.register('tool', toolDef.name, { ...toolDef, label }));
} catch (err) {
ctx.logger.warn('[AI] Failed to persist tool metadata (non-fatal)',
err instanceof Error ? { tool: toolDef.name, error: err.message } : { tool: toolDef.name });
}
}
}
ctx.logger.info(`[AI] ${DATA_TOOL_DEFINITIONS.length} data tools registered as metadata`);
}
// Register the built-in agent + skills (requires metadata service).
//
// UPSERT, not exists-gate (ADR-0040): built-in records are
// platform-owned — when the shipped definition changes (new skills,
// new instructions), existing environments must pick it up on next
// boot. The old exists-gate froze the FIRST shipped version forever
// once sys_metadata became durable, which silently stranded every
// persona/skill improvement on existing envs. Tenants who want a
// different assistant define a CUSTOM agent and bind it via
// app.defaultAgent — editing built-ins in place is not a supported
// path, so an unconditional content-refresh clobbers nothing legit.
if (metadataService) {
const upsertBuiltin = async (type: string, name: string, def: unknown): Promise<void> => {
try {
const stored = await withTimeout(metadataService.get(type, name));
if (stored !== null && stored !== undefined && JSON.stringify(stored) === JSON.stringify(def)) {
ctx.logger.debug(`[AI] built-in ${type} ${name} up to date`);
return;
}
await withTimeout(metadataService.register(type, name, def));
ctx.logger.info(
stored ? `[AI] built-in ${type} ${name} refreshed (shipped definition changed)` : `[AI] built-in ${type} ${name} registered`,
);
} catch (err) {
ctx.logger.warn(`[AI] Failed to register built-in ${type} ${name}`, err instanceof Error ? { error: err.message } : { error: String(err) });
}
};
await upsertBuiltin('agent', DATA_CHAT_AGENT.name, DATA_CHAT_AGENT);
await upsertBuiltin('skill', DATA_EXPLORER_SKILL.name, DATA_EXPLORER_SKILL);
await upsertBuiltin('skill', ACTIONS_EXECUTOR_SKILL.name, ACTIONS_EXECUTOR_SKILL);
}
}
} catch {
ctx.logger.debug('[AI] Data engine not available, skipping data tools');
}
// NOTE: AI-driven metadata authoring (the metadata_assistant agent, the
// metadata/blueprint/package authoring tools, and the metadata_authoring /
// solution_design skills) is a commercial feature and now ships in the
// cloud-only @objectstack/service-ai-studio package. It attaches via the
// `ai:ready` hook below — the same extension point any third-party tool
// plugin uses — so the open-source runtime keeps the generic AI chat/data
// capabilities while authoring "intelligence" is layered on in the cloud.
// Trigger hook to notify AI service is ready — other plugins can register tools
await ctx.trigger('ai:ready', this.service);
// ── Bridge stack-defined agents from the ObjectQL registry into the
// MetadataService so AgentRuntime.listAgents() / loadAgent() can see
// them. Agents declared via defineStack({ agents: [...] }) are stored
// in the ObjectQL registry by the AppPlugin, but the MetadataManager
// keeps an independent in-memory store. Without this bridge,
// /api/v1/ai/agents would only return agents the AI plugin registered
// itself (data_chat, metadata_assistant).
if (metadataService) {
try {
const objectql = ctx.getService<any>('objectql');
const registry = objectql?.registry;
if (registry && typeof registry.listItems === 'function') {
const stackAgents = registry.listItems('agent') as Array<any>;
let bridged = 0;
for (const entry of stackAgents) {
const agent = entry?.content ?? entry;
const agentName = agent?.name;
if (!agentName || typeof agentName !== 'string') continue;
const exists =
typeof metadataService.exists === 'function'
? await withTimeout(metadataService.exists('agent', agentName))
: false;
if (exists === true) continue;
try {
await withTimeout(metadataService.register('agent', agentName, agent));
bridged++;
} catch (err) {
ctx.logger.warn(
'[AI] Failed to bridge stack agent into metadata service (non-fatal)',
err instanceof Error ? { agent: agentName, error: err.message } : { agent: agentName },
);
}
}
if (bridged > 0) {
ctx.logger.info(`[AI] Bridged ${bridged} stack-defined agent(s) from ObjectQL registry`);
console.log(`[AI] Bridged ${bridged} stack-defined agent(s) from ObjectQL registry`);
}
}
} catch (err) {
ctx.logger.debug('[AI] ObjectQL registry not available, skipping agent bridge', err instanceof Error ? err : undefined);
}
}
// Build and expose route definitions
const routes = buildAIRoutes(this.service, this.service.conversationService, ctx.logger);
// Build tool routes
const toolRoutes = buildToolRoutes(this.service, ctx.logger);
routes.push(...toolRoutes);
ctx.logger.info(`[AI] Tool routes registered (${toolRoutes.length} routes)`);
// Build HITL pending-action routes
const pendingRoutes = buildPendingActionRoutes(this.service, ctx.logger);
routes.push(...pendingRoutes);
ctx.logger.info(`[AI] Pending-action routes registered (${pendingRoutes.length} routes)`);
// Build agent routes if metadata service is available
if (metadataService) {
const skillRegistry = new SkillRegistry(metadataService);
const agentRuntime = new AgentRuntime(metadataService, skillRegistry);
const agentRoutes = buildAgentRoutes(this.service, agentRuntime, ctx.logger);
routes.push(...agentRoutes);
ctx.logger.info(`[AI] Agent routes registered (${agentRoutes.length} routes)`);
const assistantRoutes = buildAssistantRoutes(this.service, agentRuntime, skillRegistry, ctx.logger);
routes.push(...assistantRoutes);
ctx.logger.info(`[AI] Assistant (ambient) routes registered (${assistantRoutes.length} routes)`);
// ── Eval routes — gated on a wired IDataEngine since the runner
// persists run records. When data is not available we simply
// don't expose the route (the auto-CRUD endpoints stay disabled
// too because the objects can't be migrated).
const evalDataEngine = ctx.getService<IDataEngine>('data');
if (evalDataEngine && typeof evalDataEngine.insert === 'function') {
const evalRunner = new EvalRunner(
metadataService,
evalDataEngine,
this.service,
agentRuntime,
);
const evalRoutes = buildEvalRoutes(evalRunner, ctx.logger);
routes.push(...evalRoutes);
ctx.logger.info(`[AI] Eval routes registered (${evalRoutes.length} routes)`);
} else {
ctx.logger.debug('[AI] IDataEngine not available, skipping eval routes');
}
} else {
ctx.logger.debug('[AI] Metadata service not available, skipping agent and assistant routes');
}
// Cache routes on the kernel so HttpDispatcher can find them (always — the
// per-env dispatch path reads `__aiRoutes` to match routes for this kernel).
const kernel = ctx.getKernel();
if (kernel) {
(kernel as any).__aiRoutes = routes;
}
// Trigger hook so HTTP server plugins can MOUNT these routes on the shared
// server. Skipped when `registerRoutes === false` (a host/routing-shell
// AIService in multi-tenant mode): mounting concrete routes there would
// shadow the dispatcher's `/ai/*` wildcard and serve every tenant's chat
// from the host instead of its own per-environment kernel.
if (this.options.registerRoutes !== false) {
await ctx.trigger('ai:routes', routes);
} else {
ctx.logger.info('[AI] registerRoutes=false — not mounting AI routes on this kernel (multi-tenant host)');
}
ctx.logger.info(
`[AI] Service started — adapter="${this.service.adapterName}", ` +
`tools=${this.service.toolRegistry.size}, ` +
`routes=${routes.length}`,
);
// ── Bind to the `ai` settings namespace ───────────────────────
// Apply persisted settings (provider/keys/model) once, then
// subscribe to live changes so admin edits in the Setup app
// swap the adapter without restart. Mirrors the storage pattern.
if (this.options.bindToSettings !== false) {
ctx.hook('kernel:ready', async () => {
await this.bindSettings(ctx);
});
}
}
/**
* Resolve the `settings` service, apply any persisted `ai` values,
* subscribe to changes, and register the live `ai/test` action
* (overrides the manifest's fallback stub).
*/
private async bindSettings(ctx: PluginContext): Promise<void> {
if (!this.service) return;
let settings: any;
try {
settings = ctx.getService<any>('settings');
} catch {
return; // settings service not mounted — env-only mode stays in effect
}
if (!settings || typeof settings.getNamespace !== 'function') return;
const applySettings = async (): Promise<void> => {
if (!this.service) return;
try {
const payload = await settings.getNamespace('ai');
const values: Record<string, unknown> = {};
const sources: Record<string, string | undefined> = {};
for (const [k, v] of Object.entries(payload.values as Record<string, any>)) {
values[k] = v?.value;
sources[k] = v?.source;
}
// ── Conversation auto-titling ─────────────────────────────
// Flip on whenever any non-memory provider is wired. Pure
// form-driven — no env var fallback because it costs tokens
// and operators should opt in explicitly via the toggle.
const providerForTitles = String(values.provider ?? 'memory');
const titleEnabled =
providerForTitles !== 'memory' &&
values.title_generation_enabled !== false;
const titleMaxLen = typeof values.title_max_length === 'number'
? values.title_max_length
: 16;
this.service.setTitleGenerationConfig({
enabled: titleEnabled,
maxLength: titleMaxLen,
});
const provider = providerForTitles;
// The manifest default is `memory`; default values should not mask
// boot-time env auto-detection. A stored or env-locked `memory` value
// is explicit, though, and should switch the service back to memory.
if (provider === 'memory' && (sources.provider ?? 'default') === 'default') return;
const built = await this.buildAdapterFromValues(ctx, values);
if (!built) {
ctx.logger.warn(
`[AI] Settings provider=${provider} could not be applied (missing credentials or package). ` +
`Adapter unchanged (current="${this.service.adapterName}").`,
);
return;
}
this.service.setAdapter(built.adapter);
ctx.logger.info(`[AI] Adapter rebuilt from settings: ${built.description}`);
} catch (err: any) {
ctx.logger.warn('[AI] Failed to apply ai settings: ' + (err?.message ?? err));
}
};
await applySettings();
if (typeof settings.subscribe === 'function') {
settings.subscribe('ai', () => { void applySettings(); });
ctx.logger.info('[AI] Bound to settings:changed for namespace=ai');
}
// ── Embedder binding ────────────────────────────────────────
// Build an IEmbedder from `embedder_*` settings and register it
// as the kernel-level `EMBEDDER_SERVICE`. Knowledge adapters
// (`@objectstack/knowledge-turso`, …) resolve this service when
// their `embedding` constructor option is omitted, so operators
// only need to configure the embedder once in Setup.
let currentEmbedderId: string | null = null;
const applyEmbedder = async (): Promise<void> => {
try {