PHPackages cywolf/semantic-suggestion-solr - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Search & Filtering](/categories/search) 4. / 5. cywolf/semantic-suggestion-solr ActiveTypo3-cms-extension[Search & Filtering](/categories/search) cywolf/semantic-suggestion-solr =============================== TYPO3 extension for suggesting semantically related content using Solr More Like This (MLT) and Semantic More Like This (SMLT) v1.0.0-beta.2(1mo ago)00GPL-2.0-or-laterPHPPHP ^8.2 Since Jun 15Pushed 1mo agoCompare [ Source](https://github.com/friteuseb/semantic_suggestion_solr)[ Packagist](https://packagist.org/packages/cywolf/semantic-suggestion-solr)[ Docs](https://github.com/friteuseb/semantic_suggestion_solr)[ RSS](/packages/cywolf-semantic-suggestion-solr/feed)WikiDiscussions main Synced 2w ago READMEChangelog (2)Dependencies (4)Versions (3)Used By (0) Semantic Suggestion Solr ======================== [](#semantic-suggestion-solr) TYPO3 extension that displays related content suggestions using Solr. Supports two similarity algorithms: **MLT** (lexical) and **SMLT** (semantic hybrid, combining MLT + KNN vector search server-side). Similarity modes ---------------- [](#similarity-modes) ### MLT — More Like This [](#mlt--more-like-this) Solr's built-in MLT compares term frequency (TF-IDF) across configurable fields (title, content, keywords). Fast, no external model needed. ### SMLT — Semantic More Like This [](#smlt--semantic-more-like-this) A custom Solr SearchComponent that combines classical MLT with KNN vector search **server-side** in a single Solr request. Normalizes both score sets to \[0,1\] and merges them: ``` combinedScore = (mltWeight * mltScore) + (vectorWeight * vectorScore) ``` Default weights: 0.3 MLT / 0.7 vector (configurable per request). Three internal sub-modes: `hybrid` (default), `vector_only`, `mlt_only` (useful for A/B testing). Results are returned in a separate `semanticMoreLikeThis` response section, independent of the main search query. ### Auto mode (default) [](#auto-mode-default) When `similarityMode = auto`, the algorithm is chosen automatically based on EXT:solr's TypoScript: - `plugin.tx_solr.search.query.type >= 1` -> **SMLT** (embeddings are indexed) - `plugin.tx_solr.search.query.type = 0` -> **MLT** (no vectors available) How it works ------------ [](#how-it-works) ### Cross-content-type suggestions [](#cross-content-type-suggestions) Suggestions can mix **pages** and **news** (or any indexed content type). By default, no type filter is applied, so a page about leather sewing machines may suggest both related pages and news articles about leather. Use the `allowedTypes` setting (or FlexForm) to restrict suggestions to specific types if needed. ### Language handling [](#language-handling) EXT:solr maintains one core per site language. The plugin reads the current frontend language from the request and connects to the matching Solr core via `ConnectionManager->getConnectionByRootPageId($rootPageId, $languageUid)`. Results are always in the same language as the current page. ### Context detection [](#context-detection) The plugin detects the current content type automatically: - **Standard page**: lookup by `type:pages AND uid:{pageUid}` - **News detail** (EXT:news): if `tx_news_pi1[news]` is present in the request, lookup by `type:tx_news_domain_model_news AND uid:{newsUid}` ### Image enrichment [](#image-enrichment) When `showImage = 1`, the extension resolves the first media file for each suggestion: - Pages: `pages.media` field (FAL) - News: `tx_news_domain_model_news.fal_media` field (FAL) Requirements ------------ [](#requirements) - TYPO3 13.4+ - EXT:solr 13.0+ with a working index - For SMLT mode: the SMLT JAR deployed in Solr + embeddings indexed via the `textToVector` update chain Installation ------------ [](#installation) ``` composer require cywolf/semantic-suggestion-solr:@dev ``` Flush TYPO3 caches, then include the extension's static TypoScript in the site template. SMLT setup (Semantic More Like This) ------------------------------------ [](#smlt-setup-semantic-more-like-this) ### 1. Build and deploy the SMLT JAR [](#1-build-and-deploy-the-smlt-jar) The Java source is in `.ddev/typo3-solr/smlt-plugin/`. Build with Maven: ``` docker run --rm -v "$(pwd)/.ddev/typo3-solr/smlt-plugin":/build -w /build \ maven:3.9-eclipse-temurin-17 mvn package -q ``` Copy the JAR to the Solr `typo3lib` directory (alongside `solr-typo3-plugin-6.0.0.jar`): ``` cp .ddev/typo3-solr/smlt-plugin/target/solr-semantic-mlt-1.0.0-SNAPSHOT.jar \ vendor/apache-solr-for-typo3/solr/Resources/Private/Solr/typo3lib/ ``` ### 2. Register the SearchComponent in solrconfig.xml [](#2-register-the-searchcomponent-in-solrconfigxml) Add to `vendor/.../configsets/ext_solr_13_1_0/conf/solrconfig.xml`: ``` ``` And add `smlt` to the `/select` handler's ``. ### 3. Set vector field to stored=true [](#3-set-vector-field-to-storedtrue) In `general_schema_fields.xml`, ensure the vector field has `stored="true"`: ``` ``` ### 4. Enable vector indexing and re-index [](#4-enable-vector-indexing-and-re-index) ``` plugin.tx_solr.search.query.type = 1 ``` Re-initialize the Index Queue and run the scheduler. Each document will be sent to the OpenAI embedding API during indexing. > **Note**: `query.type = 1` also enables native KNN for the frontend search. If KNN doesn't work in your setup, set it back to `0` after re-indexing. The SMLT component works independently — it reads pre-indexed vectors directly, regardless of `query.type`. ### 5. Set the similarity mode [](#5-set-the-similarity-mode) ``` plugin.tx_semanticsuggestionsolr_suggestions.settings.similarityMode = smlt ``` Or use `auto` (default) to let the extension detect `query.type` automatically. News indexing ------------- [](#news-indexing) To include news articles in Solr (required for cross-type suggestions), add the index queue configuration in your sitepackage TypoScript: ``` plugin.tx_solr.index.queue { news = 1 news { type = tx_news_domain_model_news fields { title = title abstract = teaser content = SOLR_CONTENT content.cObject = COA content.cObject.10 = TEXT content.cObject.10.field = bodytext keywords = SOLR_MULTIVALUE keywords.field = keywords url = TEXT url { typolink.parameter = {detailPageUid} typolink.additionalParams = &tx_news_pi1[controller]=News&tx_news_pi1[action]=detail&tx_news_pi1[news]={field:uid} typolink.additionalParams.insertData = 1 typolink.returnLast = url } } } } ``` Then initialize the news index queue and run the Solr indexer. Usage ----- [](#usage) ### As a content element [](#as-a-content-element) Insert the plugin "Similar content (Solr)" via the backend. The FlexForm provides per-instance settings: - **Similarity algorithm**: Auto, MLT, or SMLT - **Maximum number of suggestions** - **Allowed content types** (checkboxes: Pages, News — if none checked, all types shown) - **Restrict to pages/storage folders** (PID filter) - **Show/hide content type badge** - **Show/hide relevance score** (also shows the active mode as a badge) - **Show/hide image** ### In a Fluid template [](#in-a-fluid-template) ``` ``` ### Via TypoScript (auto-render on all pages) [](#via-typoscript-auto-render-on-all-pages) ``` [page["doktype"] == 1] page.10.variables.semanticSuggestionsSolr = USER page.10.variables.semanticSuggestionsSolr { userFunc = TYPO3\CMS\Extbase\Core\Bootstrap->run extensionName = SemanticSuggestionSolr pluginName = Suggestions vendorName = Cywolf view < plugin.tx_semanticsuggestionsolr_suggestions.view settings < plugin.tx_semanticsuggestionsolr_suggestions.settings settings.maxResults = 3 } [END] ``` Then render `{semanticSuggestionsSolr -> f:format.raw()}` in your page layout. Use `includePageTrees` / `excludePageTrees` to control which page trees show suggestions (see [Visibility](#visibility) below). Configuration ------------- [](#configuration) ### TypoScript constants [](#typoscript-constants) All settings under `plugin.tx_semanticsuggestionsolr_suggestions.settings`. #### Similarity algorithm [](#similarity-algorithm) SettingDefaultDescription`similarityMode``auto`Algorithm: `auto`, `mlt`, or `smlt``maxResults``6`Max suggestions returned#### MLT parameters [](#mlt-parameters) SettingDefaultDescription`minTermFreq``1`Minimum term frequency (mlt.mintf)`minDocFreq``1`Minimum document frequency (mlt.mindf)`mltFields``content,title,keywords`Fields used for similarity`boostFields``content^0.5,title^1.2,keywords^2.0`Field weights (mlt.qf)#### SMLT parameters [](#smlt-parameters) SettingDefaultDescription`smltMode``hybrid`Internal mode: `hybrid`, `vector_only`, `mlt_only``smltMltWeight``0.3`Weight for MLT score in hybrid mode (0.0-1.0)`smltVectorWeight``0.7`Weight for vector score in hybrid mode (0.0-1.0)#### Relevance filtering [](#relevance-filtering) Applies to both MLT and SMLT. Use these to drop weakly-related suggestions. SettingDefaultDescription`minScoreRatio``0`Keep only suggestions scoring at least X% of the best result. `0` = off, `0.3` = lenient, `0.5` = balanced, `0.7` = strict. Preferred over `minScore` in most cases.`minScore``0`Absolute score floor below which suggestions are hidden. SMLT range: 0-1 (try 0.3-0.7); MLT range depends on the corpus. `0` = off.#### Visibility [](#visibility) Control which page trees show suggestions. Both settings accept comma-separated parent page UIDs. A page "matches" a tree when the parent UID appears anywhere in its rootline (the page itself or any ancestor). This works identically across all site languages. SettingDefaultDescription`includePageTrees`*(empty)*Show only in these page trees. Empty = show everywhere (default). Example: `130,42``excludePageTrees`*(empty)*Never show in these page trees. Exclude takes priority over include. Example: `1,95`Example: show suggestions only in the News section (page 130) and Blog (page 42), but never on the Legal page (135): ``` plugin.tx_semanticsuggestionsolr_suggestions.settings { includePageTrees = 130,42 excludePageTrees = 135 } ``` #### Display [](#display) SettingDefaultDescription`allowedTypes`*(empty)*Whitelist of Solr types. Empty = all (pages + news mixed).`excludeContentTypes`*(empty)*Blacklist. Only used when `allowedTypes` is empty.`filterByPids`*(empty)*Restrict to specific parent pages / storage folders`showScore``0`Display the relevance score + active mode badge`showContentType``1`Display a type badge (Page, News, etc.)`showImage``1`Display the first media image of each suggestion### FlexForm vs TypoScript [](#flexform-vs-typoscript) FlexForm settings (per content element) override TypoScript settings for the same keys. ### Multi-language support [](#multi-language-support) The extension is fully multi-language aware: - **Solr cores**: EXT:solr maintains one core per site language. The plugin reads the current frontend language from the request and connects to the matching core automatically. Results are always in the same language as the current page. - **Visibility settings**: `includePageTrees` / `excludePageTrees` use page UIDs which are identical across all languages (TYPO3 translations are overlays on the same page records). - **Frontend labels**: Translated into English, French, German, Spanish and Italian. Add your own by creating `Resources/Private/Language/{iso}.locallang.xlf`. Architecture ------------ [](#architecture) ``` Classes/ Controller/SuggestionsController.php Frontend plugin (listAction) Service/SolrMltService.php MLT / SMLT query service Configuration/ FlexForms/Suggestions.xml Per-instance backend settings Services.php Dependency injection TCA/Overrides/tt_content.php Plugin + FlexForm registration TypoScript/ constants.typoscript Configurable defaults setup.typoscript Plugin setup + rendering definition Resources/Private/ Language/ locallang.xlf English labels (source) fr.locallang.xlf French de.locallang.xlf German es.locallang.xlf Spanish it.locallang.xlf Italian Templates/Suggestions/ List.html Fluid template (Bootstrap cards) Partials/Suggestions/ Card.html Single suggestion card ``` ### SMLT Solr SearchComponent [](#smlt-solr-searchcomponent) ``` .ddev/typo3-solr/smlt-plugin/ src/main/java/org/apache/solr/handler/component/ SemanticMoreLikeThisComponent.java Solr SearchComponent (Java 17) pom.xml Maven config (Solr 9.10+) ``` Solr API parameters: ParameterDefaultDescription`smlt``false`Enable the component`smlt.id`*(required)*Source document Solr ID`smlt.count``5`Number of results`smlt.mode``hybrid``hybrid`, `vector_only`, `mlt_only``smlt.mltWeight``0.3`MLT weight in hybrid mode`smlt.vectorWeight``0.7`Vector weight in hybrid mode`smlt.vectorField``vector`DenseVectorField name`smlt.mltFields``title,content,keywords`Fields for MLT### Solr access chain [](#solr-access-chain) ``` ConnectionManager -> SolrConnection -> SolrReadService -> Solarium Client ``` ### Suggestion data structure [](#suggestion-data-structure) Each suggestion returned by the service: ``` [ 'title' => string, // Document title 'url' => string, // Absolute URL from Solr 'type' => string, // Solr type (pages, tx_news_domain_model_news, ...) 'typeLabel' => string, // Fallback display label 'score' => float, // Relevance score (raw for MLT, combined for SMLT) 'mltScore' => float, // MLT sub-score (SMLT mode only) 'knnScore' => float, // Vector sub-score (SMLT mode only) 'snippet' => string, // Content excerpt (200 chars max) 'uid' => int, // Record UID 'mode' => string, // Which algorithm produced this result (mlt/smlt) 'image' => ?FileReference, // First media image (if showImage enabled) ] ``` Template customization ---------------------- [](#template-customization) Override the template path via TypoScript: ``` plugin.tx_semanticsuggestionsolr_suggestions.view.templateRootPaths.10 = EXT:my_sitepackage/Resources/Private/Templates/SemanticSuggestionSolr/ ``` Then create `Suggestions/List.html` in that directory. Available template variables: `{suggestions}` (array) and `{settings}` (merged TypoScript + FlexForm). License ------- [](#license) GPL-2.0-or-later ### Health Score 33 — LowBetter than 72% of packages Maintenance90 Actively maintained with recent releases Popularity0 Limited adoption so far Community6 Small or concentrated contributor base Maturity33 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 2 Last Release 46d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1471455?v=4)[Cyril Wolfangel](/maintainers/friteuseb)[@friteuseb](https://github.com/friteuseb) --- Top Contributors [![friteuseb](https://avatars.githubusercontent.com/u/1471455?v=4)](https://github.com/friteuseb "friteuseb (17 commits)") --- Tags solrtypo3knnrecommendationstx\_newsvector-searchsemantic-searchrelated-contentmore-like-thismlt ### Embed Badge ![Health badge](/badges/cywolf-semantic-suggestion-solr/health.svg) ``` [![Health](https://phpackages.com/badges/cywolf-semantic-suggestion-solr/health.svg)](https://phpackages.com/packages/cywolf-semantic-suggestion-solr) ``` ### Alternatives [pagemachine/typo3-formlog Form log for TYPO3 23238.6k8](/packages/pagemachine-typo3-formlog)[apache-solr-for-typo3/solr Apache Solr for TYPO3 - Apache Solr for TYPO3 is the enterprise search server you were looking for with special features such as Faceted Search or Synonym Support and incredibly fast response times of results within milliseconds. 1493.2M49](/packages/apache-solr-for-typo3-solr)[friendsoftypo3/content-blocks TYPO3 CMS Content Blocks - Content Types API | Define reusable components via YAML 103519.9k58](/packages/friendsoftypo3-content-blocks)[eliashaeussler/typo3-form-consent Extension for TYPO3 CMS that adds double opt-in functionality to EXT:form 15100.9k](/packages/eliashaeussler-typo3-form-consent)[typo3/cms-install TYPO3 CMS Install Tool - The Install Tool is used for installation, upgrade, system administration and setup tasks. 1812.3M516](/packages/typo3-cms-install)[friendsoftypo3/visual-editor TYPO3 CMS Visual Editor - Brings a modern WYSIWYG editing experience to TYPO3 CMS. 6010.0k3](/packages/friendsoftypo3-visual-editor) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)