generaltranslation 1.0.22 → 1.1.1

package/README.md

@@ -8,23 +8,32 @@ Note: this package is in active development.
 
 ## Getting Started
 
+In your terminal:
+
 ```
 npm i generaltranslation
 ```
 
-## Toolkit Functions
+In your code:
+
+```
+import GT from 'generaltranslation'
+// or const GT = require('generaltranslation')
+
+const gt = new GT()
+```
+
+## Language Codes
 
 ### getLanguageName(codes)
 
 Returns a language name from a two or three-letter ISO-639 language code, or an array of codes.
 
 ```
-import { getLanguageName } from 'generaltranslation'
-
-const language = getLanguageName('en');
+const language = gt.getLanguageName('en');
 console.log(language) // 'English'
 
-const languages = getLanguageName(['fr', 'es'])
+const languages = gt.getLanguageName(['fr', 'es'])
 console.log(languages) // ['French', 'Spanish']
 ```
 
@@ -33,27 +42,24 @@ console.log(languages) // ['French', 'Spanish']
 Returns an ISO-639 code from a language name or an array of language names.
 
 ```
-import { getLanguageCode } from 'generaltranslation'
-
-const code = getLanguageCode('English');
+const code = gt.getLanguageCode('English');
 console.log(language) // 'en'
 
-const codes = getLanguageCodes(['French', 'Spanish'])
+const codes = gt.getLanguageCodes(['French', 'Spanish'])
 console.log(codes) // ['fr', 'es']
 ```
 
-## Async Toolkit Functions
+## Which AI models are compatible with which languages?
 
-As language models are continuously benchmarked, we update our data in real time. Calling these async functions is completely free and requires no API key.
+We continually benchmark AI models and add new models as they are released. That means these functions have to be <code>async</code>. This information is provided as a public service. It's completely free and requires no API key.
 
 ### async getModelList()
 
 Get the latest list of models for which there is data. Returns an array of model names.
-```
-import { getModelList } from 'generaltranslation'
 
+```
 async function main() {
-    const models = await getModelList();
+    const models = await gt.getModelList();
     console.log(models) // ['gpt-4', ... ]
 }
 
@@ -62,13 +68,11 @@ main();
 
 ### async getModelLanguages(model)
 
-Get all languages known to be compatible with a given LLM. Returns an array of languages codes, [] if the model is unknown.
+Get all languages known to be compatible with a given AI model. Returns an array of languages codes, or [] if the model is unknown.
 
 ```
-import { getModelLanguages } from 'generaltranslation'
-
 async function main() {
-    const languages = await getModelLanguages('mixtral-8x7b')
+    const languages = await gt.getModelLanguages('mixtral-8x7b')
     console.log(languages) // ['en', 'fr', 'de', 'es', 'it']
 }
 
@@ -80,10 +84,8 @@ main();
 Returns true if a model is known to be compatible with a given language, represented by an ISO-639 language code. Returns false otherwise.
 
 ```
-import { isSupportedLanguage } from 'generaltranslation'
-
 async function main() {
-    const supported = await isSupportedLanguage('gpt-4', 'fr')
+    const supported = await gt.isSupportedLanguage('gpt-4', 'fr')
     console.log(supported) // true
 }
 

package/index.js

@@ -7,9 +7,26 @@ const { getLanguageName, getLanguageCode } = require('./codes/codes.js');
 
 const { getModelList, getModelLanguages, isLanguageSupported } = require('./models/models.js');
 
+class GT {
+
+    constructor({
+        apiKey = '', 
+        defaultLanguage = 'en'
+    } = {}) {
+        this.apiKey = apiKey;
+        this.defaultLanguage = defaultLanguage;
+    }
+
+    // Language code functions
+    getLanguageName = getLanguageName; // e.g. 'en' => 'English'
+    getLanguageCode = getLanguageCode; // e.g. 'English' => 'en'
+
+    getModelList = getModelList; // returns array of supported model names
+    getModelLanguages = getModelLanguages; // e.g. 'mistral-7b' => ['en']
+    isLanguageSupported = isLanguageSupported; // e.g. ('mistral-7b', 'en') => true
+
+}
+
 // ----- EXPORTS ----- //
 
-module.exports = {
-    getLanguageName, getLanguageCode,
-    getModelList, getModelLanguages, isLanguageSupported
-}
+module.exports = GT;

package/models/models.js

@@ -1,10 +1,10 @@
 // ----- MODEL INFORMATION ----- //
 
-// Get all models and all languages
+// Get all models
 // Returns an array of model names
 const getModelList = async () => {
     try {
-        const result = await fetch(`https://gtx.dev/models`);
+        const result = await fetch(`https://models.gtx.dev/models`);
         const models = await result.json();
         return models;
     } catch (error) {
@@ -19,7 +19,7 @@ const _getModelInfo = async model => {
     if (!model) return null;
     model = model?.toLowerCase();
     try {
-        const result = await fetch(`https://gtx.dev/model/${model}`);
+        const result = await fetch(`https://models.gtx.dev/model/${model}`);
         const modelInfo = await result.json();
         return modelInfo;
     } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "1.0.22",
+  "version": "1.1.1",
   "description": "A language toolkit for AI developers",
   "main": "index.js",
   "scripts": {