generaltranslation 1.1.11 → 1.1.13

package/README.md

@@ -8,13 +8,13 @@ Note: this package is in active development.
 
 ## Getting Started
 
-In your terminal:
+<b>In your terminal:</b>
 
 ```
 npm i generaltranslation
 ```
 
-In your code:
+<b>In your code:</b>
 
 ```
 import GT from 'generaltranslation'
@@ -23,6 +23,12 @@ import GT from 'generaltranslation'
 const gt = new GT()
 ```
 
+or, import functions directly:
+
+```
+import { getLanguageName } from 'generaltranslation'
+```
+
 ## Convert between languages and ISO-639 codes
 
 ### getLanguageName(codes)
@@ -58,12 +64,8 @@ We continually benchmark AI models and add new models as they are released. That
 Get the latest list of models for which there is data. Returns an array of model names.
 
 ```
-async function main() {
-    const models = await gt.getModelList();
-    console.log(models) // ['gpt-4', ... ]
-}
-
-main();
+const models = await gt.getModelList();
+console.log(models) // ['gpt-4', ... ]
 ```
 
 ### async getModelLanguages(model)
@@ -71,27 +73,81 @@ main();
 Get all languages known to be compatible with a given AI model. Returns an array of languages codes, or null if the model is unknown.
 
 ```
-async function main() {
-    const languages = await gt.getModelLanguages('mixtral-8x7b')
-    console.log(languages) // ['en', 'fr', 'de', 'es', 'it']
-}
-
-main();
+const languages = await gt.getModelLanguages('mixtral-8x7b')
+console.log(languages) // ['en', 'fr', 'de', 'es', 'it']
 ```
 
-### async isSupportedLanguage(model, language)
+### async isSupportedLanguage(model, code)
 
 Returns true if a model is known to be compatible with a given language, represented by an ISO-639 language code. Returns false otherwise.
 
 ```
-async function main() {
-    const supported = await gt.isSupportedLanguage('gpt-4', 'fr')
-    console.log(supported) // true
-}
-
-main();
+const supported = await gt.isSupportedLanguage('gpt-4', 'fr')
+console.log(supported) // true
 ```
 
 ## API
 
-Coming soon!
+For these functions, you need to sign up for an API key at <a href='https://generaltranslation.com' target='_blank'>generaltranslation.com</a>.
+
+There's a small, free allowance to let you test out the API without payment information.
+
+Add the API key to your code like this:
+
+```
+import GT from 'generaltranslation'
+
+const gt = new GT({
+	apiKey: process.env.GT_API_KEY // looks like 'gtx-XXX'
+});
+```
+
+### async gt.getPrompt(prompt, code)
+
+Translates prompt into the language represented by an ISO-639 language code. Designed for translating prompts into other languages, to internationalize responses from AI models.
+
+Just wrap `gt.getPrompt` around your prompt and go. 
+
+All of the following are valid:
+
+```
+const translatedPrompt = await gt.getPrompt('Tell me a story', 'es');
+```
+
+```
+const first = 'Tell me a story ';
+const second = 'about a cat'
+
+const translatedPrompt = await gt.getPrompt([
+    first, second
+], 'es');
+```
+
+To mark text that shouldn't be translated, wrap it in `{ text: "", translate: false }`. Items marked as `translate: false` are never sent to our API. For example:
+
+```
+const prompt = 'Tell me a story about ';
+const input = 'gatos con espadas'
+
+const translatedPrompt = await gt.getPrompt([
+    prompt, { text: input, translate: false }
+], 'es');
+```
+
+For type consistency, you can also make everything in the prompt parameter an object:
+
+```
+const prompt = 'Tell me a story about ';
+const input = 'gatos con espadas'
+
+const translatedPrompt = await gt.getPrompt([
+    { text: prompt }, 
+    { text: input, translate: false }
+], 'es');
+```
+
+This also works:
+
+```
+const translatedPrompt = await gt.getPrompt({ text: 'Tell me a story' }, 'es');
+```

package/index.js

@@ -29,8 +29,8 @@ class GT {
     isLanguageSupported = _isLanguageSupported; // e.g. ('mistral-7b', 'en') => true
 
     // Prompt internationalization
-    getPrompt = async (prompt, language) => {
-        return await _getPrompt(prompt, language, this.defaultLanguage, this.apiKey);
+    getPrompt = async (prompt, code) => {
+        return await _getPrompt(prompt, code, this.defaultLanguage, this.apiKey);
     }
 
 }

package/package.json

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

package/prompts/prompts.js

@@ -64,12 +64,12 @@ const _constructPrompt = ({translated, redacted = null}) => {
 
 // Get a translated prompt via General Translation API
 // Returns prompt string
-const _getPrompt = async (prompt, language, defaultLanguage, apiKey) => {
+const _getPrompt = async (prompt, code, defaultLanguage, apiKey) => {
     try {
         if (!apiKey) {
             throw new Error('Missing API Key!')
         }
-        if (language === defaultLanguage) {
+        if (code === defaultLanguage) {
             return _constructPrompt(prompt);
         }
         const { processed, redacted } = _processPrompt(prompt);
@@ -81,7 +81,7 @@ const _getPrompt = async (prompt, language, defaultLanguage, apiKey) => {
             },
             body: JSON.stringify({
                 prompt: processed,
-                language: language,
+                language: code,
                 defaultLanguage: defaultLanguage
             })
         })