Skip to content

Commit dcb75a0

Browse files
Alexandre Oliveiraclaude
Alexandre Oliveira
and
claude
committed
docs(turing): add Semantic Navigation admin screen reference page
- Create semantic-navigation.md with full admin UI reference for all SN Site tabs (Settings, Multi Languages, Behavior, Fields, Merge Providers, Targeting Rules, Spotlights, Top Search Terms, Result Ranking, AI Insights, Generative AI) and search REST API - Add semantic-navigation to Enterprise Search category in sidebar alongside search-engine - Add Semantic Navigation entry to index.md Enterprise Search section - Refactor administration-guide.md: replace verbose inline SN tab docs with a concise pointer to semantic-navigation.md - Refactor sn-concepts.md: remove duplicate SN Sites intro (now in semantic-navigation.md), add cross-reference header, update footer navigation Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent f280951 commit dcb75a0

5 files changed

Lines changed: 340 additions & 185 deletions

File tree

‎docs-turing/administration-guide.md‎

Lines changed: 3 additions & 176 deletions
Original file line numberDiff line numberDiff line change
@@ -245,181 +245,8 @@ For full documentation — instance creation, core management, system monitoring
245245

246246
### Semantic Navigation
247247

248-
#### Configuration
249-
250-
251-
##### Settings Tab
252-
253-
The Settings of Semantic Navigation Site contains the following attributes:
254-
255-
| Attribute | Description |
256-
|-----------|-------------|
257-
| Name | Name of Semantic Navigation Site |
258-
| Description | Description of Semantic Navigation Site |
259-
| Search Engine | Select the Search Engine that was created in Search Engine Section |
260-
| Thesaurus | If will use Thesaurus |
248+
The **Semantic Navigation** section manages SN Sites — the central configuration objects that drive every search experience in Turing ES. Each site defines its search engine binding, indexed fields, facets, AI settings, and targeting rules.
261249

262-
##### Multi Languages Tab
263-
264-
| Attribute | Description |
265-
|-----------|-------------|
266-
| Language | Language for Semantic Navigation Site |
267-
| Core | Solr Core Name to store and to search indexed content |
268-
269-
##### Behavior Tab
250+
For full documentation of all SN Site configuration tabs (Settings, Multi Languages, Behavior, Fields, Merge Providers, Targeting Rules, Spotlights, Top Search Terms, Result Ranking, AI Insights, and Generative AI) and the search REST API, see **[Semantic Navigation](./semantic-navigation.md)**.
270251

271-
| Section | Attribute | Description |
272-
|---------|-----------|-------------|
273-
| Behavior | Number of items per page | Number of items that will appear in search |
274-
| Facet | Facet enabled | If it will show Facet (Filters) on search |
275-
| Facet | Number of items per facet | Number of items that will appear in each Facet |
276-
| Highlighting | Highlighting enabled | Define whether to show highlighted lines |
277-
| Highlighting | Pre Tag | HTML Tag for begin of term. For example: `<mark>` |
278-
| Highlighting | Post Tag | HTML Tag for end of term. For example: `</mark>` |
279-
| Did you mean? | "Did you mean?" enabled | Use "did you mean?" feature |
280-
| Did you mean? | Always show corrected term | If misspelled, shows search with corrected term |
281-
| MLT | More Like This enabled? | Define whether to show MLT |
282-
| Default Fields | Title | Field used as title in Solr schema |
283-
| Default Fields | Text | Field used as text in Solr schema |
284-
| Default Fields | Description | Field used as description in Solr schema |
285-
| Default Fields | Date | Field used as date in Solr schema |
286-
| Default Fields | Image | Field used as Image URL in Solr schema |
287-
| Default Fields | URL | Field used as URL in Solr schema |
288-
289-
##### Merge Providers Details Tab
290-
291-
| Section | Attribute | Description |
292-
|---------|-----------|-------------|
293-
| Providers | Source | Name of Source Provider |
294-
| Providers | Destination | Name of Destination Provider |
295-
| Relations | Source | Relation Identifier of Source Provider |
296-
| Relations | Destination | Relation Identifier of Destination Provider |
297-
| Description | Description | More about merge providers |
298-
| Overwritten Fields | Name | Name of Source Field that overwrites destination field |
299-
300-
##### Fields Tab
301-
302-
Fields Tab contains a table with the following columns:
303-
304-
| Column Name | Description |
305-
|-------------|-------------|
306-
| Field | Name of Field |
307-
| Enabled | If the field is enabled |
308-
| MLT | If this field will be used in MLT |
309-
| Facets | To use this field like a facet (filter) |
310-
| Secondary Facet | To promote this facet to the secondary facet section of the response |
311-
| Highlighting | If this field will show highlighted lines |
312-
313-
When clicking a Field, a details page appears with:
314-
315-
| Attribute | Description |
316-
|-----------|-------------|
317-
| Name | Name of Field |
318-
| Description | Description of Field |
319-
| Type | `INT`, `LONG`, `FLOAT`, `DOUBLE`, `CURRENCY`, `STRING`, `DATE` or `BOOL` |
320-
| Multi Valued | If is an array |
321-
| Facet Name | Label of Facet on Search Page |
322-
| Facet | To use this field like a facet |
323-
| Secondary Facet | Promotes this field to the `secondaryFacet` section of the search response |
324-
| Highlighting | If this field will show highlighted lines |
325-
| MLT | If this field will be used in MLT |
326-
| Enabled | If the field is enabled |
327-
| Required | If the field is required |
328-
| Default Value | Default value if content is indexed without this field |
329-
330-
##### Spotlight Details Tab
331-
332-
| Attribute | Description |
333-
|-----------|-------------|
334-
| Name | Spotlight Name |
335-
| Description | Spotlight Description |
336-
| Terms | If any of these terms are searched, documents display as spotlights |
337-
| Indexed Documents | Documents that display as spotlights for search terms |
338-
339-
##### Top Search Terms Tab
340-
341-
During search, Turing ES saves information about search terms and generates Top Search Terms reports.
342-
343-
There are the following reports: Today, This Week, This Month and All Time. These reports show the first 50 terms and statistics about the period.
344-
345-
##### Result Ranking Tab
346-
347-
The Result Ranking tab allows you to create ranking expressions that influence search relevance by boosting documents that meet specific conditions. Expressions are converted into Solr boost queries in the format `(condition)^weight` and applied at query time by `TurSolrQueryBuilder.prepareBoostQuery()`.
348-
349-
The listing displays all configured ranking expressions for the site. Each expression is created or edited through a form divided into three sections:
350-
351-
**General Information**
352-
353-
| Attribute | Description |
354-
|-----------|-------------|
355-
| Name | Name of the ranking expression |
356-
| Description | Description of the rule |
357-
358-
**Ranking Conditions**
359-
360-
A dynamic list of one or more conditions. At least one condition is required.
361-
362-
| Attribute | Description |
363-
|-----------|-------------|
364-
| Attribute | Indexed field of the document, selected from the site's configured fields |
365-
| Condition | Operator: `Is` (equals) or `Is not` (not equals) |
366-
| Value | Value to compare against |
367-
368-
**Ranking Weight**
369-
370-
A slider from 0 to 10 that sets the boost intensity. The higher the weight, the more documents matching the conditions rise in the ranking.
371-
372-
For example: a condition `type Is news` with weight `8` causes documents of type "news" to rank higher in search results.
373-
374-
##### AI Insights Tab
375-
376-
The AI Insights tab displays an AI-generated summary of the Semantic Navigation Site — aggregating information about its configuration, fields, behavior settings, and indexed content. This summary is generated on demand and provides a natural language overview of the site for administrators.
377-
378-
##### Generative AI Tab
379-
380-
The Generative AI tab configures the RAG (Retrieval-Augmented Generation) system for the site, enabling conversational AI responses grounded in the indexed documents. The configuration is divided into four sections:
381-
382-
**Site Prompt**
383-
384-
A field for generating an automatic description of the site using AI, with streaming support. The generated description can overwrite an existing one after a confirmation dialog.
385-
386-
**RAG Activation**
387-
388-
| Attribute | Description |
389-
|-----------|-------------|
390-
| Enabled | Enables or disables the generative AI chat for this site (`/api/sn/{siteName}/chat`) |
391-
392-
**AI Model & Embedding Configuration**
393-
394-
If not configured, the site inherits the global defaults defined in **Administration → Settings**.
395-
396-
| Attribute | Description |
397-
|-----------|-------------|
398-
| LLM Instance | The language model instance to use for generating responses (e.g., OpenAI, Anthropic Claude) |
399-
| Embedding Store | The vector store where document embeddings are persisted (ChromaDB, PgVector, or Milvus) |
400-
| Embedding Model | The embedding model used to vectorize documents at indexing time and queries at search time |
401-
402-
**System Prompt**
403-
404-
An editor for the prompt template sent to the LLM on each chat request. The template must contain two required variables:
405-
406-
| Variable | Description |
407-
|----------|-------------|
408-
| `{{question}}` | The user's question |
409-
| `{{information}}` | The context retrieved from indexed documents via similarity search |
410-
411-
Saving is blocked if either variable is missing from the template.
412-
413-
**How it works:** When documents are indexed, `TurSNGenAi.addDocuments()` extracts title, summary, and body text and stores their embeddings in the configured vector store. When a user sends a chat request via `GET /api/sn/{siteName}/chat?q=...`, the system performs a similarity search in the vector store, builds the prompt with the retrieved context, sends it to the LLM, and returns the generated response. Document metadata (source ID, locale, site, modification and publication dates, URL) is preserved alongside the embeddings.
414-
415-
#### Search Page
416-
417-
##### HTML
418-
419-
In `Turing ES Console` > `Semantic Navigation` > `<SITE_NAME>` > `Multi languages` > click in `Open Search` button of some language.
420-
421-
It will open a Search Page that uses the pattern:
422-
423-
```
424-
GET http://localhost:2700/sn/<SITE_NAME>
425-
```
252+
For deep technical content — Targeting Rules Solr query mechanics, Spotlight injection, Merge Provider field overwrite rules, facet operators, and the self-describing search response structure — see **[Semantic Navigation Concepts](./sn-concepts.md)**.

‎docs-turing/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ slug: /
3939
| Guide | Description |
4040
|---|---|
4141
| [Search Engine](/turing/search-engine) | Manage search backend instances (Solr, Elasticsearch, Lucene), cores, and system monitoring |
42+
| [Semantic Navigation](/turing/semantic-navigation) | Configure SN Sites: fields, facets, spotlights, targeting rules, result ranking, and GenAI |
4243

4344
---
4445

0 commit comments

Comments
 (0)