lighton-muse
v1.1.0
Published
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![Twitter](https://img.shields.io/twitter/follow/LightOnIO?style=social)](https://twitter.com/LightOnIO)
Downloads
4
Readme
LightOn Muse JS Bindings
JavaScript bindings for the Muse API: production-ready intelligence primitives powered by state-of-the-art language models. By LightOn.
Create. Process. Understand. Learn.
Uplift your product with the natural language generation & understanding capabilities of Muse. State-of-the-art large language models in French, English, Italian, and Spanish—with more to come—are just an API call away. Our models can help you build conversational AI, copywriting tools, text classifiers, semantic search, and more.
🛣️ Accessing the Muse API public beta
The Muse API is currently in public beta. Learn more about Muse and sign up at muse.lighton.ai.
Installation and documentation
To add the Muse API client to your project, run one of the following commands:
yarn add lighton-muse
or
npm install lighton-muse
The library documentation is available at lightonai.github.io/js-lightonmuse/. Guides and documentation can be found at the API docs website.
Examples
You can find more examples in the repository
yarn build-examples
# and then
node examples/<example-name>.js
Quickstart
Using lighton-muse
is pretty simple, the interface matches the endpoints offered by the Muse API. The whole API is typed.
You can initialize the client with your token.
import { MuseRequest, ApiModel, Endpoint } from 'lighton-muse';
const client = new MuseRequest('<your-api-key>');
// or
const client = new MuseRequest('API_KEY', 'Your own API base URL');
Create
let { error, response } = client.query(ApiModel.OrionFrV2, Endpoint.Create, {
text: 'Hello, world!',
});
if (error) {
console.error(error);
} else {
console.log(response);
}
Select
let { error, response } = client.query(ApiModel.OrionFrV2, Endpoint.Select, {
reference: 'Quel nom est correct ?',
candidates: ['pain au chocolat', 'chocolatine'],
});
if (error) {
console.error(error);
} else {
console.log(response);
}
Analyse
let { error, response } = client.query(ApiModel.OrionFrV2, Endpoint.Analyse, {
text: "Avec `Analyse` on peut toujours trouver les parties plus surprenantes d'une phrase.",
});
if (error) {
console.error(error);
} else {
console.log(response);
}
Embed
let { error, response } = client.query(ApiModel.LyraEn, Endpoint.Embed, {
text: 'This sentence will be transformed in a nice matrix of numbers.',
});
if (error) {
console.error(error);
} else {
console.log(response);
}
Compare
let { error, response } = client.query(ApiModel.LyraEn, Endpoint.Compare, {
reference: 'This is the reference.',
candidates: [
'This is close to the reference',
'While this is most definitely not',
],
});
if (error) {
console.error(error);
} else {
console.log(response);
}
Tokenize
let { error, response } = client.query(ApiModel.LyraEn, Endpoint.Tokenize, {
text: "Let's discover how many tokens is this text",
});
if (error) {
console.error(error);
} else {
console.log(response);
}
Access to LightOn Muse
Access the public beta of LightOn Muse and try our intelligence primitives at muse.lighton.ai