Skip to content

Commit ef91969

Browse files
Alexandre Oliveiraclaude
andcommitted
docs(turing): cross-reference Chat, Assets, Token Usage across all entry-point docs
index.md: - Restructure into 5 sections: Getting Started, Administration & Development, Management (Assets), Generative AI (GenAI, Chat, Token Usage), Technical Reference - Add all three new pages with descriptions intro.md: - Add Assets, Chat, Token Usage to Key Concepts table - Add 3 new "Where to go next" paths: chat, knowledge base upload, token monitoring core-concepts.md: - Knowledge Base section: link to Assets page, describe auto-index on upload/delete - AI Agents section: link "chat interface" to Chat page - "Ready to go deeper?" table: add Chat, Assets, Token Usage rows architecture-overview.md: - Admin Console module row: list Assets, Chat, Token Usage as named features - MinIO asset indexing paragraph: rewrite to reference Assets page, add Tika/chunking details - Frontend tech stack row: update to React + shadcn/ui + Vite, list all UI sections Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent c65492d commit ef91969

4 files changed

Lines changed: 61 additions & 14 deletions

File tree

docs-turing/architecture-overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The Turing ES application is organized into cohesive modules, each with a well-d
8484
| **Persistence** | `persistence` | JPA entities, repositories, and DTOs for all domain objects |
8585
| **Security** | `spring/security` | Keycloak OAuth2 and HTTP Basic authentication |
8686
| **API Layer** | `api` | REST controllers and GraphQL resolvers exposed to clients |
87-
| **Admin Console** | React (`turing-react`) | Browser-based UI for administration, configuration, and MinIO file/folder management |
87+
| **Admin Console** | React (`turing-react`) | Browser-based UI: administration, SN Site configuration, [Assets](./assets.md) file manager (MinIO), [Chat](./chat.md) interface, and [Token Usage](./token-usage.md) dashboard |
8888

8989
---
9090

@@ -142,7 +142,7 @@ sequenceDiagram
142142

143143
**Embedding stores:** If Generative AI is enabled for a Semantic Navigation site, a vector embedding is generated for each indexed document and written to the configured embedding store. Turing ES supports three embedding backends via Spring AI: **ChromaDB**, **PgVector** (PostgreSQL extension), and **Milvus**. Only one is active per deployment. The default embedding store and embedding model are defined globally in **Administration → Settings**.
144144

145-
**MinIO asset indexing:** Turing ES includes a file and folder management UI in the admin console, backed by MinIO as the object storage layer. Files uploaded through this interface are processed by the indexing pipeline and stored as vector embeddings, making them available for RAG queries alongside Semantic Navigation content.
145+
**MinIO asset indexing:** Turing ES includes an **[Assets](./assets.md)** file manager in the admin console, backed by MinIO as the object storage layer. Files are uploaded via drag-and-drop, organized into folders, and automatically indexed as vector embeddings on upload (and unindexed on deletion). A batch "Train AI with Assets" operation processes all files using Apache Tika for text extraction, chunking at 1,024 characters, and storing embeddings in the active vector store.
146146

147147
**Application logs in MongoDB:** When MongoDB is configured, Turing ES ships with a custom Logback appender that extends `ch.qos.logback`. Every log entry generated by the application — including indexing events, search requests, errors, and system events — is persisted to MongoDB in addition to standard output. These logs are exposed in the admin console, giving administrators full visibility into application behavior without requiring access to the server file system or a separate log management tool.
148148

@@ -221,7 +221,7 @@ sequenceDiagram
221221
| **Load Balancer** | Apache HTTP Server | Optional; required for high-availability cluster deployments |
222222
| **Connector System** | Viglet Dumont DEP | Separate application; feeds Turing ES via Artemis |
223223
| **Build System** | Apache Maven | Multi-module project |
224-
| **Frontend** | React + TypeScript | Admin console (`turing-react`) |
224+
| **Frontend** | React + TypeScript + shadcn/ui + Vite | Admin console (`turing-react`) — includes SN configuration, [Assets](./assets.md) manager, [Chat](./chat.md) interface, [Token Usage](./token-usage.md) dashboard |
225225
| **Containerization** | Docker / Docker Compose | Available in `containers/` directory |
226226
| **Orchestration** | Kubernetes | Manifests available in `k8s/` directory |
227227
| **API Protocols** | REST + GraphQL | Swagger UI available in development mode |

docs-turing/getting-started/core-concepts.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,8 @@ This is called **Retrieval-Augmented Generation (RAG)**. The LLM does not make t
128128

129129
Beyond SN Sites, Turing ES provides a **Knowledge Base** — a file and folder interface in the admin console (backed by MinIO) where you can upload documents directly. These files are also indexed as vector embeddings and become available to AI Agents as a searchable knowledge source, independent of any connector or SN Site.
130130

131+
The Knowledge Base is managed through the **[Assets](../assets.md)** page: drag-and-drop upload, folder navigation, inline preview, and batch AI training with real-time progress. Uploaded files are indexed automatically on upload and unindexed on deletion.
132+
131133
### AI Agents
132134

133135
An **AI Agent** is a named assistant that you compose from three ingredients:
@@ -136,9 +138,9 @@ An **AI Agent** is a named assistant that you compose from three ingredients:
136138
- A set of **tools** it can call (search your SN Sites, query the Knowledge Base, browse the web, run Python code, get financial data, and more)
137139
- Optionally, one or more **MCP Servers** — external services that provide additional tools via the Model Context Protocol
138140

139-
Each AI Agent appears as its own tab in the Turing ES chat interface. You can have a "Research Assistant" that combines SN Site search with web browsing, a "Data Analyst" that can run Python code and query your knowledge base, and a "Support Agent" that only sees your product documentation — all on the same platform.
141+
Each AI Agent appears as its own tab in the **[Chat](../chat.md)** interface. You can have a "Research Assistant" that combines SN Site search with web browsing, a "Data Analyst" that can run Python code and query your knowledge base, and a "Support Agent" that only sees your product documentation — all on the same platform.
140142

141-
See [GenAI & LLM Configuration](../genai-llm.md) for how to set all of this up.
143+
See [GenAI & LLM Configuration](../genai-llm.md) for how to configure agents, tools, and MCP Servers.
142144

143145
---
144146

@@ -201,6 +203,9 @@ npm install @viglet/turing-sdk
201203
| Understand the full system architecture | [Architecture Overview](../architecture-overview.md) |
202204
| Configure Spotlights, Targeting Rules, or Merge Providers | [Semantic Navigation Concepts](../sn-concepts.md) |
203205
| Set up GenAI, RAG, or AI Agents | [GenAI & LLM Configuration](../genai-llm.md) |
206+
| Use the AI chat interface | [Chat](../chat.md) |
207+
| Upload documents to the Knowledge Base | [Assets](../assets.md) |
208+
| Monitor LLM token consumption | [Token Usage](../token-usage.md) |
204209
| Secure Turing ES with Keycloak | [Security & Keycloak](../security-keycloak.md) |
205210
| Install Turing ES | [Installation Guide](../installation-guide.md) |
206211

docs-turing/getting-started/intro.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ These are the main building blocks you will work with in Turing ES. You do not n
5959
| **Merge Providers** | Rules that combine documents from two different connectors into one enriched result. | [Semantic Navigation](../sn-concepts.md) |
6060
| **RAG** | Retrieval-Augmented Generation — finding relevant documents and using them to ground an LLM's response. | [GenAI & LLM](../genai-llm.md) |
6161
| **AI Agent** | A named assistant that combines an LLM with a set of tools and knowledge sources. | [GenAI & LLM](../genai-llm.md) |
62+
| **Assets** | A file manager backed by MinIO where you upload documents to feed the Knowledge Base — files are automatically indexed as vector embeddings. | [Assets](../assets.md) |
63+
| **Chat** | The conversational AI interface — three tabs for direct LLM chat, Semantic Navigation search, and each configured AI Agent. | [Chat](../chat.md) |
64+
| **Token Usage** | A dashboard showing LLM token consumption by model, day, and month — useful for monitoring AI costs. | [Token Usage](../token-usage.md) |
6265

6366
---
6467

@@ -78,6 +81,15 @@ Not sure where to start? Here is a suggested path depending on what you want to
7881
**I want to add generative AI to my search**
7982
→ Read [GenAI & LLM Configuration](../genai-llm.md).
8083

84+
**I want to use the AI chat interface**
85+
→ Go to [Chat](../chat.md) for direct LLM, Semantic Navigation, and AI Agent tabs.
86+
87+
**I want to upload documents to the Knowledge Base**
88+
→ Go to [Assets](../assets.md) to manage files and train the RAG index.
89+
90+
**I want to monitor LLM usage and costs**
91+
→ Go to [Token Usage](../token-usage.md).
92+
8193
**I want to secure Turing ES with SSO**
8294
→ Go directly to [Security & Keycloak](../security-keycloak.md).
8395

docs-turing/index.md

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,58 @@ slug: /
1212
- **Current Release:** 2026.1
1313
- **GitHub:** [https://github.com/openviglet/turing](https://github.com/openviglet/turing)
1414

15+
---
16+
1517
## Getting Started
1618

1719
| Guide | Description |
18-
|-------|-------------|
20+
|---|---|
1921
| [What is Turing ES?](/turing/getting-started/intro) | Platform overview and key capabilities |
2022
| [Core Concepts](/turing/getting-started/core-concepts) | SN Sites, connectors, search, GenAI — the mental model |
2123
| [Installation Guide](/turing/installation-guide) | How to install and configure Turing ES |
2224

23-
## Reference
25+
---
26+
27+
## Administration & Development
2428

2529
| Guide | Description |
26-
|-------|-------------|
27-
| [Administration Guide](/turing/administration-guide) | Console reference: Search Engine, SN Sites, GenAI, Integration |
28-
| [Developer Guide](/turing/developer-guide) | REST API, SDKs, and integration examples |
29-
| [Release Notes](/turing/release-notes) | Release history and changelog |
30-
| [Javadoc](https://turing.viglet.com/latest/javadoc/) | API Reference (external) |
30+
|---|---|
31+
| [Administration Guide](/turing/administration-guide) | Console reference: users, roles, API tokens, search engine, SN Sites, global settings |
32+
| [Developer Guide](/turing/developer-guide) | REST API, SDKs, tech stack, and contribution guide |
33+
34+
---
35+
36+
## Management
37+
38+
| Guide | Description |
39+
|---|---|
40+
| [Assets](/turing/assets) | File manager backed by MinIO — upload, organise, and train the RAG Knowledge Base |
41+
42+
---
43+
44+
## Generative AI
45+
46+
| Guide | Description |
47+
|---|---|
48+
| [Generative AI & LLM Configuration](/turing/genai-llm) | LLM providers, RAG, embedding models, Tool Callings, MCP Servers, AI Agents |
49+
| [Chat](/turing/chat) | Chat interface — direct LLM, Semantic Navigation, and AI Agent tabs |
50+
| [Token Usage](/turing/token-usage) | Monitor and analyse LLM token consumption by model and day |
51+
52+
---
3153

3254
## Technical Reference
3355

3456
| Guide | Description |
35-
|-------|-------------|
57+
|---|---|
3658
| [Architecture Overview](/turing/architecture-overview) | Component diagram, indexing and search flows, deployment topologies |
3759
| [Semantic Navigation Concepts](/turing/sn-concepts) | Targeting Rules, Spotlights, Merge Providers, Facets, search response |
38-
| [Generative AI & LLM Configuration](/turing/genai-llm) | LLM providers, RAG, Tool Callings, MCP Servers, AI Agents |
3960
| [Security & Keycloak](/turing/security-keycloak) | OAuth2/OIDC setup, Apache reverse proxy, security checklist |
61+
62+
---
63+
64+
## Other
65+
66+
| Guide | Description |
67+
|---|---|
68+
| [Release Notes](/turing/release-notes) | Release history and changelog |
69+
| [Javadoc](https://turing.viglet.com/latest/javadoc/) | Java API Reference (external) |

0 commit comments

Comments
 (0)