docs: update README

tak-bro · Jul 25, 2024 · 40d93a8 · 40d93a8
1 parent 0c837e3
commit 40d93a8
Show file tree

Hide file tree

Showing 13 changed files with 323 additions and 291 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -50,14 +50,6 @@ node ./dist/cli.mjs
 
 ## Testing
 
-Testing requires passing in `OPENAI_KEY` as an environment variable:
-
-```sh
-OPENAI_KEY=<your OPENAI key> pnpm test
-```
-
-You can still run tests that don't require `OPENAI_KEY` but will not test the main functionality:
-
 ```
 pnpm test
 ```

diff --git a/README.md b/README.md
diff --git a/package.json b/package.json
@@ -27,7 +27,9 @@
         "llm",
         "chatgpt",
         "cohere",
-        "groq"
+        "groq",
+        "aipick",
+        "aip"
     ],
     "license": "MIT",
     "repository": "tak-bro/aipick",

diff --git a/src/services/ai/anthropic.service.ts b/src/services/ai/anthropic.service.ts
@@ -59,7 +59,7 @@ export class AnthropicService extends AIService {
             const generatedSystemPrompt = generatePrompt(promptOptions);
 
             const params: Anthropic.MessageCreateParams = {
-                max_tokens: this.params.config['max-tokens'],
+                max_tokens: this.params.config.maxTokens,
                 temperature,
                 system: generatedSystemPrompt,
                 messages: [

diff --git a/src/services/ai/codestral.service.ts b/src/services/ai/codestral.service.ts
@@ -106,7 +106,7 @@ export class CodestralService extends AIService {
                 ],
                 temperature: this.params.config.temperature,
                 top_p: 1,
-                max_tokens: this.params.config['max-tokens'],
+                max_tokens: this.params.config.maxTokens,
                 stream: false,
                 safe_prompt: false,
                 random_seed: getRandomNumber(10, 1000),

diff --git a/src/services/ai/cohere.service.ts b/src/services/ai/cohere.service.ts
@@ -51,7 +51,7 @@ export class CohereService extends AIService {
                 systemPromptPath,
             };
             const generatedSystemPrompt = generatePrompt(promptOptions);
-            const maxTokens = this.params.config['max-tokens'];
+            const maxTokens = this.params.config.maxTokens;
 
             const prediction = await this.cohere.chat({
                 chatHistory: [{ role: 'SYSTEM', message: generatedSystemPrompt }],

diff --git a/src/services/ai/gemini.service.ts b/src/services/ai/gemini.service.ts
@@ -40,8 +40,8 @@ export class GeminiService extends AIService {
     private async generateResponses(): Promise<AIResponse[]> {
         try {
             const userMessage = this.params.userMessage;
-            const { systemPrompt, systemPromptPath, logging, temperature } = this.params.config;
-            const maxTokens = this.params.config['max-tokens'];
+            const { systemPrompt, systemPromptPath, logging } = this.params.config;
+            const maxTokens = this.params.config.maxTokens;
             const promptOptions: PromptOptions = {
                 ...DEFAULT_PROMPT_OPTIONS,
                 userMessage,

diff --git a/src/services/ai/groq.service.ts b/src/services/ai/groq.service.ts
@@ -42,7 +42,7 @@ export class GroqService extends AIService {
         try {
             const userMessage = this.params.userMessage;
             const { systemPrompt, systemPromptPath, logging, temperature } = this.params.config;
-            const maxTokens = this.params.config['max-tokens'];
+            const maxTokens = this.params.config.maxTokens;
             const promptOptions: PromptOptions = {
                 ...DEFAULT_PROMPT_OPTIONS,
                 userMessage,

diff --git a/src/services/ai/hugging-face.service.ts b/src/services/ai/hugging-face.service.ts
@@ -95,7 +95,7 @@ export class HuggingFaceService extends AIService {
             await this.intialize();
 
             const userMessage = this.params.userMessage;
-            const { systemPrompt, systemPromptPath, logging, temperature } = this.params.config;
+            const { systemPrompt, systemPromptPath, logging } = this.params.config;
             const promptOptions: PromptOptions = {
                 ...DEFAULT_PROMPT_OPTIONS,
                 userMessage,

diff --git a/src/services/ai/mistral.service.ts b/src/services/ai/mistral.service.ts
@@ -154,7 +154,7 @@ export class MistralService extends AIService {
                 ],
                 temperature: this.params.config.temperature,
                 top_p: 1,
-                max_tokens: this.params.config['max-tokens'],
+                max_tokens: this.params.config.maxTokens,
                 stream: false,
                 safe_prompt: false,
                 random_seed: getRandomNumber(10, 1000),

diff --git a/src/services/ai/ollama.service.ts b/src/services/ai/ollama.service.ts
@@ -70,7 +70,7 @@ export class OllamaService extends AIService {
     private async generateMessages(): Promise<AIResponse[]> {
         try {
             const userMessage = this.params.userMessage;
-            const { systemPrompt, systemPromptPath, logging, temperature } = this.params.config;
+            const { systemPrompt, systemPromptPath, logging } = this.params.config;
             const promptOptions: PromptOptions = {
                 ...DEFAULT_PROMPT_OPTIONS,
                 userMessage,
@@ -97,7 +97,7 @@ export class OllamaService extends AIService {
             const response = await new HttpRequestBuilder({
                 method: 'GET',
                 baseURL: `${this.host}`,
-                timeout: this.params.config.OLLAMA_TIMEOUT,
+                timeout: this.params.config.timeout,
             }).execute();
 
             return response.data;

diff --git a/src/services/ai/openai.service.ts b/src/services/ai/openai.service.ts
@@ -77,7 +77,7 @@ export class OpenAIService extends AIService {
             this.params.config.key,
             this.params.config.model,
             this.params.config.timeout,
-            this.params.config['max-tokens'],
+            this.params.config.maxTokens,
             temperature,
             generate,
             userMessage,

diff --git a/src/utils/config.ts b/src/utils/config.ts
@@ -62,12 +62,12 @@ const generalConfigParsers = {
 
         return parsed;
     },
-    'max-tokens'(maxTokens?: string) {
+    maxTokens(maxTokens?: string) {
         if (!maxTokens) {
             return 1024;
         }
 
-        parseAssert('max-tokens', /^\d+$/.test(maxTokens), 'Must be an integer');
+        parseAssert('maxTokens', /^\d+$/.test(maxTokens), 'Must be an integer');
         return Number(maxTokens);
     },
     logging(enable?: string | boolean) {
@@ -112,7 +112,7 @@ const modelConfigParsers: Record<ModelName, Record<string, (value: any) => any>>
         systemPromptPath: generalConfigParsers.systemPromptPath,
         timeout: generalConfigParsers.timeout,
         temperature: generalConfigParsers.temperature,
-        'max-tokens': generalConfigParsers['max-tokens'],
+        maxTokens: generalConfigParsers.maxTokens,
         logging: generalConfigParsers.logging,
     },
     OLLAMA: {
@@ -134,7 +134,7 @@ const modelConfigParsers: Record<ModelName, Record<string, (value: any) => any>>
         systemPromptPath: generalConfigParsers.systemPromptPath,
         timeout: generalConfigParsers.timeout,
         temperature: generalConfigParsers.temperature,
-        'max-tokens': generalConfigParsers['max-tokens'],
+        maxTokens: generalConfigParsers.maxTokens,
         logging: generalConfigParsers.logging,
     },
     HUGGINGFACE: {
@@ -175,7 +175,7 @@ const modelConfigParsers: Record<ModelName, Record<string, (value: any) => any>>
         systemPromptPath: generalConfigParsers.systemPromptPath,
         timeout: generalConfigParsers.timeout,
         temperature: generalConfigParsers.temperature,
-        'max-tokens': generalConfigParsers['max-tokens'],
+        maxTokens: generalConfigParsers.maxTokens,
         logging: generalConfigParsers.logging,
     },
     ANTHROPIC: {
@@ -199,7 +199,7 @@ const modelConfigParsers: Record<ModelName, Record<string, (value: any) => any>>
         systemPromptPath: generalConfigParsers.systemPromptPath,
         timeout: generalConfigParsers.timeout,
         temperature: generalConfigParsers.temperature,
-        'max-tokens': generalConfigParsers['max-tokens'],
+        maxTokens: generalConfigParsers.maxTokens,
         logging: generalConfigParsers.logging,
     },
     MISTRAL: {
@@ -232,7 +232,7 @@ const modelConfigParsers: Record<ModelName, Record<string, (value: any) => any>>
         systemPromptPath: generalConfigParsers.systemPromptPath,
         timeout: generalConfigParsers.timeout,
         temperature: generalConfigParsers.temperature,
-        'max-tokens': generalConfigParsers['max-tokens'],
+        maxTokens: generalConfigParsers.maxTokens,
         logging: generalConfigParsers.logging,
     },
     CODESTRAL: {
@@ -250,7 +250,7 @@ const modelConfigParsers: Record<ModelName, Record<string, (value: any) => any>>
         systemPromptPath: generalConfigParsers.systemPromptPath,
         timeout: generalConfigParsers.timeout,
         temperature: generalConfigParsers.temperature,
-        'max-tokens': generalConfigParsers['max-tokens'],
+        maxTokens: generalConfigParsers.maxTokens,
         logging: generalConfigParsers.logging,
     },
     COHERE: {
@@ -267,7 +267,7 @@ const modelConfigParsers: Record<ModelName, Record<string, (value: any) => any>>
         systemPromptPath: generalConfigParsers.systemPromptPath,
         timeout: generalConfigParsers.timeout,
         temperature: generalConfigParsers.temperature,
-        'max-tokens': generalConfigParsers['max-tokens'],
+        maxTokens: generalConfigParsers.maxTokens,
         logging: generalConfigParsers.logging,
     },
     GROQ: {
@@ -284,7 +284,7 @@ const modelConfigParsers: Record<ModelName, Record<string, (value: any) => any>>
         systemPromptPath: generalConfigParsers.systemPromptPath,
         timeout: generalConfigParsers.timeout,
         temperature: generalConfigParsers.temperature,
-        'max-tokens': generalConfigParsers['max-tokens'],
+        maxTokens: generalConfigParsers.maxTokens,
         logging: generalConfigParsers.logging,
     },
 };