TypeScript Large Language Model Templates (TS-LLMT)

This repository holds experimental code aimed at providing native TypeScript support for Large Language Model Templates.

The key idea is to track "named-holes" in templates at type-checking (typing) time. This means:

• You never need to debug an accidental substitution for the wrong variable name.
• You can substitute for some variables but not others, in any order you like, and the remaining variables are tracked in the type.
• You can substitute templates with more holes into a named-hole in a template, and you get the correct remaining holes in the right places in the final template.
• The same hole can appear in multiple places, substitution substitutes it everywhere, as you would expect.
• There is support for few-shot prompts (where you have some iterated sub-template over a data structure).

Here's a mini-example:

import { nv, template } from 'ts-llmt';

const thingVar = nv('thing');
const thing2Var = nv('thing2');
// *NOTE*: type of `whatIsAtoB` is magically inferred to be:
//         `Template<"thing" | "thing2">`
const whatIsAtoB = template`what is a ${thingVar} to a ${thing2Var}?`;

// Replacing the `thing` variable in whatIsAtoB, gives the type:
//         `Template<"thing2">`
const whatIsTabletoB = whatIsAtoB.vars.thing.substStr('table');

// The escaped raw form of this template is as so:
expect(whatIsTabletoB.escaped).toEqual('what is a table to a {{thing2}}?');

The key nice feature of this is that you get as "as-you-type" error checking, and arguments can be auto-completed by the IDE. You can never substitute for a variable that is not there.

You can do multi-variable replacement nicely too, and still have all the wonderful type-checking like so:

whatIsAtoB.substs({ thing: 'table', thing2: 'chair' });
expect(whatIsTabletoB.escaped).toEqual('what is a table to a chair?');

License: Apache 2.0

Source code for this library is released under the Apache 2.0 license. The full text of the Apache-2.0 license is available in the accompanying LICENSE.md file.

Contributing

See the CONTRIBUTING.md file for details of how to contribute, setup your environment, run tests, check license headers, style, and format your commit messages.