From 0a7dcfcacf23c7f4038d6e05febfcd09d17f99e6 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Mon, 9 Feb 2026 17:22:46 +0000 Subject: [PATCH] Add documentation for GeoSential AI and Search options - Created `docs` directory. - Added `docs/geosential_ai.md` with instructions and commands for the AI assistant. - Added `docs/search_options.md` with instructions for advanced web scan and dark web search. - Updated `README.md` to link the new documentation and include a comprehensive list of APIs with their official websites. Co-authored-by: h9zdev <67865621+h9zdev@users.noreply.github.com> --- README.md | 31 ++++++++++++++++++----- docs/geosential_ai.md | 57 ++++++++++++++++++++++++++++++++++++++++++ docs/search_options.md | 49 ++++++++++++++++++++++++++++++++++++ 3 files changed, 131 insertions(+), 6 deletions(-) create mode 100644 docs/geosential_ai.md create mode 100644 docs/search_options.md diff --git a/README.md b/README.md index 141a0c7..946151a 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,12 @@ Stay updated with the latest **Geo Sentinel AI** releases and announcements. πŸ‘‰ **Subscribe here:** https://docs.google.com/forms/d/e/1FAIpQLSe3qBh6r1orih2MkLf5DjdolX0jv5Abct02363lLxpXEute-Q/viewform +## πŸ“š Documentation + +Detailed guides on how to use GeoSentinel's advanced features: +- πŸ€– [GeoSential AI Guide](docs/geosential_ai.md) - Learn how to use the AI assistant and its commands. +- πŸ” [Search & Dark Web Guide](docs/search_options.md) - Instructions for OSINT and dark web searching. + ## 🌟 Features - πŸ—ΊοΈ Access to GeoJSON data and surveillance grid tiles. @@ -224,12 +230,25 @@ ollama serve ## πŸ™ API TO USE -- [OpenStreetMap](https://www.openstreetmap.org/) -- [ADSB.one](https://adsb.one/) -- [AISstream.io](https://aisstream.io/) -- [CoinGecko](https://www.coingecko.com/) -- [NewsAPI](https://newsapi.org/) -- [tomtom](https://developer.tomtom.com) +Below is a list of APIs used in GeoSentinel and where to obtain your API keys: + +- 🌍 [OpenStreetMap](https://www.openstreetmap.org/) - Geocoding and map data. +- ✈️ [ADSB.one](https://adsb.one/) - Real-time flight tracking data. +- 🚒 [AISstream.io](https://aisstream.io/) - Real-time vessel tracking (AIS). +- πŸ“Š [CoinGecko](https://www.coingecko.com/) - Cryptocurrency market data. +- πŸ“° [NewsAPI](https://newsapi.org/) - Global news feeds. +- πŸ—ΊοΈ [TomTom Maps](https://developer.tomtom.com) - Mapping and routing services. +- πŸ“Ά [OpenCellID](https://opencellid.org/) - Cell tower location data. +- πŸ€— [Hugging Face](https://huggingface.co/) - AI models and inference. +- πŸ€– [OpenRouter](https://openrouter.ai/) - Unified AI model gateway. +- πŸ“‘ [OpenSky Network](https://opensky-network.org/) - Flight metadata and routing. +- 🌐 [MyMemory Translation](https://mymemory.translated.net/) - Free translation services. +- 🐦 [Twitter/X API](https://developer.twitter.com/) - Social media OSINT. +- πŸ” [DuckDuckGo](https://duckduckgo.com/) - Web search integration. +- 🌐 [Google Search](https://www.google.com/) - Web search integration. +- πŸ…±οΈ [Bing Search](https://www.bing.com/) - Web search integration. +- πŸ”’ [Ahmia](https://ahmia.fi/) - Dark web search services. +- πŸ¦™ [Ollama](https://ollama.com/) - Local LLM processing. ## πŸ—ΊοΈ Images of GeoSentinel UI ![GeoSentinel Screenshot](images/Screenshot%20From%202026-01-08%2001-01-15.png) diff --git a/docs/geosential_ai.md b/docs/geosential_ai.md new file mode 100644 index 0000000..212c905 --- /dev/null +++ b/docs/geosential_ai.md @@ -0,0 +1,57 @@ +# πŸ€– GeoSential AI Documentation + +Welcome to the **GeoSential AI** manual! GeoSential AI is your high-tech Geospatial Intelligence (GEOINT) and OSINT assistant, designed to automate tracking and provide real-time global briefings. πŸŒπŸ›°οΈ + +## πŸš€ Overview + +GeoSential AI integrates real-time web data, map functionality, and semantic memory to assist in monitoring global activities. It can track flights, vessels, scan sectors for signals, and provide up-to-the-minute news and market data. + +## πŸ› οΈ How to Use + +### πŸ–₯️ Interface +You can interact with GeoSential AI directly through the **Earth View** dashboard in the GeoSentinel UI. Look for the AI chat panel to start a conversation. + +### πŸ”Œ API Endpoint +For developers, the AI is accessible via the following endpoint: +- **URL**: `/api/geosentialai/chat` +- **Method**: `POST` +- **Payload**: +```json +{ + "message": "Track flight UAE202", + "web_search": true, + "human_mode": false, + "engine": "huggingface", + "context": {} +} +``` + +## πŸ“œ Commands & Tags + +GeoSential AI can trigger specific actions in the UI by outputting special tags. These tags allow the AI to interact directly with the map: + +| Command | Action | +| :--- | :--- | +| `[TRACK_FLIGHT: ]` | ✈️ Zooms the map to a specific flight using its ICAO hex code. | +| `[TRACK_VESSEL: ]` | 🚒 Zooms the map to a specific vessel using its MMSI number. | +| `[SHOW_WEATHER: , ]` | 🌦️ Opens the meteorology/environment GUI for the specified coordinates. | +| `[SCAN_MAP: , ]` | πŸ“‘ Zooms to coordinates and initiates a sector-wide signal scan. | + +## πŸ” Search Integration + +GeoSential AI is equipped with a powerful web search capability πŸ•΅οΈβ€β™‚οΈ. +- **Auto-Trigger**: The AI automatically enables web search if your message contains keywords like *news, stock, price, market, update, latest,* or *happening*. +- **DuckDuckGo Integration**: It uses DuckDuckGo to pull real-time snippets from the web to ground its answers in current events. + +## 🧠 Memory System + +The AI uses **ChromaDB** to maintain a "Memory Stream" 🧠. It remembers previous interactions and can recall relevant context to provide more personalized and consistent assistance. + +## βš™οΈ AI Engines + +You can choose between two processing engines: +1. **Cloud (Hugging Face)**: Uses `Llama-3.1-8B-Instruct` for high-performance reasoning (Default). +2. **Local (Ollama)**: Uses the `phi` model running locally on your machine for enhanced privacy and offline use. + +--- +*Stay informed, stay ahead with GeoSential AI. πŸš€* diff --git a/docs/search_options.md b/docs/search_options.md new file mode 100644 index 0000000..26c5876 --- /dev/null +++ b/docs/search_options.md @@ -0,0 +1,49 @@ +# πŸ” Search Options & Dark Web Documentation + +Explore the powerful search capabilities of GeoSentinel, from surface web OSINT to the depths of the dark web. πŸ•΅οΈβ€β™‚οΈπŸ”’ + +## 🌐 Advanced Web Scan + +The Advanced Web Scan tool allows you to perform deep OSINT searches across multiple platforms and search engines simultaneously. + +### πŸ› οΈ How to Use +- **URL**: `/api/tools/web_scan` +- **Method**: `POST` +- **Parameters**: + - `query`: Your search term or target. + - `type`: `text`, `images`, or `all`. + - `sources`: A list of platforms to target. + - `aggressive`: Set to `true` for deep scraping of result pages. + +### πŸ“± Supported Sources +You can restrict your search to specific high-value OSINT sources: +- **Social Media**: Twitter, Reddit, Instagram, LinkedIn. +- **Communication**: Telegram, Discord. +- **Developer/Code**: GitHub, StackOverflow. +- **Leaks/Dumps**: Pastebin, BreachForums. +- **General Web**: Multi-engine aggregation (Google, Bing, DuckDuckGo). + +### πŸš€ Aggressive Mode +When **Aggressive Mode** is enabled, GeoSentinel goes beyond simple search results. It attempts to visit the top result links and extract the actual page content to provide a more comprehensive intelligence briefing. + +--- + +## πŸ”’ Dark Web Search + +GeoSentinel provides integrated access to the dark web, allowing you to search across multiple `.onion` search engines anonymously. πŸ•ΆοΈ + +### πŸ›‘οΈ How it Works +1. **Tor Network**: If a Tor proxy is running locally (port 9050), GeoSentinel routes queries through the Tor network to access `.onion` sites directly. +2. **Onion Aggregation**: It queries a vast list of dark web engines, including: + - Ahmia + - OnionLand + - Torgle + - Torch + - ...and many others. +3. **Clearnet Fallback**: If Tor is not available locally, the system automatically falls back to the Ahmia clearnet proxy to fetch results. + +### πŸ•΅οΈβ€β™‚οΈ Accessing Dark Web Results +Results from the dark web are flagged with the `TOR_NETWORK` or `Ahmia_Clearnet` source tag. These links typically end in `.onion` and require a Tor-enabled browser (like Tor Browser) to open. + +--- +*Unlock the hidden layers of the web with GeoSentinel. πŸ”πŸ”’*