ai-compare-candidates 0.0.1

package/.editorconfig

@@ -0,0 +1,51 @@
+root=true
+
+[*]
+charset=utf-8
+indent_style=tab
+indent_size=4
+end_of_line=lf
+insert_final_newline=false
+trim_trailing_whitespace=false
+space_before_type_parameters_brackets=false
+space_within_type_parameters_brackets=false
+space_before_colon_in_type_annotation=false
+space_after_colon_in_type_annotation=false
+space_around_pipe_or_amper_in_type_usage=false
+space_after_comma=false
+space_before_comma=false
+space_before_semicolon=false
+space_before_semicolon_in_for_statement=false
+space_after_semicolon_in_for_statement=false
+space_before_method_call_parentheses=false
+space_before_empty_method_call_parentheses=false
+space_between_method_call_parameter_list_parentheses=false
+space_between_method_call_empty_parameter_list_parentheses=false
+space_before_method_parentheses=false
+space_before_method_parentheses_anonymous=false
+space_between_method_declaration_empty_parameter_list_parentheses=false
+space_between_method_declaration_parameter_list_parentheses=false
+space_after_keywords_in_control_flow_statements=false
+space_between_parentheses_of_control_flow_statements=false
+space_before_open_square_brackets=false
+space_between_square_brackets=false
+space_before_ternary_quest=false
+space_after_ternary_quest=false
+space_before_ternary_colon=false
+space_after_ternary_colon=false
+space_before_property_colon=false
+space_after_property_colon=false
+space_within_object_literal_braces=false
+space_within_empty_object_literal_braces=false
+space_within_import_braces=false
+space_between_square_brackets=false
+space_between_empty_square_brackets=false
+space_around_binary_operator=false
+space_around_assignment_operator=false
+space_around_dot=false
+space_within_parentheses=false
+space_before_colon_in_case=false
+space_before_arrow=false
+space_after_arrow=false
+space_within_template_argument=false
+types_braces=end_of_line_no_space

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+	"typescript.tsdk": "node_modules/typescript/lib"
+}

package/.yarnrc.yml

@@ -0,0 +1,16 @@
+nodeLinker: node-modules
+
+supportedArchitectures:
+  cpu:
+    - current
+    - x86
+    - x64
+    - arm64
+    - ia32
+  os:
+    - current
+    - darwin
+    - linux
+    - win32
+
+yarnPath: .yarn/releases/yarn-4.12.0.cjs

package/LICENSE

@@ -0,0 +1,6 @@
+© 2025 Wilson Foo Yu Kang. All rights reserved except as expressly set out hereinafter.
+Unrestricted sole licence granted to Custom Automated Systems ® Pte Ltd, revocable with express written notice by Wilson Foo Yu Kang.
+
+Dual licensed under:
+CC-BY-NC-SA-4.0 https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode
+Proprietary sub-licence with Custom Automated Systems Pte Ltd (contact sales@customautosys.com to negotiate licence terms)

package/README.md

@@ -0,0 +1,77 @@
+# ai-compare-candidates
+
+## Compare and rank multiple candidate objects using artificial intelligence retrieval augmented generation, providing the rationale
+
+This package allows you to rank multiple candidate objects in a customised manner by providing a user-supplied function that converts each such object into a candidate document in the form of a string. It then uses a vector database and embedding to perform a similarity search retrieval of an initial number of candidates. This search is then refined into the same or a smaller number of candidates by feeding them into a large language model which will rank the candidates. The candidate documents or part thereof can also be summarised into a defined word limit.
+
+## Cloning of package
+
+After performing a git clone:
+
+0. This assumes that you have a suitable node version installed. If you don't already have yarn installed globally:
+
+```bash
+npm install -g yarn
+```
+
+1. Remove the line ```"packageManager": "yarn@4.12.0"``` and the preceding comma in package.json
+2. Remove the line ```yarnPath: .yarn/releases/yarn-4.12.0.cjs``` from .yarnrc.yml
+3. 
+```bash
+yarn set version 4.12.0
+yarn --immutable
+```
+
+### Running of example
+
+0. If you don't already have @quasar/cli installed globally
+
+```bash
+npm install -g @quasar/cli
+```
+
+1. 
+```bash
+cd example
+yarn workspaces focus
+yarn dev
+```
+
+## Usage
+
+```typescript
+AICompareCandidates.compareCandidates<Candidate>({
+	candidates,
+	problemDescription='',
+	generateSearchAreasInstruction=this.defaultGenerateSearchAreasInstruction.bind(this),
+	convertCandidateToDocument=this.defaultConvertCandidateToDocument.bind(this),
+	candidatesForInitialSelection=2,
+	candidatesForFinalSelection=1,
+	generateRankingInstruction=this.defaultGenerateRankingInstruction.bind(this),
+	extractIdentifiersFromRationale=this.defaultExtractIdentifiersFromRationale.bind(this),
+	extractIdentifierFromCandidateDocument=this.defaultExtractIdentifierFromCandidateDocument.bind(this),
+	candidateIdentifierField=undefined,
+	getSummarisableSubstringIndices
+}:AICompareCandidates.CompareArguments<Candidate>=<AICompareCandidates.CompareArguments<Candidate>>{}):Promise<AICompareCandidates.CompareCandidatesReturn<Candidate>|void>
+```
+candidates: Candidate objects as you define them
+
+problemDescription: The prompt for description of the problem, i.e. how you would like the AI model to select the candidates.
+
+generateSearchAreasInstruction: A function for generating the instruction for determining the relevant subject areas to use to search the vector database.
+
+convertCandidateToDocument: A function to convert a candidate object to a candidate document, i.e. a string, which can be embedded in the vector database.
+
+candidatesForInitialSelection: The number of candidates which should be returned by the initial vector database search.
+
+candidatesForFinalSelection: The number of candidates which should be finally selected by the text generation ranking model.
+
+generateRankingInstruction: A function for generating the instruction for ranking the candidates returned by the initial vector database search.
+
+extractIdentifiersFromRationale: A function for extracting the correct candidate object identifiers from the entire rationale generated by the ranking model.
+
+extractIdentifierFromCandidateDocument: A function for extracting the correct candidate object identifier from a candidate document string.
+
+candidateIdentifierField: The field in the candidate object which is used to identify it, e.g. name or ID number.
+
+getSummarisableSubstringIndices: A function for identifying the substring indices of a candidate document string which can be summarised by the summarisation model.

package/dist/index.cjs

@@ -0,0 +1,24 @@
+Object.defineProperty(exports,`__esModule`,{value:!0});var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));let c=require(`@huggingface/transformers`),l=require(`@langchain/classic/vectorstores/memory`),u=require(`@langchain/core/embeddings`),d=require(`lodash`);d=s(d);let f=require(`jsan`);f=s(f);var p=class extends u.Embeddings{env=c.env;DEBUG=!0;generator=null;generatorModelName=`Xenova/LaMini-GPT-774M`;generatorPromise=null;generatorProgressInfo={};generatorProgressCallback=null;summariser=null;summariserModelName=`Xenova/distilbart-cnn-12-6`;summariserPromise=null;summariserProgressInfo={};summariserProgressCallback=null;embedder=null;embedderModelName=`Xenova/all-MiniLM-L12-v2`;embedderPromise=null;embedderProgressInfo={};embedderProgressCallback=null;tokeniser=null;tokeniserModelName=this.generatorModelName;tokeniserPromise=null;tokeniserProgressInfo={};tokeniserProgressCallback=null;generateSearchAreasMaxNewTokens=64;generateSearchAreasTemperature=.35;generateSearchAreasRepetitionPenalty=1.5;rankingMaxNewTokens=64;rankingTemperature=.35;rankingRepetitionPenalty=1.5;targetSummarisedStringTokenCount=420;static{c.env.localModelPath=``,c.env.allowRemoteModels=!0,c.env.allowLocalModels=!1}constructor(){super({})}async loadGenerator({progressCallback:e,modelName:t=``}={}){if(typeof t==`string`&&t&&(this.generatorModelName=t),!this.generatorModelName)throw Error(`Invalid generator model name`);return e&&(this.generatorProgressCallback=e),this.generatorPromise=(0,c.pipeline)(`text-generation`,this.generatorModelName,{device:`webgpu`,progress_callback:e=>(this.DEBUG&&console.log(f.default.stringify(e)),Object.assign(this.generatorProgressInfo,e),this.generatorProgressCallback?.(e))}),this.generator=await this.generatorPromise,this.generator}async checkGeneratorLoaded(){if(this.generatorPromise||this.loadGenerator(),this.generator||await this.generatorPromise,!this.generator)throw Error(`Unable to load generator`)}async loadSummariser({progressCallback:e,modelName:t=``}={}){if(typeof t==`string`&&t&&(this.summariserModelName=t),!this.summariserModelName)throw Error(`Invalid summariser model name`);return e&&(this.summariserProgressCallback=e),this.summariserPromise=(0,c.pipeline)(`summarization`,this.summariserModelName,{device:`webgpu`,progress_callback:e=>(this.DEBUG&&console.log(f.default.stringify(e)),Object.assign(this.summariserProgressInfo,e),this.summariserProgressCallback?.(e))}),this.summariser=await this.summariserPromise,this.summariser}async checkSummariserLoaded(){if(this.summariserPromise||this.loadSummariser(),this.summariser||await this.summariserPromise,!this.summariser)throw Error(`Unable to load summariser`)}async loadEmbedder({progressCallback:e,modelName:t=``}={}){if(typeof t==`string`&&t&&(this.embedderModelName=t),!this.embedderModelName)throw Error(`Invalid embedder model name`);return e&&(this.embedderProgressCallback=e),this.embedderPromise=(0,c.pipeline)(`feature-extraction`,this.embedderModelName,{device:`webgpu`,progress_callback:e=>(this.DEBUG&&console.log(f.default.stringify(e)),Object.assign(this.embedderProgressInfo,e),this.embedderProgressCallback?.(e))}),this.embedder=await this.embedderPromise,this.embedder}async checkEmbedderLoaded(){if(this.embedderPromise||this.loadEmbedder(),this.embedder||await this.embedderPromise,!this.embedder)throw Error(`Unable to load embedder`)}async loadTokeniser({progressCallback:e,modelName:t=``}={}){if(typeof t==`string`&&t&&(this.tokeniserModelName=t),!this.tokeniserModelName)throw Error(`Invalid tokeniser model name`);return e&&(this.tokeniserProgressCallback=e),this.tokeniserPromise=c.AutoTokenizer.from_pretrained(this.tokeniserModelName,{progress_callback:e=>(this.DEBUG&&console.log(f.default.stringify(e)),Object.assign(this.tokeniserProgressInfo,e),this.tokeniserProgressCallback?.(e))}),this.tokeniser=await this.tokeniserPromise,this.tokeniser}async checkTokeniserLoaded(){if(this.tokeniserPromise||this.loadTokeniser(),this.tokeniser||await this.tokeniserPromise,!this.tokeniser)throw Error(`Unable to load tokeniser`)}async embedQuery(e){return await this.checkEmbedderLoaded(),Array.from((await this.embedder?.(e,{pooling:`mean`,normalize:!0}))?.data)}async embedDocuments(e){return Promise.all(e.map(e=>this.embedQuery(e)))}generatePromptTemplate(e){return`Below is an instruction that describes a task. Write a response that appropriately completes the request.
+
+### Instruction:
+`+e+`
+
+### Response:`}defaultGenerateSearchAreasInstruction(e){return`List the relevant subject areas for the following issues. Limit your response to 100 words.
+Issues: "`+e+`"`}defaultConvertCandidateToDocument({candidate:e,index:t}={}){let n=`Start of Candidate #`+t;for(let t in e)n+=`
+`+d.default.startCase(t)+`: `+(typeof e[t]==`object`?f.default.stringify(e[t]):String(e[t]));return n+=`
+End of Candidate #`+t,n}defaultGenerateRankingInstruction({problemDescription:e,summaries:t,candidatesForFinalSelection:n,candidateIdentifierField:r}={}){return`Strictly follow these rules:
+1. Rank ONLY the top `+n+` candidates with one 15-word sentence explaining why
+2. Rank the candidates based on "`+e.replace(/(\r|\n)/g,` `)+`"
+3. If unclear, say "Insufficient information to determine"
+
+Candidates:
+
+`+t.join(`
+
+`)+`
+
+Format exactly:
+#1. "Full `+d.default.startCase(r)+`": 15-word explanation
+#2. ...`}regexIndexOf(e,t,n){let r=e.slice(n).search(t);return r<0?r:r+n}defaultExtractIdentifierFromCandidateDocument({candidateDocument:e,candidateIdentifierField:t}={}){this.DEBUG&&console.log(e,t);let n=d.default.startCase(t),r=e.indexOf(n);if(r<0&&(r=e.toLowerCase().indexOf(n.toLowerCase())),this.DEBUG&&console.log(r),r>=0&&(r+=n.length),r<0&&(r=e.toLowerCase().indexOf(t.toLowerCase()),r>=0&&(r+=t.length)),this.DEBUG)console.log(r);else return``;if(r=e.indexOf(`:`,r),this.DEBUG&&console.log(r),r<0&&(r=this.regexIndexOf(e,/\s+/,r)),this.DEBUG&&console.log(r),r<0)return``;let i=e.indexOf(`
+`,r);return i<0&&(i=e.length),this.DEBUG&&console.log(i),e.substring(r,i).trim()}defaultExtractIdentifiersFromRationale(e){let t=/^\s*#\s*\d+\s*\.?\s*"([^"]+)"/gm,n=[];for(let r;Array.isArray(r=t.exec(e));)r[1]&&n.push(r[1]);return n}async compareCandidates({candidates:e,problemDescription:t=``,generateSearchAreasInstruction:n=this.defaultGenerateSearchAreasInstruction.bind(this),convertCandidateToDocument:r=this.defaultConvertCandidateToDocument.bind(this),candidatesForInitialSelection:i=2,candidatesForFinalSelection:a=1,generateRankingInstruction:o=this.defaultGenerateRankingInstruction.bind(this),extractIdentifiersFromRationale:s=this.defaultExtractIdentifiersFromRationale.bind(this),extractIdentifierFromCandidateDocument:c=this.defaultExtractIdentifierFromCandidateDocument.bind(this),candidateIdentifierField:u=void 0,getSummarisableSubstringIndices:f}={}){if(!Array.isArray(e)||e.length<=0)throw Error(`No candidates provided`);if(i=d.default.toSafeInteger(i),i<=0||(a=d.default.toSafeInteger(a),a<=0))throw Error(`Candidates for initial selection must be a positive integer bigger than 0`);if(i<a)throw Error(`Candidates for initial selection must be equal or more than candidates for final selection`);if(i>e.length)throw Error(`There are `+i+`candidates for initial selection which is more than the total number of candidates of `+e.length);if(a>e.length)throw Error(`There are `+a+`candidates for initial selection which is more than the total number of candidates of `+e.length);if(!u&&(u=Object.keys(e[0])[0],!u))throw Error(`No candidate identifier field`);let p=``,m=[];if(await this.checkEmbedderLoaded(),!this.embedder)return;let h=e.map((e,t)=>r({candidate:e,index:t})),g=await l.MemoryVectorStore.fromTexts(d.default.cloneDeep(h),h.map((e,t)=>t),this),_=this.generatePromptTemplate(n(t));if(this.DEBUG&&console.log(`Formatted search areas prompt: `+_),await this.checkTokeniserLoaded(),!this.tokeniser)return;if(this.tokeniser.encode(_).length>this.tokeniser.model_max_length)throw Error(`Search areas instruction prompt is too long for the tokeniser model`);if(await this.checkGeneratorLoaded(),!this.generator)return;let v=this.tokeniser.pad_token_id??this.tokeniser.sep_token_id??0,y=this.tokeniser.sep_token_id??2,b=await this.generator(_,{max_new_tokens:this.generateSearchAreasMaxNewTokens,temperature:this.generateSearchAreasTemperature,repetition_penalty:this.generateSearchAreasRepetitionPenalty,pad_token_id:v,eos_token_id:y}),x=Array.isArray(b?.[0])?b?.[0]?.[0]:b?.[0];if(!x.generated_text)throw Error(`No generated text for search areas`);this.DEBUG&&console.log(`Generated search areas response: `+x.generated_text);let S=x.generated_text.toString().indexOf(`### Response:`);S>=0?S+=13:S=0;let C=x.generated_text.toString().substring(S).trim();this.DEBUG&&console.log(`Vector search query: `+C);let w=await g.similaritySearch(C,i);this.DEBUG&&console.log(`Vector search results: `,w);let T=[];if(w.some(e=>e.pageContent.trim().split(/\s+/).length>this.targetSummarisedStringTokenCount)){if(await this.checkSummariserLoaded(),!this.summariser)return;T=(await Promise.allSettled(w.map(async e=>{if(!e.pageContent||typeof e.pageContent!=`string`)return``;if(e.pageContent.trim().split(/\s+/).length<=this.targetSummarisedStringTokenCount)return e.pageContent;let t={start:0,end:e.pageContent.length};f&&Object.assign(t,f(e.pageContent)),t.start=d.default.clamp(d.default.toSafeInteger(t.start),0,e.pageContent.length),t.end=d.default.clamp(d.default.toSafeInteger(t.end),0,e.pageContent.length);let n=e.pageContent.substring(t.start,t.end),r=e.pageContent.substring(0,t.start),i=e.pageContent.substring(t.end),a=r.split(/s+/).length+i.split(/s+/).length,o=Math.max(1,420-a),s=await this.summariser?.(n,{max_length:o}),c=r+((Array.isArray(s?.[0])?s?.[0]?.[0]:s?.[0])?.summary_text??``).split(/s+/).slice(o).join(` `)+i;return this.DEBUG&&console.log(`Summarised candidate: `+c),c}))).filter(e=>e.status===`fulfilled`&&e.value).map(e=>e.value)}else T=w.map(e=>e.pageContent);let E=this.generatePromptTemplate(o({problemDescription:t,summaries:T,candidatesForFinalSelection:a,candidateIdentifierField:String(u)}));if(this.DEBUG&&console.log(`Formatted ranking prompt: `+E),this.tokeniser.encode(E).length>this.tokeniser.model_max_length)throw Error(`Ranking instruction prompt is too long for the tokeniser model`);let D=await this.generator(E,{max_new_tokens:this.rankingMaxNewTokens,temperature:this.rankingTemperature,repetition_penalty:this.rankingRepetitionPenalty,pad_token_id:v,eos_token_id:y});p=(Array.isArray(D?.[0])?D?.[0]?.[0]:D[0]).generated_text.toString().trim().replace(/(\*\*)|(<\/?s>)|(\[.*?\])\s*/g,``),this.DEBUG&&console.log(`Generated rationale: `+p);let O=p.indexOf(`### Response:`);if(O>=0?O+=13:O=0,p=p.substring(O),p){let t=s(p);t.length>a&&(t=t.slice(0,a)),m=d.default.compact(t.map(t=>{let n=e.find(e=>String(e[u]).toLowerCase()===t.toLowerCase());return n||(n=e.find(e=>String(e[u]).toLowerCase().includes(t.toLowerCase())),n)||(n=e.find(e=>t.toLowerCase().includes(String(e[u]).toLowerCase())),n)?n:null}))}return(!Array.isArray(m)||m.length<=0)&&(m=d.default.uniq(d.default.compact(w.map(t=>{let n=c({candidateDocument:t.pageContent,candidateIdentifierField:String(u)});this.DEBUG&&console.log(`Extracted identifier from candidate document: `+n);let r=e.find(e=>String(e[u]).toLowerCase()===n.toLowerCase());return r||(r=e.find(e=>String(e[u]).toLowerCase().includes(n.toLowerCase())),r)||(r=e.find(e=>n.toLowerCase().includes(String(e[u]).toLowerCase())),r)?r:null}))).slice(a)),this.DEBUG&&console.log(`Selected candidates`,m),{rationale:p,selectedCandidates:m}}};(function(e){})(p||={});var m=p;Object.defineProperty(exports,`AICompareCandidates`,{enumerable:!0,get:function(){return p}}),exports.default=m;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["Embeddings","env","AutoTokenizer","matches:string[]","match:RegExpExecArray|null","selectedCandidates:Candidate[]","MemoryVectorStore","summaries:string[]","summarisableSubstringIndices:AICompareCandidates.SummarisableSubstringIndices"],"sources":["../src/index.ts"],"sourcesContent":["import{\n\tenv,\n\tpipeline,\n\tAutoTokenizer,\n\tTextGenerationPipeline,\n\tProgressInfo,\n\tProgressCallback,\n\tSummarizationPipeline,\n\tFeatureExtractionPipeline,\n\tPreTrainedTokenizer,\n\tTextGenerationConfig\n}from '@huggingface/transformers';\nimport {MemoryVectorStore} from '@langchain/classic/vectorstores/memory';\nimport {Embeddings} from '@langchain/core/embeddings';\nimport lodash from 'lodash';\nimport jsan from 'jsan';\n\nexport class AICompareCandidates extends Embeddings{\n\treadonly env=env;\n\tDEBUG=true;\n\n\tgenerator:TextGenerationPipeline|null=null;\n\tgeneratorModelName='Xenova/LaMini-GPT-774M';\n\tgeneratorPromise:Promise<TextGenerationPipeline>|null=null;\n\tgeneratorProgressInfo:ProgressInfo=<ProgressInfo>{};\n\tgeneratorProgressCallback:ProgressCallback|null=null;\n\n\tsummariser:SummarizationPipeline|null=null;\n\tsummariserModelName='Xenova/distilbart-cnn-12-6';\n\tsummariserPromise:Promise<SummarizationPipeline>|null=null;\n\tsummariserProgressInfo:ProgressInfo=<ProgressInfo>{};\n\tsummariserProgressCallback:ProgressCallback|null=null;\n\n\tembedder:FeatureExtractionPipeline|null=null;\n\tembedderModelName='Xenova/all-MiniLM-L12-v2';\n\tembedderPromise:Promise<FeatureExtractionPipeline>|null=null;\n\tembedderProgressInfo:ProgressInfo=<ProgressInfo>{};\n\tembedderProgressCallback:ProgressCallback|null=null;\n\n\ttokeniser:PreTrainedTokenizer|null=null;\n\ttokeniserModelName=this.generatorModelName;\n\ttokeniserPromise:Promise<PreTrainedTokenizer>|null=null;\n\ttokeniserProgressInfo:ProgressInfo=<ProgressInfo>{};\n\ttokeniserProgressCallback:ProgressCallback|null=null;\n\n\tgenerateSearchAreasMaxNewTokens=64;\n\tgenerateSearchAreasTemperature=0.35;\n\tgenerateSearchAreasRepetitionPenalty=1.5;\n\n\trankingMaxNewTokens=64;\n\trankingTemperature=0.35;\n\trankingRepetitionPenalty=1.5;\n\n\ttargetSummarisedStringTokenCount=420;\n\n\tstatic{\n\t\tenv.localModelPath='';\n\t\tenv.allowRemoteModels=true;\n\t\tenv.allowLocalModels=false;\n\t}\n\n\tconstructor(){\n\t\tsuper({});\n\t}\n\t\n\tasync loadGenerator({\n\t\tprogressCallback,\n\t\tmodelName=''\n\t}:AICompareCandidates.LoadArguments=<AICompareCandidates.LoadArguments>{}){\n\t\tif(typeof modelName==='string'&&modelName)this.generatorModelName=modelName;\n\t\tif(!this.generatorModelName)throw new Error('Invalid generator model name');\n\t\tif(progressCallback)this.generatorProgressCallback=progressCallback;\n\t\t//ts-ignore is needed due to frequent error TS2590: Expression produces a union type that is too complex to represent.\n\t\t//@ts-ignore\n\t\tthis.generatorPromise=pipeline('text-generation',this.generatorModelName,{\n\t\t\tdevice:'webgpu',\n\t\t\tprogress_callback:progressInfo=>{\n\t\t\t\tif(this.DEBUG)console.log(jsan.stringify(progressInfo));\n\t\t\t\tObject.assign(this.generatorProgressInfo,progressInfo);\n\t\t\t\treturn this.generatorProgressCallback?.(progressInfo);\n\t\t\t}\n\t\t});\n\t\tthis.generator=await this.generatorPromise;\n\t\treturn this.generator;\n\t}\n\n\tasync checkGeneratorLoaded(){\n\t\tif(!this.generatorPromise)this.loadGenerator();\n\t\tif(!this.generator)await this.generatorPromise;\n\t\tif(!this.generator)throw new Error('Unable to load generator');\n\t}\n\n\tasync loadSummariser({\n\t\tprogressCallback,\n\t\tmodelName=''\n\t}:AICompareCandidates.LoadArguments=<AICompareCandidates.LoadArguments>{}){\n\t\tif(typeof modelName==='string'&&modelName)this.summariserModelName=modelName;\n\t\tif(!this.summariserModelName)throw new Error('Invalid summariser model name');\n\t\tif(progressCallback)this.summariserProgressCallback=progressCallback;\n\t\t//ts-ignore is needed due to frequent error TS2590: Expression produces a union type that is too complex to represent.\n\t\t//@ts-ignore\n\t\tthis.summariserPromise=pipeline('summarization',this.summariserModelName,{\n\t\t\tdevice:'webgpu',\n\t\t\tprogress_callback:progressInfo=>{\n\t\t\t\tif(this.DEBUG)console.log(jsan.stringify(progressInfo));\n\t\t\t\tObject.assign(this.summariserProgressInfo,progressInfo);\n\t\t\t\treturn this.summariserProgressCallback?.(progressInfo);\n\t\t\t}\n\t\t});\n\t\tthis.summariser=await this.summariserPromise;\n\t\treturn this.summariser;\n\t}\n\n\tasync checkSummariserLoaded(){\n\t\tif(!this.summariserPromise)this.loadSummariser();\n\t\tif(!this.summariser)await this.summariserPromise;\n\t\tif(!this.summariser)throw new Error('Unable to load summariser');\n\t}\n\n\tasync loadEmbedder({\n\t\tprogressCallback,\n\t\tmodelName=''\n\t}:AICompareCandidates.LoadArguments=<AICompareCandidates.LoadArguments>{}){\n\t\tif(typeof modelName==='string'&&modelName)this.embedderModelName=modelName;\n\t\tif(!this.embedderModelName)throw new Error('Invalid embedder model name');\n\t\tif(progressCallback)this.embedderProgressCallback=progressCallback;\n\t\t//ts-ignore is needed due to frequent error TS2590: Expression produces a union type that is too complex to represent.\n\t\t//@ts-ignore\n\t\tthis.embedderPromise=pipeline('feature-extraction',this.embedderModelName,{\n\t\t\tdevice:'webgpu',\n\t\t\tprogress_callback:progressInfo=>{\n\t\t\t\tif(this.DEBUG)console.log(jsan.stringify(progressInfo));\n\t\t\t\tObject.assign(this.embedderProgressInfo,progressInfo);\n\t\t\t\treturn this.embedderProgressCallback?.(progressInfo);\n\t\t\t}\n\t\t});\n\t\tthis.embedder=await this.embedderPromise;\n\t\treturn this.embedder;\n\t}\n\n\tasync checkEmbedderLoaded(){\n\t\tif(!this.embedderPromise)this.loadEmbedder();\n\t\tif(!this.embedder)await this.embedderPromise;\n\t\tif(!this.embedder)throw new Error('Unable to load embedder');\n\t}\n\n\tasync loadTokeniser({\n\t\tprogressCallback,\n\t\tmodelName=''\n\t}:AICompareCandidates.LoadArguments=<AICompareCandidates.LoadArguments>{}){\n\t\tif(typeof modelName==='string'&&modelName)this.tokeniserModelName=modelName;\n\t\tif(!this.tokeniserModelName)throw new Error('Invalid tokeniser model name');\n\t\tif(progressCallback)this.tokeniserProgressCallback=progressCallback;\n\t\t//ts-ignore is needed due to frequent error TS2590: Expression produces a union type that is too complex to represent.\n\t\t//@ts-ignore\n\t\tthis.tokeniserPromise=AutoTokenizer.from_pretrained(this.tokeniserModelName,{\n\t\t\tprogress_callback:progressInfo=>{\n\t\t\t\tif(this.DEBUG)console.log(jsan.stringify(progressInfo));\n\t\t\t\tObject.assign(this.tokeniserProgressInfo,progressInfo);\n\t\t\t\treturn this.tokeniserProgressCallback?.(progressInfo);\n\t\t\t}\n\t\t})\n\t\tthis.tokeniser=await this.tokeniserPromise;\n\t\treturn this.tokeniser;\n\t}\n\n\tasync checkTokeniserLoaded(){\n\t\tif(!this.tokeniserPromise)this.loadTokeniser();\n\t\tif(!this.tokeniser)await this.tokeniserPromise;\n\t\tif(!this.tokeniser)throw new Error('Unable to load tokeniser');\n\t}\n\n\tasync embedQuery(text:string):Promise<number[]>{\n\t\tawait this.checkEmbedderLoaded();\n\t\treturn Array.from((await this.embedder?.(text,{\n\t\t\tpooling:'mean',\n\t\t\tnormalize:true\n\t\t}))?.data);\n\t}\n\n\tasync embedDocuments(texts:string[]):Promise<number[][]>{\n\t\treturn Promise.all(texts.map(text=>this.embedQuery(text)));\n\t}\n\n\tgeneratePromptTemplate(prompt:string){\n\t\treturn 'Below is an instruction that describes a task. Write a response that appropriately completes the request.\\n\\n'+\n\t\t\t'### Instruction:\\n'+\n\t\t\tprompt+\n\t\t\t'\\n\\n### Response:';\n\t}\n\n\tdefaultGenerateSearchAreasInstruction(problemDescription:string){\n\t\treturn 'List the relevant subject areas for the following issues. Limit your response to 100 words.\\nIssues: \"'+problemDescription+'\"';\n\t}\n\n\tdefaultConvertCandidateToDocument<Candidate>({\n\t\tcandidate,\n\t\tindex\n\t}:AICompareCandidates.ConvertCandidateToDocumentArguments<Candidate>=<AICompareCandidates.ConvertCandidateToDocumentArguments<Candidate>>{}){\n\t\tlet document='Start of Candidate #'+index;\n\t\tfor(let i in candidate)document+='\\n'+lodash.startCase(i)+': '+(typeof candidate[i]==='object'?jsan.stringify(candidate[i]):String(candidate[i]));\n\t\tdocument+='\\nEnd of Candidate #'+index;\n\t\treturn document;\n\t}\n\n\tdefaultGenerateRankingInstruction({\n\t\tproblemDescription,\n\t\tsummaries,\n\t\tcandidatesForFinalSelection,\n\t\tcandidateIdentifierField\n\t}:AICompareCandidates.GenerateRankingInstructionArguments=<AICompareCandidates.GenerateRankingInstructionArguments>{}){\n\t\treturn 'Strictly follow these rules:\\n'+\n\t\t\t'1. Rank ONLY the top '+candidatesForFinalSelection+' candidates with one 15-word sentence explaining why\\n'+\n\t\t\t'2. Rank the candidates based on \"'+problemDescription.replace(/(\\r|\\n)/g,' ')+'\"\\n'+\n\t\t\t'3. If unclear, say \"Insufficient information to determine\"\\n\\n'+\n\t\t\t'Candidates:\\n\\n'+summaries.join('\\n\\n')+'\\n\\n'+\n\t\t\t'Format exactly:\\n'+\n\t\t\t'#1. \"Full '+lodash.startCase(candidateIdentifierField)+'\": 15-word explanation\\n'+\n\t\t\t'#2. ...';\n\t}\n\n\tregexIndexOf(text:string,regex:RegExp,startIndex:number){\n    \tlet indexInSuffix=text.slice(startIndex).search(regex);\n    \treturn indexInSuffix<0?indexInSuffix:indexInSuffix+startIndex;\n\t}\n\n\tdefaultExtractIdentifierFromCandidateDocument({\n\t\tcandidateDocument,\n\t\tcandidateIdentifierField\n\t}:AICompareCandidates.ExtractIdentifierFromCandidateDocumentArguments=<AICompareCandidates.ExtractIdentifierFromCandidateDocumentArguments>{}){\n\t\tif(this.DEBUG)console.log(candidateDocument,candidateIdentifierField);\n\t\tlet startCase=lodash.startCase(candidateIdentifierField);\n\t\tlet startIndex=candidateDocument.indexOf(startCase);\n\t\tif(startIndex<0)startIndex=candidateDocument.toLowerCase().indexOf(startCase.toLowerCase());\n\t\tif(this.DEBUG)console.log(startIndex);\n\t\tif(startIndex>=0)startIndex+=startCase.length;\n\t\tif(startIndex<0){\n\t\t\tstartIndex=candidateDocument.toLowerCase().indexOf(candidateIdentifierField.toLowerCase());\n\t\t\tif(startIndex>=0)startIndex+=candidateIdentifierField.length;\n\t\t}\n\t\tif(this.DEBUG)console.log(startIndex);\n\t\telse return '';\n\t\tstartIndex=candidateDocument.indexOf(':',startIndex);\n\t\tif(this.DEBUG)console.log(startIndex);\n\t\tif(startIndex<0)startIndex=this.regexIndexOf(candidateDocument,/\\s+/,startIndex);\n\t\tif(this.DEBUG)console.log(startIndex);\n\t\tif(startIndex<0)return '';\n\t\tlet endIndex=candidateDocument.indexOf('\\n',startIndex);\n\t\tif(endIndex<0)endIndex=candidateDocument.length;\n\t\tif(this.DEBUG)console.log(endIndex);\n\t\treturn candidateDocument.substring(startIndex,endIndex).trim();\n\t}\n\n\tdefaultExtractIdentifiersFromRationale(rationale:string){\n\t\tlet regex=/^\\s*#\\s*\\d+\\s*\\.?\\s*\"([^\"]+)\"/gm;\n\t\tlet matches:string[]=[];\n\t\tfor(let match:RegExpExecArray|null;Array.isArray(match=regex.exec(rationale));)if(match[1])matches.push(match[1]);\n\t\treturn matches;\n\t}\n\n\tasync compareCandidates<Candidate>({\n\t\tcandidates,\n\t\tproblemDescription='',\n\t\tgenerateSearchAreasInstruction=this.defaultGenerateSearchAreasInstruction.bind(this),\n\t\tconvertCandidateToDocument=this.defaultConvertCandidateToDocument.bind(this),\n\t\tcandidatesForInitialSelection=2,\n\t\tcandidatesForFinalSelection=1,\n\t\tgenerateRankingInstruction=this.defaultGenerateRankingInstruction.bind(this),\n\t\textractIdentifiersFromRationale=this.defaultExtractIdentifiersFromRationale.bind(this),\n\t\textractIdentifierFromCandidateDocument=this.defaultExtractIdentifierFromCandidateDocument.bind(this),\n\t\tcandidateIdentifierField=undefined,\n\t\tgetSummarisableSubstringIndices\n\t}:AICompareCandidates.CompareArguments<Candidate>=<AICompareCandidates.CompareArguments<Candidate>>{}):Promise<AICompareCandidates.CompareCandidatesReturn<Candidate>|void>{\n\t\tif(!Array.isArray(candidates)||candidates.length<=0)throw new Error('No candidates provided');\n\t\tcandidatesForInitialSelection=lodash.toSafeInteger(candidatesForInitialSelection);\n\t\tif(candidatesForInitialSelection<=0)throw new Error('Candidates for initial selection must be a positive integer bigger than 0');\n\t\tcandidatesForFinalSelection=lodash.toSafeInteger(candidatesForFinalSelection);\n\t\tif(candidatesForFinalSelection<=0)throw new Error('Candidates for initial selection must be a positive integer bigger than 0');\n\t\tif(candidatesForInitialSelection<candidatesForFinalSelection)throw new Error('Candidates for initial selection must be equal or more than candidates for final selection');\n\t\tif(candidatesForInitialSelection>candidates.length)throw new Error('There are '+candidatesForInitialSelection+'candidates for initial selection which is more than the total number of candidates of '+candidates.length);\n\t\tif(candidatesForFinalSelection>candidates.length)throw new Error('There are '+candidatesForFinalSelection+'candidates for initial selection which is more than the total number of candidates of '+candidates.length);\n\t\tif(!candidateIdentifierField){\n\t\t\tcandidateIdentifierField=Object.keys(candidates[0] as object)[0] as keyof Candidate;\n\t\t\tif(!candidateIdentifierField)throw new Error('No candidate identifier field');\n\t\t}\n\n\t\tlet rationale='';\n\t\tlet selectedCandidates:Candidate[]=[];\n\n\t\tawait this.checkEmbedderLoaded();\n\t\tif(!this.embedder)return;\n\t\tlet candidateDocuments=candidates.map((candidate,index)=>convertCandidateToDocument({\n\t\t\tcandidate,\n\t\t\tindex\n\t\t}));\n\t\tlet vectorStore=await MemoryVectorStore.fromTexts(\n\t\t\tlodash.cloneDeep(candidateDocuments),\n\t\t\tcandidateDocuments.map((document,index)=>index),\n\t\t\tthis\n\t\t);\n\n\t\tlet searchAreasPromptTemplate=this.generatePromptTemplate(generateSearchAreasInstruction(problemDescription));\n\t\tif(this.DEBUG)console.log('Formatted search areas prompt: '+searchAreasPromptTemplate);\n\t\tawait this.checkTokeniserLoaded();\n\t\tif(!this.tokeniser)return;\n\t\tlet searchAreasPromptTokens=this.tokeniser.encode(searchAreasPromptTemplate);\n\t\tif(searchAreasPromptTokens.length>this.tokeniser.model_max_length)throw new Error('Search areas instruction prompt is too long for the tokeniser model');\n\n\t\tawait this.checkGeneratorLoaded();\n\t\tif(!this.generator)return;\n\t\tlet pad_token_id=this.tokeniser.pad_token_id??this.tokeniser.sep_token_id??0;\n\t\tlet eos_token_id=this.tokeniser.sep_token_id??2;\n\t\tlet searchAreasReplyArray=await this.generator(searchAreasPromptTemplate,{\n\t\t\tmax_new_tokens:this.generateSearchAreasMaxNewTokens,\n\t\t\ttemperature:this.generateSearchAreasTemperature,\n\t\t\trepetition_penalty:this.generateSearchAreasRepetitionPenalty,\n\t\t\tpad_token_id,\n\t\t\teos_token_id\n\t\t});\n\t\tlet searchAreasReply=Array.isArray(searchAreasReplyArray?.[0])?searchAreasReplyArray?.[0]?.[0]:searchAreasReplyArray?.[0];\n\t\tif(!searchAreasReply.generated_text)throw new Error('No generated text for search areas');\n\t\tif(this.DEBUG)console.log('Generated search areas response: '+searchAreasReply.generated_text);\n\t\tlet searchAreasResponseIndex=searchAreasReply.generated_text.toString().indexOf('### Response:');\n\t\tif(searchAreasResponseIndex>=0)searchAreasResponseIndex+='### Response:'.length;\n\t\telse searchAreasResponseIndex=0;\n\n\t\tlet vectorSearchQuery=searchAreasReply.generated_text.toString().substring(searchAreasResponseIndex).trim();\n\t\t//generally the first sentence has the greatest relevance to the actual prompt\n\t\t//if(vectorSearchQuery.includes('.'))vectorSearchQuery=vectorSearchQuery.split('.')[0].trim();\n\t\tif(this.DEBUG)console.log('Vector search query: '+vectorSearchQuery);\n\t\tlet queryResult=await vectorStore.similaritySearch(vectorSearchQuery,candidatesForInitialSelection);\n\t\tif(this.DEBUG)console.log('Vector search results: ',queryResult);\n\n\t\tlet summaries:string[]=[];\n\t\t//only bother doing summarisation if there are candidates which exceed the token count\n\t\tif(queryResult.some(result=>result.pageContent.trim().split(/\\s+/).length>this.targetSummarisedStringTokenCount)){\n\t\t\tawait this.checkSummariserLoaded();\n\t\t\tif(!this.summariser)return;\n\t\t\tsummaries=(await Promise.allSettled(queryResult.map(async result=>{\n\t\t\t\tif(!result.pageContent||typeof result.pageContent!=='string')return '';\n\t\t\t\tif(result.pageContent.trim().split(/\\s+/).length<=this.targetSummarisedStringTokenCount)return result.pageContent;\n\t\t\t\tlet summarisableSubstringIndices:AICompareCandidates.SummarisableSubstringIndices={\n\t\t\t\t\tstart:0,\n\t\t\t\t\tend:result.pageContent.length\n\t\t\t\t};\n\t\t\t\tif(getSummarisableSubstringIndices)Object.assign(summarisableSubstringIndices,getSummarisableSubstringIndices(result.pageContent));\n\t\t\t\tsummarisableSubstringIndices.start=lodash.clamp(lodash.toSafeInteger(summarisableSubstringIndices.start),0,result.pageContent.length);\n\t\t\t\tsummarisableSubstringIndices.end=lodash.clamp(lodash.toSafeInteger(summarisableSubstringIndices.end),0,result.pageContent.length);\n\t\t\t\tlet summarisableSubstring=result.pageContent.substring(summarisableSubstringIndices.start,summarisableSubstringIndices.end);\n\t\t\t\tlet contentBefore=result.pageContent.substring(0,summarisableSubstringIndices.start);\n\t\t\t\tlet contentAfter=result.pageContent.substring(summarisableSubstringIndices.end);\n\t\t\t\tlet wordsWithoutSummarisable=contentBefore.split(/s+/).length+contentAfter.split(/s+/).length;\n\t\t\t\tlet targetSummarisedSubstringTokenCount=Math.max(1,420-wordsWithoutSummarisable);\n\t\t\t\tlet summarisedSubstringArray=await this.summariser?.(summarisableSubstring,<TextGenerationConfig>{\n\t\t\t\t\tmax_length:targetSummarisedSubstringTokenCount\n\t\t\t\t});\n\t\t\t\tlet summarisedSubstring=Array.isArray(summarisedSubstringArray?.[0])?summarisedSubstringArray?.[0]?.[0]:summarisedSubstringArray?.[0];\n\t\t\t\tlet summarisedString=contentBefore+(summarisedSubstring?.summary_text??'').split(/s+/).slice(targetSummarisedSubstringTokenCount).join(' ')+contentAfter;\n\t\t\t\tif(this.DEBUG)console.log('Summarised candidate: '+summarisedString);\n\t\t\t\treturn summarisedString;\n\t\t\t}))).filter(result=>result.status==='fulfilled'&&result.value).map(result=>(result as PromiseFulfilledResult<string>).value);\n\t\t}else{\n\t\t\tsummaries=queryResult.map(result=>result.pageContent);\n\t\t}\n\n\t\tlet rankingPromptTemplate=this.generatePromptTemplate(generateRankingInstruction({\n\t\t\tproblemDescription,\n\t\t\tsummaries,\n\t\t\tcandidatesForFinalSelection,\n\t\t\tcandidateIdentifierField:String(candidateIdentifierField)\n\t\t}));\n\t\tif(this.DEBUG)console.log('Formatted ranking prompt: '+rankingPromptTemplate);\n\t\tlet rankingPromptTokens=this.tokeniser.encode(rankingPromptTemplate);\n\t\tif(rankingPromptTokens.length>this.tokeniser.model_max_length)throw new Error('Ranking instruction prompt is too long for the tokeniser model');\n\t\tlet rankingArray=await this.generator(rankingPromptTemplate,{\n\t\t\tmax_new_tokens:this.rankingMaxNewTokens,\n\t\t\ttemperature:this.rankingTemperature,\n\t\t\trepetition_penalty:this.rankingRepetitionPenalty,\n\t\t\tpad_token_id,\n\t\t\teos_token_id\n\t\t});\n\t\tlet ranking=Array.isArray(rankingArray?.[0])?rankingArray?.[0]?.[0]:rankingArray[0];\n\t\trationale=ranking.generated_text.toString().trim().replace(/(\\*\\*)|(<\\/?s>)|(\\[.*?\\])\\s*/g, '');\n\t\tif(this.DEBUG)console.log('Generated rationale: '+rationale);\n\t\tlet rationaleResponseIndex=rationale.indexOf('### Response:');\n\t\tif(rationaleResponseIndex>=0)rationaleResponseIndex+='### Response:'.length;\n\t\telse rationaleResponseIndex=0;\n\t\trationale=rationale.substring(rationaleResponseIndex);\n\t\t//if(!rationale)throw new Error('No rationale generated');\n\n\t\tif(rationale){\n\t\t\tlet identifiers=extractIdentifiersFromRationale(rationale);\n\t\t\tif(identifiers.length>candidatesForFinalSelection)identifiers=identifiers.slice(0,candidatesForFinalSelection);\n\t\t\tselectedCandidates=lodash.compact(identifiers.map(identifier=>{\n\t\t\t\tlet selectedCandidate=candidates.find(candidate=>String(candidate[candidateIdentifierField]).toLowerCase()===identifier.toLowerCase());\n\t\t\t\tif(selectedCandidate)return selectedCandidate;\n\t\t\t\tselectedCandidate=candidates.find(candidate=>String(candidate[candidateIdentifierField]).toLowerCase().includes(identifier.toLowerCase()));\n\t\t\t\tif(selectedCandidate)return selectedCandidate;\n\t\t\t\tselectedCandidate=candidates.find(candidate=>identifier.toLowerCase().includes(String(candidate[candidateIdentifierField]).toLowerCase()));\n\t\t\t\tif(selectedCandidate)return selectedCandidate;\n\t\t\t\treturn null;\n\t\t\t}));\n\t\t}\n\n\t\tif(!Array.isArray(selectedCandidates)||selectedCandidates.length<=0){\n\t\t\tselectedCandidates=lodash.uniq(lodash.compact(queryResult.map(result=>{\n\t\t\t\tlet identifier=extractIdentifierFromCandidateDocument({\n\t\t\t\t\tcandidateDocument:result.pageContent,\n\t\t\t\t\tcandidateIdentifierField:String(candidateIdentifierField)\n\t\t\t\t});\n\t\t\t\tif(this.DEBUG)console.log('Extracted identifier from candidate document: '+identifier);\n\t\t\t\tlet selectedCandidate=candidates.find(candidate=>String(candidate[candidateIdentifierField]).toLowerCase()===identifier.toLowerCase());\n\t\t\t\tif(selectedCandidate)return selectedCandidate;\n\t\t\t\tselectedCandidate=candidates.find(candidate=>String(candidate[candidateIdentifierField]).toLowerCase().includes(identifier.toLowerCase()));\n\t\t\t\tif(selectedCandidate)return selectedCandidate;\n\t\t\t\tselectedCandidate=candidates.find(candidate=>identifier.toLowerCase().includes(String(candidate[candidateIdentifierField]).toLowerCase()));\n\t\t\t\tif(selectedCandidate)return selectedCandidate;\n\t\t\t\treturn null;\n\t\t\t}))).slice(candidatesForFinalSelection);\n\t\t}\n\t\tif(this.DEBUG)console.log('Selected candidates',selectedCandidates);\n\n\t\treturn{\n\t\t\trationale,\n\t\t\tselectedCandidates\n\t\t};\n\t}\n};\n\nexport namespace AICompareCandidates{\n\texport interface LoadArguments{\n\t\tprogressCallback?:ProgressCallback;\n\t\tmodelName:string;\n\t};\n\n\texport interface SummarisableSubstringIndices{\n\t\tstart:number;\n\t\tend:number;\n\t};\n\n\texport interface CompareArguments<Candidate>{\n\t\tcandidates:Candidate[];\n\t\tproblemDescription:string;\n\t\tgenerateSearchAreasInstruction?:(problemDescription:string)=>string;\n\t\tconvertCandidateToDocument?:(convertCandidateToDocumentArguments:ConvertCandidateToDocumentArguments<Candidate>)=>string;\n\t\tcandidatesForInitialSelection?:number;\n\t\tcandidatesForFinalSelection?:number;\n\t\tgenerateRankingInstruction?:(generateRankingInstructionArguments:GenerateRankingInstructionArguments)=>string;\n\t\textractIdentifiersFromRationale?:(rationale:string)=>string[];\n\t\textractIdentifierFromCandidateDocument?:(extractIdentifierFromCandidateDocumentArguments:ExtractIdentifierFromCandidateDocumentArguments)=>string;\n\t\tcandidateIdentifierField?:keyof Candidate;\n\t\tgetSummarisableSubstringIndices?:(candidateDocument:string)=>SummarisableSubstringIndices;\n\t};\n\n\texport interface ConvertCandidateToDocumentArguments<Candidate>{\n\t\tcandidate:Candidate;\n\t\tindex:number;\n\t};\n\n\texport interface ExtractIdentifierFromCandidateDocumentArguments{\n\t\tcandidateDocument:string;\n\t\tcandidateIdentifierField:string;\n\t};\n\n\texport interface GenerateRankingInstructionArguments{\n\t\tproblemDescription:string;\n\t\tsummaries:string[];\n\t\tcandidatesForFinalSelection:number;\n\t\tcandidateIdentifierField:string;\n\t};\n\n\texport interface CompareCandidatesReturn<Candidate>{\n\t\tselectedCandidates:Candidate[],\n\t\trationale:string\n\t};\n};\n\nexport default AICompareCandidates;"],"mappings":"otBAiBA,IAAa,EAAb,cAAyCA,EAAAA,UAAU,CAClD,IAAaC,EAAAA,IACb,MAAM,GAEN,UAAsC,KACtC,mBAAmB,yBACnB,iBAAsD,KACtD,sBAAiD,EAAE,CACnD,0BAAgD,KAEhD,WAAsC,KACtC,oBAAoB,6BACpB,kBAAsD,KACtD,uBAAkD,EAAE,CACpD,2BAAiD,KAEjD,SAAwC,KACxC,kBAAkB,2BAClB,gBAAwD,KACxD,qBAAgD,EAAE,CAClD,yBAA+C,KAE/C,UAAmC,KACnC,mBAAmB,KAAK,mBACxB,iBAAmD,KACnD,sBAAiD,EAAE,CACnD,0BAAgD,KAEhD,gCAAgC,GAChC,+BAA+B,IAC/B,qCAAqC,IAErC,oBAAoB,GACpB,mBAAmB,IACnB,yBAAyB,IAEzB,iCAAiC,IAEjC,OACC,EAAA,IAAI,eAAe,GACnB,EAAA,IAAI,kBAAkB,GACtB,EAAA,IAAI,iBAAiB,GAGtB,aAAa,CACZ,MAAM,EAAE,CAAC,CAGV,MAAM,cAAc,CACnB,mBACA,YAAU,IAC4D,EAAE,CAAC,CAEzE,GADG,OAAO,GAAY,UAAU,IAAU,KAAK,mBAAmB,GAC/D,CAAC,KAAK,mBAAmB,MAAU,MAAM,+BAA+B,CAa3E,OAZG,IAAiB,KAAK,0BAA0B,GAGnD,KAAK,kBAAA,EAAA,EAAA,UAA0B,kBAAkB,KAAK,mBAAmB,CACxE,OAAO,SACP,kBAAkB,IACd,KAAK,OAAM,QAAQ,IAAI,EAAA,QAAK,UAAU,EAAa,CAAC,CACvD,OAAO,OAAO,KAAK,sBAAsB,EAAa,CAC/C,KAAK,4BAA4B,EAAa,EAEtD,CAAC,CACF,KAAK,UAAU,MAAM,KAAK,iBACnB,KAAK,UAGb,MAAM,sBAAsB,CAG3B,GAFI,KAAK,kBAAiB,KAAK,eAAe,CAC1C,KAAK,WAAU,MAAM,KAAK,iBAC3B,CAAC,KAAK,UAAU,MAAU,MAAM,2BAA2B,CAG/D,MAAM,eAAe,CACpB,mBACA,YAAU,IAC4D,EAAE,CAAC,CAEzE,GADG,OAAO,GAAY,UAAU,IAAU,KAAK,oBAAoB,GAChE,CAAC,KAAK,oBAAoB,MAAU,MAAM,gCAAgC,CAa7E,OAZG,IAAiB,KAAK,2BAA2B,GAGpD,KAAK,mBAAA,EAAA,EAAA,UAA2B,gBAAgB,KAAK,oBAAoB,CACxE,OAAO,SACP,kBAAkB,IACd,KAAK,OAAM,QAAQ,IAAI,EAAA,QAAK,UAAU,EAAa,CAAC,CACvD,OAAO,OAAO,KAAK,uBAAuB,EAAa,CAChD,KAAK,6BAA6B,EAAa,EAEvD,CAAC,CACF,KAAK,WAAW,MAAM,KAAK,kBACpB,KAAK,WAGb,MAAM,uBAAuB,CAG5B,GAFI,KAAK,mBAAkB,KAAK,gBAAgB,CAC5C,KAAK,YAAW,MAAM,KAAK,kBAC5B,CAAC,KAAK,WAAW,MAAU,MAAM,4BAA4B,CAGjE,MAAM,aAAa,CAClB,mBACA,YAAU,IAC4D,EAAE,CAAC,CAEzE,GADG,OAAO,GAAY,UAAU,IAAU,KAAK,kBAAkB,GAC9D,CAAC,KAAK,kBAAkB,MAAU,MAAM,8BAA8B,CAazE,OAZG,IAAiB,KAAK,yBAAyB,GAGlD,KAAK,iBAAA,EAAA,EAAA,UAAyB,qBAAqB,KAAK,kBAAkB,CACzE,OAAO,SACP,kBAAkB,IACd,KAAK,OAAM,QAAQ,IAAI,EAAA,QAAK,UAAU,EAAa,CAAC,CACvD,OAAO,OAAO,KAAK,qBAAqB,EAAa,CAC9C,KAAK,2BAA2B,EAAa,EAErD,CAAC,CACF,KAAK,SAAS,MAAM,KAAK,gBAClB,KAAK,SAGb,MAAM,qBAAqB,CAG1B,GAFI,KAAK,iBAAgB,KAAK,cAAc,CACxC,KAAK,UAAS,MAAM,KAAK,gBAC1B,CAAC,KAAK,SAAS,MAAU,MAAM,0BAA0B,CAG7D,MAAM,cAAc,CACnB,mBACA,YAAU,IAC4D,EAAE,CAAC,CAEzE,GADG,OAAO,GAAY,UAAU,IAAU,KAAK,mBAAmB,GAC/D,CAAC,KAAK,mBAAmB,MAAU,MAAM,+BAA+B,CAY3E,OAXG,IAAiB,KAAK,0BAA0B,GAGnD,KAAK,iBAAiBC,EAAAA,cAAc,gBAAgB,KAAK,mBAAmB,CAC3E,kBAAkB,IACd,KAAK,OAAM,QAAQ,IAAI,EAAA,QAAK,UAAU,EAAa,CAAC,CACvD,OAAO,OAAO,KAAK,sBAAsB,EAAa,CAC/C,KAAK,4BAA4B,EAAa,EAEtD,CAAC,CACF,KAAK,UAAU,MAAM,KAAK,iBACnB,KAAK,UAGb,MAAM,sBAAsB,CAG3B,GAFI,KAAK,kBAAiB,KAAK,eAAe,CAC1C,KAAK,WAAU,MAAM,KAAK,iBAC3B,CAAC,KAAK,UAAU,MAAU,MAAM,2BAA2B,CAG/D,MAAM,WAAW,EAA8B,CAE9C,OADA,MAAM,KAAK,qBAAqB,CACzB,MAAM,MAAM,MAAM,KAAK,WAAW,EAAK,CAC7C,QAAQ,OACR,UAAU,GACV,CAAC,GAAG,KAAK,CAGX,MAAM,eAAe,EAAmC,CACvD,OAAO,QAAQ,IAAI,EAAM,IAAI,GAAM,KAAK,WAAW,EAAK,CAAC,CAAC,CAG3D,uBAAuB,EAAc,CACpC,MAAO;;;EAEN,EACA;;eAGF,sCAAsC,EAA0B,CAC/D,MAAO;WAAyG,EAAmB,IAGpI,kCAA6C,CAC5C,YACA,SACwI,EAAE,CAAC,CAC3I,IAAI,EAAS,uBAAuB,EACpC,IAAI,IAAI,KAAK,EAAU,GAAU;EAAK,EAAA,QAAO,UAAU,EAAE,CAAC,MAAM,OAAO,EAAU,IAAK,SAAS,EAAA,QAAK,UAAU,EAAU,GAAG,CAAC,OAAO,EAAU,GAAG,EAEhJ,MADA,IAAU;oBAAuB,EAC1B,EAGR,kCAAkC,CACjC,qBACA,YACA,8BACA,4BACkH,EAAE,CAAC,CACrH,MAAO;uBACkB,EAA4B;mCAChB,EAAmB,QAAQ,WAAW,IAAI,CAAC;;;;;EAE7D,EAAU,KAAK;;EAAO,CAAC;;;YAE5B,EAAA,QAAO,UAAU,EAAyB,CAAC;SAI1D,aAAa,EAAY,EAAa,EAAkB,CACpD,IAAI,EAAc,EAAK,MAAM,EAAW,CAAC,OAAO,EAAM,CACtD,OAAO,EAAc,EAAE,EAAc,EAAc,EAGvD,8CAA8C,CAC7C,oBACA,4BAC0I,EAAE,CAAC,CAC1I,KAAK,OAAM,QAAQ,IAAI,EAAkB,EAAyB,CACrE,IAAI,EAAU,EAAA,QAAO,UAAU,EAAyB,CACpD,EAAW,EAAkB,QAAQ,EAAU,CAQnD,GAPG,EAAW,IAAE,EAAW,EAAkB,aAAa,CAAC,QAAQ,EAAU,aAAa,CAAC,EACxF,KAAK,OAAM,QAAQ,IAAI,EAAW,CAClC,GAAY,IAAE,GAAY,EAAU,QACpC,EAAW,IACb,EAAW,EAAkB,aAAa,CAAC,QAAQ,EAAyB,aAAa,CAAC,CACvF,GAAY,IAAE,GAAY,EAAyB,SAEpD,KAAK,MAAM,QAAQ,IAAI,EAAW,MAChC,MAAO,GAKZ,GAJA,EAAW,EAAkB,QAAQ,IAAI,EAAW,CACjD,KAAK,OAAM,QAAQ,IAAI,EAAW,CAClC,EAAW,IAAE,EAAW,KAAK,aAAa,EAAkB,MAAM,EAAW,EAC7E,KAAK,OAAM,QAAQ,IAAI,EAAW,CAClC,EAAW,EAAE,MAAO,GACvB,IAAI,EAAS,EAAkB,QAAQ;EAAK,EAAW,CAGvD,OAFG,EAAS,IAAE,EAAS,EAAkB,QACtC,KAAK,OAAM,QAAQ,IAAI,EAAS,CAC5B,EAAkB,UAAU,EAAW,EAAS,CAAC,MAAM,CAG/D,uCAAuC,EAAiB,CACvD,IAAI,EAAM,kCACNC,EAAiB,EAAE,CACvB,IAAI,IAAIC,EAA2B,MAAM,QAAQ,EAAM,EAAM,KAAK,EAAU,CAAC,EAAK,EAAM,IAAG,EAAQ,KAAK,EAAM,GAAG,CACjH,OAAO,EAGR,MAAM,kBAA6B,CAClC,aACA,qBAAmB,GACnB,iCAA+B,KAAK,sCAAsC,KAAK,KAAK,CACpF,6BAA2B,KAAK,kCAAkC,KAAK,KAAK,CAC5E,gCAA8B,EAC9B,8BAA4B,EAC5B,6BAA2B,KAAK,kCAAkC,KAAK,KAAK,CAC5E,kCAAgC,KAAK,uCAAuC,KAAK,KAAK,CACtF,yCAAuC,KAAK,8CAA8C,KAAK,KAAK,CACpG,2BAAyB,IAAA,GACzB,mCACkG,EAAE,CAAsE,CAC1K,GAAG,CAAC,MAAM,QAAQ,EAAW,EAAE,EAAW,QAAQ,EAAE,MAAU,MAAM,yBAAyB,CAI7F,GAHA,EAA8B,EAAA,QAAO,cAAc,EAA8B,CAC9E,GAA+B,IAClC,EAA4B,EAAA,QAAO,cAAc,EAA4B,CAC1E,GAA6B,GAAE,MAAU,MAAM,4EAA4E,CAC9H,GAAG,EAA8B,EAA4B,MAAU,MAAM,6FAA6F,CAC1K,GAAG,EAA8B,EAAW,OAAO,MAAU,MAAM,aAAa,EAA8B,yFAAyF,EAAW,OAAO,CACzN,GAAG,EAA4B,EAAW,OAAO,MAAU,MAAM,aAAa,EAA4B,yFAAyF,EAAW,OAAO,CACrN,GAAG,CAAC,IACH,EAAyB,OAAO,KAAK,EAAW,GAAa,CAAC,GAC3D,CAAC,GAAyB,MAAU,MAAM,gCAAgC,CAG9E,IAAI,EAAU,GACVC,EAA+B,EAAE,CAGrC,GADA,MAAM,KAAK,qBAAqB,CAC7B,CAAC,KAAK,SAAS,OAClB,IAAI,EAAmB,EAAW,KAAK,EAAU,IAAQ,EAA2B,CACnF,YACA,QACA,CAAC,CAAC,CACC,EAAY,MAAMC,EAAAA,kBAAkB,UACvC,EAAA,QAAO,UAAU,EAAmB,CACpC,EAAmB,KAAK,EAAS,IAAQ,EAAM,CAC/C,KACA,CAEG,EAA0B,KAAK,uBAAuB,EAA+B,EAAmB,CAAC,CAG7G,GAFG,KAAK,OAAM,QAAQ,IAAI,kCAAkC,EAA0B,CACtF,MAAM,KAAK,sBAAsB,CAC9B,CAAC,KAAK,UAAU,OAEnB,GAD4B,KAAK,UAAU,OAAO,EAA0B,CACjD,OAAO,KAAK,UAAU,iBAAiB,MAAU,MAAM,sEAAsE,CAGxJ,GADA,MAAM,KAAK,sBAAsB,CAC9B,CAAC,KAAK,UAAU,OACnB,IAAI,EAAa,KAAK,UAAU,cAAc,KAAK,UAAU,cAAc,EACvE,EAAa,KAAK,UAAU,cAAc,EAC1C,EAAsB,MAAM,KAAK,UAAU,EAA0B,CACxE,eAAe,KAAK,gCACpB,YAAY,KAAK,+BACjB,mBAAmB,KAAK,qCACxB,eACA,eACA,CAAC,CACE,EAAiB,MAAM,QAAQ,IAAwB,GAAG,CAAC,IAAwB,KAAK,GAAG,IAAwB,GACvH,GAAG,CAAC,EAAiB,eAAe,MAAU,MAAM,qCAAqC,CACtF,KAAK,OAAM,QAAQ,IAAI,oCAAoC,EAAiB,eAAe,CAC9F,IAAI,EAAyB,EAAiB,eAAe,UAAU,CAAC,QAAQ,gBAAgB,CAC7F,GAA0B,EAAE,GAA0B,GACpD,EAAyB,EAE9B,IAAI,EAAkB,EAAiB,eAAe,UAAU,CAAC,UAAU,EAAyB,CAAC,MAAM,CAGxG,KAAK,OAAM,QAAQ,IAAI,wBAAwB,EAAkB,CACpE,IAAI,EAAY,MAAM,EAAY,iBAAiB,EAAkB,EAA8B,CAChG,KAAK,OAAM,QAAQ,IAAI,0BAA0B,EAAY,CAEhE,IAAIC,EAAmB,EAAE,CAEzB,GAAG,EAAY,KAAK,GAAQ,EAAO,YAAY,MAAM,CAAC,MAAM,MAAM,CAAC,OAAO,KAAK,iCAAiC,CAAC,CAEhH,GADA,MAAM,KAAK,uBAAuB,CAC/B,CAAC,KAAK,WAAW,OACpB,GAAW,MAAM,QAAQ,WAAW,EAAY,IAAI,KAAM,IAAQ,CACjE,GAAG,CAAC,EAAO,aAAa,OAAO,EAAO,aAAc,SAAS,MAAO,GACpE,GAAG,EAAO,YAAY,MAAM,CAAC,MAAM,MAAM,CAAC,QAAQ,KAAK,iCAAiC,OAAO,EAAO,YACtG,IAAIC,EAA8E,CACjF,MAAM,EACN,IAAI,EAAO,YAAY,OACvB,CACE,GAAgC,OAAO,OAAO,EAA6B,EAAgC,EAAO,YAAY,CAAC,CAClI,EAA6B,MAAM,EAAA,QAAO,MAAM,EAAA,QAAO,cAAc,EAA6B,MAAM,CAAC,EAAE,EAAO,YAAY,OAAO,CACrI,EAA6B,IAAI,EAAA,QAAO,MAAM,EAAA,QAAO,cAAc,EAA6B,IAAI,CAAC,EAAE,EAAO,YAAY,OAAO,CACjI,IAAI,EAAsB,EAAO,YAAY,UAAU,EAA6B,MAAM,EAA6B,IAAI,CACvH,EAAc,EAAO,YAAY,UAAU,EAAE,EAA6B,MAAM,CAChF,EAAa,EAAO,YAAY,UAAU,EAA6B,IAAI,CAC3E,EAAyB,EAAc,MAAM,KAAK,CAAC,OAAO,EAAa,MAAM,KAAK,CAAC,OACnF,EAAoC,KAAK,IAAI,EAAE,IAAI,EAAyB,CAC5E,EAAyB,MAAM,KAAK,aAAa,EAA4C,CAChG,WAAW,EACX,CAAC,CAEE,EAAiB,IADG,MAAM,QAAQ,IAA2B,GAAG,CAAC,IAA2B,KAAK,GAAG,IAA2B,KAC1E,cAAc,IAAI,MAAM,KAAK,CAAC,MAAM,EAAoC,CAAC,KAAK,IAAI,CAAC,EAE5I,OADG,KAAK,OAAM,QAAQ,IAAI,yBAAyB,EAAiB,CAC7D,GACN,CAAC,EAAE,OAAO,GAAQ,EAAO,SAAS,aAAa,EAAO,MAAM,CAAC,IAAI,GAAS,EAA0C,MAAM,MAE5H,EAAU,EAAY,IAAI,GAAQ,EAAO,YAAY,CAGtD,IAAI,EAAsB,KAAK,uBAAuB,EAA2B,CAChF,qBACA,YACA,8BACA,yBAAyB,OAAO,EAAyB,CACzD,CAAC,CAAC,CAGH,GAFG,KAAK,OAAM,QAAQ,IAAI,6BAA6B,EAAsB,CACrD,KAAK,UAAU,OAAO,EAAsB,CAC7C,OAAO,KAAK,UAAU,iBAAiB,MAAU,MAAM,iEAAiE,CAC/I,IAAI,EAAa,MAAM,KAAK,UAAU,EAAsB,CAC3D,eAAe,KAAK,oBACpB,YAAY,KAAK,mBACjB,mBAAmB,KAAK,yBACxB,eACA,eACA,CAAC,CAEF,GADY,MAAM,QAAQ,IAAe,GAAG,CAAC,IAAe,KAAK,GAAG,EAAa,IAC/D,eAAe,UAAU,CAAC,MAAM,CAAC,QAAQ,gCAAiC,GAAG,CAC5F,KAAK,OAAM,QAAQ,IAAI,wBAAwB,EAAU,CAC5D,IAAI,EAAuB,EAAU,QAAQ,gBAAgB,CAM7D,GALG,GAAwB,EAAE,GAAwB,GAChD,EAAuB,EAC5B,EAAU,EAAU,UAAU,EAAuB,CAGlD,EAAU,CACZ,IAAI,EAAY,EAAgC,EAAU,CACvD,EAAY,OAAO,IAA4B,EAAY,EAAY,MAAM,EAAE,EAA4B,EAC9G,EAAmB,EAAA,QAAO,QAAQ,EAAY,IAAI,GAAY,CAC7D,IAAI,EAAkB,EAAW,KAAK,GAAW,OAAO,EAAU,GAA0B,CAAC,aAAa,GAAG,EAAW,aAAa,CAAC,CAMtI,OALG,IACH,EAAkB,EAAW,KAAK,GAAW,OAAO,EAAU,GAA0B,CAAC,aAAa,CAAC,SAAS,EAAW,aAAa,CAAC,CAAC,CACvI,KACH,EAAkB,EAAW,KAAK,GAAW,EAAW,aAAa,CAAC,SAAS,OAAO,EAAU,GAA0B,CAAC,aAAa,CAAC,CAAC,CACvI,GAAyB,EACrB,MACN,CAAC,CAqBJ,OAlBG,CAAC,MAAM,QAAQ,EAAmB,EAAE,EAAmB,QAAQ,KACjE,EAAmB,EAAA,QAAO,KAAK,EAAA,QAAO,QAAQ,EAAY,IAAI,GAAQ,CACrE,IAAI,EAAW,EAAuC,CACrD,kBAAkB,EAAO,YACzB,yBAAyB,OAAO,EAAyB,CACzD,CAAC,CACC,KAAK,OAAM,QAAQ,IAAI,iDAAiD,EAAW,CACtF,IAAI,EAAkB,EAAW,KAAK,GAAW,OAAO,EAAU,GAA0B,CAAC,aAAa,GAAG,EAAW,aAAa,CAAC,CAMtI,OALG,IACH,EAAkB,EAAW,KAAK,GAAW,OAAO,EAAU,GAA0B,CAAC,aAAa,CAAC,SAAS,EAAW,aAAa,CAAC,CAAC,CACvI,KACH,EAAkB,EAAW,KAAK,GAAW,EAAW,aAAa,CAAC,SAAS,OAAO,EAAU,GAA0B,CAAC,aAAa,CAAC,CAAC,CACvI,GAAyB,EACrB,MACN,CAAC,CAAC,CAAC,MAAM,EAA4B,EAErC,KAAK,OAAM,QAAQ,IAAI,sBAAsB,EAAmB,CAE7D,CACL,YACA,qBACA,2BAoDH,IAAA,EAAe"}

package/dist/index.d.cts

@@ -0,0 +1,134 @@
+import * as _huggingface_transformers_types_env0 from "@huggingface/transformers/types/env";
+import { FeatureExtractionPipeline, PreTrainedTokenizer, ProgressCallback, ProgressInfo, SummarizationPipeline, TextGenerationPipeline } from "@huggingface/transformers";
+import { Embeddings } from "@langchain/core/embeddings";
+
+//#region src/index.d.ts
+declare class AICompareCandidates extends Embeddings {
+  readonly env: _huggingface_transformers_types_env0.TransformersEnvironment;
+  DEBUG: boolean;
+  generator: TextGenerationPipeline | null;
+  generatorModelName: string;
+  generatorPromise: Promise<TextGenerationPipeline> | null;
+  generatorProgressInfo: ProgressInfo;
+  generatorProgressCallback: ProgressCallback | null;
+  summariser: SummarizationPipeline | null;
+  summariserModelName: string;
+  summariserPromise: Promise<SummarizationPipeline> | null;
+  summariserProgressInfo: ProgressInfo;
+  summariserProgressCallback: ProgressCallback | null;
+  embedder: FeatureExtractionPipeline | null;
+  embedderModelName: string;
+  embedderPromise: Promise<FeatureExtractionPipeline> | null;
+  embedderProgressInfo: ProgressInfo;
+  embedderProgressCallback: ProgressCallback | null;
+  tokeniser: PreTrainedTokenizer | null;
+  tokeniserModelName: string;
+  tokeniserPromise: Promise<PreTrainedTokenizer> | null;
+  tokeniserProgressInfo: ProgressInfo;
+  tokeniserProgressCallback: ProgressCallback | null;
+  generateSearchAreasMaxNewTokens: number;
+  generateSearchAreasTemperature: number;
+  generateSearchAreasRepetitionPenalty: number;
+  rankingMaxNewTokens: number;
+  rankingTemperature: number;
+  rankingRepetitionPenalty: number;
+  targetSummarisedStringTokenCount: number;
+  constructor();
+  loadGenerator({
+    progressCallback,
+    modelName
+  }?: AICompareCandidates.LoadArguments): Promise<TextGenerationPipeline>;
+  checkGeneratorLoaded(): Promise<void>;
+  loadSummariser({
+    progressCallback,
+    modelName
+  }?: AICompareCandidates.LoadArguments): Promise<SummarizationPipeline>;
+  checkSummariserLoaded(): Promise<void>;
+  loadEmbedder({
+    progressCallback,
+    modelName
+  }?: AICompareCandidates.LoadArguments): Promise<FeatureExtractionPipeline>;
+  checkEmbedderLoaded(): Promise<void>;
+  loadTokeniser({
+    progressCallback,
+    modelName
+  }?: AICompareCandidates.LoadArguments): Promise<PreTrainedTokenizer>;
+  checkTokeniserLoaded(): Promise<void>;
+  embedQuery(text: string): Promise<number[]>;
+  embedDocuments(texts: string[]): Promise<number[][]>;
+  generatePromptTemplate(prompt: string): string;
+  defaultGenerateSearchAreasInstruction(problemDescription: string): string;
+  defaultConvertCandidateToDocument<Candidate>({
+    candidate,
+    index
+  }?: AICompareCandidates.ConvertCandidateToDocumentArguments<Candidate>): string;
+  defaultGenerateRankingInstruction({
+    problemDescription,
+    summaries,
+    candidatesForFinalSelection,
+    candidateIdentifierField
+  }?: AICompareCandidates.GenerateRankingInstructionArguments): string;
+  regexIndexOf(text: string, regex: RegExp, startIndex: number): number;
+  defaultExtractIdentifierFromCandidateDocument({
+    candidateDocument,
+    candidateIdentifierField
+  }?: AICompareCandidates.ExtractIdentifierFromCandidateDocumentArguments): string;
+  defaultExtractIdentifiersFromRationale(rationale: string): string[];
+  compareCandidates<Candidate>({
+    candidates,
+    problemDescription,
+    generateSearchAreasInstruction,
+    convertCandidateToDocument,
+    candidatesForInitialSelection,
+    candidatesForFinalSelection,
+    generateRankingInstruction,
+    extractIdentifiersFromRationale,
+    extractIdentifierFromCandidateDocument,
+    candidateIdentifierField,
+    getSummarisableSubstringIndices
+  }?: AICompareCandidates.CompareArguments<Candidate>): Promise<AICompareCandidates.CompareCandidatesReturn<Candidate> | void>;
+}
+declare namespace AICompareCandidates {
+  interface LoadArguments {
+    progressCallback?: ProgressCallback;
+    modelName: string;
+  }
+  interface SummarisableSubstringIndices {
+    start: number;
+    end: number;
+  }
+  interface CompareArguments<Candidate> {
+    candidates: Candidate[];
+    problemDescription: string;
+    generateSearchAreasInstruction?: (problemDescription: string) => string;
+    convertCandidateToDocument?: (convertCandidateToDocumentArguments: ConvertCandidateToDocumentArguments<Candidate>) => string;
+    candidatesForInitialSelection?: number;
+    candidatesForFinalSelection?: number;
+    generateRankingInstruction?: (generateRankingInstructionArguments: GenerateRankingInstructionArguments) => string;
+    extractIdentifiersFromRationale?: (rationale: string) => string[];
+    extractIdentifierFromCandidateDocument?: (extractIdentifierFromCandidateDocumentArguments: ExtractIdentifierFromCandidateDocumentArguments) => string;
+    candidateIdentifierField?: keyof Candidate;
+    getSummarisableSubstringIndices?: (candidateDocument: string) => SummarisableSubstringIndices;
+  }
+  interface ConvertCandidateToDocumentArguments<Candidate> {
+    candidate: Candidate;
+    index: number;
+  }
+  interface ExtractIdentifierFromCandidateDocumentArguments {
+    candidateDocument: string;
+    candidateIdentifierField: string;
+  }
+  interface GenerateRankingInstructionArguments {
+    problemDescription: string;
+    summaries: string[];
+    candidatesForFinalSelection: number;
+    candidateIdentifierField: string;
+  }
+  interface CompareCandidatesReturn<Candidate> {
+    selectedCandidates: Candidate[];
+    rationale: string;
+  }
+}
+//#endregion
+export { AICompareCandidates, AICompareCandidates as default };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;cAiBa,mBAAA,SAA4B,UAAA;gBAAR,oCAAA,CACpB;;EADA,SAAA,EAIF,sBAJsB,GAAA,IAAA;EAAA,kBAAA,EAAA,MAAA;EAItB,gBAAA,EAEO,OAFP,CAEe,sBAFf,CAAA,GAAA,IAAA;EAEe,qBAAA,EACH,YADG;EAAR,yBAAA,EAES,gBAFT,GAAA,IAAA;EACK,UAAA,EAGX,qBAHW,GAAA,IAAA;EACI,mBAAA,EAAA,MAAA;EAEf,iBAAA,EAEO,OAFP,CAEe,qBAFf,CAAA,GAAA,IAAA;EAEe,sBAAA,EACH,YADG;EAAR,0BAAA,EAES,gBAFT,GAAA,IAAA;EACK,QAAA,EAGd,yBAHc,GAAA,IAAA;EACI,iBAAA,EAAA,MAAA;EAElB,eAAA,EAEO,OAFP,CAEe,yBAFf,CAAA,GAAA,IAAA;EAEe,oBAAA,EACH,YADG;EAAR,wBAAA,EAES,gBAFT,GAAA,IAAA;EACK,SAAA,EAGX,mBAHW,GAAA,IAAA;EACI,kBAAA,EAAA,MAAA;EAEf,gBAAA,EAEO,OAFP,CAEe,mBAFf,CAAA,GAAA,IAAA;EAEe,qBAAA,EACH,YADG;EAAR,yBAAA,EAES,gBAFT,GAAA,IAAA;EACK,+BAAA,EAAA,MAAA;EACI,8BAAA,EAAA,MAAA;EAuBzB,oCAAA,EAAA,MAAA;EACA,mBAAA,EAAA,MAAA;EACC,kBAAoB,EAAA,MAAA;EAAmD,wBAAA,EAAA,MAAA;EAAA,gCAAA,EAAA,MAAA;EAkB/C,WAAA,CAAA;EAOzB,aAAA,CAAA;IAAA,gBAAA;IAAA;EAAA,CAAA,CAAA,EAzBC,mBAAA,CAAoB,aAyBrB,CAAA,EAzBwE,OAyBxE,CAzBwE,sBAyBxE,CAAA;EACA,oBAAA,CAAA,CAAA,EARyB,OAQzB,CAAA,IAAA,CAAA;EACC,cAAA,CAAA;IAAoB,gBAAA;IAAA;EAAA,CAAA,CAAA,EAApB,mBAAA,CAAoB,aAAA,CAAA,EAAmD,OAAnD,CAAmD,qBAAnD,CAAA;EAAmD,qBAAA,CAAA,CAAA,EAkB9C,OAlB8C,CAAA,IAAA,CAAA;EAAA,YAAA,CAAA;IAAA,gBAAA;IAAA;EAAA,CAAA,CAAA,EA2BvE,mBAAA,CAAoB,aA3BmD,CAAA,EA2BA,OA3BA,CA2BA,yBA3BA,CAAA;EAkB9C,mBAAA,CAAA,CAAA,EA2BF,OA3BE,CAAA,IAAA,CAAA;EAO1B,aAAA,CAAA;IAAA,gBAAA;IAAA;EAAA,CAAA,CAAA,EA6BC,mBAAA,CAAoB,aA7BrB,CAAA,EA6BwE,OA7BxE,CA6BwE,mBA7BxE,CAAA;EACA,oBAAA,CAAA,CAAA,EA6CyB,OA7CzB,CAAA,IAAA,CAAA;EACC,UAAA,CAAA,IAAA,EAAoB,MAAA,CAAA,EAkDQ,OAlDR,CAAA,MAAA,EAAA,CAAA;EAAmD,cAAA,CAAA,KAAA,EAAA,MAAA,EAAA,CAAA,EA0DpC,OA1DoC,CAAA,MAAA,EAAA,EAAA,CAAA;EAAA,sBAAA,CAAA,MAAA,EAAA,MAAA,CAAA,EAAA,MAAA;EAkBhD,qCAAA,CAAA,kBAAA,EAAA,MAAA,CAAA,EAAA,MAAA;EAOxB,iCAAA,CAAA,SAAA,CAAA,CAAA;IAAA,SAAA;IAAA;EAAA,CAAA,CAAA,EAmDC,mBAAA,CAAoB,mCAnDrB,CAmDyD,SAnDzD,CAAA,CAAA,EAAA,MAAA;EACA,iCAAA,CAAA;IAAA,kBAAA;IAAA,SAAA;IAAA,2BAAA;IAAA;EAAA,CAAA,CAAA,EA8DC,mBAAA,CAAoB,mCA9DrB,CAAA,EAAA,MAAA;EACC,YAAA,CAAA,IAAoB,EAAA,MAAA,EAAA,KAAA,EAwES,MAxET,EAAA,UAAA,EAAA,MAAA,CAAA,EAAA,MAAA;EAAmD,6CAAA,CAAA;IAAA,iBAAA;IAAA;EAAA,CAAA,CAAA,EAgFvE,mBAAA,CAAoB,+CAhFmD,CAAA,EAAA,MAAA;EAAA,sCAAA,CAAA,SAAA,EAAA,MAAA,CAAA,EAAA,MAAA,EAAA;EAiB/C,iBAAA,CAAA,SAAA,CAAA,CAAA;IAAA,UAAA;IAAA,kBAAA;IAAA,8BAAA;IAAA,0BAAA;IAAA,6BAAA;IAAA,2BAAA;IAAA,0BAAA;IAAA,+BAAA;IAAA,sCAAA;IAAA,wBAAA;IAAA;EAAA,CAAA,CAAA,EA0GxB,mBAAA,CAAoB,gBA1GI,CA0Ga,SA1Gb,CAAA,CAAA,EA0G6E,OA1G7E,CA0GqF,mBAAA,CAAoB,uBA1GzG,CA0GiI,SA1GjI,CAAA,GAAA,IAAA,CAAA;;AAcW,kBAyPrB,mBAAA,CAzPqB;EAgBpC,UAAA,aAAA,CAAA;IACA,gBAAA,CAAA,EA0OkB,gBA1OlB;IACyD,SAAA,EAAA,MAAA;EAAxD;EAQD,UAAA,4BAAA,CAAA;IACA,KAAA,EAAA,MAAA;IACA,GAAA,EAAA,MAAA;EACA;EACC,UAAA,gBAAoB,CAAA,SAAA,CAAA,CAAA;IAWS,UAAA,EA4NnB,SA5NmB,EAAA;IAM9B,kBAAA,EAAA,MAAA;IACA,8BAAA,CAAA,EAAA,CAAA,kBAAA,EAAA,MAAA,EAAA,GAAA,MAAA;IACC,0BAAoB,CAAA,EAAA,CAAA,mCAAA,EAuN4C,mCAvN5C,CAuNgF,SAvNhF,CAAA,EAAA,GAAA,MAAA;IAgCrB,6BAAA,CAAA,EAAA,MAAA;IACA,2BAAA,CAAA,EAAA,MAAA;IACA,0BAAA,CAAA,EAAA,CAAA,mCAAA,EAwLiE,mCAxLjE,EAAA,GAAA,MAAA;IACA,+BAAA,CAAA,EAAA,CAAA,SAAA,EAAA,MAAA,EAAA,GAAA,MAAA,EAAA;IACA,sCAAA,CAAA,EAAA,CAAA,+CAAA,EAwLyF,+CAxLzF,EAAA,GAAA,MAAA;IACA,wBAAA,CAAA,EAAA,MAwLgC,SAxLhC;IACA,+BAAA,CAAA,EAAA,CAAA,iBAAA,EAAA,MAAA,EAAA,GAwL6D,4BAxL7D;EACA;EACA,UAAA,mCAAA,CAAA,SAAA,CAAA,CAAA;IACA,SAAA,EAyLU,SAzLV;IACA,KAAA,EAAA,MAAA;EACsC;EAArC,UAAA,+CAAoB,CAAA;IAAqI,iBAAA,EAAA,MAAA;IAA5C,wBAAoB,EAAA,MAAA;EAA5B;EA/P/D,UAAA,mCAAA,CAAA;IAAU,kBAAA,EAAA,MAAA;IA4ZlC,SAAA,EAAA,MAAA,EAAmB;IAEhB,2BAAA,EAAA,MAAA;IAUP,wBAAA,EAAA,MAAA;EAG0F;EAApC,UAAA,uBAAA,CAAA,SAAA,CAAA,CAAA;IAGA,kBAAA,EAyB9C,SAzB8C,EAAA;IAEwB,SAAA,EAAA,MAAA;EACzD"}

package/dist/index.d.mts

@@ -0,0 +1,134 @@
+import { FeatureExtractionPipeline, PreTrainedTokenizer, ProgressCallback, ProgressInfo, SummarizationPipeline, TextGenerationPipeline } from "@huggingface/transformers";
+import { Embeddings } from "@langchain/core/embeddings";
+import * as _huggingface_transformers_types_env0 from "@huggingface/transformers/types/env";
+
+//#region src/index.d.ts
+declare class AICompareCandidates extends Embeddings {
+  readonly env: _huggingface_transformers_types_env0.TransformersEnvironment;
+  DEBUG: boolean;
+  generator: TextGenerationPipeline | null;
+  generatorModelName: string;
+  generatorPromise: Promise<TextGenerationPipeline> | null;
+  generatorProgressInfo: ProgressInfo;
+  generatorProgressCallback: ProgressCallback | null;
+  summariser: SummarizationPipeline | null;
+  summariserModelName: string;
+  summariserPromise: Promise<SummarizationPipeline> | null;
+  summariserProgressInfo: ProgressInfo;
+  summariserProgressCallback: ProgressCallback | null;
+  embedder: FeatureExtractionPipeline | null;
+  embedderModelName: string;
+  embedderPromise: Promise<FeatureExtractionPipeline> | null;
+  embedderProgressInfo: ProgressInfo;
+  embedderProgressCallback: ProgressCallback | null;
+  tokeniser: PreTrainedTokenizer | null;
+  tokeniserModelName: string;
+  tokeniserPromise: Promise<PreTrainedTokenizer> | null;
+  tokeniserProgressInfo: ProgressInfo;
+  tokeniserProgressCallback: ProgressCallback | null;
+  generateSearchAreasMaxNewTokens: number;
+  generateSearchAreasTemperature: number;
+  generateSearchAreasRepetitionPenalty: number;
+  rankingMaxNewTokens: number;
+  rankingTemperature: number;
+  rankingRepetitionPenalty: number;
+  targetSummarisedStringTokenCount: number;
+  constructor();
+  loadGenerator({
+    progressCallback,
+    modelName
+  }?: AICompareCandidates.LoadArguments): Promise<TextGenerationPipeline>;
+  checkGeneratorLoaded(): Promise<void>;
+  loadSummariser({
+    progressCallback,
+    modelName
+  }?: AICompareCandidates.LoadArguments): Promise<SummarizationPipeline>;
+  checkSummariserLoaded(): Promise<void>;
+  loadEmbedder({
+    progressCallback,
+    modelName
+  }?: AICompareCandidates.LoadArguments): Promise<FeatureExtractionPipeline>;
+  checkEmbedderLoaded(): Promise<void>;
+  loadTokeniser({
+    progressCallback,
+    modelName
+  }?: AICompareCandidates.LoadArguments): Promise<PreTrainedTokenizer>;
+  checkTokeniserLoaded(): Promise<void>;
+  embedQuery(text: string): Promise<number[]>;
+  embedDocuments(texts: string[]): Promise<number[][]>;
+  generatePromptTemplate(prompt: string): string;
+  defaultGenerateSearchAreasInstruction(problemDescription: string): string;
+  defaultConvertCandidateToDocument<Candidate>({
+    candidate,
+    index
+  }?: AICompareCandidates.ConvertCandidateToDocumentArguments<Candidate>): string;
+  defaultGenerateRankingInstruction({
+    problemDescription,
+    summaries,
+    candidatesForFinalSelection,
+    candidateIdentifierField
+  }?: AICompareCandidates.GenerateRankingInstructionArguments): string;
+  regexIndexOf(text: string, regex: RegExp, startIndex: number): number;
+  defaultExtractIdentifierFromCandidateDocument({
+    candidateDocument,
+    candidateIdentifierField
+  }?: AICompareCandidates.ExtractIdentifierFromCandidateDocumentArguments): string;
+  defaultExtractIdentifiersFromRationale(rationale: string): string[];
+  compareCandidates<Candidate>({
+    candidates,
+    problemDescription,
+    generateSearchAreasInstruction,
+    convertCandidateToDocument,
+    candidatesForInitialSelection,
+    candidatesForFinalSelection,
+    generateRankingInstruction,
+    extractIdentifiersFromRationale,
+    extractIdentifierFromCandidateDocument,
+    candidateIdentifierField,
+    getSummarisableSubstringIndices
+  }?: AICompareCandidates.CompareArguments<Candidate>): Promise<AICompareCandidates.CompareCandidatesReturn<Candidate> | void>;
+}
+declare namespace AICompareCandidates {
+  interface LoadArguments {
+    progressCallback?: ProgressCallback;
+    modelName: string;
+  }
+  interface SummarisableSubstringIndices {
+    start: number;
+    end: number;
+  }
+  interface CompareArguments<Candidate> {
+    candidates: Candidate[];
+    problemDescription: string;
+    generateSearchAreasInstruction?: (problemDescription: string) => string;
+    convertCandidateToDocument?: (convertCandidateToDocumentArguments: ConvertCandidateToDocumentArguments<Candidate>) => string;
+    candidatesForInitialSelection?: number;
+    candidatesForFinalSelection?: number;
+    generateRankingInstruction?: (generateRankingInstructionArguments: GenerateRankingInstructionArguments) => string;
+    extractIdentifiersFromRationale?: (rationale: string) => string[];
+    extractIdentifierFromCandidateDocument?: (extractIdentifierFromCandidateDocumentArguments: ExtractIdentifierFromCandidateDocumentArguments) => string;
+    candidateIdentifierField?: keyof Candidate;
+    getSummarisableSubstringIndices?: (candidateDocument: string) => SummarisableSubstringIndices;
+  }
+  interface ConvertCandidateToDocumentArguments<Candidate> {
+    candidate: Candidate;
+    index: number;
+  }
+  interface ExtractIdentifierFromCandidateDocumentArguments {
+    candidateDocument: string;
+    candidateIdentifierField: string;
+  }
+  interface GenerateRankingInstructionArguments {
+    problemDescription: string;
+    summaries: string[];
+    candidatesForFinalSelection: number;
+    candidateIdentifierField: string;
+  }
+  interface CompareCandidatesReturn<Candidate> {
+    selectedCandidates: Candidate[];
+    rationale: string;
+  }
+}
+//#endregion
+export { AICompareCandidates, AICompareCandidates as default };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;cAiBa,mBAAA,SAA4B,UAAA;gBAAR,oCAAA,CACpB;;EADA,SAAA,EAIF,sBAJsB,GAAA,IAAA;EAAA,kBAAA,EAAA,MAAA;EAItB,gBAAA,EAEO,OAFP,CAEe,sBAFf,CAAA,GAAA,IAAA;EAEe,qBAAA,EACH,YADG;EAAR,yBAAA,EAES,gBAFT,GAAA,IAAA;EACK,UAAA,EAGX,qBAHW,GAAA,IAAA;EACI,mBAAA,EAAA,MAAA;EAEf,iBAAA,EAEO,OAFP,CAEe,qBAFf,CAAA,GAAA,IAAA;EAEe,sBAAA,EACH,YADG;EAAR,0BAAA,EAES,gBAFT,GAAA,IAAA;EACK,QAAA,EAGd,yBAHc,GAAA,IAAA;EACI,iBAAA,EAAA,MAAA;EAElB,eAAA,EAEO,OAFP,CAEe,yBAFf,CAAA,GAAA,IAAA;EAEe,oBAAA,EACH,YADG;EAAR,wBAAA,EAES,gBAFT,GAAA,IAAA;EACK,SAAA,EAGX,mBAHW,GAAA,IAAA;EACI,kBAAA,EAAA,MAAA;EAEf,gBAAA,EAEO,OAFP,CAEe,mBAFf,CAAA,GAAA,IAAA;EAEe,qBAAA,EACH,YADG;EAAR,yBAAA,EAES,gBAFT,GAAA,IAAA;EACK,+BAAA,EAAA,MAAA;EACI,8BAAA,EAAA,MAAA;EAuBzB,oCAAA,EAAA,MAAA;EACA,mBAAA,EAAA,MAAA;EACC,kBAAoB,EAAA,MAAA;EAAmD,wBAAA,EAAA,MAAA;EAAA,gCAAA,EAAA,MAAA;EAkB/C,WAAA,CAAA;EAOzB,aAAA,CAAA;IAAA,gBAAA;IAAA;EAAA,CAAA,CAAA,EAzBC,mBAAA,CAAoB,aAyBrB,CAAA,EAzBwE,OAyBxE,CAzBwE,sBAyBxE,CAAA;EACA,oBAAA,CAAA,CAAA,EARyB,OAQzB,CAAA,IAAA,CAAA;EACC,cAAA,CAAA;IAAoB,gBAAA;IAAA;EAAA,CAAA,CAAA,EAApB,mBAAA,CAAoB,aAAA,CAAA,EAAmD,OAAnD,CAAmD,qBAAnD,CAAA;EAAmD,qBAAA,CAAA,CAAA,EAkB9C,OAlB8C,CAAA,IAAA,CAAA;EAAA,YAAA,CAAA;IAAA,gBAAA;IAAA;EAAA,CAAA,CAAA,EA2BvE,mBAAA,CAAoB,aA3BmD,CAAA,EA2BA,OA3BA,CA2BA,yBA3BA,CAAA;EAkB9C,mBAAA,CAAA,CAAA,EA2BF,OA3BE,CAAA,IAAA,CAAA;EAO1B,aAAA,CAAA;IAAA,gBAAA;IAAA;EAAA,CAAA,CAAA,EA6BC,mBAAA,CAAoB,aA7BrB,CAAA,EA6BwE,OA7BxE,CA6BwE,mBA7BxE,CAAA;EACA,oBAAA,CAAA,CAAA,EA6CyB,OA7CzB,CAAA,IAAA,CAAA;EACC,UAAA,CAAA,IAAA,EAAoB,MAAA,CAAA,EAkDQ,OAlDR,CAAA,MAAA,EAAA,CAAA;EAAmD,cAAA,CAAA,KAAA,EAAA,MAAA,EAAA,CAAA,EA0DpC,OA1DoC,CAAA,MAAA,EAAA,EAAA,CAAA;EAAA,sBAAA,CAAA,MAAA,EAAA,MAAA,CAAA,EAAA,MAAA;EAkBhD,qCAAA,CAAA,kBAAA,EAAA,MAAA,CAAA,EAAA,MAAA;EAOxB,iCAAA,CAAA,SAAA,CAAA,CAAA;IAAA,SAAA;IAAA;EAAA,CAAA,CAAA,EAmDC,mBAAA,CAAoB,mCAnDrB,CAmDyD,SAnDzD,CAAA,CAAA,EAAA,MAAA;EACA,iCAAA,CAAA;IAAA,kBAAA;IAAA,SAAA;IAAA,2BAAA;IAAA;EAAA,CAAA,CAAA,EA8DC,mBAAA,CAAoB,mCA9DrB,CAAA,EAAA,MAAA;EACC,YAAA,CAAA,IAAoB,EAAA,MAAA,EAAA,KAAA,EAwES,MAxET,EAAA,UAAA,EAAA,MAAA,CAAA,EAAA,MAAA;EAAmD,6CAAA,CAAA;IAAA,iBAAA;IAAA;EAAA,CAAA,CAAA,EAgFvE,mBAAA,CAAoB,+CAhFmD,CAAA,EAAA,MAAA;EAAA,sCAAA,CAAA,SAAA,EAAA,MAAA,CAAA,EAAA,MAAA,EAAA;EAiB/C,iBAAA,CAAA,SAAA,CAAA,CAAA;IAAA,UAAA;IAAA,kBAAA;IAAA,8BAAA;IAAA,0BAAA;IAAA,6BAAA;IAAA,2BAAA;IAAA,0BAAA;IAAA,+BAAA;IAAA,sCAAA;IAAA,wBAAA;IAAA;EAAA,CAAA,CAAA,EA0GxB,mBAAA,CAAoB,gBA1GI,CA0Ga,SA1Gb,CAAA,CAAA,EA0G6E,OA1G7E,CA0GqF,mBAAA,CAAoB,uBA1GzG,CA0GiI,SA1GjI,CAAA,GAAA,IAAA,CAAA;;AAcW,kBAyPrB,mBAAA,CAzPqB;EAgBpC,UAAA,aAAA,CAAA;IACA,gBAAA,CAAA,EA0OkB,gBA1OlB;IACyD,SAAA,EAAA,MAAA;EAAxD;EAQD,UAAA,4BAAA,CAAA;IACA,KAAA,EAAA,MAAA;IACA,GAAA,EAAA,MAAA;EACA;EACC,UAAA,gBAAoB,CAAA,SAAA,CAAA,CAAA;IAWS,UAAA,EA4NnB,SA5NmB,EAAA;IAM9B,kBAAA,EAAA,MAAA;IACA,8BAAA,CAAA,EAAA,CAAA,kBAAA,EAAA,MAAA,EAAA,GAAA,MAAA;IACC,0BAAoB,CAAA,EAAA,CAAA,mCAAA,EAuN4C,mCAvN5C,CAuNgF,SAvNhF,CAAA,EAAA,GAAA,MAAA;IAgCrB,6BAAA,CAAA,EAAA,MAAA;IACA,2BAAA,CAAA,EAAA,MAAA;IACA,0BAAA,CAAA,EAAA,CAAA,mCAAA,EAwLiE,mCAxLjE,EAAA,GAAA,MAAA;IACA,+BAAA,CAAA,EAAA,CAAA,SAAA,EAAA,MAAA,EAAA,GAAA,MAAA,EAAA;IACA,sCAAA,CAAA,EAAA,CAAA,+CAAA,EAwLyF,+CAxLzF,EAAA,GAAA,MAAA;IACA,wBAAA,CAAA,EAAA,MAwLgC,SAxLhC;IACA,+BAAA,CAAA,EAAA,CAAA,iBAAA,EAAA,MAAA,EAAA,GAwL6D,4BAxL7D;EACA;EACA,UAAA,mCAAA,CAAA,SAAA,CAAA,CAAA;IACA,SAAA,EAyLU,SAzLV;IACA,KAAA,EAAA,MAAA;EACsC;EAArC,UAAA,+CAAoB,CAAA;IAAqI,iBAAA,EAAA,MAAA;IAA5C,wBAAoB,EAAA,MAAA;EAA5B;EA/P/D,UAAA,mCAAA,CAAA;IAAU,kBAAA,EAAA,MAAA;IA4ZlC,SAAA,EAAA,MAAA,EAAmB;IAEhB,2BAAA,EAAA,MAAA;IAUP,wBAAA,EAAA,MAAA;EAG0F;EAApC,UAAA,uBAAA,CAAA,SAAA,CAAA,CAAA;IAGA,kBAAA,EAyB9C,SAzB8C,EAAA;IAEwB,SAAA,EAAA,MAAA;EACzD"}

package/dist/index.mjs

@@ -0,0 +1,24 @@
+import{AutoTokenizer as e,env as t,pipeline as n}from"@huggingface/transformers";import{MemoryVectorStore as r}from"@langchain/classic/vectorstores/memory";import{Embeddings as i}from"@langchain/core/embeddings";import a from"lodash";import o from"jsan";var s=class extends i{env=t;DEBUG=!0;generator=null;generatorModelName=`Xenova/LaMini-GPT-774M`;generatorPromise=null;generatorProgressInfo={};generatorProgressCallback=null;summariser=null;summariserModelName=`Xenova/distilbart-cnn-12-6`;summariserPromise=null;summariserProgressInfo={};summariserProgressCallback=null;embedder=null;embedderModelName=`Xenova/all-MiniLM-L12-v2`;embedderPromise=null;embedderProgressInfo={};embedderProgressCallback=null;tokeniser=null;tokeniserModelName=this.generatorModelName;tokeniserPromise=null;tokeniserProgressInfo={};tokeniserProgressCallback=null;generateSearchAreasMaxNewTokens=64;generateSearchAreasTemperature=.35;generateSearchAreasRepetitionPenalty=1.5;rankingMaxNewTokens=64;rankingTemperature=.35;rankingRepetitionPenalty=1.5;targetSummarisedStringTokenCount=420;static{t.localModelPath=``,t.allowRemoteModels=!0,t.allowLocalModels=!1}constructor(){super({})}async loadGenerator({progressCallback:e,modelName:t=``}={}){if(typeof t==`string`&&t&&(this.generatorModelName=t),!this.generatorModelName)throw Error(`Invalid generator model name`);return e&&(this.generatorProgressCallback=e),this.generatorPromise=n(`text-generation`,this.generatorModelName,{device:`webgpu`,progress_callback:e=>(this.DEBUG&&console.log(o.stringify(e)),Object.assign(this.generatorProgressInfo,e),this.generatorProgressCallback?.(e))}),this.generator=await this.generatorPromise,this.generator}async checkGeneratorLoaded(){if(this.generatorPromise||this.loadGenerator(),this.generator||await this.generatorPromise,!this.generator)throw Error(`Unable to load generator`)}async loadSummariser({progressCallback:e,modelName:t=``}={}){if(typeof t==`string`&&t&&(this.summariserModelName=t),!this.summariserModelName)throw Error(`Invalid summariser model name`);return e&&(this.summariserProgressCallback=e),this.summariserPromise=n(`summarization`,this.summariserModelName,{device:`webgpu`,progress_callback:e=>(this.DEBUG&&console.log(o.stringify(e)),Object.assign(this.summariserProgressInfo,e),this.summariserProgressCallback?.(e))}),this.summariser=await this.summariserPromise,this.summariser}async checkSummariserLoaded(){if(this.summariserPromise||this.loadSummariser(),this.summariser||await this.summariserPromise,!this.summariser)throw Error(`Unable to load summariser`)}async loadEmbedder({progressCallback:e,modelName:t=``}={}){if(typeof t==`string`&&t&&(this.embedderModelName=t),!this.embedderModelName)throw Error(`Invalid embedder model name`);return e&&(this.embedderProgressCallback=e),this.embedderPromise=n(`feature-extraction`,this.embedderModelName,{device:`webgpu`,progress_callback:e=>(this.DEBUG&&console.log(o.stringify(e)),Object.assign(this.embedderProgressInfo,e),this.embedderProgressCallback?.(e))}),this.embedder=await this.embedderPromise,this.embedder}async checkEmbedderLoaded(){if(this.embedderPromise||this.loadEmbedder(),this.embedder||await this.embedderPromise,!this.embedder)throw Error(`Unable to load embedder`)}async loadTokeniser({progressCallback:t,modelName:n=``}={}){if(typeof n==`string`&&n&&(this.tokeniserModelName=n),!this.tokeniserModelName)throw Error(`Invalid tokeniser model name`);return t&&(this.tokeniserProgressCallback=t),this.tokeniserPromise=e.from_pretrained(this.tokeniserModelName,{progress_callback:e=>(this.DEBUG&&console.log(o.stringify(e)),Object.assign(this.tokeniserProgressInfo,e),this.tokeniserProgressCallback?.(e))}),this.tokeniser=await this.tokeniserPromise,this.tokeniser}async checkTokeniserLoaded(){if(this.tokeniserPromise||this.loadTokeniser(),this.tokeniser||await this.tokeniserPromise,!this.tokeniser)throw Error(`Unable to load tokeniser`)}async embedQuery(e){return await this.checkEmbedderLoaded(),Array.from((await this.embedder?.(e,{pooling:`mean`,normalize:!0}))?.data)}async embedDocuments(e){return Promise.all(e.map(e=>this.embedQuery(e)))}generatePromptTemplate(e){return`Below is an instruction that describes a task. Write a response that appropriately completes the request.
+
+### Instruction:
+`+e+`
+
+### Response:`}defaultGenerateSearchAreasInstruction(e){return`List the relevant subject areas for the following issues. Limit your response to 100 words.
+Issues: "`+e+`"`}defaultConvertCandidateToDocument({candidate:e,index:t}={}){let n=`Start of Candidate #`+t;for(let t in e)n+=`
+`+a.startCase(t)+`: `+(typeof e[t]==`object`?o.stringify(e[t]):String(e[t]));return n+=`
+End of Candidate #`+t,n}defaultGenerateRankingInstruction({problemDescription:e,summaries:t,candidatesForFinalSelection:n,candidateIdentifierField:r}={}){return`Strictly follow these rules:
+1. Rank ONLY the top `+n+` candidates with one 15-word sentence explaining why
+2. Rank the candidates based on "`+e.replace(/(\r|\n)/g,` `)+`"
+3. If unclear, say "Insufficient information to determine"
+
+Candidates:
+
+`+t.join(`
+
+`)+`
+
+Format exactly:
+#1. "Full `+a.startCase(r)+`": 15-word explanation
+#2. ...`}regexIndexOf(e,t,n){let r=e.slice(n).search(t);return r<0?r:r+n}defaultExtractIdentifierFromCandidateDocument({candidateDocument:e,candidateIdentifierField:t}={}){this.DEBUG&&console.log(e,t);let n=a.startCase(t),r=e.indexOf(n);if(r<0&&(r=e.toLowerCase().indexOf(n.toLowerCase())),this.DEBUG&&console.log(r),r>=0&&(r+=n.length),r<0&&(r=e.toLowerCase().indexOf(t.toLowerCase()),r>=0&&(r+=t.length)),this.DEBUG)console.log(r);else return``;if(r=e.indexOf(`:`,r),this.DEBUG&&console.log(r),r<0&&(r=this.regexIndexOf(e,/\s+/,r)),this.DEBUG&&console.log(r),r<0)return``;let i=e.indexOf(`
+`,r);return i<0&&(i=e.length),this.DEBUG&&console.log(i),e.substring(r,i).trim()}defaultExtractIdentifiersFromRationale(e){let t=/^\s*#\s*\d+\s*\.?\s*"([^"]+)"/gm,n=[];for(let r;Array.isArray(r=t.exec(e));)r[1]&&n.push(r[1]);return n}async compareCandidates({candidates:e,problemDescription:t=``,generateSearchAreasInstruction:n=this.defaultGenerateSearchAreasInstruction.bind(this),convertCandidateToDocument:i=this.defaultConvertCandidateToDocument.bind(this),candidatesForInitialSelection:o=2,candidatesForFinalSelection:s=1,generateRankingInstruction:c=this.defaultGenerateRankingInstruction.bind(this),extractIdentifiersFromRationale:l=this.defaultExtractIdentifiersFromRationale.bind(this),extractIdentifierFromCandidateDocument:u=this.defaultExtractIdentifierFromCandidateDocument.bind(this),candidateIdentifierField:d=void 0,getSummarisableSubstringIndices:f}={}){if(!Array.isArray(e)||e.length<=0)throw Error(`No candidates provided`);if(o=a.toSafeInteger(o),o<=0||(s=a.toSafeInteger(s),s<=0))throw Error(`Candidates for initial selection must be a positive integer bigger than 0`);if(o<s)throw Error(`Candidates for initial selection must be equal or more than candidates for final selection`);if(o>e.length)throw Error(`There are `+o+`candidates for initial selection which is more than the total number of candidates of `+e.length);if(s>e.length)throw Error(`There are `+s+`candidates for initial selection which is more than the total number of candidates of `+e.length);if(!d&&(d=Object.keys(e[0])[0],!d))throw Error(`No candidate identifier field`);let p=``,m=[];if(await this.checkEmbedderLoaded(),!this.embedder)return;let h=e.map((e,t)=>i({candidate:e,index:t})),g=await r.fromTexts(a.cloneDeep(h),h.map((e,t)=>t),this),_=this.generatePromptTemplate(n(t));if(this.DEBUG&&console.log(`Formatted search areas prompt: `+_),await this.checkTokeniserLoaded(),!this.tokeniser)return;if(this.tokeniser.encode(_).length>this.tokeniser.model_max_length)throw Error(`Search areas instruction prompt is too long for the tokeniser model`);if(await this.checkGeneratorLoaded(),!this.generator)return;let v=this.tokeniser.pad_token_id??this.tokeniser.sep_token_id??0,y=this.tokeniser.sep_token_id??2,b=await this.generator(_,{max_new_tokens:this.generateSearchAreasMaxNewTokens,temperature:this.generateSearchAreasTemperature,repetition_penalty:this.generateSearchAreasRepetitionPenalty,pad_token_id:v,eos_token_id:y}),x=Array.isArray(b?.[0])?b?.[0]?.[0]:b?.[0];if(!x.generated_text)throw Error(`No generated text for search areas`);this.DEBUG&&console.log(`Generated search areas response: `+x.generated_text);let S=x.generated_text.toString().indexOf(`### Response:`);S>=0?S+=13:S=0;let C=x.generated_text.toString().substring(S).trim();this.DEBUG&&console.log(`Vector search query: `+C);let w=await g.similaritySearch(C,o);this.DEBUG&&console.log(`Vector search results: `,w);let T=[];if(w.some(e=>e.pageContent.trim().split(/\s+/).length>this.targetSummarisedStringTokenCount)){if(await this.checkSummariserLoaded(),!this.summariser)return;T=(await Promise.allSettled(w.map(async e=>{if(!e.pageContent||typeof e.pageContent!=`string`)return``;if(e.pageContent.trim().split(/\s+/).length<=this.targetSummarisedStringTokenCount)return e.pageContent;let t={start:0,end:e.pageContent.length};f&&Object.assign(t,f(e.pageContent)),t.start=a.clamp(a.toSafeInteger(t.start),0,e.pageContent.length),t.end=a.clamp(a.toSafeInteger(t.end),0,e.pageContent.length);let n=e.pageContent.substring(t.start,t.end),r=e.pageContent.substring(0,t.start),i=e.pageContent.substring(t.end),o=r.split(/s+/).length+i.split(/s+/).length,s=Math.max(1,420-o),c=await this.summariser?.(n,{max_length:s}),l=r+((Array.isArray(c?.[0])?c?.[0]?.[0]:c?.[0])?.summary_text??``).split(/s+/).slice(s).join(` `)+i;return this.DEBUG&&console.log(`Summarised candidate: `+l),l}))).filter(e=>e.status===`fulfilled`&&e.value).map(e=>e.value)}else T=w.map(e=>e.pageContent);let E=this.generatePromptTemplate(c({problemDescription:t,summaries:T,candidatesForFinalSelection:s,candidateIdentifierField:String(d)}));if(this.DEBUG&&console.log(`Formatted ranking prompt: `+E),this.tokeniser.encode(E).length>this.tokeniser.model_max_length)throw Error(`Ranking instruction prompt is too long for the tokeniser model`);let D=await this.generator(E,{max_new_tokens:this.rankingMaxNewTokens,temperature:this.rankingTemperature,repetition_penalty:this.rankingRepetitionPenalty,pad_token_id:v,eos_token_id:y});p=(Array.isArray(D?.[0])?D?.[0]?.[0]:D[0]).generated_text.toString().trim().replace(/(\*\*)|(<\/?s>)|(\[.*?\])\s*/g,``),this.DEBUG&&console.log(`Generated rationale: `+p);let O=p.indexOf(`### Response:`);if(O>=0?O+=13:O=0,p=p.substring(O),p){let t=l(p);t.length>s&&(t=t.slice(0,s)),m=a.compact(t.map(t=>{let n=e.find(e=>String(e[d]).toLowerCase()===t.toLowerCase());return n||(n=e.find(e=>String(e[d]).toLowerCase().includes(t.toLowerCase())),n)||(n=e.find(e=>t.toLowerCase().includes(String(e[d]).toLowerCase())),n)?n:null}))}return(!Array.isArray(m)||m.length<=0)&&(m=a.uniq(a.compact(w.map(t=>{let n=u({candidateDocument:t.pageContent,candidateIdentifierField:String(d)});this.DEBUG&&console.log(`Extracted identifier from candidate document: `+n);let r=e.find(e=>String(e[d]).toLowerCase()===n.toLowerCase());return r||(r=e.find(e=>String(e[d]).toLowerCase().includes(n.toLowerCase())),r)||(r=e.find(e=>n.toLowerCase().includes(String(e[d]).toLowerCase())),r)?r:null}))).slice(s)),this.DEBUG&&console.log(`Selected candidates`,m),{rationale:p,selectedCandidates:m}}};(function(e){})(s||={});var c=s;export{s as AICompareCandidates,c as default};
+//# sourceMappingURL=index.mjs.map