@sqlrooms/ai-settings 0.28.0-rc.0 → 0.28.0
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 +104 -1
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1 +1,104 @@
|
|
|
1
|
-
AI settings
|
|
1
|
+
AI provider/model settings state and UI components for SQLRooms.
|
|
2
|
+
|
|
3
|
+
This package gives you:
|
|
4
|
+
|
|
5
|
+
- `createAiSettingsSlice()` to manage providers, models, custom models, and model parameters
|
|
6
|
+
- settings UI components (`AiSettingsPanel`, `AiProvidersSettings`, `AiModelsSettings`, etc.)
|
|
7
|
+
- settings actions/selectors accessible from your app's `useRoomStore`
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @sqlrooms/ai-settings @sqlrooms/ai-core @sqlrooms/room-store @sqlrooms/ui
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Basic store setup
|
|
16
|
+
|
|
17
|
+
```tsx
|
|
18
|
+
import {AiSliceState, createAiSlice} from '@sqlrooms/ai-core';
|
|
19
|
+
import {
|
|
20
|
+
AiSettingsSliceState,
|
|
21
|
+
createAiSettingsSlice,
|
|
22
|
+
} from '@sqlrooms/ai-settings';
|
|
23
|
+
import {
|
|
24
|
+
BaseRoomStoreState,
|
|
25
|
+
createBaseRoomSlice,
|
|
26
|
+
createRoomStore,
|
|
27
|
+
} from '@sqlrooms/room-store';
|
|
28
|
+
|
|
29
|
+
type State = BaseRoomStoreState & AiSliceState & AiSettingsSliceState;
|
|
30
|
+
|
|
31
|
+
export const {roomStore, useRoomStore} = createRoomStore<State>(
|
|
32
|
+
(set, get, store) => ({
|
|
33
|
+
...createBaseRoomSlice()(set, get, store),
|
|
34
|
+
...createAiSettingsSlice({
|
|
35
|
+
config: {
|
|
36
|
+
providers: {
|
|
37
|
+
openai: {
|
|
38
|
+
baseUrl: 'https://api.openai.com/v1',
|
|
39
|
+
apiKey: '',
|
|
40
|
+
models: [{modelName: 'gpt-4.1'}],
|
|
41
|
+
},
|
|
42
|
+
},
|
|
43
|
+
customModels: [],
|
|
44
|
+
modelParameters: {
|
|
45
|
+
maxSteps: 30,
|
|
46
|
+
additionalInstruction: '',
|
|
47
|
+
},
|
|
48
|
+
},
|
|
49
|
+
})(set, get, store),
|
|
50
|
+
...createAiSlice({
|
|
51
|
+
getInstructions: () => 'You are a data analytics assistant.',
|
|
52
|
+
})(set, get, store),
|
|
53
|
+
}),
|
|
54
|
+
);
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Render the settings UI
|
|
58
|
+
|
|
59
|
+
```tsx
|
|
60
|
+
import {AiSettingsPanel} from '@sqlrooms/ai-settings';
|
|
61
|
+
import {Button, useDisclosure} from '@sqlrooms/ui';
|
|
62
|
+
|
|
63
|
+
export function SettingsView() {
|
|
64
|
+
const disclosure = useDisclosure();
|
|
65
|
+
|
|
66
|
+
return (
|
|
67
|
+
<>
|
|
68
|
+
<Button onClick={disclosure.onOpen}>AI Settings</Button>
|
|
69
|
+
<AiSettingsPanel disclosure={disclosure}>
|
|
70
|
+
<AiSettingsPanel.ProvidersSettings />
|
|
71
|
+
<AiSettingsPanel.ModelsSettings />
|
|
72
|
+
<AiSettingsPanel.ModelParametersSettings />
|
|
73
|
+
</AiSettingsPanel>
|
|
74
|
+
</>
|
|
75
|
+
);
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Update settings programmatically
|
|
80
|
+
|
|
81
|
+
```tsx
|
|
82
|
+
import {useRoomStore} from './store';
|
|
83
|
+
import {Button} from '@sqlrooms/ui';
|
|
84
|
+
|
|
85
|
+
function MaxStepsControl() {
|
|
86
|
+
const maxSteps = useRoomStore(
|
|
87
|
+
(state) => state.aiSettings.config.modelParameters.maxSteps,
|
|
88
|
+
);
|
|
89
|
+
const setMaxSteps = useRoomStore(
|
|
90
|
+
(state) => state.aiSettings.setMaxSteps,
|
|
91
|
+
);
|
|
92
|
+
|
|
93
|
+
return (
|
|
94
|
+
<Button onClick={() => setMaxSteps(maxSteps + 5)}>
|
|
95
|
+
Increase max steps ({maxSteps})
|
|
96
|
+
</Button>
|
|
97
|
+
);
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## Notes
|
|
102
|
+
|
|
103
|
+
- `AiModelsSettings` integrates with AI session state from `@sqlrooms/ai-core`.
|
|
104
|
+
- `AiSettingsSliceConfig` is re-exported from `@sqlrooms/ai-config` for persistence and validation.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sqlrooms/ai-settings",
|
|
3
|
-
"version": "0.28.0
|
|
3
|
+
"version": "0.28.0",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"module": "dist/index.js",
|
|
@@ -19,11 +19,11 @@
|
|
|
19
19
|
"access": "public"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@sqlrooms/ai-config": "0.28.0
|
|
23
|
-
"@sqlrooms/ai-core": "0.28.0
|
|
24
|
-
"@sqlrooms/recharts": "0.28.0
|
|
25
|
-
"@sqlrooms/room-store": "0.28.0
|
|
26
|
-
"@sqlrooms/ui": "0.28.0
|
|
22
|
+
"@sqlrooms/ai-config": "0.28.0",
|
|
23
|
+
"@sqlrooms/ai-core": "0.28.0",
|
|
24
|
+
"@sqlrooms/recharts": "0.28.0",
|
|
25
|
+
"@sqlrooms/room-store": "0.28.0",
|
|
26
|
+
"@sqlrooms/ui": "0.28.0",
|
|
27
27
|
"immer": "^11.0.1",
|
|
28
28
|
"lucide-react": "^0.556.0",
|
|
29
29
|
"recharts": "^2.12.7"
|
|
@@ -39,5 +39,5 @@
|
|
|
39
39
|
"typecheck": "tsc --noEmit",
|
|
40
40
|
"typedoc": "typedoc"
|
|
41
41
|
},
|
|
42
|
-
"gitHead": "
|
|
42
|
+
"gitHead": "dcac54f8adf77240e293c93d224a0ce9fd8142a9"
|
|
43
43
|
}
|