Community Edition | Enterprise Edition
Glossary
| Term | Definition |
|---|---|
| AIProvider | A configuration of an LLM, including metadata identifying the model type, API key, base URL, and the search roles it should fulfill (chat, RAG, query rewriting, embeddings). (Available in SWIRL Community as of 4.5; previously Enterprise-only.) |
| Authenticator | A configuration of a Single Sign-On (SSO) or Identity Provider (IDP) such as Microsoft, Okta, or Ping Federate. (SWIRL Enterprise only) |
| Chat | A SWIRL object that stores message objects exchanged within the AI Search Assistant. |
| Connector | A SWIRL module that interacts with a specific data source, wrapping existing Python libraries (e.g., requests.get, elasticsearch). |
| Confidence | A prediction of relevancy for a SWIRL search result, ranging from 0 to 1. (SWIRL Enterprise only) |
| Message | A SWIRL object containing a message sent to or from an LLM. (SWIRL Enterprise only) |
| Mixer | Combines results from multiple SearchProviders into a unified result set, applying relevancy ranking. |
| Page Fetcher | A SWIRL module that retrieves a copy of a specific document for additional processing. SWIRL Enterprise can authenticate when fetching. |
| Processors | Modules that process search queries and results — for example, removing control characters, spell-checking, or normalizing formats. |
| Prompt | A SWIRL object that configures an LLM for use in AI-assisted search roles, such as Retrieval-Augmented Generation (RAG) or chat. (SWIRL Enterprise only) |
| Pipelines | Execute predefined sequences of Processors to transform search input or result content dynamically. |
| Query | The search terms entered by a user. In search engines, the act of searching is distinct from the terms themselves, which are called the query. |
| Search | A SWIRL object that defines a search execution request, containing a query_string (search text) and optional metadata. |
| SearchProvider | A configuration of a Connector, defining a searchable source and including metadata such as authentication credentials and endpoint details. |
| Subscribe | A key property of Search objects. When set to true, SWIRL periodically re-runs the search, sorting by date to retrieve newer data while removing duplicates. Users currently poll for updates; future releases will support callbacks when new results are available, and automatic AI Insights regeneration. |
| Result | A retrieved search result from a SearchProvider within a federated search. |
| Relevancy Ranking | A scoring system that determines the importance of a search result compared to others. See Relevance in Information Retrieval. |