OpenRouter: Add as vector storage provider (#4736) * OpenRouter: Add as vector storage provider * Better array filtering

845bd8c99980451a02e4e58643e2efb56fd89c37

Cohee <18619528+Cohee1207@users.noreply.github.com>

Signed

Parents: 73c1bc2d039b3290a034220014feb5c479ac8455

public/scripts/extensions/vectors/index.js+52 -0 Viewed

     togetherai_model: 'togethercomputer/m2-bert-80M-32k-retrieval',
     openai_model: 'text-embedding-ada-002',
     electronhub_model: 'text-embedding-3-small',
 +    openrouter_model: 'openai/text-embedding-3-large',
     cohere_model: 'embed-english-v3.0',
     ollama_model: 'mxbai-embed-large',
     ollama_keep: false,

         case 'electronhub':
             body.model = extension_settings.vectors.electronhub_model;
             break;
 +        case 'openrouter':
 +            body.model = extension_settings.vectors.openrouter_model;
 +            break;
         case 'togetherai':
             body.model = extension_settings.vectors.togetherai_model;
             break;

 function throwIfSourceInvalid() {
     if (settings.source === 'openai' && !secret_state[SECRET_KEYS.OPENAI] ||
         settings.source === 'electronhub' && !secret_state[SECRET_KEYS.ELECTRONHUB] ||
 +        settings.source === 'openrouter' && !secret_state[SECRET_KEYS.OPENROUTER] ||
         settings.source === 'palm' && !secret_state[SECRET_KEYS.MAKERSUITE] ||
         settings.source === 'vertexai' && !secret_state[SECRET_KEYS.VERTEXAI] && !secret_state[SECRET_KEYS.VERTEXAI_SERVICE_ACCOUNT] ||
         settings.source === 'mistral' && !secret_state[SECRET_KEYS.MISTRALAI] ||

     $('#together_vectorsModel').toggle(settings.source === 'togetherai');
     $('#openai_vectorsModel').toggle(settings.source === 'openai');
     $('#electronhub_vectorsModel').toggle(settings.source === 'electronhub');
 +    $('#openrouter_vectorsModel').toggle(settings.source === 'openrouter');
     $('#cohere_vectorsModel').toggle(settings.source === 'cohere');
     $('#ollama_vectorsModel').toggle(settings.source === 'ollama');
     $('#llamacpp_vectorsModel').toggle(settings.source === 'llamacpp');

@@ -1138,6 +1144,9 @@ function toggleSettings() {
1138	1144	case 'electronhub':
1139	1145	loadElectronHubModels();
1140	1146	break;
	1147	+ case 'openrouter':
	1148	+ loadOpenRouterModels();
	1149	+ break;
1141	1150	}
1142	1151	}
1143	1152

     $('#vectors_electronhub_model').val(settings.electronhub_model);
+}
 +async function loadOpenRouterModels() {
 +    try {
 +        const response = await fetch('/api/openrouter/models/embedding', {
 +            method: 'POST',
 +            headers: getRequestHeaders(),
 +        });
 +        if (!response.ok) {
 +            throw new Error(`HTTP ${response.status}`);
 +        }
 +        /** @type {Array<any>} */
 +        const data = await response.json();
 +        const models = Array.isArray(data) ? data : [];
 +        populateOpenRouterModelSelect(models);
 +    } catch (err) {
 +        console.warn('OpenRouter models fetch failed', err);
 +        populateOpenRouterModelSelect([]);
 +    }
 +}
++
 +/**
 + * Populates the OpenRouter model select element.
 + * @param {{ id: string, name: string }[]} models OpenRouter models
 + */
 +function populateOpenRouterModelSelect(models) {
 +    const select = $('#vectors_openrouter_model');
 +    select.empty();
 +    for (const m of models) {
 +        const option = document.createElement('option');
 +        option.value = m.id;
 +        option.text = m.name || m.id;
 +        select.append(option);
 +    }
 +    if (!settings.openrouter_model && models.length) {
 +        settings.openrouter_model = models[0].id;
 +    }
 +    $('#vectors_openrouter_model').val(settings.openrouter_model);
 +}
++
 /**
  * Executes a function with WebLLM error handling.
  * @param {function(): Promise<T>} func Function to execute

         Object.assign(extension_settings.vectors, settings);
         saveSettingsDebounced();
     });
 +    $('#vectors_openrouter_model').val(settings.openrouter_model).on('change', () => {
 +        settings.openrouter_model = String($('#vectors_openrouter_model').val());
 +        Object.assign(extension_settings.vectors, settings);
 +        saveSettingsDebounced();
 +    });
     $('#vectors_cohere_model').val(settings.cohere_model).on('change', () => {
         settings.cohere_model = String($('#vectors_cohere_model').val());
         Object.assign(extension_settings.vectors, settings);

public/scripts/extensions/vectors/settings.html+10 -0 Viewed

                     <option value="nomicai">NomicAI</option>
                     <option value="ollama">Ollama</option>
                     <option value="openai">OpenAI</option>
 +                    <option value="openrouter">OpenRouter</option>
                     <option value="togetherai">TogetherAI</option>
                     <option value="vllm">vLLM</option>
                     <option value="webllm" data-i18n="WebLLM Extension">WebLLM Extension</option>

                     <span data-i18n="Click to set">Click to set</span>
                 </div>
             </div>
 +            <div class="flex-container flexFlowColumn" id="openrouter_vectorsModel">
 +                <label for="vectors_openrouter_model" data-i18n="Vectorization Model">
 +                    Vectorization Model
 +                </label>
 +                <select id="vectors_openrouter_model" class="text_pole"></select>
 +                <i data-i18n="Hint: Set your OpenRouter API key in API Connections.">
 +                    Hint: Set your OpenRouter API key in API Connections.
 +                </i>
 +            </div>
             <div class="flex-container marginTopBot5">
                 <div class="flex-container flex1 flexFlowColumn" title="How many last messages will be matched for relevance.">

src/endpoints/openrouter.js+34 -0 Viewed

         return res.sendStatus(500);
+    }
 });
++
 +router.post('/models/embedding', async (_req, res) => {
 +    try {
 +        // The endpoint is available without authentication
 +        const response = await fetch(`${API_OPENROUTER}/models`, {
 +            method: 'GET',
 +            headers: {
 +                'Accept': 'application/json',
 +            },
 +        });
++
 +        if (!response.ok) {
 +            console.warn('OpenRouter API request failed', response.statusText);
 +            return res.json([]);
 +        }
++
 +        /** @type {any} */
 +        const data = await response.json();
++
 +        if (!Array.isArray(data?.data)) {
 +            console.warn('OpenRouter API response was not an array');
 +            return res.json([]);
 +        }
++
 +        const embeddingModels = data.data
 +            .filter(m => Array.isArray(m?.architecture?.output_modalities))
 +            .filter(m => m.architecture.output_modalities.includes('embeddings'));
++
 +        return res.json(embeddingModels);
 +    } catch (error) {
 +        console.error(error);
 +        return res.sendStatus(500);
 +    }
 +});

src/endpoints/vectors.js+10 -0 Viewed

     'koboldcpp',
     'vertexai',
     'electronhub',
 +    'openrouter',
 ];
 /**

             return getOpenAIVector(text, source, directories, sourceSettings.model);
         case 'electronhub':
             return getOpenAIVector(text, source, directories, sourceSettings.model);
 +        case 'openrouter':
 +            return getOpenAIVector(text, source, directories, sourceSettings.model);
         case 'transformers':
             return getTransformersVector(text);
         case 'extras':

             case 'electronhub':
                 results.push(...await getOpenAIBatchVector(batch, source, directories, sourceSettings.model));
                 break;
 +            case 'openrouter':
 +                results.push(...await getOpenAIBatchVector(batch, source, directories, sourceSettings.model));
 +                break;
             case 'transformers':
                 results.push(...await getTransformersBatchVector(batch));
                 break;

             return {
                 model: String(request.body.model || 'text-embedding-3-small'),
             };
 +        case 'openrouter':
 +            return {
 +                model: String(request.body.model) || 'openai/text-embedding-3-large',
 +            };
         case 'cohere':
             return {
                 model: String(request.body.model),

src/vectors/openai-vectors.js+18 -6 Viewed

 import fetch from 'node-fetch';
 import { SECRET_KEYS, readSecret } from '../endpoints/secrets.js';
 +import { OPENROUTER_HEADERS } from '../constants.js';
 const SOURCES = {
     'togetherai': {
         secretKey: SECRET_KEYS.TOGETHERAI,
         url: 'https://api.together.xyz/v1',
         model: 'togethercomputer/m2-bert-80M-32k-retrieval',
 +        headers: {},
     },
     'mistral': {
         secretKey: SECRET_KEYS.MISTRALAI,
         url: 'https://api.mistral.ai/v1',
         model: 'mistral-embed',
 +        headers: {},
     },
     'openai': {
         secretKey: SECRET_KEYS.OPENAI,
         url: 'https://api.openai.com/v1',
         model: 'text-embedding-ada-002',
 +        headers: {},
     },
     'electronhub': {
         secretKey: SECRET_KEYS.ELECTRONHUB,
         url: 'https://api.electronhub.ai/v1',
         model: 'text-embedding-3-small',
 +        headers: {},
 +    },
 +    'openrouter': {
 +        secretKey: SECRET_KEYS.OPENROUTER,
 +        url: 'https://openrouter.ai/api/v1',
 +        model: 'openai/text-embedding-3-large',
 +        headers: { ...OPENROUTER_HEADERS },
     },
 };

+    }
     const url = config.url;
     const response = await fetch(`https://${url}/v1/embeddings`, {
         method: 'POST',
         headers: {
             'Content-Type': 'application/json',
             'Authorization': `Bearer ${key}`,
 +            ...config.headers,
         },
         body: JSON.stringify({
             input: texts,