[v2.4.14] Make openai key not required for other chat and embedding models (#261)

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "copilot",
 	"name": "Copilot",
-	"version": "2.4.13",
+	"version": "2.4.14",
 	"minAppVersion": "0.15.0",
 	"description": "A ChatGPT Copilot in Obsidian.",
 	"author": "Logan Yang",

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "obsidian-copilot",
-  "version": "2.4.13",
+  "version": "2.4.14",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "obsidian-copilot",
-      "version": "2.4.13",
+      "version": "2.4.14",
       "license": "AGPL-3.0",
       "dependencies": {
         "@huggingface/inference": "^2.6.4",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-copilot",
-  "version": "2.4.13",
+  "version": "2.4.14",
   "description": "ChatGPT integration for Obsidian",
   "main": "main.js",
   "scripts": {

src/LLMProviders/chainManager.ts

@@ -55,7 +55,6 @@ export default class ChainManager {
     this.memoryManager = MemoryManager.getInstance(this.langChainParams);
     this.chatModelManager = ChatModelManager.getInstance(this.langChainParams);
     this.promptManager = PromptManager.getInstance(this.langChainParams);
-    this.embeddingsManager = EmbeddingsManager.getInstance(this.langChainParams);
     this.createChainWithNewModel(this.langChainParams.modelDisplayName);
   }
 
@@ -134,12 +133,15 @@ export default class ChainManager {
       return;
     }
     this.validateChainType(chainType);
+    // MUST set embeddingsManager when switching to QA mode
+    if (chainType === ChainType.RETRIEVAL_QA_CHAIN) {
+      this.embeddingsManager = EmbeddingsManager.getInstance(this.langChainParams);
+    }
 
     // Get chatModel, memory, prompt, and embeddingAPI from respective managers
     const chatModel = this.chatModelManager.getChatModel();
     const memory = this.memoryManager.getMemory();
     const chatPrompt = this.promptManager.getChatPrompt();
-    const embeddingsAPI = this.embeddingsManager.getEmbeddingsAPI();
 
     switch (chainType) {
       case ChainType.LLM_CHAIN: {
@@ -182,8 +184,14 @@ export default class ChainManager {
         const parsedMemoryVectors: MemoryVector[] | undefined = await VectorDBManager.getMemoryVectors(docHash);
         if (parsedMemoryVectors) {
           // Index already exists
+          const embeddingsAPI = this.embeddingsManager.getEmbeddingsAPI();
+          if (!embeddingsAPI) {
+            console.error('Error getting embeddings API. Please check your settings.');
+            return;
+          }
           const vectorStore = await VectorDBManager.rebuildMemoryVectorStore(
-            parsedMemoryVectors, embeddingsAPI
+            parsedMemoryVectors,
+            embeddingsAPI,
           );
 
           // Create new conversational retrieval chain
@@ -391,14 +399,19 @@ export default class ChainManager {
   }
 
   async buildIndex(noteContent: string, docHash: string): Promise<void> {
-    const textSplitter = new RecursiveCharacterTextSplitter({ chunkSize: 1000 });
-
-    const docs = await textSplitter.createDocuments([noteContent]);
-    const embeddingsAPI = this.embeddingsManager.getEmbeddingsAPI();
-
     // Note: HF can give 503 errors frequently (it's free)
     console.log('Creating vector store...');
     try {
+      const textSplitter = new RecursiveCharacterTextSplitter({ chunkSize: 1000 });
+
+      const docs = await textSplitter.createDocuments([noteContent]);
+      const embeddingsAPI = this.embeddingsManager.getEmbeddingsAPI();
+      if (!embeddingsAPI) {
+        const errorMsg = 'Failed to create vector store, embedding API is not set correctly, please check your settings.';
+        new Notice(errorMsg);
+        console.error(errorMsg);
+        return;
+      }
       this.vectorStore = await MemoryVectorStore.fromDocuments(
         docs, embeddingsAPI,
       );

src/LLMProviders/embeddingManager.ts

@@ -21,7 +21,7 @@ export default class EmbeddingManager {
     return EmbeddingManager.instance;
   }
 
-  getEmbeddingsAPI(): Embeddings {
+  getEmbeddingsAPI(): Embeddings | undefined {
     const {
       openAIApiKey,
       azureOpenAIApiKey,
@@ -33,26 +33,32 @@ export default class EmbeddingManager {
 
     // Note that openAIProxyBaseUrl has the highest priority.
     // If openAIProxyBaseUrl is set, it overrides both chat and embedding models.
-    const OpenAIEmbeddingsAPI = openAIProxyBaseUrl ?
-      new ProxyOpenAIEmbeddings({
-        modelName: this.langChainParams.embeddingModel,
-        openAIApiKey,
-        maxRetries: 3,
-        maxConcurrency: 3,
-        timeout: 10000,
-        openAIProxyBaseUrl,
-      }):
-      new OpenAIEmbeddings({
-        modelName: this.langChainParams.embeddingModel,
-        openAIApiKey,
-        maxRetries: 3,
-        maxConcurrency: 3,
-        timeout: 10000,
-      });
+    const OpenAIEmbeddingsAPI = openAIApiKey ? (
+      openAIProxyBaseUrl ?
+        new ProxyOpenAIEmbeddings({
+          modelName: this.langChainParams.embeddingModel,
+          openAIApiKey,
+          maxRetries: 3,
+          maxConcurrency: 3,
+          timeout: 10000,
+          openAIProxyBaseUrl,
+        }) :
+        new OpenAIEmbeddings({
+          modelName: this.langChainParams.embeddingModel,
+          openAIApiKey,
+          maxRetries: 3,
+          maxConcurrency: 3,
+          timeout: 10000,
+        })
+    ) : null;
 
     switch(this.langChainParams.embeddingProvider) {
       case ModelProviders.OPENAI:
-        return OpenAIEmbeddingsAPI
+        if (OpenAIEmbeddingsAPI) {
+          return OpenAIEmbeddingsAPI;
+        }
+        console.error('OpenAI API key is not provided for the embedding model.');
+        break;
       case ModelProviders.HUGGINGFACE:
         return new HuggingFaceInferenceEmbeddings({
           apiKey: this.langChainParams.huggingfaceApiKey,
@@ -66,18 +72,27 @@ export default class EmbeddingManager {
           maxConcurrency: 3,
         });
       case ModelProviders.AZURE_OPENAI:
-        return new OpenAIEmbeddings({
-          azureOpenAIApiKey,
-          azureOpenAIApiInstanceName,
-          azureOpenAIApiDeploymentName: azureOpenAIApiEmbeddingDeploymentName,
-          azureOpenAIApiVersion,
+        if (azureOpenAIApiKey) {
+          return new OpenAIEmbeddings({
+            azureOpenAIApiKey,
+            azureOpenAIApiInstanceName,
+            azureOpenAIApiDeploymentName: azureOpenAIApiEmbeddingDeploymentName,
+            azureOpenAIApiVersion,
+            maxRetries: 3,
+            maxConcurrency: 3,
+          });
+        }
+        console.error('Azure OpenAI API key is not provided for the embedding model.');
+        break;
+      default:
+        console.error('No embedding provider set or no valid API key provided. Defaulting to OpenAI.');
+        return OpenAIEmbeddingsAPI || new OpenAIEmbeddings({
+          modelName: this.langChainParams.embeddingModel,
+          openAIApiKey: 'default-key',
           maxRetries: 3,
           maxConcurrency: 3,
+          timeout: 10000,
         });
-      default:
-        console.error('No embedding provider set. Using OpenAI.');
-        return OpenAIEmbeddingsAPI;
     }
   }
-
 }

src/settings/SettingsPage.tsx

@@ -49,6 +49,7 @@ export class CopilotSettingTab extends PluginSettingTab {
       await this.plugin.saveSettings();
 
       // Reload the plugin
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const app = (this.plugin.app as any);
       await app.plugins.disablePlugin("copilot");
       await app.plugins.enablePlugin("copilot");

src/settings/components/ApiSettings.tsx

@@ -20,6 +20,8 @@ interface ApiSettingsProps {
   setAzureOpenAIApiDeploymentName: (value: string) => void;
   azureOpenAIApiVersion: string;
   setAzureOpenAIApiVersion: (value: string) => void;
+  azureOpenAIApiEmbeddingDeploymentName: string;
+  setAzureOpenAIApiEmbeddingDeploymentName: (value: string) => void;
 }
 
 const ApiSettings: React.FC<ApiSettingsProps> = ({
@@ -39,6 +41,8 @@ const ApiSettings: React.FC<ApiSettingsProps> = ({
   setAzureOpenAIApiDeploymentName,
   azureOpenAIApiVersion,
   setAzureOpenAIApiVersion,
+  azureOpenAIApiEmbeddingDeploymentName,
+  setAzureOpenAIApiEmbeddingDeploymentName,
 }) => {
   return (
     <div>
@@ -154,6 +158,14 @@ const ApiSettings: React.FC<ApiSettingsProps> = ({
             placeholder="Enter Azure OpenAI API Version"
             type="text"
           />
+          <ApiSetting
+            title="Azure OpenAI API Embedding Deployment Name"
+            description="(Optional) For embedding provider Azure OpenAI"
+            value={azureOpenAIApiEmbeddingDeploymentName}
+            setValue={setAzureOpenAIApiEmbeddingDeploymentName}
+            placeholder="Enter Azure OpenAI API Embedding Deployment Name"
+            type="text"
+          />
         </div>
       </Collapsible>
     </div>

src/settings/components/QASettings.tsx

@@ -50,6 +50,7 @@ const QASettings: React.FC<QASettingsProps> = ({
       />
       <DropdownComponent
         name="OpenAI Embedding Model"
+        description="(for when embedding provider is OpenAI)"
         value={embeddingModel}
         onChange={setEmbeddingModel}
         options={OPENAI_EMBEDDING_MODELS}

src/settings/components/SettingsMain.tsx

@@ -31,6 +31,7 @@ export default function SettingsMain({ plugin, reloadPlugin }: SettingsMainProps
   const [azureOpenAIApiInstanceName, setAzureOpenAIApiInstanceName] = useState(plugin.settings.azureOpenAIApiInstanceName);
   const [azureOpenAIApiDeploymentName, setAzureOpenAIApiDeploymentName] = useState(plugin.settings.azureOpenAIApiDeploymentName);
   const [azureOpenAIApiVersion, setAzureOpenAIApiVersion] = useState(plugin.settings.azureOpenAIApiVersion);
+  const [azureOpenAIApiEmbeddingDeploymentName, setAzureOpenAIApiEmbeddingDeploymentName] = useState(plugin.settings.azureOpenAIApiEmbeddingDeploymentName);
 
   // QA settings
   const [embeddingProvider, setEmbeddingProvider] = useState(plugin.settings.embeddingProvider);
@@ -66,6 +67,7 @@ export default function SettingsMain({ plugin, reloadPlugin }: SettingsMainProps
     plugin.settings.azureOpenAIApiInstanceName = azureOpenAIApiInstanceName;
     plugin.settings.azureOpenAIApiDeploymentName = azureOpenAIApiDeploymentName;
     plugin.settings.azureOpenAIApiVersion = azureOpenAIApiVersion;
+    plugin.settings.azureOpenAIApiEmbeddingDeploymentName = azureOpenAIApiEmbeddingDeploymentName;
 
     // QA settings
     plugin.settings.embeddingProvider = embeddingProvider;
@@ -184,6 +186,8 @@ export default function SettingsMain({ plugin, reloadPlugin }: SettingsMainProps
         setAzureOpenAIApiDeploymentName={setAzureOpenAIApiDeploymentName}
         azureOpenAIApiVersion={azureOpenAIApiVersion}
         setAzureOpenAIApiVersion={setAzureOpenAIApiVersion}
+        azureOpenAIApiEmbeddingDeploymentName={azureOpenAIApiEmbeddingDeploymentName}
+        setAzureOpenAIApiEmbeddingDeploymentName={setAzureOpenAIApiEmbeddingDeploymentName}
       />
       <QASettings
         embeddingProvider={embeddingProvider}

versions.json

@@ -34,5 +34,6 @@
 	"2.4.10": "0.15.0",
 	"2.4.11": "0.15.0",
 	"2.4.12": "0.15.0",
-	"2.4.13": "0.15.0"
+	"2.4.13": "0.15.0",
+	"2.4.14": "0.15.0"
 }