@jumploops/magic v0.0.6

🪄

AI functions for Typescript

Magically generate results for your Typescript functions by utilizing large language models (LLMs) like GPT-4 from OpenAI.

Warning

The code in this repository (including this README) was created with GPT-4. This is not a production repository and caution should be used when running this code.

tl;dr

How does it work?

This library uses a Typescript transformer to take the return type of a function, convert that type into a JSON Schema, and then replace the function body with code to query the OpenAI API and validate the response against the JSON Schema.

This library doesn't write code for your functions, it allows you to use LLMs as a runtime.

Features

• Seamlessly transform your TypeScript functions with a simple //@magic comment
• Integrate the latest AI language models such as GPT-4 from OpenAI
• Effortless setup with your existing TypeScript project
• Automagically validate LLM responses against your Typescript interfaces

Usage

Transform your TypeScript functions by adding the //@magic comment.

Here's an example function:

// @magic
async function example(): Promise<Mountain> {
  //Return the 3rd highest mountain
}

When this function is called, it'll leverage an AI language model like GPT-4 and return the following result:

{ name: 'Kangchenjunga', height: { meters: 8586, feet: 28169 } }

Note: In this example, Mountain is defined as:

interface Height {
  meters: number;
  feet: number;
}

interface Mountain {
  name: string;
  height: Height;
}

Prerequisites

The OPENAI_API_KEY environment variable is required to access the OpenAI API. The OPENAI_MODEL environment variable allows you to optionally specify which model to use, and defaults to gpt-3.5-turbo if not set.

export OPENAI_API_KEY=your_api_key_here
export OPENAI_MODEL=gpt-4 #this step is optional

Installation

First, install @jumploops/magic as a development dependency using:

npm install --save-dev @jumploops/magic

Setup with ts-patch

npm install -D ts-patch
ts-patch install

Now, add the plugin to your tsconfig.json:

{
  "compilerOptions": {
    "plugins": [
      { "transform": "@jumploops/magic/transformer" }
    ]
  }
}

Setup with ttypescript

Install ttypescript:

npm i -D ttypescript

Next, add the plugin to your tsconfig.json:

{
  "compilerOptions": {
    "plugins": [
      { "transform": "@jumploops/magic/transformer" }
    ]
  }
}

Compile your project using ttypescript:

ttsc

API Reference

@magic

Use //@magic to annotate a TypeScript function that you want to transform into a call to an external LLM. The function should be async.

Example:

// @magic
async function example(): Promise<Mountain> {
  //Return the 3rd highest mountain
}

Prior Art

This package took inspiration from Marvin - build AI functions that use an LLM as a runtime

Contributing

We welcome contributions! Please open an issue or submit a pull request if you'd like to help improve @jumploops/magic.

License

MIT License.