Intlayer कॉन्फ़िगरेशन दस्तावेज़ीकरण

अवलोकन

Intlayer कॉन्फ़िगरेशन फ़ाइलें प्लगइन के विभिन्न पहलुओं को अनुकूलित करने की अनुमति देती हैं, जैसे कि अंतर्राष्ट्रीयकरण, मिडलवेयर, और सामग्री प्रबंधन। यह दस्तावेज़ कॉन्फ़िगरेशन में प्रत्येक गुण का विस्तृत विवरण प्रदान करता है।

कॉन्फ़िगरेशन फ़ाइल समर्थन

Intlayer JSON, JS, MJS, और TS कॉन्फ़िगरेशन फ़ाइल स्वरूप स्वीकार करता है:

• intlayer.config.ts
• intlayer.config.js
• intlayer.config.json
• intlayer.config.cjs
• intlayer.config.mjs
• .intlayerrc

उदाहरण कॉन्फ़िगरेशन फ़ाइल

import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [Locales.ENGLISH], // उपलब्ध भाषाओं की सूची  },  content: {    autoFill: "./{{fileName}}.content.json", // सामग्री को स्वचालित रूप से भरने के लिए फ़ाइल पथ    contentDir: ["src", "../ui-library"], // सामग्री निर्देशिकाएँ  },  middleware: {    noPrefix: false, // क्या प्रीफ़िक्स को हटाना है  },  editor: {    applicationURL: "https://example.com", // संपादक के लिए एप्लिकेशन URL  },  ai: {    apiKey: process.env.OPENAI_API_KEY, // AI सेवा के लिए API कुंजी    applicationContext: "This is a test application", // एप्लिकेशन संदर्भ  },  build: {    importMode: "dynamic", // आयात मोड  },};export default config;

कॉन्फ़िगरेशन संदर्भ

निम्नलिखित अनुभाग Intlayer के लिए उपलब्ध विभिन्न कॉन्फ़िगरेशन सेटिंग्स का वर्णन करते हैं।

अंतरराष्ट्रीयकरण कॉन्फ़िगरेशन

अंतरराष्ट्रीयकरण से संबंधित सेटिंग्स को परिभाषित करता है, जिसमें उपलब्ध भाषाएँ और एप्लिकेशन के लिए डिफ़ॉल्ट भाषा शामिल हैं।

गुण

• locales:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['en']
  • विवरण: एप्लिकेशन में समर्थित भाषाओं की सूची।
  • उदाहरण: ['en', 'fr', 'es']
• requiredLocales:
  • प्रकार: string[]
  • डिफ़ॉल्ट: []
  • विवरण: एप्लिकेशन में आवश्यक भाषाओं की सूची।
  • उदाहरण: []
  • नोट: यदि खाली है, तो strict मोड में सभी लोकल्स आवश्यक हैं।
  • नोट: सुनिश्चित करें कि आवश्यक लोकल्स locales फ़ील्ड में भी परिभाषित हैं।

• strictMode:

  • प्रकार: string
  • डिफ़ॉल्ट: inclusive
  • विवरण: टाइपस्क्रिप्ट का उपयोग करके अंतरराष्ट्रीयकृत सामग्री के मजबूत कार्यान्वयन सुनिश्चित करें।
  • नोट: यदि इसे "strict" पर सेट किया गया है, तो अनुवाद t फ़ंक्शन प्रत्येक घोषित लोकल को परिभाषित करने की आवश्यकता होगी। यदि कोई लोकल गायब है, या यदि कोई लोकल आपकी कॉन्फ़िग में घोषित नहीं है, तो यह एक त्रुटि फेंकेगा।
  • नोट: यदि इसे "inclusive" पर सेट किया गया है, तो अनुवाद t फ़ंक्शन प्रत्येक घोषित लोकल को परिभाषित करने की आवश्यकता होगी। यदि कोई लोकल गायब है, तो यह एक चेतावनी देगा। लेकिन यदि कोई लोकल आपकी कॉन्फ़िग में घोषित नहीं है, लेकिन मौजूद है, तो इसे स्वीकार करेगा।
  • नोट: यदि इसे "loose" पर सेट किया गया है, तो अनुवाद t फ़ंक्शन किसी भी मौजूदा लोकल को स्वीकार करेगा।

• defaultLocale:

  • प्रकार: string
  • डिफ़ॉल्ट: 'en'
  • विवरण: डिफ़ॉल्ट लोकल जो एक फॉलबैक के रूप में उपयोग किया जाता है यदि अनुरोधित लोकल नहीं मिलता है।
  • उदाहरण: 'en'
  • नोट: इसका उपयोग उस लोकल को निर्धारित करने के लिए किया जाता है जब URL, कुकी, या हेडर में कोई लोकल निर्दिष्ट नहीं होता है।

संपादक विन्यास

एकीकृत संपादक से संबंधित सेटिंग्स को परिभाषित करता है, जिसमें सर्वर पोर्ट और सक्रिय स्थिति शामिल हैं।

गुण

• applicationURL:

  • प्रकार: string
  • डिफ़ॉल्ट: http://localhost:3000
  • विवरण: एप्लिकेशन का URL। सुरक्षा कारणों से संपादक की उत्पत्ति को सीमित करने के लिए उपयोग किया जाता है।
  • उदाहरण:
    • 'http://localhost:3000'
    • 'https://example.com'
  • process.env.INTLAYER_EDITOR_URL
  • नोट: एप्लिकेशन का URL। सुरक्षा कारणों से संपादक के मूल को प्रतिबंधित करने के लिए उपयोग किया जाता है। यदि इसे '*' पर सेट किया गया है, तो संपादक किसी भी मूल से सुलभ होगा।

• port:

  • प्रकार: number
  • डिफ़ॉल्ट: 8000
  • विवरण: विज़ुअल संपादक सर्वर द्वारा उपयोग किया जाने वाला पोर्ट।

• editorURL:

  • प्रकार: string
  • डिफ़ॉल्ट: 'http://localhost:8000'
  • विवरण: संपादक सर्वर का URL। सुरक्षा कारणों से संपादक के मूल को प्रतिबंधित करने के लिए उपयोग किया जाता है।
    • 'http://localhost:3000'
    • 'https://example.com'
    • process.env.INTLAYER_EDITOR_URL
  • नोट: एप्लिकेशन से पहुँचने के लिए एडिटर सर्वर का URL। सुरक्षा कारणों से उन मूलों को प्रतिबंधित करने के लिए उपयोग किया जाता है जो एप्लिकेशन के साथ इंटरैक्ट कर सकते हैं। यदि इसे '*' पर सेट किया गया है, तो एडिटर किसी भी मूल से सुलभ होगा। यदि पोर्ट बदला गया है, या यदि एडिटर किसी अलग डोमेन पर होस्ट किया गया है, तो इसे सेट किया जाना चाहिए।

• cmsURL:

  • प्रकार: string
  • डिफ़ॉल्ट: 'https://intlayer.org'
  • विवरण: Intlayer CMS का URL।
  • उदाहरण: 'https://intlayer.org'
  • नोट: Intlayer CMS का URL।

• backendURL:

  • प्रकार: string
  • डिफ़ॉल्ट: https://back.intlayer.org
  • विवरण: बैकएंड सर्वर का URL।
  • उदाहरण: http://localhost:4000

• enabled:

  • प्रकार: boolean
  • डिफ़ॉल्ट: true
  • विवरण: यह दर्शाता है कि क्या एप्लिकेशन विज़ुअल एडिटर के साथ इंटरैक्ट करता है।
  • उदाहरण: process.env.NODE_ENV !== 'production'
  • नोट: यदि true है, तो एडिटर एप्लिकेशन के साथ इंटरैक्ट कर सकेगा। यदि false है, तो एडिटर एप्लिकेशन के साथ इंटरैक्ट नहीं कर सकेगा। किसी भी स्थिति में, एडिटर केवल विज़ुअल एडिटर द्वारा सक्षम किया जा सकता है। विशिष्ट वातावरणों के लिए एडिटर को अक्षम करना सुरक्षा लागू करने का एक तरीका है।

• clientId:

  • प्रकार: string | undefined
  • डिफ़ॉल्ट: undefined
  • विवरण: clientId और clientSecret intlayer पैकेजों को oAuth2 प्रमाणीकरण का उपयोग करके बैकएंड के साथ प्रमाणीकरण करने की अनुमति देते हैं। एक एक्सेस टोकन का उपयोग परियोजना से संबंधित उपयोगकर्ता को प्रमाणित करने के लिए किया जाता है। एक्सेस टोकन प्राप्त करने के लिए, https://intlayer.org/dashboard/project पर जाएं और एक खाता बनाएं।
  • उदाहरण: true
  • नोट: महत्वपूर्ण: clientId और clientSecret को गोपनीय रखा जाना चाहिए और सार्वजनिक रूप से साझा नहीं किया जाना चाहिए। कृपया इन्हें सुरक्षित स्थान पर रखें, जैसे कि पर्यावरण चर (environment variables) में।

• clientSecret:

  • प्रकार: string | undefined
  • डिफ़ॉल्ट: undefined
  • विवरण: clientId और clientSecret intlayer पैकेजों को oAuth2 प्रमाणीकरण का उपयोग करके बैकएंड के साथ प्रमाणीकरण करने की अनुमति देते हैं। एक एक्सेस टोकन का उपयोग परियोजना से संबंधित उपयोगकर्ता को प्रमाणित करने के लिए किया जाता है। एक्सेस टोकन प्राप्त करने के लिए, https://intlayer.org/dashboard/project पर जाएं और एक खाता बनाएं।
  • उदाहरण: true
  • नोट: महत्वपूर्ण: clientId और clientSecret को गोपनीय रखा जाना चाहिए और सार्वजनिक रूप से साझा नहीं किया जाना चाहिए। कृपया इन्हें सुरक्षित स्थान पर रखें, जैसे कि पर्यावरण चर।

• dictionaryPriorityStrategy:

  • प्रकार: string
  • डिफ़ॉल्ट: 'local_first'
  • विवरण: जब स्थानीय और दूरस्थ दोनों शब्दकोश मौजूद हों, तो शब्दकोशों को प्राथमिकता देने की रणनीति। यदि इसे 'distant_first' पर सेट किया गया है, तो एप्लिकेशन दूरस्थ शब्दकोशों को स्थानीय शब्दकोशों पर प्राथमिकता देगा। यदि इसे 'local_first' पर सेट किया गया है, तो एप्लिकेशन स्थानीय शब्दकोशों को दूरस्थ शब्दकोशों पर प्राथमिकता देगा।
  • उदाहरण: 'distant_first'

• liveSync:

  • प्रकार: boolean
  • डिफ़ॉल्ट: false
  • विवरण: यह संकेत करता है कि जब CMS / विज़ुअल एडिटर / बैकएंड में कोई परिवर्तन होता है, तो एप्लिकेशन सर्वर को एप्लिकेशन की सामग्री को हॉट रीलोड करना चाहिए या नहीं।
  • उदाहरण: true
  • नोट: उदाहरण के लिए, जब कोई नया शब्दकोश जोड़ा या अपडेट किया जाता है, तो एप्लिकेशन पृष्ठ में दिखाने के लिए सामग्री को अपडेट करेगा।
  • नोट: लाइव सिंक को एप्लिकेशन की सामग्री को किसी अन्य सर्वर पर बाहरीकरण करने की आवश्यकता होती है। इसका मतलब है कि यह एप्लिकेशन के प्रदर्शन को थोड़ा प्रभावित कर सकता है। इसे सीमित करने के लिए, हम सुझाव देते हैं कि एप्लिकेशन और लाइव सिंक सर्वर को एक ही मशीन पर होस्ट किया जाए। साथ ही, लाइव सिंक और optimize के संयोजन से लाइव सिंक सर्वर पर कई अनुरोध भेजे जा सकते हैं। आपकी इन्फ्रास्ट्रक्चर के आधार पर, हम दोनों विकल्पों और उनके संयोजन का परीक्षण करने की सलाह देते हैं।

• liveSyncPort:

  • प्रकार: number
  • डिफ़ॉल्ट: 4000
  • विवरण: लाइव सिंक सर्वर का पोर्ट।
  • उदाहरण: 4000
  • नोट: लाइव सिंक सर्वर का पोर्ट।

• liveSyncURL:

  • प्रकार: string
  • डिफ़ॉल्ट: 'http://localhost:{liveSyncPort}'
  • विवरण: लाइव सिंक सर्वर का URL।
  • उदाहरण: 'https://example.com'
  • नोट: डिफ़ॉल्ट रूप से localhost की ओर इशारा करता है लेकिन रिमोट लाइव सिंक सर्वर के मामले में इसे किसी भी URL में बदला जा सकता है।

मिडलवेयर कॉन्फ़िगरेशन

सेटिंग्स जो मिडलवेयर के व्यवहार को नियंत्रित करती हैं, जिसमें एप्लिकेशन कुकीज़, हेडर, और लोकल प्रबंधन के लिए URL प्रीफिक्स कैसे संभालता है शामिल है।

गुण

• headerName:

  • प्रकार: string
  • डिफ़ॉल्ट: 'x-intlayer-locale'
  • विवरण: HTTP हेडर का नाम जिसका उपयोग लोकल निर्धारित करने के लिए किया जाता है।
  • उदाहरण: 'x-custom-locale'
  • नोट: यह API-आधारित लोकल निर्धारण के लिए उपयोगी है।

• cookieName:

  • प्रकार: string
  • डिफ़ॉल्ट: 'intlayer-locale'
  • विवरण: लोकल को स्टोर करने के लिए उपयोग की जाने वाली कुकी का नाम।
  • उदाहरण: 'custom-locale'
  • नोट: सत्रों के बीच लोकल को बनाए रखने के लिए उपयोग किया जाता है।

• prefixDefault:

  • प्रकार: boolean
  • डिफ़ॉल्ट: false
  • विवरण: क्या URL में डिफ़ॉल्ट लोकल शामिल किया जाए।
  • उदाहरण: true
  • नोट:
    • यदि true और defaultLocale = 'en': पथ = /en/dashboard या /fr/dashboard
    • यदि false और defaultLocale = 'en': पथ = /dashboard या /fr/dashboard

• basePath:

  • प्रकार: string
  • डिफ़ॉल्ट: ''
  • विवरण: एप्लिकेशन URL के लिए बेस पथ।
  • उदाहरण: '/my-app'
  • नोट:
    • यदि एप्लिकेशन https://example.com/my-app पर होस्ट किया गया है
    • बेस पथ होगा '/my-app'
    • URL होगा https://example.com/my-app/en
    • यदि बेस पाथ सेट नहीं है, तो URL होगा https://example.com/en

• serverSetCookie:

  • प्रकार: string
  • डिफ़ॉल्ट: 'always'
  • विवरण: सर्वर पर लोकल कुकी सेट करने का नियम।
  • विकल्प: 'always', 'never'
  • उदाहरण: 'never'
  • नोट: नियंत्रित करता है कि लोकल कुकी हर अनुरोध पर सेट की जाए या कभी नहीं।

• noPrefix:

  • प्रकार: boolean
  • डिफ़ॉल्ट: false
  • विवरण: क्या URL से लोकल प्रीफिक्स को हटाना है।
  • उदाहरण: true
  • नोट:
    • यदि true: URL में कोई प्रीफिक्स नहीं होगा
    • यदि false: URL में प्रीफिक्स होगा
    • basePath = '/my-app' के साथ उदाहरण:
      • यदि noPrefix = false: URL होगा https://example.com/my-app/en
      • यदि noPrefix = true: URL होगा https://example.com

• detectLocaleOnPrefetchNoPrefix:

  • प्रकार: boolean
  • डिफ़ॉल्ट: false
  • विवरण: नियंत्रित करता है कि Next.js प्रीफ़ेच अनुरोधों के दौरान लोकल डिटेक्शन होता है या नहीं।
  • उदाहरण: true
  • नोट: यह सेटिंग Next.js के लोकल प्रीफ़ेचिंग को कैसे संभालता है, इसे प्रभावित करती है:
    • उदाहरण परिदृश्य:
      • उपयोगकर्ता के ब्राउज़र की भाषा 'fr' है
      • वर्तमान पृष्ठ /fr/about है
      • लिंक /about को प्रीफ़ेच करता है
    • detectLocaleOnPrefetchNoPrefix: true के साथ:
      • प्रीफ़ेच ब्राउज़र से 'fr' लोकल का पता लगाता है
      • प्रीफ़ेच को /fr/about पर पुनर्निर्देशित करता है
    • detectLocaleOnPrefetchNoPrefix: false (डिफ़ॉल्ट) के साथ:
      • प्रीफ़ेच डिफ़ॉल्ट लोकल का उपयोग करता है
      • प्रीफ़ेच को /en/about पर पुनर्निर्देशित करता है (मानते हुए कि 'en' डिफ़ॉल्ट है)
    • कब true का उपयोग करें:
      • आपका ऐप गैर-स्थानीयकृत आंतरिक लिंक का उपयोग करता है (जैसे <a href="/about">)
      • आप नियमित और प्रीफ़ेच अनुरोधों के बीच सुसंगत स्थानीय पहचान व्यवहार चाहते हैं
    • false (डिफ़ॉल्ट) कब उपयोग करें:
      • आपका ऐप स्थानीय-उपसर्ग वाले लिंक का उपयोग करता है (जैसे <a href="/fr/about">)
      • आप प्रीफ़ेचिंग प्रदर्शन को अनुकूलित करना चाहते हैं
      • आप संभावित रीडायरेक्ट लूप से बचना चाहते हैं

सामग्री विन्यास

ऐप्लिकेशन के भीतर सामग्री प्रबंधन से संबंधित सेटिंग्स, जिनमें निर्देशिका नाम, फ़ाइल एक्सटेंशन, और व्युत्पन्न विन्यास शामिल हैं।

गुण

• autoFill:

  • प्रकार: boolean | string | { [key in Locales]?: string }
  • डिफ़ॉल्ट: undefined
  • विवरण: यह संकेत करता है कि सामग्री को AI का उपयोग करके स्वचालित रूप से कैसे भरा जाना चाहिए। इसे वैश्विक रूप से intlayer.config.ts फ़ाइल में घोषित किया जा सकता है।
  • उदाहरण: true
  • उदाहरण: './{{fileName}}.content.json'
  • उदाहरण: { fr: './{{fileName}}.fr.content.json', es: './{{fileName}}.es.content.json' }
  • नोट: ऑटो फिल कॉन्फ़िगरेशन। यह हो सकता है:
    • boolean: सभी लोकल के लिए ऑटो फिल सक्षम करें
    • string: एकल फ़ाइल या वेरिएबल्स के साथ टेम्पलेट का पथ
    • object: प्रति-लोकल फ़ाइल पथ

• watch:

  • प्रकार: boolean
  • डिफ़ॉल्ट: process.env.NODE_ENV === 'development'
  • विवरण: यह संकेत करता है कि Intlayer को ऐप में सामग्री घोषणा फ़ाइलों में परिवर्तनों के लिए देखना चाहिए ताकि संबंधित शब्दकोशों को पुनर्निर्मित किया जा सके।

• fileExtensions:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['.content.ts', '.content.js', '.content.cjs', '.content.mjs', '.content.json', '.content.tsx', '.content.jsx']
  • विवरण: शब्दकोश बनाने के दौरान खोजने के लिए फ़ाइल एक्सटेंशन।
  • उदाहरण: ['.data.ts', '.data.js', '.data.json']
  • टिप्पणी: फ़ाइल एक्सटेंशन को कस्टमाइज़ करने से टकराव से बचा जा सकता है।

• baseDir:

  • प्रकार: string
  • डिफ़ॉल्ट: process.cwd()
  • विवरण: परियोजना के लिए मूल निर्देशिका।
  • उदाहरण: '/path/to/project'
  • टिप्पणी: इसका उपयोग सभी Intlayer-संबंधित निर्देशिकाओं को हल करने के लिए किया जाता है।

• dictionaryOutput:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['intlayer']
  • विवरण: उपयोग करने के लिए शब्दकोश आउटपुट का प्रकार, जैसे 'intlayer' या 'i18next'।

• contentDir:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['.']
  • उदाहरण: ['src', '../../ui-library', require.resolve("@my-package/content")]
  • विवरण: वह डायरेक्टरी पथ जहाँ सामग्री संग्रहीत होती है।

• dictionariesDir:

  • प्रकार: string
  • डिफ़ॉल्ट: '.intlayer/dictionaries'
  • विवरण: मध्यवर्ती या आउटपुट परिणामों को संग्रहीत करने के लिए डायरेक्टरी पथ।

• moduleAugmentationDir:

  • प्रकार: string
  • डिफ़ॉल्ट: '.intlayer/types'
  • विवरण: मॉड्यूल ऑगमेंटेशन के लिए डायरेक्टरी, जो बेहतर IDE सुझाव और टाइप जांच की अनुमति देती है।
  • उदाहरण: 'intlayer-types'
  • नोट: सुनिश्चित करें कि इसे tsconfig.json में शामिल किया गया है।

• unmergedDictionariesDir:

  • प्रकार: string
  • डिफ़ॉल्ट: '.intlayer/unmerged_dictionary'
  • विवरण: बिना मर्ज किए गए शब्दकोशों को संग्रहीत करने के लिए डायरेक्टरी।
  • उदाहरण: 'translations'

• dictionariesDir:

  • प्रकार: string
  • डिफ़ॉल्ट: '.intlayer/dictionary'
  • विवरण: स्थानीयकरण शब्दकोशों को संग्रहीत करने के लिए निर्देशिका।
  • उदाहरण: 'translations'

• i18nextResourcesDir:

  • प्रकार: string
  • डिफ़ॉल्ट: 'i18next_dictionary'
  • विवरण: i18n शब्दकोशों को संग्रहीत करने के लिए निर्देशिका।
  • उदाहरण: 'translations'
  • नोट: सुनिश्चित करें कि यह निर्देशिका i18next आउटपुट प्रकार के लिए कॉन्फ़िगर की गई हो।

• typesDir:

  • प्रकार: string
  • डिफ़ॉल्ट: 'types'
  • विवरण: शब्दकोश प्रकारों को संग्रहीत करने के लिए निर्देशिका।
  • उदाहरण: 'intlayer-types'

• mainDir:

  • प्रकार: string
  • डिफ़ॉल्ट: 'main'
  • विवरण: मुख्य एप्लिकेशन फ़ाइलों को संग्रहीत करने के लिए निर्देशिका।
  • उदाहरण: 'intlayer-main'

• excludedPath:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['node_modules']
  • विवरण: सामग्री खोज से बाहर किए गए निर्देशिकाएँ।
  • नोट: यह सेटिंग अभी उपयोग में नहीं है, लेकिन भविष्य में लागू करने की योजना है।

लॉगर कॉन्फ़िगरेशन

सेटिंग्स जो लॉगर को नियंत्रित करती हैं, जिसमें उपयोग के लिए उपसर्ग शामिल है।

गुण

• mode:

  • प्रकार: string
  • डिफ़ॉल्ट: default
  • विवरण: लॉगर के मोड को दर्शाता है।
  • विकल्प: default, verbose, disabled
  • उदाहरण: default
  • नोट: लॉगर का मोड। verbose मोड अधिक जानकारी लॉग करेगा, लेकिन इसे डिबगिंग के लिए उपयोग किया जा सकता है। disabled मोड लॉगर को अक्षम कर देगा।

• prefix:

  • प्रकार: string
  • डिफ़ॉल्ट: '[intlayer] '
  • विवरण: लॉगर का उपसर्ग।
  • उदाहरण: '[my custom prefix] '
  • Note: लॉगर का उपसर्ग।

एआई कॉन्फ़िगरेशन

सेटिंग्स जो Intlayer की एआई विशेषताओं को नियंत्रित करती हैं, जिसमें प्रदाता, मॉडल, और API कुंजी शामिल हैं।

यह कॉन्फ़िगरेशन वैकल्पिक है यदि आप Intlayer डैशबोर्ड पर एक एक्सेस कुंजी का उपयोग करके पंजीकृत हैं। Intlayer स्वचालित रूप से आपकी आवश्यकताओं के लिए सबसे कुशल और लागत-प्रभावी एआई समाधान का प्रबंधन करेगा। डिफ़ॉल्ट विकल्पों का उपयोग करने से बेहतर दीर्घकालिक रखरखाव सुनिश्चित होता है क्योंकि Intlayer लगातार सबसे प्रासंगिक मॉडलों का उपयोग करने के लिए अपडेट होता रहता है।

यदि आप अपनी स्वयं की API कुंजी या विशिष्ट मॉडल का उपयोग करना पसंद करते हैं, तो आप अपनी कस्टम एआई कॉन्फ़िगरेशन परिभाषित कर सकते हैं। यह AI कॉन्फ़िगरेशन आपके Intlayer पर्यावरण में वैश्विक रूप से उपयोग किया जाएगा। CLI कमांड इन सेटिंग्स का उपयोग कमांड्स (जैसे fill) के लिए डिफ़ॉल्ट के रूप में करेंगे, साथ ही SDK, विज़ुअल एडिटर, और CMS भी इनका उपयोग करेंगे। आप कमांड पैरामीटर का उपयोग करके विशिष्ट उपयोग मामलों के लिए इन डिफ़ॉल्ट मानों को ओवरराइड कर सकते हैं।

Intlayer बेहतर लचीलापन और विकल्प के लिए कई AI प्रदाताओं का समर्थन करता है। वर्तमान में समर्थित प्रदाता हैं:

• OpenAI (डिफ़ॉल्ट)
• Anthropic Claude
• Mistral AI
• DeepSeek
• Google Gemini
• Meta Llama

गुण

• provider:

  • प्रकार: string
  • डिफ़ॉल्ट: 'openai'
  • विवरण: Intlayer की AI सुविधाओं के लिए उपयोग करने वाला प्रदाता।
  • विकल्प: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini'
  • उदाहरण: 'anthropic'
  • नोट: विभिन्न प्रदाताओं के लिए अलग-अलग API कुंजी और मूल्य निर्धारण मॉडल हो सकते हैं।

• model:

  • प्रकार: string
  • डिफ़ॉल्ट: कोई नहीं
  • विवरण: Intlayer की AI सुविधाओं के लिए उपयोग किया जाने वाला मॉडल।
  • उदाहरण: 'gpt-4o-2024-11-20'
  • नोट: उपयोग किए जाने वाले विशिष्ट मॉडल प्रदाता के अनुसार भिन्न हो सकते हैं।

• temperature:

  • प्रकार: number
  • डिफ़ॉल्ट: कोई नहीं
  • विवरण: तापमान AI की प्रतिक्रियाओं की यादृच्छिकता को नियंत्रित करता है।
  • उदाहरण: 0.1
  • नोट: उच्च तापमान AI को अधिक रचनात्मक और कम पूर्वानुमेय बनाता है।

• apiKey:

  • प्रकार: string
  • डिफ़ॉल्ट: कोई नहीं
  • विवरण: चुने गए प्रदाता के लिए आपकी API कुंजी।
  • उदाहरण: process.env.OPENAI_API_KEY
  • नोट: महत्वपूर्ण: API कुंजियाँ गोपनीय रखनी चाहिए और सार्वजनिक रूप से साझा नहीं करनी चाहिए। कृपया सुनिश्चित करें कि इन्हें सुरक्षित स्थान पर रखा जाए, जैसे कि पर्यावरण चर (environment variables) में।

• applicationContext:

  • प्रकार: string
  • डिफ़ॉल्ट: कोई नहीं
  • विवरण: आपके एप्लिकेशन के बारे में अतिरिक्त संदर्भ AI मॉडल को प्रदान करता है, जिससे यह अधिक सटीक और संदर्भानुसार उपयुक्त अनुवाद उत्पन्न कर सके। इसमें आपके ऐप के डोमेन, लक्षित दर्शक, टोन, या विशिष्ट शब्दावली की जानकारी शामिल हो सकती है।

बिल्ड कॉन्फ़िगरेशन

सेटिंग्स जो नियंत्रित करती हैं कि Intlayer आपके एप्लिकेशन की अंतरराष्ट्रीयकरण को कैसे अनुकूलित और बिल्ड करता है।

बिल्ड विकल्प @intlayer/babel और @intlayer/swc प्लगइन्स पर लागू होते हैं।

विकास मोड में, Intlayer विकास अनुभव को सरल बनाने के लिए शब्दकोशों के लिए स्थैतिक आयात का उपयोग करता है।

जब अनुकूलित किया जाता है, तो Intlayer शब्दकोश कॉल को अनुकूलित करने के लिए बदल देगा, ताकि अंतिम बंडल केवल उन शब्दकोशों को आयात करे जो वास्तव में उपयोग किए जाते हैं।

गुण

• optimize:

  • प्रकार: boolean
  • डिफ़ॉल्ट: process.env.NODE_ENV === 'production'
  • विवरण: नियंत्रित करता है कि क्या बिल्ड को अनुकूलित किया जाना चाहिए।
  • उदाहरण: true
  • नोट: सक्षम होने पर, Intlayer शब्दकोशों के सभी कॉल को अनुकूलित करने के लिए बदल देगा। इस तरह अंतिम बंडल केवल उन शब्दकोशों को आयात करेगा जो उपयोग किए जाते हैं। सभी आयात स्थैतिक आयात के रूप में रहेंगे ताकि शब्दकोशों को लोड करते समय असिंक्रोनस प्रोसेसिंग से बचा जा सके।
  • नोट: Intlayer useIntlayer के सभी कॉल्स को importMode विकल्प द्वारा परिभाषित मोड से और getIntlayer को getDictionary से बदल देगा।
  • नोट: यह विकल्प @intlayer/babel और @intlayer/swc प्लगइन्स पर निर्भर करता है।
  • नोट: सुनिश्चित करें कि सभी कुंजियाँ useIntlayer कॉल्स में स्थैतिक रूप से घोषित हों। उदाहरण के लिए useIntlayer('navbar')।

• importMode:

  • प्रकार: 'static' | 'dynamic' | 'live'
  • डिफ़ॉल्ट: 'static'
  • विवरण: नियंत्रित करता है कि शब्दकोश कैसे आयात किए जाते हैं।
  • उदाहरण: 'dynamic'
  • नोट: उपलब्ध मोड:
    • "static": शब्दकोश स्थैतिक रूप से आयात किए जाते हैं। useIntlayer को useDictionary से बदलता है।
    • "dynamic": शब्दकोश Suspense का उपयोग करके गतिशील रूप से आयात किए जाते हैं। useIntlayer को useDictionaryDynamic से बदलता है।
  • "live": शब्दकोशों को लाइव सिंक API का उपयोग करके गतिशील रूप से प्राप्त किया जाता है। useIntlayer को useDictionaryFetch से बदलता है।
  • नोट: डायनेमिक इम्पोर्ट्स Suspense पर निर्भर करते हैं और रेंडरिंग प्रदर्शन को थोड़ा प्रभावित कर सकते हैं।
  • नोट: यदि अक्षम किया गया है, तो सभी लोकल एक साथ लोड होंगे, भले ही उनका उपयोग न किया जाए।
  • नोट: यह विकल्प @intlayer/babel और @intlayer/swc प्लगइन्स पर निर्भर करता है।
  • नोट: सुनिश्चित करें कि useIntlayer कॉल्स में सभी कुंजी स्थैतिक रूप से घोषित हों। उदाहरण के लिए useIntlayer('navbar')।
  • नोट: यदि optimize अक्षम है, तो इस विकल्प को अनदेखा किया जाएगा।
  • नोट: यदि इसे "live" पर सेट किया गया है, तो केवल वे शब्दकोश जो रिमोट सामग्री शामिल करते हैं, और जिन्हें "live" फ्लैग के रूप में सेट किया गया है, उन्हें लाइव मोड के रूप में परिवर्तित किया जाएगा। अन्य शब्दकोशों को "dynamic" मोड के रूप में गतिशील रूप से आयात किया जाएगा ताकि फ़ेच क्वेरी की संख्या और लोड प्रदर्शन का अनुकूलन किया जा सके।
  • नोट: लाइव मोड शब्दकोशों को प्राप्त करने के लिए लाइव सिंक API का उपयोग करेगा। यदि API कॉल विफल हो जाती है, तो शब्दकोशों को "dynamic" मोड के रूप में गतिशील रूप से आयात किया जाएगा।
  • नोट: यह विकल्प getIntlayer, getDictionary, useDictionary, useDictionaryAsync और useDictionaryDynamic फ़ंक्शनों को प्रभावित नहीं करेगा।

• traversePattern:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['**/*.{js,ts,mjs,cjs,jsx,tsx,mjx,cjx}', '!**/node_modules/**']
  • विवरण: पैटर्न जो यह परिभाषित करते हैं कि अनुकूलन के दौरान किन फ़ाइलों को ट्रैवर्स किया जाना चाहिए।
    • उदाहरण: ['src/**/*.{ts,tsx}', '../ui-library/**/*.{ts,tsx}', '!**/node_modules/**']
  • नोट: इसका उपयोग संबंधित कोड फ़ाइलों तक अनुकूलन को सीमित करने और बिल्ड प्रदर्शन में सुधार करने के लिए करें।
  • नोट: यदि optimize अक्षम है तो इस विकल्प को नजरअंदाज किया जाएगा।
  • नोट: ग्लोब पैटर्न का उपयोग करें।

दस्तावेज़ इतिहास