feat: github trending vector + fixes (#81)

Co-authored-by: Mike Grabowski <[email protected]>

Author: pkarw

example/README.md

@@ -56,6 +56,14 @@ Scrapes and analyzes trending Python projects from GitHub, creating a markdown s
 
 **Actors:** Github Researcher, Redactor
 
+## 📈 GitHub Trending with Vector Store
+
+> `src/github_trending_vector.ts`
+
+Scrapes and analyzes trending Typescript projects from GitHub. Then: asks user about which project he/she wants top learn more - and creates a markdown summary report.
+
+**Actors:** Github Researcher, Redactor
+
 ## Running
 
 Each example is a self-contained TypeScript file that can be run with Bun, or with `tsx`

example/src/github_trending.ts

@@ -1,14 +1,13 @@
-import { agent } from '@dead-simple-ai-agent/framework/agent'
-import { teamwork } from '@dead-simple-ai-agent/framework/teamwork'
-import { logger } from '@dead-simple-ai-agent/framework/telemetry'
-import { solution, workflow } from '@dead-simple-ai-agent/framework/workflow'
+import { createFireCrawlTool } from '@fabrice-ai/tools/firecrawl'
 import { getApiKey } from '@fabrice-ai/tools/utils'
-
-import { createFireCrawlTool } from './tools/firecrawlScrape.js'
+import { agent } from 'fabrice-ai/agent'
+import { teamwork } from 'fabrice-ai/teamwork'
+import { logger } from 'fabrice-ai/telemetry'
+import { solution, workflow } from 'fabrice-ai/workflow'
 
 const apiKey = await getApiKey('Firecrawl.dev API Key', 'FIRECRAWL_API_KEY')
 
-const { firecrawlScrape } = createFireCrawlTool({
+const { firecrawl } = createFireCrawlTool({
   apiKey,
 })
 
@@ -18,7 +17,7 @@ const githubResearcher = agent({
     You are skilled at browsing what's hot on Github trending page.
   `,
   tools: {
-    firecrawlScrape,
+    firecrawl,
   },
 })
 

example/src/github_trending_vector.ts

@@ -0,0 +1,83 @@
+import { createFireCrawlTool } from '@fabrice-ai/tools/firecrawl'
+import { getApiKey } from '@fabrice-ai/tools/utils'
+import { createVectorStoreTools } from '@fabrice-ai/tools/vector'
+import { agent } from 'fabrice-ai/agent'
+import { teamwork } from 'fabrice-ai/teamwork'
+import { logger } from 'fabrice-ai/telemetry'
+import { tool } from 'fabrice-ai/tool'
+import { solution, workflow } from 'fabrice-ai/workflow'
+import { z } from 'zod'
+
+import { askUser } from './tools/askUser.js'
+
+const apiKey = await getApiKey('Firecrawl.dev API Key', 'FIRECRAWL_API_KEY')
+
+const printTool = tool({
+  description: 'Display information to the user',
+  parameters: z.object({
+    message: z.string().describe('The information to be displayed'),
+  }),
+  execute: async ({ message }) => {
+    console.log(message)
+    return ''
+  },
+})
+
+const { saveDocumentInVectorStore, searchInVectorStore } = createVectorStoreTools()
+
+const { firecrawl } = createFireCrawlTool({
+  apiKey,
+})
+
+const githubResearcher = agent({
+  role: 'Github Researcher',
+  description: `
+    You are skilled at browsing what's hot on Github trending page.
+    You are saving the documents to vector store for later usage
+  `,
+  tools: {
+    firecrawl,
+    saveDocumentInVectorStore,
+  },
+})
+
+const wrapupRedactor = agent({
+  role: 'Redactor',
+  description: `
+    Your role is to wrap up reports.
+    You ask users for which topic to focus on if it's defined in the task.
+    You're famous of beautiful Markdown formatting.
+  `,
+  tools: {
+    printTool,
+    askUser,
+    searchInVectorStore,
+  },
+})
+
+const wrapUpTrending = workflow({
+  members: [githubResearcher, wrapupRedactor],
+  description: `
+    Research the URL "https://github.com/trending/typescript" page using scraper tool
+    Get 3 top projects. You can get the title and description from the project page.
+    Then summarize it all into a comprehensive report markdown output.
+
+    Ask user about which project he wants to learn more.
+    Search for the project in the vector store and provide more details in the report.
+
+    Here are some ground rules to follow: 
+      - Include one sentence summary for each project.
+      - Print the list of projects to the user.
+      - Ask user about which project he wants to learn more.
+      - Display more information about this specific project from the vector store.
+  `,
+  output: `
+    Comprehensive markdown report with the top trending Typescript projects.
+    Detailed report about the project selected by the user.
+  `,
+  snapshot: logger,
+})
+
+const result = await teamwork(wrapUpTrending)
+
+console.log(solution(result))

example/src/medical_survey/workflow.ts

@@ -1,28 +1,8 @@
 import { agent } from 'fabrice-ai/agent'
-import { tool } from 'fabrice-ai/tool'
 import { workflow } from 'fabrice-ai/workflow'
-import { z } from 'zod'
 
-async function requestUserInput(prompt: string): Promise<string> {
-  return new Promise((resolve) => {
-    console.log('❔' + prompt)
-    process.stdin.resume()
-    process.stdin.once('data', (data) => {
-      process.stdin.pause()
-      resolve(data.toString().trim())
-    })
-  })
-}
+import { askUser } from '../tools/askUser.js'
 
-const askPatient = tool({
-  description: 'Tool for asking patient a question',
-  parameters: z.object({
-    query: z.string().describe('The question to ask the patient'),
-  }),
-  execute: ({ query }): Promise<string> => {
-    return requestUserInput(query)
-  },
-})
 
 const nurse = agent({
   role: 'Nurse',
@@ -33,7 +13,7 @@ const nurse = agent({
     Ask one question at time up to 5 questions. 
   `,
   tools: {
-    askPatient,
+    askPatient: askUser,
   },
 })
 

example/src/tools/askUser.ts

@@ -0,0 +1,23 @@
+import { tool } from 'fabrice-ai/tool'
+import { z } from 'zod'
+
+async function requestUserInput(prompt: string): Promise<string> {
+  return new Promise((resolve) => {
+    console.log('❔' + prompt)
+    process.stdin.resume()
+    process.stdin.once('data', (data) => {
+      process.stdin.pause()
+      resolve(data.toString().trim())
+    })
+  })
+}
+
+export const askUser = tool({
+  description: 'Tool for asking user a question',
+  parameters: z.object({
+    query: z.string().describe('The question to ask the user'),
+  }),
+  execute: ({ query }): Promise<string> => {
+    return requestUserInput(query)
+  },
+})

packages/create-fabrice-ai/src/index.ts

@@ -100,7 +100,7 @@ const template = await select({
     },
     {
       value: {
-        files: ['src/github_trending.ts', 'src/tools/firecrawlScrape.ts'],
+        files: ['src/github_trending.ts', 'src/tools/firecrawl.ts'],
       },
       label: 'GitHub Trending - Track and summarize hot Python projects on GitHub',
     },

packages/tools/README.md

@@ -1,3 +1,189 @@
 @fabrice-ai/tools
 ====
 
+## 📅 Get Current Date
+
+> `packages/tools/src/date.ts`
+
+Retrieves the current date in ISO format.
+
+### Example
+```typescript
+import { getCurrentDate } from '@fabrice-ai/tools/date'
+
+const exampleAgent = agent({
+  role: '...',
+  description: '...',
+  tools: {
+    getCurrentDate,
+  },
+})
+```
+
+## 🔍 Google Search with Serply.io
+
+> `packages/tools/src/webSearch.ts`
+
+Performs a Google search with a search query using the Serply API.
+
+### Example
+```typescript
+import { createWebSearchTools } from '@fabrice-ai/tools/webSearch'
+
+const apiKey = 'your-serply-api-key'
+const { googleSearch } = createWebSearchTools({ apiKey })
+
+const exampleAgent = agent({
+  role: '...',
+  description: '...',
+  tools: {
+    googleSearch,
+  },
+})
+```
+
+## 🖼️ Google Image Search
+
+> `packages/tools/src/webSearch.ts`
+
+Performs a Google Image search with a search query using the Serply API.
+
+### Example
+```typescript
+import { createWebSearchTools } from '@fabrice-ai/tools/webSearch'
+
+const apiKey = 'your-serply-api-key'
+const { googleImageSearch } = createWebSearchTools({ apiKey })
+
+const exampleAgent = agent({
+  role: '...',
+  description: '...',
+  tools: {
+    googleImageSearch,
+  },
+})
+```
+
+## 🌐 Web Scraper
+
+> `packages/tools/src/firecrawl.ts`
+
+Scrapes a website using Firecrawl.dev to extract metadata and content.
+
+### Example
+```typescript
+import { createFireCrawlTool } from '@fabrice-ai/tools/firecrawl'
+
+const exampleAgent = agent({
+  role: '...',
+  description: '...',
+  tools: {
+    createFireCrawlTool({
+        apiKey: 'Firecrawl API key ...'
+    }),
+  },
+})
+```
+
+## 🫙 Vector Store
+
+> `packages/tools/src/vector.ts`
+
+Save documents with embeddings, perform vector search.
+
+### Example
+```typescript
+import { createVectorStoreTools } from '@fabrice-ai/tools/vector'
+
+const { saveDocumentInVectorStore, searchInVectorStore } = createVectorStoreTools()
+
+const exampleAgent = agent({
+  role: '...',
+  description: '...',
+  tools: {
+    saveDocumentInVectorStore,
+    searchInVectorStore
+  },
+})
+```
+
+### Example with custom VectorStore
+```typescript
+import { createVectorStoreTools } from '@fabrice-ai/tools/vector'
+
+/**
+ * createVectorStore accepts a `vectorStore` adapter. 
+ * This is a way to switch the default - in-memory store to Pinecone or others of your choice.
+ */
+const createPineconeVectorStore = () => {
+  const store = new Map<string, EmbeddingResult>()
+
+  const set = async (id: string, value: EmbeddingResult): Promise<void> => {
+    // @tbd: implement storing document in Pinecone
+  }
+
+  const entries = async (): Promise<[string, EmbeddingResult][]> => {
+    // @tbd: implement searching documents in Pinecone
+  }
+
+  return {
+    set,
+    entries,
+  }
+}
+
+const { saveDocumentInVectorStore, searchInVectorStore } = createVectorStoreTools(createPineconeVectorStore())
+
+const exampleAgent = agent({
+  role: '...',
+  description: '...',
+  tools: {
+    saveDocumentInVectorStore,
+    searchInVectorStore
+  },
+})
+```
+
+## 🖼️ Vision tool
+
+> `packages/tools/src/vision.ts`
+
+Uses LLM as a OCR / Vision tool. Extract text or features from a picture.
+
+### Example
+```typescript
+import { visionTool } from '@fabrice-ai/tools/vision'
+
+const exampleAgent = agent({
+  role: '...',
+  description: '...',
+  tools: {
+    visionTool    
+  },
+})
+```
+
+## 🗄️ FileSystem tools
+
+> `packages/tools/src/filesystem.ts`
+
+File system tools for reading, writing and listing files. The tools are sandboxed into `workingDir` for safety.
+
+### Example
+```typescript
+import { createFileSystemTools } from '@fabrice-ai/tools/filesystem'
+
+const workingDir = path.resolve(__dirname, '../assets/')
+
+const { saveFile, readFile, listFilesFromDirectory } = createFileSystemTools({
+  workingDir,
+})
+
+const exampleAgent = agent({
+  role: '...',
+  description: '...',
+  tools: {
+    visionTool    
+  },
+})
+```