JSPM – ai-function-chain@0.0.39

Package Exports

ai-function-chain
ai-function-chain/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ai-function-chain) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Demo

Demonstration YouTube link: FunctionChain: OpenAI Function Calling Simplified in Node.js

Installation

Install the package using npm or yarn:

npm install ai-function-chain
# or
yarn add ai-function-chain
# or
pnpm install ai-function-chain

Create a file named .env at the root of your project. Obtain your OpenAI API Key from here, and add it to the .env file:

OPENAI_API_KEY=your_openai_api_key

Setup

To setup FunctionChain:

Create an index.js file in the root of your project.
Import the FunctionChain class from ai-function-chain and instantiate it.
Call the call method with a message. Optionally, you can specify a set of functions to execute.

import { FunctionChain } from "ai-function-chain";

const functionChain = new FunctionChain();

async function main() {
    const res1 = await functionChain.call("Get me the latest price of Bitcoin");
    const res2 = await functionChain.call("Open the calculator on my computer");
    const res3 = await functionChain.call("Get me the latest price of Ethereum", {
        functionArray: ["fetchCryptoPrice"] // Optionally specify which functions to use
    });
    console.log(res1, res2, res3);
}

main();

Running Your Project

After setting up index.js and adding your functions, run your project using:

npm run dev

Scoped FunctionChain Instance

In this example, we limit the functions available to the FunctionChain instance to only the getAlphaVantageCompanyOverview function:

import { FunctionChain } from "ai-function-chain";

// By passing in no options, the default FunctionChain instance will use all available functions within the core FunctionChain library.
// Note that it will not include any custom functions unless a directory is explicitly passed.

const functionChain = new FunctionChain();

// The below invocations will use all functions in the functions directory to try to answer the question
const res1 = functionChain.call("Get me the latest price of Bitcoin");
const res2 = functionChain.call("Open the calculator on my computer");
const res3 = functionChain.call("Get me the latest price of Ethereum");

// The below invocations will use the specified functions to try to answer the question
const res4 = functionChain.call("Get me the latest price of Bitcoin", { functionArray: ["fetchCryptoPrices"] });
const res4 = functionChain.call("What is Apple's market capitalization", { functionArray: ["getAlphaVantageCompanyOverview"] });

// Alternatively, you can create a scoped FunctionChain instance like this to use an array of functions for all calls made with a FunctionChain instance
const scopedFunctionChain = new FunctionChain({ functionArray: ["getAlphaVantageCompanyOverview"] });

// These calls will use the scoped FunctionChain instance
// which includes only the "getAlphaVantageCompanyOverview" function
const res6 = scopedFunctionChain.call("What is Amazon's Revenue (TTM)");
const res7 = scopedFunctionChain.call("What is Alphabet's EBITDA");

console.log(res1, res2, res3, res4, res5, res6, res7);

// Note: The calls from res5 to res7 require a free API key from Alpha Vantage.
// To make these calls work, please replace the placeholder API key in the .env file
// with your own API key obtained from Alpha Vantage.