@plsr/blaze

Note: right now this lib is only compatible with openai LLMs.

# bun
bun i openai @plsr/blaze

# npm
npm i openai @plsr/blaze

# yarn
yarn add openai @plsr/blaze

Todo

• [ ] On Translator.result()
  • [x] Try to fix badly formatted JSON
  • [ ] Remove any null fields
  • [ ] Optionally apply default values

Examples

Example setup

index.mjs:

import OpenAI from "openai";
import { Translator } from "@plsr/blaze";

const openai = new OpenAI(); // Requires api key in environment
const schema = {
    $schema: "http://json-schema.org/draft-07/schema#",
    title: "Client",
    description: "Schema representing a client.",
    type: "object",
    properties: {
        isCompany: {
            default: false,
            type: "boolean",
            description: "true if the client is a company.",
        },
        firstName: {
            type: "string",
            description: "First name of the client.",
        },
        lastName: {
            type: "string",
            description: "Last name of the client.",
        },
        companyName: {
            type: "string",
            description: "Name of the company.",
        },
        address: {
            type: "string",
            description: "Client's address.",
        },
        email: {
            type: "string",
            format: "email",
            description: "Client's email address.",
        },
        phone: {
            type: "string",
            description: "Client's telephone number.",
        },
    },
};

const translator = new Translator(openai, schema);

Basic

translator
    .translate(
        "Just sold 2 resistors and one capacitor to Jean Michel Frey, he's a really good guy! He lives just next to my house in the Avenue Montaigne in Paris",
    )
    .then((x) => console.log(x.result));

{
    "isCompany": false,
    "firstName": "Jean Michel",
    "lastName": "Frey",
    "address": "Avenue Montaigne, Paris"
}

Completion

translator
    .translate(
        "Just sold 2 resistors and one capacitor to Jean Michel Frey, he's a really good guy!",
    )
    .then((x) => x.middleware((res) => console.log(res)))
    .then((x) => x.addContext("He lives just next to my house in the Avenue Montaigne in Paris"))
    .then((x) => console.log(x.result));

First log

{
    "isCompany": false,
    "firstName": "Jean Michel",
    "lastName": "Frey"
}

Second log

{
    "isCompany": false,
    "firstName": "Jean Michel",
    "lastName": "Frey",
    "address": "Avenue Montaigne, Paris"
}

Give examples

Bad example, just to demonstrate method usage.

translator
    .addExample('Jean paul mars lives in Paris', {
        isCompany: false,
        firstName: "Jean-Paul",
        lastName: "Mars",
        address: "Paris"
    })
    .translate(
        "Just sold 2 resistors and one capacitor to Jean Michel Frey, he's a really good guy!",
    )
    .then((x) => console.log(x.result));

{
    "isCompany": false,
    "firstName": "Jean Michel",
    "lastName": "Frey",
    "address": "Avenue Montaigne, Paris"
}

Enable advanced parsing

To enable javascript or typescript parsing, you can set translator.insecureParsing = true. Under the hood this will detect and evaluate javascript or typescript to return JSON.

Ideas

You could use this lib json-schema-to-typescript to generate typings for your inputs.

Dev

To install dependencies:

bun install

To run:

bun run index.ts

This project was created using bun init in bun v1.0.3. Bun is a fast all-in-one JavaScript runtime.