Merge pull request #27 from alexZrAl/main

Add plugin SearXNG Search

README.md

@@ -13,6 +13,7 @@ This project stores [Plugins](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web
 
 | Name | Authentication | Description |
 | ---- | --- | ----------------------------- |
+| [SearXNGSearch](./plugins/searxng) | - | Plugin for searxng search engine. |
 | [Dalle3](./plugins/dalle) | bearer | openai's dall-e image generator|
 | [FluxPro](./plugins/flux) | custom | The pro version of FLUX.1, served in partnership with BFL |
 | [WolframAlpha](./plugins/wolframalpha) | custom | A wrapper around Wolfram Alpha |

plugins/searxng/README.md

@@ -0,0 +1,41 @@
+# SearXNGSearch
+
+NextChat plugin that connects the model and SearXNG search engine.
+
+## Schema
+
+[openapi.json](./openapi.json)
+
+## Servers
+
+You can use one of the public instances:
+[Public SearXNG Instances](https://uptime.searxng.org/)
+Or use your own instance (recommended). Either way you will need to modify `openapi.json`:
+
+```json
+  "servers": [
+    {
+      "url": "https://YOUR_SEARXNG_INSTANCE_URL",
+      "description": "SearXNG instance URL."
+    }
+  ],
+```
+
+
+
+## Operations
+
+1. SearXNGSearch
+
+> `GET` /search
+
+## Authentication
+
+```
+type: none
+```
+
+## Preview
+
+Tested with local docker deployment on Mar.17 2025, using a private searxng instance.
+![](preview.jpg)

plugins/searxng/openapi.json

@@ -0,0 +1,83 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "SearXNG Search",
+    "version": "1.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://YOUR_SEARXNG_INSTANCE_URL",
+      "description": "SearXNG instance URL."
+    }
+  ],
+  "paths": {
+    "/search": {
+      "get": {
+        "summary": "Perform a search query (GET)",
+        "operationId": "SearXNGSearch",
+        "parameters": [
+          {
+            "name": "q",
+            "in": "query",
+            "description": "The search query string.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "category",
+            "in": "query",
+            "description": "Category of the search. Defaults to 'general'.",
+            "schema": {
+              "type": "string",
+              "enum": ["general", "news"],
+              "default": "general"
+            }
+          },
+          {
+            "name": "format",
+            "in": "query",
+            "description": "Output format of the results. Defaults to 'json'.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "default": "json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Search results retrieved successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "results": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "title": { "type": "string" },
+                          "link": { "type": "string" },
+                          "snippet": { "type": "string" }
+                        },
+                        "required": ["title", "link"]
+                      }
+                    },
+                    "total": { "type": "integer" }
+                  },
+                  "required": ["results"]
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid request parameters."
+          }
+        }
+      }
+    }
+  }
+}