@christianriedl/utils 1.0.138 → 1.0.140

package/dist/iOpenAI.d.ts

@@ -1,6 +1,6 @@
 import { InjectionKey } from 'vue';
 import { ILogger } from './iLogger';
-import { Dictionary } from './types';
+import { Dictionary, IDataItem, ItemType } from './types';
 export declare const getOpenAISymbol: InjectionKey<() => IOpenAIService>;
 export interface IResultAnnotation {
     file_id?: string;
@@ -78,7 +78,7 @@ export interface IFunctionTool extends ITool {
 export interface IComparisonFilter {
     key: string;
     type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte';
-    value: string | number | boolean;
+    value: ItemType;
 }
 export interface ICompoundFilter {
     filters: IComparisonFilter[] | unknown;
@@ -112,17 +112,23 @@ export interface IOpenAIServiceWithTools extends IOpenAIService {
     addFunctionTool(tool: IFunctionTool, toolFunction: ToolFunction): void;
     getToolFunctions(tool: string): Promise<IResponseResult>;
 }
+export interface IVectorFile {
+    id: string;
+    filename: string;
+    attributes: Dictionary<ItemType> | null;
+}
 export interface IVectorStore {
     id: string;
     name: string;
-    files: Dictionary<string>;
+    metadata: Dictionary<string> | null;
+    files: Dictionary<IVectorFile>;
 }
 export interface IVectorSearchContent {
     type: 'text';
     text: string;
 }
 export interface IVectorSearchResult {
-    attributes: Dictionary<string | number | boolean> | null;
+    attributes: Dictionary<ItemType> | null;
     content: IVectorSearchContent[];
     file_id: string;
     filename: string;
@@ -130,14 +136,17 @@ export interface IVectorSearchResult {
 }
 export interface IOpenAIServiceWithVectorStore extends IOpenAIServiceWithTools {
     vectorStore?: Dictionary<IVectorStore>;
+    vsMetadata: IDataItem[];
+    fileAttributes: IDataItem[];
     initializeVectorStore(): Promise<boolean>;
     getVectorStore(vectorStoreId: string): IVectorStore | undefined;
-    addVectorStore(vectorStoreName: string): Promise<boolean>;
-    addFile(fileUrl: string | File, vectorStoreName: string, wait?: boolean): Promise<boolean>;
+    addVectorStore(vectorStoreName: string, metadata?: Dictionary<string>): Promise<boolean>;
+    addFile(fileUrl: string | File, vectorStoreName: string, attributes?: Dictionary<ItemType>, wait?: boolean): Promise<boolean>;
+    setAttributes(vectorStoreName: string, fileId: string | null, attributes: Dictionary<ItemType>): Promise<boolean>;
     deleteFile(fileId: string): Promise<boolean>;
-    deleteVectorStore(vectorStoreId: string): Promise<boolean>;
+    deleteVectorStore(vectorStoreName: string): Promise<boolean>;
     searchVectoreStore(vectorStoreName: string, query: string | string[], rewriteQuery?: boolean, maxNumResults?: number, filters?: ICompoundFilter | IComparisonFilter): Promise<IVectorSearchResult[]>;
-    getFileId(fileUrl: string): string | undefined;
+    getFile(fileUrl: string): IVectorFile | undefined;
 }
 export interface IOpenAIAppConfig {
     officeAITools: string;

package/dist/types.d.ts

@@ -104,12 +104,14 @@ export interface IAppState extends IAppInfo {
     toggleFullScreen(): Promise<boolean>;
 }
 export type ItemType = string | number | boolean;
-export interface IConfigItem {
+export interface IDataItem {
     name: string;
-    description: string;
     values?: string[];
     value: ItemType;
     default: ItemType;
+}
+export interface IConfigItem extends IDataItem {
+    description: string;
     doNotChange: boolean;
     scopes: EScope;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@christianriedl/utils",
-  "version": "1.0.138",
+  "version": "1.0.140",
   "description": "Interfaces, local storage, service worker, configuration, application state",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/components/OpenAIConfig.vue

@@ -2,6 +2,7 @@
     import { inject, ref, reactive } from 'vue';
     import { appConfigSymbol, AppConfig, Dictionary } from '@christianriedl/utils';
     import { getOpenAISymbol, IOpenAIServiceWithVectorStore, IOpenAIAppConfig, IOpenAIOptions, ITool, IMcpTool, IFileSearchTool } from '@christianriedl/utils';
+    import OpenAIMetaData from '@christianriedl/utils/src/components/OpenAIMetaData.vue';
 
     interface IFunction {
 	name: string;
@@ -30,6 +31,9 @@
     const selectedVectorStoreName = ref('');
     const selectedVectorStoreFile = ref('');
     const showFunctions = ref(false);
+    const showMetaData = ref(false);
+    const editVectorStore = ref(false);
+    const metadata = ref<Dictionary<ItemType>>({});
     const toolName = ref('');
     const toolFunctions = reactive<IFunction[]>([]);
     let fileHandle: FileSystemFileHandle | null = null;
@@ -172,8 +176,16 @@
 	}
 	initializeTools();
     }
+    async function editVectorStore() {
+	const vs = openAI.vectorStore![selectedVectorStoreName.value];
+	if (vs) {
+	    editVectorStore.value = true;
+	    metadata.value = vs.metadata ? vs.metadata : openAI.vsMetadata;
+	    showMetaData.value = true;
+	}
+    }
     async function addFile() {
-	if (openAI.getFileId(selectedVectorStoreFile.value)) {
+	if (openAI.getFile(selectedVectorStoreFile.value)) {
 	    alert('File already exists, add a new file path or url !');
 	    return;
 	}
@@ -189,30 +201,42 @@
 	}
     }
     async function deleteFile() {
-	const fileId = openAI.getFileId(selectedVectorStoreFile.value);
-	if (!fileId) {
+	const file = openAI.getFile(selectedVectorStoreFile.value);
+	if (!file) {
 	    alert('File not existing !');
 	    return;
 	}
-	if (!await openAI.deleteFile(fileId)) {
+	if (!await openAI.deleteFile(file.id)) {
 	    alert('File not deleted, error ! ');
 	}
 	else {
 	    vectorStoreSelected();
 	}
     }
-    async function searchFile() {
-	let files: FileSystemFileHandle[] = [];
-	try {
-	    files = await (window as any).showOpenFilePicker();
-	    if (files.length > 0) {
-		fileHandle = files[0];
-		selectedVectorStoreFile.value = fileHandle.name;
-	    }
+    async function editFile() {
+	const file = openAI.getFile(selectedVectorStoreFile.value);
+	if (file) {
+	    editVectorStore.value = false;
+	    metadata.value = file.attributes ? file.attributes : openAI.fileAttributes;
+	    showMetaData.value = true;
 	}
-	catch (e) {
-	    console.error('Error opening file picker:', e);
-	    return;
+    }
+    async function saveMetaData(items?: Dictionary<ItemType>) {
+	showMetaData.value = false;
+	if (items) {
+	    if (editVectorStore.value) {
+		if (await openAI.setAttributes(selectedVectorStoreName.value, null, items as Dictionary<string>)) {
+		    vs.metadata = items;
+		}
+	    }
+	    else {
+		const file = openAI.getFile(selectedVectorStoreFile.value);
+		if (file) {
+		    if (await openAI.setAttributes(selectedVectorStoreName.value, file.id, items)) {
+			file.attributes = items;
+		    }
+		}
+	    }
 	}
     }
 </script>
@@ -222,7 +246,7 @@
 	<h4>OpenAI Settings</h4>
 	<v-row dense align="center">
 	    <v-col cols="3">
-		<v-select v-model="options.model" :items="openAI.modelNames" hide-details density="compact" 
+		<v-select v-model="options.model" :items="openAI.modelNames" hide-details density="compact"
 			  label="Model" @update:modelValue="onOptionChange">
 		</v-select>
 	    </v-col>
@@ -312,27 +336,32 @@
 	</template>
 	<v-row dense align="center">
 	    <v-col cols="2">
-		<v-btn class="bg-office" @click="emits('back')">BACK
+		<v-btn class="bg-office" @click="emits('back')">
+		    BACK
 		    <v-icon icon="$back"></v-icon>
 		</v-btn>
 	    </v-col>
 	    <v-col cols="2">
-		<v-btn :disabled="!optionsChanged && !toolsChanged" class="bg-office" @click="onSave">SAVE
+		<v-btn :disabled="!optionsChanged && !toolsChanged" class="bg-office" @click="onSave">
+		    SAVE
 		    <v-icon icon="$save"></v-icon>
 		</v-btn>
 	    </v-col>
 	    <v-col cols="2">
-		<v-btn :disabled="!useChanged" class="bg-office" @click="onSaveUsage">SAVE TOOL USE
+		<v-btn :disabled="!useChanged" class="bg-office" @click="onSaveUsage">
+		    SAVE TOOL USE
 		    <v-icon icon="$save"></v-icon>
 		</v-btn>
 	    </v-col>
 	    <v-col cols="2">
-		<v-btn class="bg-office" @click="onAddMcp">ADD MCP
+		<v-btn class="bg-office" @click="onAddMcp">
+		    ADD MCP
 		    <v-icon icon="$plus"></v-icon>
 		</v-btn>
 	    </v-col>
 	    <v-col cols="2">
-		<v-btn class="bg-office" @click="onAddSearch">ADD SEARCH
+		<v-btn class="bg-office" @click="onAddSearch">
+		    ADD SEARCH
 		    <v-icon icon="$plus"></v-icon>
 		</v-btn>
 	    </v-col>
@@ -345,11 +374,10 @@
 		<v-col cols="2">
 		    <v-combobox v-model="selectedVectorStoreName" :items="vectorStoreNames" hide-details density="compact" @update:modelValue="vectorStoreSelected()"></v-combobox>
 		</v-col>
-		<v-col cols="1">
-		    <v-btn variant="text" prepend-icon="$delete" @click="deleteVectorStore">VS</v-btn>
-		</v-col>
-		<v-col cols="1">
-		    <v-btn variant="text" prepend-icon="$plus" @click="addVectorStore">VS</v-btn>
+		<v-col cols="2">
+		    <v-btn disabled="!selectedVectorStoreName" variant="text" prepend-icon="$delete" @click="deleteVectorStore">VS</v-btn>
+		    <v-btn disabled="!selectedVectorStoreName" variant="text" prepend-icon="$plus" @click="addVectorStore">VS</v-btn>
+		    <v-btn disabled="!selectedVectorStoreName" variant="text" prepend-icon="$pencil" @click="editVectorStore">VS</v-btn>
 		</v-col>
 		<v-col cols="5">
 		    <v-combobox v-model="selectedVectorStoreFile" :items="vectorStoreFiles" hide-details density="compact"></v-combobox>
@@ -358,13 +386,15 @@
 		    <v-btn variant="text" prepend-icon="$search" @click="searchFile">FILE</v-btn>
 		</v-col>
 		<v-col cols="1">
-		    <v-btn variant="text" prepend-icon="$delete" @click="deleteFile">FILE</v-btn>
-		</v-col>
-		<v-col cols="1">
-		    <v-btn variant="text" prepend-icon="$plus" @click="addFile">FILE</v-btn>
+		    <v-btn disabled="!selectedVectorStoreFile" variant="text" prepend-icon="$delete" @click="deleteFile">FILE</v-btn>
+		    <v-btn disabled="!selectedVectorStoreFile" variant="text" prepend-icon="$plus" @click="addFile">FILE</v-btn>
+		    <v-btn disabled="!selectedVectorStoreFile" variant="text" prepend-icon="$pencil" @click="editFile">VS</v-btn>
 		</v-col>
 	    </v-row>
 	</template>
+	<v-dialog v-model="showMetaData">
+	    <OpenAIMetaData :items="metadata" :vectorstore="editVectorStore" @back="saveMetaData"></OpenAIMetaData>
+	</v-dialog>
 	<v-dialog v-model="showFunctions">
 	    <v-container fluid class="bg-office overflow-y-auto">
 		<h4>{{toolName + " functions"}}</h4>
@@ -374,7 +404,8 @@
 		</v-row>
 		<v-row dense align="center">
 		    <v-col cols="2">
-			<v-btn class="bg-office" @click="showFunctions = false">BACK
+			<v-btn class="bg-office" @click="showFunctions = false">
+			    BACK
 			    <v-icon icon="$back"></v-icon>
 			</v-btn>
 		    </v-col>

package/src/components/OpenAIMetaData.vue

@@ -0,0 +1,55 @@
+<script setup lang="ts">
+    import { inject, computed, ref, StyleValue } from 'vue';
+    import { IDataItem, Dictionary } from '@christianriedl/utils'
+    import SettingsLine from '../components/SettingsLine.vue';
+
+    const props = defineProps<{ items: IDataItem[], vectorstore: boolean }>();
+    const emits = defineEmits<{ (e: 'back', items?: IDataItem[]): void }>();
+    const items: IDataItem[] = [];
+    for (const it of props.items) {
+	items.push(Object.assign({}, it);
+    }
+    const header = props.vectorstore ? "Vector Store Metadata" : "File Attributes";
+    const changedItems = new Set<string>();
+    const changed = ref(false);
+
+    function onChange(item: IDataItem, changed: boolean) {
+	if (changed)
+	    changedItems.add(item.name);
+	else
+	    changedItems.delete(item.name);
+	changed.value = changedItems.size > 0;
+    }
+    function onBack(save: boolean) {
+	if (save) {
+	    emits('back', items);
+	}
+	else {
+	    emits('back');
+	}
+
+</script>
+
+<template>
+    <v-container fluid >
+	<h4>{{header}}</h4>
+	<v-table>
+	    <thead>
+		<tr>
+		    <th style="width:50%">Name</th>
+		    <th style="width:50%">Value</th>
+		</tr>
+	    </thead>
+	    <tbody>
+		<settings-line v-for="item in items" :key="item.name" :item="item" @change="onChange(item, true)" @clear="onChange(item, false)"></settings-line>
+		<tr>
+		    <td style="width:50%">
+			<v-btn @click="onBack(false)">BACK</v-btn>
+			<v-btn v-if="changed" @click="onBack(true)">SAVE</v-btn>
+		    </td>
+		    <td style="width:50%"></td>
+		</tr>
+	    </tbody>
+	</v-table>
+    </v-container>
+</template>

package/src/components/SettingsLine.vue

@@ -1,36 +1,41 @@
 <script setup lang="ts">
     import { reactive } from 'vue';
-    import { IConfigItem, ItemType, EScope } from '@christianriedl/utils';
+    import { IConfigItem, IDataItem, ItemType, EScope } from '@christianriedl/utils';
 
-    const props = defineProps<{item: IConfigItem; scopes: EScope }>();
-    const emits = defineEmits<{ (e: 'change', value: any): void }>();
+    const props = defineProps<{ item: IConfigItem | IDataItem; scopes?: EScope, clearable?: boolean }>();
+    const emits = defineEmits<{ (e: 'change'): void, (e: 'clear'): void }>();
 
     const item = reactive(props.item);
     const isString = typeof item.default === 'string' && !item.values;
     const isEnum = typeof item.default === 'string' && item.values;
     const isNumber = typeof item.default === 'number';
     const isBoolean = typeof item.default === 'boolean';
-    const isDisabled = item.doNotChange;
-    const isVisible = (item.scopes & props.scopes) != 0; 
+    const isDisabled = (item as IConfigItem).doNotChange;
+    const isVisible = !props.scopes || ((item as IConfigItem).scopes & props.scopes) != 0;
     const enumValues: ItemType[] = item.values!;
+    const description = (item as IConfigItem).description || item.name;
 
     function onChange() {
-        emits('change', true);
+	emits('change');
+    }
+    function onClear() {
+	item.value = item.default;
+	emits('clear');
     }
 </script>
 
 <template>
     <tr v-if="isVisible" class="settingsline">
-        <td style="width:50%">{{item.description}}</td>
+        <td style="width:50%">{{description}}</td>
         <td style="width:50%">
-            <v-switch v-if="isBoolean" v-model="item.value" :disabled="isDisabled" density="compact" hide-details marg color="primary" @change="onChange"></v-switch>
-            <v-text-field v-if="isString" v-model="item.value" :disabled="isDisabled" density="compact" hide-details type="string" @change="onChange"></v-text-field>
-            <v-text-field v-if="isNumber" v-model="item.value" :disabled="isDisabled" density="compact" hide-details type="number" @change="onChange"></v-text-field>
-            <v-select v-if="isEnum" name="enum" density="compact" v-model="item.value" :disabled="isDisabled" 
-                :items="enumValues"
-                persistent-hint
-                @update:modelValue="onChange"
-                dense solo hide-details single-line>
+            <v-switch v-if="isBoolean" v-model="item.value" :disabled="isDisabled" density="compact" hide-details color="primary" 
+                            :append-icon="props.clearable ? '$clear' : undefined" @update:modelValue="onChange" @click:append="onClear"></v-switch>
+            <v-text-field v-if="isString" v-model="item.value" :disabled="isDisabled" :clearable="props.clearable" density="compact" 
+                            hide-details type="string" @update:modelValue="onChange" @click:clear="onClear"></v-text-field>
+            <v-text-field v-if="isNumber" v-model="item.value" :disabled="isDisabled" :clearable="props.clearable" density="compact" 
+                            hide-details type="number"  @update:modelValue="onChange" @click:clear="onClear"></v-text-field>
+            <v-select v-if="isEnum" name="enum" density="compact" v-model="item.value" :disabled="isDisabled" :clearable="props.clearable"
+                            :items="enumValues" persistent-hint @update:modelValue="onChange" @click:clear="onClear" dense solo hide-details single-line>
             </v-select>
         </td>
     </tr>