ai-compare-candidates 0.0.1

package/example/src/layouts/app.vue

@@ -0,0 +1,147 @@
+<template>
+	<q-layout view="lHh Lpr lFf">
+		<q-header elevated>
+			<q-toolbar>
+				<q-toolbar-title>
+					AI Compare Candidates Example
+				</q-toolbar-title>
+			</q-toolbar>
+		</q-header>
+		<q-page-container>
+			<q-page>
+				<q-virtual-scroll :items="candidates">
+					<template #default="{item,index}:{item:Candidate,index:number}">
+						<q-item>
+							<q-item-section side>
+								<q-item-label>{{index+1}}.</q-item-label>
+							</q-item-section>
+							<q-item-section>
+								<q-input label="Name" v-model="item.name"/>
+							</q-item-section>
+							<q-item-section side>
+								<q-btn no-caps icon="fas fa-trash-can" label="Remove Candidate" @click="removeCandidate(index)"/>
+							</q-item-section>
+						</q-item>
+					</template>
+				</q-virtual-scroll>
+				<q-list>
+					<q-item>
+						<q-item-section>
+							<q-input autogrow label="Artificial Intelligence Problem Description Prompt" v-model="problemDescription"/>
+						</q-item-section>
+					</q-item>
+					<q-item>
+						<q-item-section>
+							<q-input label="Candidates for Initial Selection" type="number" v-model.number="candidatesForInitialSelection"/>
+						</q-item-section>
+					</q-item>
+					<q-item>
+						<q-item-section>
+							<q-input label="Candidates for Final Selection" type="number" v-model.number="candidatesForFinalSelection"/>
+						</q-item-section>
+					</q-item>
+					<q-item>
+						<q-item-section>
+							<q-btn no-caps icon="fas fa-plus" label="Add Candidate" @click="addCandidate"/>
+						</q-item-section>
+						<q-item-section>
+							<q-btn no-caps icon="fas fa-brain" label="Artificial Intelligence" @click="artificialIntelligence"/>
+						</q-item-section>
+					</q-item>
+					<q-item>
+						<q-item-section>
+							<q-item-label>Rationale:</q-item-label>
+							<q-item-label>{{outcome.rationale}}</q-item-label>
+						</q-item-section>
+					</q-item>
+				</q-list>
+				<q-virtual-scroll :items="outcome.selectedCandidates">
+					<template #before>
+						<q-item>
+							<q-item-section>
+								<q-item-label>Selected Candidates:</q-item-label>
+							</q-item-section>
+						</q-item>
+					</template>
+					<template #default="{item,index}:{item:Candidate,index:number}">
+						<q-item>
+							<q-item-section side>
+								<q-item-label>{{index+1}}.</q-item-label>
+							</q-item-section>
+							<q-item-section>
+								<q-item-label>{{item.name}}</q-item-label>
+							</q-item-section>
+						</q-item>
+					</template>
+				</q-virtual-scroll>
+			</q-page>
+		</q-page-container>
+	</q-layout>
+</template>
+
+<script setup lang="ts">
+import{
+	nextTick,
+	ref,
+	watch
+}from 'vue';
+import{
+	Dialog,
+	Loading
+}from 'quasar';
+import jsan from 'jsan';
+import lodash from 'lodash';
+import useStore from '../stores/store';
+import type AICompareCandidates from 'ai-compare-candidates';
+
+interface Candidate{
+	name:string;
+}
+
+const store=useStore();
+
+const candidates=ref<Candidate[]>([{name:'Testing 1'},{name:'Testing 2'}]);
+const problemDescription=ref('Pick the best name');
+const candidatesForInitialSelection=ref(2);
+const candidatesForFinalSelection=ref(1);
+const outcome=ref<AICompareCandidates.CompareCandidatesReturn<Candidate>>({
+	selectedCandidates:[],
+	rationale:''
+});
+
+watch(candidatesForInitialSelection,value=>nextTick(()=>candidatesForInitialSelection.value=lodash.clamp(value,Math.max(candidatesForFinalSelection.value,1),candidates.value.length)));
+watch(candidatesForFinalSelection,value=>nextTick(()=>candidatesForFinalSelection.value=lodash.clamp(value,1,Math.min(candidatesForInitialSelection.value,candidates.value.length))));
+
+function removeCandidate(index:number){
+	if(candidates.value.length<=2){
+		Dialog.create({message:'There must be at least 2 candidates to compare'});
+		return;
+	}
+	candidates.value.splice(index,1);
+}
+
+function addCandidate(){
+	candidates.value.push({name:''});
+}
+
+function errorMessage(error:any){
+	return typeof error?.response?.data==='string'?error.response.data:error?.response?.data?jsan.stringify(error.response.data):typeof error?.message==='string'?error.message:error?.message?jsan.stringify(error.message):typeof error==='string'?error:jsan.stringify(error);
+}
+
+async function artificialIntelligence(){
+	try{
+		Loading.show();
+		outcome.value=(await store.aiCompareCandidates.compareCandidates({
+			candidates:candidates.value,
+			problemDescription:problemDescription.value,
+			candidatesForInitialSelection:candidatesForInitialSelection.value,
+			candidatesForFinalSelection:candidatesForFinalSelection.value
+		})) as AICompareCandidates.CompareCandidatesReturn<Candidate>;
+	}catch(error){
+		console.log(error);
+		Dialog.create({message:errorMessage(error)});
+	}finally{
+		Loading.hide();
+	}
+}
+</script>

package/example/src/router/index.ts

@@ -0,0 +1,37 @@
+import {defineRouter} from '#q-app/wrappers';
+import{
+	createMemoryHistory,
+	createRouter,
+	createWebHashHistory,
+	createWebHistory,
+}from 'vue-router';
+import routes from './routes';
+
+/*
+ * If not building with SSR mode, you can
+ * directly export the Router instantiation;
+ *
+ * The function below can be async too; either use
+ * async/await or return a Promise which resolves
+ * with the Router instance.
+ */
+
+export default defineRouter(function(/* { store, ssrContext } */){
+	const createHistory=process.env.SERVER||process.env.VUE_ROUTER_MODE==='abstract'?
+		createMemoryHistory:
+		(process.env.VUE_ROUTER_MODE==='history'?createWebHistory:createWebHashHistory);
+
+	const Router=createRouter({
+		scrollBehavior:()=>({
+			left:0,
+			top:0
+		}),
+		routes,
+		// Leave this as is and make changes in quasar.conf.js instead!
+		// quasar.conf.js -> build -> vueRouterMode
+		// quasar.conf.js -> build -> publicPath
+		history:createHistory(process.env.VUE_ROUTER_BASE),
+	});
+
+	return Router;
+});

package/example/src/router/routes.ts

@@ -0,0 +1,8 @@
+import type {RouteRecordRaw} from 'vue-router';
+
+const routes:RouteRecordRaw[]=[{
+	path:'/:catchAll(.*)*',
+	component:()=>import('layouts/app.vue')
+}];
+
+export default routes;

package/example/src/stores/index.ts

@@ -0,0 +1,32 @@
+import { defineStore } from '#q-app/wrappers'
+import { createPinia } from 'pinia'
+
+/*
+ * When adding new properties to stores, you should also
+ * extend the `PiniaCustomProperties` interface.
+ * @see https://pinia.vuejs.org/core-concepts/plugins.html#typing-new-store-properties
+ */
+declare module 'pinia' {
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+  export interface PiniaCustomProperties {
+    // add your custom properties here, if any
+  }
+}
+
+/*
+ * If not building with SSR mode, you can
+ * directly export the Store instantiation;
+ *
+ * The function below can be async too; either use
+ * async/await or return a Promise which resolves
+ * with the Store instance.
+ */
+
+export default defineStore((/* { ssrContext } */) => {
+  const pinia = createPinia()
+
+  // You can add Pinia plugins here
+  // pinia.use(SomePiniaPlugin)
+
+  return pinia
+})

package/example/src/stores/store.ts

@@ -0,0 +1,19 @@
+import{
+	defineStore,
+	acceptHMRUpdate
+}from 'pinia';
+import {shallowRef} from 'vue';
+import AICompareCandidates from 'ai-compare-candidates';
+
+export const useStore=defineStore('store',()=>{
+	const aiCompareCandidates=shallowRef(new AICompareCandidates());
+	return{
+		aiCompareCandidates
+	};
+});
+
+export default useStore;
+
+if(import.meta.hot){
+	import.meta.hot.accept(acceptHMRUpdate(useStore, import.meta.hot));
+}

package/example/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./.quasar/tsconfig.json"
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+	"name": "ai-compare-candidates",
+	"version": "0.0.1",
+	"description": "Compare and rank multiple candidate objects using artificial intelligence retrieval augmented generation, providing the rationale",
+	"main": "dist/index.mjs",
+	"scripts": {
+		"build": "tsc --noEmit && tsdown --config tsdown.config.ts"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/customautosys/ai-compare-candidates.git"
+	},
+	"keywords": [
+		"artificial",
+		"intelligence",
+		"candidates",
+		"compare",
+		"retrieval",
+		"augmented",
+		"generation"
+	],
+	"author": "Wilson Foo Yu Kang",
+	"license": "CC-BY-NC-SA-4.0",
+	"bugs": {
+		"url": "https://github.com/customautosys/ai-compare-candidates/issues"
+	},
+	"homepage": "https://github.com/customautosys/ai-compare-candidates#readme",
+	"packageManager": "yarn@4.12.0",
+	"dependencies": {
+		"@huggingface/transformers": "^3.8.1",
+		"@langchain/classic": "^1.0.6",
+		"@langchain/core": "^1.1.5",
+		"jsan": "^3.1.14",
+		"lodash": "^4.17.21"
+	},
+	"devDependencies": {
+		"@types/jsan": "^3",
+		"@types/lodash": "^4",
+		"tsdown": "^0.17.3",
+		"typescript": "^5.9.3"
+	},
+	"workspaces": [
+		"example"
+	],
+	"exports": {
+		"import": {
+			"types": "./dist/index.d.mts",
+			"default": "./dist/index.mjs"
+		},
+		"require": {
+			"types": "./dist/index.d.cts",
+			"default": "./dist/index.cjs"
+		}
+	}
+}