Merge pull request #64 from donvito/feature/web-search

Feature/web search

Author: donvito

README.md

@@ -29,6 +29,7 @@ Since APIs are ready to use, you don't need to understand prompt engineering. Ju
 | **/api/rewrite** | Rewrite text with instructions (improve, shorten, fix grammar, tone) |
 | **/api/compose** | Compose short-form text given a topic |
 | **/api/pdf-summarizer** | Extract and summarize content from PDF documents with AI |
+| **/api/web-search** | Perform web searches and get AI-powered summaries of results |
 
 ### Image Processing
 

idea-http-scripts/Summarization.http

@@ -0,0 +1,16 @@
+### Summarization Request
+POST http://localhost:3000/api/v1/summarize
+Content-Type: application/json
+
+{
+  "payload": {
+    "text": "Customer John Doe: Hello, I need help with my recent order. I received the wrong item. Agent Jane Smith: Hi! I'm sorry to hear that. Could you please provide your order number so I can look into this for you? Customer John Doe: Sure, the order number is 123456789. I ordered a wireless mouse, but I received a wired one instead. Agent Jane Smith: Thank you for the information. Let me check your order details. Please hold on a moment. Customer John Doe: Okay, take your time. Agent Jane Smith: Thanks for waiting. I see that the order was for a wired mouse. It appears there was an inventory mistake. I apologize for the inconvenience. Customer John Doe: That's frustrating. Can you send me the correct item? Agent Jane Smith: Absolutely. I will initiate the process to send the wireless mouse to you immediately. You will receive it within 3-5 business days. Would you like a return label for the wired mouse? Customer John Doe: Yes, that would be great. Thank you. Agent Jane Smith: You're welcome! I will email you the return shipping label shortly. Is there anything else I can assist you with today? Customer John Doe: No, that's all. Thanks for your help. Agent Jane Smith: My pleasure! Have a great day!",
+    "maxLength": 150
+  },
+  "config": {
+    "provider": "lmstudio",
+    "model": "gemma-3-4b-it",
+    "temperature": 0,
+    "stream": false
+  }
+}

idea-http-scripts/WebSearch.http

@@ -0,0 +1,45 @@
+### Web Search Request
+POST http://localhost:3000/api/v1/web-search
+Content-Type: application/json
+
+{
+  "payload": {
+    "query": "Latest AI trends 2025",
+    "limit": 5,
+    "sources": ["web"]
+  },
+  "config": {
+    "provider": "lmstudio",
+    "model": "gemma-3-4b-it",
+    "stream": false
+  }
+}
+
+
+
+### Expected Response Structure:
+# The response will contain:
+# - searchResult: Natural language summary of search results with links included
+# - provider: AI provider used
+# - model: Model used
+# - usage: Token usage information
+# - apiVersion: API version
+
+###
+
+POST http://localhost:3000/api/v1/web-search
+Content-Type: application/json
+
+{
+  "payload": {
+    "query": "Latest AI trends 2025",
+    "limit": 5,
+    "sources": ["web"]
+  },
+  "config": {
+    "provider": "openai",
+    "model": "gpt-4.1-nano",
+    "stream": false
+  }
+}
+

src/app.ts

@@ -57,6 +57,7 @@ function configureApiSecurity(app: OpenAPIHono, tokenConfig: string) {
                 path === '/api/v1/outline-demo' ||
                 path === '/api/v1/pdf-summarizer-demo' ||
                 path === '/api/v1/pdf-translate-demo' ||
+                path === '/api/v1/web-search-demo' ||
                 path === '/api/models' ||
                 path === '/api/jsoneditor' ||
                 // Public read-only service catalog for demos

src/config/models.json

@@ -3,6 +3,7 @@ import * as path from 'path'
 
 export type ModelCapability =
   | 'summarize'
+  | 'web-search'
   | 'pdf-summarizer'
   | 'pdf-translate'
   | 'rewrite'

src/config/models.ts

@@ -0,0 +1,33 @@
+import { OpenAPIHono, createRoute } from '@hono/zod-openapi'
+import { readFileSync } from 'fs'
+import { join } from 'path'
+
+const router = new OpenAPIHono()
+
+const demoRoute = createRoute({
+  method: 'get',
+  path: '/',
+  responses: {
+    200: {
+      description: 'Returns the WebSearch demo page.',
+      content: {
+        'text/html': {
+          schema: { type: 'string' }
+        }
+      }
+    }
+  },
+  tags: ['Demos']
+})
+
+function getWebSearchDemoHtml() {
+  const templatePath = join(process.cwd(), 'src', 'templates', 'webSearchDemo.html')
+  return readFileSync(templatePath, 'utf-8')
+}
+
+router.openapi(demoRoute, (c) => c.html(getWebSearchDemoHtml()))
+
+export default {
+  handler: router,
+  mountPath: 'web-search-demo'
+}

src/routes/v1/demos/webSearchDemo.ts

@@ -70,7 +70,7 @@ const modelsSchema = z.object({
   available: z.boolean()
 })
 
-const capabilityEnum = z.enum(['summarize', 'pdf-summarizer', 'pdf-translate', 'rewrite', 'compose', 'keywords', 'sentiment', 'emailReply', 'vision', 'askText', 'translate', 'meetingNotes', 'planning', 'outline'])
+const capabilityEnum = z.enum(['summarize', 'web-search', 'pdf-summarizer', 'pdf-translate', 'rewrite', 'compose', 'keywords', 'sentiment', 'emailReply', 'vision', 'askText', 'translate', 'meetingNotes', 'planning', 'outline'])
 const byProviderSchema = z.record(z.array(z.string()))
 const providerViewSchema = z.record(z.array(z.object({
   name: z.string(),
@@ -81,6 +81,7 @@ const providerViewSchema = z.record(z.array(z.object({
     source: z.literal('config'),
     byCapability: z.object({
       summarize: byProviderSchema,
+      'web-search': byProviderSchema,
       'pdf-summarizer': byProviderSchema,
       'pdf-translate': byProviderSchema,
       rewrite: byProviderSchema,
@@ -115,6 +116,7 @@ async function handleGetModels(c: Context) {
     if (source === 'config') {
       const byCapability = {
         summarize: getModelsByCapability('summarize'),
+        'web-search': getModelsByCapability('web-search'),
         'pdf-summarizer': getModelsByCapability('pdf-summarizer'),
         'pdf-translate': getModelsByCapability('pdf-translate'),
         rewrite: getModelsByCapability('rewrite'),