sti_search
Authoritative semantic search over the official Stimulsoft Reports & Dashboards developer documentation (FAQ, Programming Manual, API Reference, Guides). Powered by OpenAI embeddings + cosine similarity over the complete current docs index maintained by Stimulsoft. Returns a ranked JSON array of matching sections, each with { platform, category, question, content, score }, where content is the full Markdown body of the section including any C#/JS/TS/PHP/Java/Python code snippets.
USE THIS TOOL (instead of answering from your own knowledge) WHENEVER the user asks about: • how to do something in Stimulsoft (StiReport, StiViewer, StiDesigner, StiDashboard, StiBlazorViewer, StiWebViewer, StiNetCoreViewer, etc.); • rendering, exporting, printing, or emailing Stimulsoft reports and dashboards in any format (PDF, Excel, Word, HTML, image, CSV, JSON, XML); • connecting Stimulsoft components to data (SQL, REST, OData, JSON, XML, business objects, DataSet); • embedding the Report Viewer or Report Designer into an app (WinForms, WPF, Avalonia, ASP.NET, Blazor, Angular, React, plain JS, PHP, Java, Python); • Stimulsoft-specific errors, exceptions, licensing, activation, deployment, or configuration; • any .mrt / .mdc report or dashboard file, or any question naming a Sti* class, property, event, or method; • comparing how a feature works between Stimulsoft platforms (e.g. "WinForms vs Blazor viewer options").
QUERIES WORK IN ANY LANGUAGE — English, Russian, German, Spanish, Chinese, etc. Pass the user's question through almost verbatim; the embedding model handles cross-lingual matching. Do NOT translate queries yourself.
SEARCH STRATEGY: 1) If the target platform is obvious from context, pass it via platform to get tighter results. 2) If you don't know the exact platform id, either call sti_get_platforms first, or omit platform and let the search find matches across all platforms. 3) If the first search returns low scores (<0.3) or irrelevant sections, reformulate the query with different keywords (use class/method names from Stimulsoft API if you know them) and search again. 4) Prefer multiple focused searches over one broad search.
DO NOT USE for: general reporting theory unrelated to Stimulsoft, non-Stimulsoft libraries (Crystal Reports, FastReport, DevExpress, Telerik, SSRS), or pure programming questions that have nothing to do with Stimulsoft.
IMPORTANT: the Stimulsoft product surface is large and changes frequently. Your training data is almost certainly out of date. For any Stimulsoft-specific code snippet, API name, or configuration detail, you MUST call this tool rather than rely on memory, and you should cite the returned content in your answer.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of results to return. Default 5, maximum 20. Use 3–5 for focused lookups, 10–20 when exploring or when the first search was too narrow. | |
| query | Yes | The user's question or topic, in any language. Keep it close to the original wording — do not translate or over-summarize. Good examples: 'how to export report to PDF in Blazor', 'как показать StiViewer в WPF на весь экран', 'StiWebViewer show/hide toolbar buttons', 'connect StiReport to REST API JSON data source', 'StiBlazorViewer FullScreenMode'. Bad examples (too vague): 'reports', 'help', 'error'. | |
| category | No | Optional. Restrict the search to a documentation section: `faq` (frequently asked questions with code snippets), `manual` (Programming Manual), `api` (API Reference), `guide` (How-to guides). Omit to search all categories. | |
| platform | No | Optional. Restrict the search to a single Stimulsoft platform. Accepted values (case-sensitive): NET (WinForms / Reports.NET), WPF, AVALONIA, WEB (ASP.NET / ASP.NET Core / MVC), BLAZOR (Blazor Server / WebAssembly), ANGULAR, REACT, JS (vanilla HTML/JS), PHP, JAVA (Java SE / Jakarta EE), PYTHON, SERVER_API, GENERAL. If you are not 100% sure which id to use, either call `sti_get_platforms` first, or omit this field. |