OmniRoute/docs/i18n/mr/docs/frameworks/PLUGIN_SDK.md

OmniRoute Plugin SDK (मराठी)

🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇳🇬 ha · 🇮🇱 he · 🇮🇳 hi · 🇭🇷 hr · 🇭🇺 hu · 🇦🇲 hy · 🇮🇩 id · 🇳🇬 ig · 🇮🇹 it · 🇯🇵 ja · 🇬🇪 ka · 🇰🇭 km · 🇮🇳 kn · 🇰🇷 ko · 🇱🇹 lt · 🇱🇻 lv · 🇮🇳 ml · 🇲🇾 ms · 🇲🇹 mt · 🇲🇲 my · 🇳🇵 ne · 🇳🇱 nl · 🇳🇴 no · 🇮🇳 or · 🇮🇳 pa · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇱🇰 si · 🇸🇰 sk · 🇸🇮 sl · 🇷🇸 sr · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇳🇬 yo · 🇨🇳 zh-CN · 🇹🇼 zh-TW

---

त्वरित प्रारंभ

import { definePlugin } from "omniroute/plugins/sdk";

export default definePlugin({
  name: "my-plugin",
  priority: 50,
  onRequest: async (ctx) => {
    console.log(`Request ${ctx.requestId} for ${ctx.model}`);
  },
  onResponse: async (ctx, response) => {
    console.log(`Response for ${ctx.requestId}`);
    return response;
  },
  onError: async (ctx, error) => {
    console.error(`Error: ${error.message}`);
  },
});

API संदर्भ

definePlugin(def: PluginDefinition): Plugin

डीफॉल्ट मूल्यासह Plugin ऑब्जेक्ट तयार करणारे फॅक्टरी फंक्शन.

पॅरामीटर्स:

• name (string, आवश्यक) — kebab-case मधील प्लगइनचे नाव
• priority (number, पर्यायी, डीफॉल्ट: 100) — कमी मूल्य असलेले प्रथम चालते
• enabled (boolean, पर्यायी, डीफॉल्ट: true) — सुरुवातीपासून सक्षम ठेवायचे का?
• onRequest (function, पर्यायी) — चॅट हँडलरपूर्वी चालते
• onResponse (function, पर्यायी) — चॅट हँडलरनंतर चालते
• onError (function, पर्यायी) — हँडलरमध्ये त्रुटी आल्यास चालते

blockRequest(response?): BlockingHookResult

विनंती अवरोधित करा आणि पर्यायाने सानुकूल प्रतिसाद परत करा.

onRequest: (ctx) => {
  if (!ctx.headers["authorization"]) {
    return blockRequest({ error: "Unauthorized", status: 401 });
  }
};

modifyBody(body): PluginResult

विनंती प्रोव्हायडरपर्यंत पोहोचण्यापूर्वी तिच्या बॉडीमध्ये बदल करा.

onRequest: (ctx) => {
  return modifyBody({ ...ctx.body, temperature: 0.7 });
};

addMetadata(metadata): PluginResult

विनंतीच्या संदर्भाला मेटाडेटा संलग्न करा.

onRequest: (ctx) => {
  return addMetadata({ source: "my-plugin", version: "1.0.0" });
};

प्लगइन संदर्भ (PluginContext)

फील्ड	प्रकार	वर्णन
requestId	string	विनंतीचा अद्वितीय ओळखकर्ता
model	string	विनंती केलेल्या मॉडेलचे नाव
provider	string	लक्ष्य प्रोव्हायडर ID
body	Record<string, unknown>	विनंतीची बॉडी
headers	Record<string, string>	विनंतीचे हेडर्स
metadata	Record<string, unknown>	बदलता येणारा मेटाडेटा
timestamp	number	विनंतीचा टाइमस्टॅम्प

मॅनिफेस्ट (plugin.json)

{
  "name": "my-plugin",
  "version": "1.0.0",
  "description": "A sample plugin",
  "author": "your-name",
  "main": "index.js",
  "hooks": {
    "onRequest": { "enabled": true, "priority": 50 },
    "onResponse": true,
    "onError": false
  },
  "requires": {
    "permissions": ["network", "file-read"]
  },
  "enabledByDefault": false,
  "configSchema": {
    "apiKey": {
      "type": "string",
      "description": "API key for external service"
    },
    "maxRetries": { "type": "number", "min": 1, "max": 10, "default": 3 },
    "debug": { "type": "boolean", "default": false },
    "mode": { "type": "string", "enum": ["fast", "slow"], "default": "fast" }
  }
}

हुक प्राधान्य

हुक प्राधान्यानुसार कॉन्फिगर करता येतात (कमी मूल्य = प्रथम चालते):

{
  "hooks": {
    "onRequest": { "enabled": true, "priority": 10 },
    "onResponse": { "enabled": true, "priority": 100 }
  }
}

किंवा साध्या boolean मूल्यांच्या स्वरूपात (डीफॉल्ट प्राधान्य 100):

{
  "hooks": {
    "onRequest": true,
    "onResponse": true
  }
}

परवानगी प्रणाली

प्लगइन सँडबॉक्स केलेल्या VM संदर्भात चालतात. बाह्य संसाधनांमध्ये प्रवेश करण्यासाठी स्पष्ट परवानग्या आवश्यक आहेत:

परवानगी	प्रदान केलेला प्रवेश
network	fetch, AbortController, Headers, Request, Response
file-read	fs.readFile, fs.readdir, fs.stat
file-write	fs.writeFile, fs.mkdir, fs.rm
env	केवळ-वाचनीय process.env प्रॉक्सी
exec	child_process.exec, child_process.execSync

परवानगी नसल्यास, संबंधित ग्लोबल्स सँडबॉक्समध्ये उपलब्ध नसतात.

कॉन्फिग स्कीमा

कॉन्फिगर करता येणाऱ्या सेटिंग्ज configSchema मध्ये परिभाषित करा:

{
  "configSchema": {
    "apiKey": { "type": "string", "description": "External API key" },
    "maxRetries": { "type": "number", "min": 1, "max": 10, "default": 3 },
    "debug": { "type": "boolean", "default": false },
    "mode": { "type": "string", "enum": ["fast", "slow"], "default": "fast" }
  }
}

फील्ड प्रकार: string, number, boolean, select

फील्ड पर्याय: default, min, max, enum, description

कॉन्फिग मूल्ये डेटाबेसमध्ये कायम ठेवली जातात आणि डॅशबोर्डच्या कॉन्फिग पृष्ठाद्वारे उपलब्ध असतात.

अंगभूत इव्हेंट्स

इव्हेंट	केव्हा	पेलोड
onRequest	चॅट हँडलरपूर्वी	विनंती संदर्भ
onResponse	चॅट हँडलरनंतर	प्रतिसाद डेटा
onError	हँडलर त्रुटी आल्यावर	त्रुटी ऑब्जेक्ट
onModelSelect	रूटिंगसाठी मॉडेल निवडल्यावर	मॉडेल माहिती
onComboResolve	कॉम्बो रूटिंग निश्चित झाल्यावर	कॉम्बो लक्ष्ये
onRateLimit	दरमर्यादा गाठल्यावर	मर्यादा माहिती
onQuotaExhaust	कोटा संपल्यावर	कोटा माहिती
onProviderError	प्रदात्याने त्रुटी परत केल्यावर	त्रुटीचे तपशील
onStreamStart	SSE प्रवाह सुरू झाल्यावर	प्रवाह माहिती
onStreamEnd	SSE प्रवाह संपल्यावर	प्रवाह आकडेवारी
onInstall	प्लगइन स्थापित झाल्यावर	{ name, version, manifest }
onActivate	प्लगइन सक्रिय झाल्यावर	{ name, version, manifest }
onDeactivate	प्लगइन निष्क्रिय झाल्यावर	{ name, version, manifest }
onUninstall	प्लगइन विस्थापित झाल्यावर (फायली हटवण्यापूर्वी)	{ name, version, manifest }

उदाहरणे

विनंती लॉगर

import { definePlugin } from "omniroute/plugins/sdk";

export default definePlugin({
  name: "request-logger",
  onRequest: async (ctx) => {
    console.log(`[${new Date().toISOString()}] ${ctx.method} ${ctx.model} -> ${ctx.provider}`);
  },
});

दर मर्यादक

import { definePlugin, blockRequest } from "omniroute/plugins/sdk";

const requests = new Map<string, number[]>();

export default definePlugin({
  name: "rate-limiter",
  priority: 10,
  onRequest: async (ctx) => {
    const key = ctx.headers["x-api-key"] || "anonymous";
    const now = Date.now();
    const window = 60000; // 1 मिनिट
    const maxRequests = 100;

    const timestamps = (requests.get(key) || []).filter((t) => t > now - window);
    timestamps.push(now);
    requests.set(key, timestamps);

    if (timestamps.length > maxRequests) {
      return blockRequest({ error: "Rate limit exceeded", status: 429 });
    }
  },
});

प्रतिसाद ट्रान्सफॉर्मर

import { definePlugin } from "omniroute/plugins/sdk";

export default definePlugin({
  name: "response-transformer",
  onResponse: async (ctx, response) => {
    if (response.choices) {
      response.choices = response.choices.map((c: any) => ({
        ...c,
        message: { ...c.message, content: c.message.content.trim() },
      }));
    }
    return response;
  },
});