Examples

To see TypeChat in action, check out the examples found in /typescript/examples.

Each example shows how TypeChat handles natural language input, and maps to validated JSON as output. Most example inputs run on both GPT 3.5 and GPT 4. We are working to reproduce outputs with other models. Generally, models trained on both code and natural language text have high accuracy.

We recommend reading each example in the following order.

Name	Description
Sentiment	A sentiment classifier which categorizes user input as negative, neutral, or positive. This is TypeChat's "hello world!"
Coffee Shop	An intelligent agent for a coffee shop. This sample translates user intent into a list of coffee order items.
Calendar	An intelligent scheduler. This sample translates user intent into a sequence of actions to modify a calendar.
Restaurant	An intelligent agent for taking orders at a restaurant. Similar to the coffee shop example, but uses a more complex schema to model more complex linguistic input. The prose files illustrate the line between simpler and more advanced language models in handling compound sentences, distractions, and corrections. This example also shows how we can use TypeScript to provide a user intent summary.
Math	Translate calculations into simple programs given an API that can perform the 4 basic mathematical operators. This example highlights TypeChat's program generation capabilities.
Music	An app for playing music, creating playlists, etc. on Spotify through natural language. Each user intent is translated into a series of actions in JSON which correspond to a simple dataflow program, where each step can consume data produced from previous step.

Step 1: Configure development environment

Option 1: Local Machine

You can experiment with these TypeChat examples on your local machine with just Node.js.

Ensure Node.js (18.16.0 LTS or newer) or newer is installed.

git clone https://github.com/microsoft/TypeChat
cd TypeChat
npm install

Option 2: GitHub Codespaces

GitHub Codespaces enables you to try TypeChat quickly in a development environment hosted in the cloud.

On the TypeChat repository page:

Click the green button labeled <> Code
Select the Codespaces tab.
Click the green Create codespace button.

If this is your first time creating a codespace, read this.

If this is your first time creating a codespace on this repository, GitHub will take a moment to create a dev container image for your session. Once the image has been created, the browser will load Visual Studio Code in a developer environment automatically configured with the necessary prerequisites, TypeChat cloned, and packages installed.

Remember that you are running in the cloud, so all changes you make to the source tree must be committed and pushed before destroying the codespace. GitHub accounts are usually configured to automatically delete codespaces that have been inactive for 30 days.

For more information, see the GitHub Codespaces Overview

Step 2: Build TypeChat Examples

Build TypeChat and the examples by running the following command in the repository root:

npm run build-all

Step 3: Configure environment variables

Currently, the examples are running on OpenAI or Azure OpenAI endpoints. To use an OpenAI endpoint, include the following environment variables:

Variable	Value
`OPENAI_MODEL`	The OpenAI model name (e.g. `gpt-3.5-turbo` or `gpt-4`)
`OPENAI_API_KEY`	Your OpenAI API key

To use an Azure OpenAI endpoint, include the following environment variables:

Variable	Value
`AZURE_OPENAI_ENDPOINT`	The full URL of the Azure OpenAI REST API (e.g. `https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2023-05-15`)
`AZURE_OPENAI_API_KEY`	Your Azure OpenAI API key

We recommend setting environment variables by creating a .env file in the root directory of the project that looks like the following:

# For OpenAI
OPENAI_MODEL=...
OPENAI_API_KEY=...

# For Azure OpenAI
AZURE_OPENAI_ENDPOINT=...
AZURE_OPENAI_API_KEY=...

Step 4: Run the examples

Examples can be found in the typescript/examples directory.

To run an example interactively, type node ./dist/main.js from the example's directory and enter requests when prompted. Type quit or exit to end the session. You can also open in VS Code the selected example's directory and press F5 to launch it in debug mode.

Note that there are various sample "prose" files (e.g. input.txt) provided in each src directory that can give a sense of what you can run.

To run an example with one of these input files, run node ./dist/main.js <input-file-path>. For example, in the coffeeShop directory, you can run:

node ./dist/main.js ./dist/input.txt