graphai 0.0.10 → 0.0.11

package/README.md

@@ -52,6 +52,64 @@ GraphAI is designed to simplify this process by decoupling the complexity of mul
 
 Furthermore, GraphAI's robust mechanisms for error handling, retry strategies, timeouts, and logging empower developers to concentrate on refining the application logic.
 
+## Quick Install
+
+```
+pip install graphai
+```
+
+or
+
+```
+yarn add graphai
+```
+
+## Collaboration
+
+Step 1. Install git, node and yarn
+
+Step 2. Clone the project and install necessary node modules
+
+```
+git clone git@github.com:snakajima/graphai.git
+cd graphai
+yarn install
+```
+
+Step 3. Set the environment variable OPENAI_API_KEY to your own key (=sk-...)
+
+You need to set ANTHROPIC_API_KEY as well, if you want to use Claude.
+
+Step 4. Run the test script
+
+Start web server for http agent
+
+```
+cd tests/http-server/docs/
+npx http-server
+```
+
+then run the test
+
+```
+npm run test
+```
+
+Step 5. Run one of sample scripts
+
+```
+npm run sample ./samples/home.ts
+```
+
+Step 6. Write some code and send pull requests
+
+Key principles:
+
+1. Keep the core (Node and GraphAI classes) small and simple.
+2. Enhance the platform by adding 'agents' (plug ins).
+3. Simple but effective test scripts make it easy to maintain.
+4. Run "npm run format" before submitting pull requests. 
+
 ## Data Flow Graph
 
 A Data Flow Graph (DFG) is a JavaScript object, which defines the flow of data. It is typically described in YAML file and loaded at runtime.

package/lib/experimental_agents/data_agent.d.ts

@@ -0,0 +1,3 @@
+import { AgentFunction } from "../graphai";
+export declare const dataObjectMergeTemplateAgent: AgentFunction;
+export declare const dataSumTemplateAgent: AgentFunction<Record<string, any>, number, number>;

package/lib/experimental_agents/data_agent.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dataSumTemplateAgent = exports.dataObjectMergeTemplateAgent = void 0;
+const deepmerge_1 = __importDefault(require("deepmerge"));
+const dataObjectMergeTemplateAgent = async ({ nodeId, params, inputs, verbose }) => {
+    if (verbose) {
+        console.log("executing", nodeId, params);
+    }
+    return inputs.reduce((tmp, input) => {
+        return (0, deepmerge_1.default)(tmp, input);
+    }, {});
+};
+exports.dataObjectMergeTemplateAgent = dataObjectMergeTemplateAgent;
+const dataSumTemplateAgent = async ({ nodeId, params, inputs, verbose }) => {
+    if (verbose) {
+        console.log("executing", nodeId, params);
+    }
+    return inputs.reduce((tmp, input) => {
+        return tmp + input;
+    }, 0);
+};
+exports.dataSumTemplateAgent = dataSumTemplateAgent;

package/lib/experimental_agents/index.d.ts

@@ -1,2 +1,5 @@
 export * from "./string_agent";
 export * from "./slashgpt_agent";
+export * from "./sleeper_agent";
+export * from "./data_agent";
+export * from "./nested_agent";

package/lib/experimental_agents/index.js

@@ -16,3 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./string_agent"), exports);
 __exportStar(require("./slashgpt_agent"), exports);
+__exportStar(require("./sleeper_agent"), exports);
+__exportStar(require("./data_agent"), exports);
+__exportStar(require("./nested_agent"), exports);

package/lib/experimental_agents/nested_agent.d.ts

@@ -0,0 +1,6 @@
+import { GraphData, AgentFunction } from "../graphai";
+export declare const nestedAgent: AgentFunction<{
+    graph: GraphData;
+    nodeId: string;
+    inputNodes?: Array<string>;
+}>;

package/lib/experimental_agents/nested_agent.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nestedAgent = void 0;
+const graphai_1 = require("../graphai");
+const nestedAgent = async ({ params, inputs, agents }) => {
+    const graph = new graphai_1.GraphAI(params.graph, agents);
+    try {
+        // Inject inputs to specified source nodes
+        (params.inputNodes ?? []).forEach((nodeId, index) => {
+            graph.injectResult(nodeId, inputs[index]);
+        });
+        const results = await graph.run();
+        return results[params.nodeId];
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            console.log("Error:", error.message);
+        }
+        throw error;
+    }
+};
+exports.nestedAgent = nestedAgent;

package/lib/experimental_agents/slashgpt_agent.js

@@ -7,17 +7,19 @@ exports.slashGPTAgent = void 0;
 const path_1 = __importDefault(require("path"));
 const slashgpt_1 = require("slashgpt");
 const config = new slashgpt_1.ChatConfig(path_1.default.resolve(__dirname));
-const slashGPTAgent = async (context) => {
-    console.log("executing", context.nodeId, context.params);
-    const session = new slashgpt_1.ChatSession(config, context.params.manifest ?? {});
-    const query = context.params?.query ? [context.params.query] : [];
-    const contents = query.concat(context.inputs.map((input) => {
+const slashGPTAgent = async ({ nodeId, params, inputs, verbose }) => {
+    if (verbose) {
+        console.log("executing", nodeId, params);
+    }
+    const session = new slashgpt_1.ChatSession(config, params.manifest ?? {});
+    const query = params?.query ? [params.query] : [];
+    const contents = query.concat(inputs.map((input) => {
         return input.content;
     }));
     session.append_user_question(contents.join("\n"));
     await session.call_loop(() => { });
     const message = (() => {
-        if (context.params?.function_result) {
+        if (params?.function_result) {
             return session.history.messages().find((m) => m.role === "function_result");
         }
         return session.history.last_message();

package/lib/experimental_agents/sleeper_agent.d.ts

@@ -0,0 +1,10 @@
+import { AgentFunction } from "../graphai";
+export declare const sleeperAgent: AgentFunction<{
+    duration: number;
+    result?: Record<string, any>;
+}>;
+export declare const sleeperAgentDebug: AgentFunction<{
+    duration: number;
+    result?: Record<string, any>;
+    fail?: boolean;
+}>;

package/lib/experimental_agents/sleeper_agent.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleeperAgentDebug = exports.sleeperAgent = void 0;
+const utils_1 = require("../utils/utils");
+const deepmerge_1 = __importDefault(require("deepmerge"));
+const sleeperAgent = async (context) => {
+    const { params, inputs } = context;
+    await (0, utils_1.sleep)(params.duration);
+    return inputs.reduce((result, input) => {
+        return (0, deepmerge_1.default)(result, input);
+    }, params.result ?? {});
+};
+exports.sleeperAgent = sleeperAgent;
+const sleeperAgentDebug = async (context) => {
+    const { nodeId, params, inputs, retry } = context;
+    await (0, utils_1.sleep)(params.duration / (retry + 1));
+    if (params.fail && retry < 2) {
+        console.log("failed (intentional)", nodeId, retry);
+        throw new Error("Intentional Failure");
+    }
+    return inputs.reduce((result, input) => {
+        return (0, deepmerge_1.default)(result, input);
+    }, params.result ?? {});
+};
+exports.sleeperAgentDebug = sleeperAgentDebug;

package/lib/experimental_agents/string_agent.js

@@ -1,11 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stringTemplateAgent = void 0;
-const stringTemplateAgent = async (context) => {
-    console.log("executing", context.nodeId, context.params);
-    const content = context.inputs.reduce((template, input, index) => {
-        return template.replace("${" + index + "}", input[context.params.inputKey ?? "content"]);
-    }, context.params.template);
+// see example
+//  tests/agents/test_string_agent.ts
+const stringTemplateAgent = async ({ nodeId, params, inputs, verbose }) => {
+    if (verbose) {
+        console.log("executing", nodeId, params);
+    }
+    const content = inputs.reduce((template, input, index) => {
+        return template.replace("${" + index + "}", input[params.inputKey ?? "content"]);
+    }, params.template);
     return { content };
 };
 exports.stringTemplateAgent = stringTemplateAgent;

package/lib/graphai.d.ts

@@ -24,6 +24,7 @@ type NodeData = {
 export type GraphData = {
     nodes: Record<string, NodeData>;
     concurrency?: number;
+    verbose?: boolean;
 };
 export type TransactionLog = {
     nodeId: string;
@@ -43,6 +44,8 @@ export type AgentFunctionContext<ParamsType, ResultType, PreviousResultType> = {
     retry: number;
     params: NodeDataParams<ParamsType>;
     inputs: Array<PreviousResultType>;
+    verbose: boolean;
+    agents: CallbackDictonaryArgs;
 };
 export type AgentFunction<ParamsType = Record<string, any>, ResultType = Record<string, any>, PreviousResultType = Record<string, any>> = (context: AgentFunctionContext<ParamsType, ResultType, PreviousResultType>) => Promise<ResultData<ResultType>>;
 export type AgentFunctionDictonary = Record<string, AgentFunction<any, any, any>>;
@@ -75,6 +78,7 @@ declare class Node {
     execute(): Promise<void>;
 }
 type GraphNodes = Record<string, Node>;
+export type CallbackDictonaryArgs = AgentFunctionDictonary | AgentFunction<any, any, any>;
 export declare class GraphAI {
     nodes: GraphNodes;
     callbackDictonary: AgentFunctionDictonary;
@@ -83,8 +87,9 @@ export declare class GraphAI {
     private nodeQueue;
     private onComplete;
     private concurrency;
+    verbose: boolean;
     private logs;
-    constructor(data: GraphData, callbackDictonary: AgentFunctionDictonary | AgentFunction<any, any, any>);
+    constructor(data: GraphData, callbackDictonary: CallbackDictonaryArgs);
     getCallback(_agentId?: string): AgentFunction<any, any, any>;
     asString(): string;
     results(): ResultDataDictonary<Record<string, any>>;

package/lib/graphai.js

@@ -117,6 +117,8 @@ class Node {
                 params: this.params,
                 inputs: results,
                 forkIndex: this.forkIndex,
+                verbose: this.graph.verbose,
+                agents: this.graph.callbackDictonary,
             });
             if (this.transactionId !== transactionId) {
                 console.log(`-- ${this.nodeId}: transactionId mismatch`);
@@ -167,6 +169,7 @@ class GraphAI {
         this.logs = [];
         this.callbackDictonary = typeof callbackDictonary === "function" ? { _default: callbackDictonary } : callbackDictonary;
         this.concurrency = data.concurrency ?? defaultConcurrency;
+        this.verbose = data.verbose === true;
         this.onComplete = () => {
             console.error("-- SOMETHING IS WRONG: onComplete is called without run()");
         };

package/lib/utils/utils.d.ts

@@ -0,0 +1 @@
+export declare const sleep: (milliseconds: number) => Promise<unknown>;

package/lib/utils/utils.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleep = void 0;
+const sleep = async (milliseconds) => {
+    return await new Promise((resolve) => setTimeout(resolve, milliseconds));
+};
+exports.sleep = sleep;

package/package.json

@@ -1,15 +1,21 @@
 {
   "name": "graphai",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "description": "Asynchronous data flow execution engine to make it simple to build LLM apps.",
   "main": "lib/index.js",
-  "bin": "lib/graphai_cli.js",
+  "bin": {
+    "graphai": "lib/graphai_cli.js"
+  },
+  "files": [
+    "./lib"
+  ],
   "scripts": {
     "build": "tsc && tsc-alias",
     "eslint": "eslint --fix --ext src/**/*.{ts} tests/**/*.ts",
     "format": "prettier --write '{src,tests,samples}/**/*.ts' .eslintrc.js",
     "test": "node --test  -r tsconfig-paths/register --require ts-node/register ./tests/**/test_*.ts",
     "cli": "npx ts-node  -r tsconfig-paths/register ./src/graphai_cli.ts",
+    "samples": "npx ts-node  -r tsconfig-paths/register samples/sample_runner.ts",
     "sample": "npx ts-node  -r tsconfig-paths/register"
   },
   "repository": {
@@ -23,11 +29,14 @@
   },
   "homepage": "https://github.com/snakajima/graphai#readme",
   "devDependencies": {
+    "@inquirer/prompts": "^5.0.0",
     "@types/express": "^4.17.21",
     "@types/node": "^20.8.7",
     "@typescript-eslint/eslint-plugin": "^6.8.0",
     "@typescript-eslint/parser": "^6.8.0",
     "arxiv-api-ts": "^1.0.3",
+    "deepmerge": "^4.3.1",
+    "dotenv": "^16.4.5",
     "eslint": "^7.32.0 || ^8.2.0",
     "eslint-plugin-import": "^2.25.2",
     "express": "^4.19.2",
@@ -37,7 +46,8 @@
     "ts-node": "^10.9.1",
     "tsc-alias": "^1.8.8",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.2.2"
+    "typescript": "^5.2.2",
+    "wikipedia": "^2.1.2"
   },
   "dependencies": {
     "yaml": "^2.3.3"

package/.eslintrc.js

@@ -1,30 +0,0 @@
-module.exports = {
-  env: {
-    es2021: true,
-    node: true,
-  },
-  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
-  overrides: [
-    {
-      env: {
-        node: true,
-      },
-      files: [".eslintrc.{js,cjs}"],
-      parserOptions: {
-        sourceType: "script",
-      },
-    },
-  ],
-  parser: "@typescript-eslint/parser",
-  parserOptions: {
-    ecmaVersion: "latest",
-    sourceType: "module",
-  },
-  plugins: ["@typescript-eslint"],
-  rules: {
-    indent: ["error", 2],
-    "linebreak-style": ["error", "unix"],
-    quotes: ["error", "double"],
-    semi: ["error", "always"],
-  },
-};

package/.github/workflows/node.js.yml

@@ -1,28 +0,0 @@
-# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
-
-name: Node.js CI
-
-on:
-  pull_request
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [18.x, 20.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - run: yarn install
-    - run: cd tests/http-server/docs/ && npx http-server &
-    - run: yarn test

package/.prettierrc

@@ -1,3 +0,0 @@
-{
-  "printWidth": 160
-}

package/samples/agents/arxiv_agent.ts

@@ -1,45 +0,0 @@
-import search from "arXiv-api-ts";
-
-import { AgentFunction } from "@/graphai";
-
-type arxivData = { id: string; title: string; summary: string };
-
-const search_arxiv_papers = async (keywords: string[], limit = 10) => {
-  const includes = keywords.map((k) => {
-    return { name: k };
-  });
-  const papers = await search({
-    searchQueryParams: [
-      {
-        include: includes,
-      },
-    ],
-    sortBy: "lastUpdatedDate",
-    sortOrder: "descending",
-    start: 0,
-    maxResults: limit,
-  });
-  return papers.entries || [];
-};
-
-export const arxivAgent: AgentFunction<{ keywords: string[]; limit: number }, arxivData[]> = async (context) => {
-  const { keywords, limit } = context.params;
-  const arxivResult = await search_arxiv_papers(keywords, limit);
-  // console.log("executing", arxivResult, context.params.keywords);
-
-  const result = arxivResult.map((r: any) => {
-    const { id, title, summary } = r;
-    return { id, title, summary };
-  });
-  return result;
-};
-
-export const arxiv2TextAgent: AgentFunction<{}, Record<string, any>, string[]> = async (context) => {
-  const result = (context.inputs[0] || [])
-    .map((r: any) => {
-      const { id, title, summary } = r;
-      return ["id:", id, "title:", title, "summary:", summary].join("\n");
-    })
-    .join("\n\n\n");
-  return { content: result };
-};

package/samples/agents/parroting_agent.ts

@@ -1,5 +0,0 @@
-import { AgentFunction } from "@/graphai";
-
-export const parrotingAgent: AgentFunction = async (context) => {
-  return context.params;
-};

package/samples/agents/slashgpt_agent.ts

@@ -1,19 +0,0 @@
-import path from "path";
-import { AgentFunction } from "@/graphai";
-import { ChatSession, ChatConfig, ManifestData } from "slashgpt";
-
-const config = new ChatConfig(path.resolve(__dirname));
-
-export const slashGPTFuncitons2TextAgent: AgentFunction<
-  { function_data_key: string; result_key: number },
-  Record<string, string>,
-  { function_data: { [key: string]: string[] } }
-> = async (context) => {
-  const { params } = context;
-  const result = (context?.inputs[0].function_data[params.function_data_key] || []).map((r: any) => {
-    const { title, description } = r;
-    return ["title:", title, "description:", description].join("\n");
-  });
-
-  return { content: result[context.forkIndex ?? 0] };
-};

package/samples/express.ts

@@ -1,47 +0,0 @@
-//  npx ts-node samples/express.ts
-import { GraphAI, AgentFunction } from "@/graphai";
-
-import express from "express";
-
-const app = express();
-
-const graphAISample = async (req: express.Request, res: express.Response) => {
-  const graph_data = {
-    nodes: {
-      node1: {
-        params: {},
-      },
-    },
-    concurrency: 8,
-  };
-  const testFunction: AgentFunction<Record<string, string>> = async (context) => {
-    console.log("hello");
-    return {};
-  };
-  const graph = new GraphAI(graph_data, testFunction);
-  const response = await graph.run();
-  res.json({ result: response });
-  res.end();
-};
-
-const hello = async (req: express.Request, res: express.Response) => {
-  const { params, query } = req;
-  res.json({
-    result: [
-      {
-        message: "hello",
-        params,
-        query,
-      },
-    ],
-  });
-  res.end();
-};
-
-app.use(express.json());
-app.get("/", hello);
-app.get("/mock", graphAISample);
-
-const server = app.listen(8080, () => {
-  console.log("Running Server");
-});

package/samples/graphs/arxiv.yml

@@ -1,25 +0,0 @@
-nodes:
-  searchArxiv:
-    params:
-      keywords:
-        - llm
-        - gpt
-      limit: 10
-    agentId: arxivAgent
-  arxiv2TextAgent:
-    inputs: [searchArxiv]
-    agentId: arxiv2TextAgent
-  slashGPTAgent:
-    inputs: [arxiv2TextAgent]
-    agentId: slashGPTAgent
-    params:
-      query: |
-        与えられたそれぞれの論文の要点をまとめ、以下の項目で日本語で出力せよ。それぞれの項目は最大でも180文字以内に要約せよ。
-        ```
-        論文名:タイトルの日本語訳
-        キーワード:この論文のキーワード
-        課題:この論文が解決する課題
-        手法:この論文が提案する手法,
-        結果:提案手法によって得られた結果
-        ```
-      

package/samples/graphs/slash_gpt.yml

@@ -1,28 +0,0 @@
-nodes:
-  node1:
-    agentId: slashgpt
-    params:
-      query: Come up with ten business ideas for AI startup
-  node2:
-    agentId: stringTemplate
-    inputs: [node1]
-    params:
-      template: |
-        Please evaluate following business ideas.
-        ${0}
-  node3:
-    agentId: slashgpt
-    inputs: [node2]
-  node4:
-    agentId: stringTemplate
-    inputs: [node1, node3]
-    params:
-      template:  |
-        Please pick the winner of this business idea contest.
-        [ideas]
-        ${0}
-        [evalutations]
-        ${1}
-  node5:
-    agentId: slashgpt
-    inputs: [node4]