Glossary
What are we talking about? Some of the terminology for Silverstripe Search has a specific scope or meaning which you can find below:
- Plan means the base service tier offering that includes a predefined set of features, performance levels, and support options
- Add-on means an additional resource that is part of your plan such as extra engines or a larger request quota.
- Engine means the core software component responsible for executing search queries, indexing content, and generating search results. For more information, see Engines and Schema
- Silverstripe CMS website means a website or web application built with Silverstripe CMS technology
- Software Development Kit (SDK) means a set of code and documentation making it easier to integrate with Silverstripe Search
- Bifröst API is the main programmatic entry point for this service. The SDK communicates with this API
- Schema defines the shape of your data. Schemas consist of schema fields
- Schema field tells Silverstripe Search more about what your documents contain. Each schema field has a field type
- Field type defines what kind of data can be stored in the field
- Search Documents means any individual piece of content that can be indexed and retrieved by a search engine
- A Document is a representation of your content that is stored in Silverstripe Search. Only content added into documents will be available to search on. Documents consist of fields.
- Subscription means the service agreement between the customer and Silverstripe for accessing and using Silverstripe Search, it includes: the Plan; Add-ons, their features; performance levels; and support options
- Field means a key and a value pair. The key is the name of the field and this is the same for all documents within the engine. A field’s value represents the unique content of the document
- Query is a word or phrase that a user wants information about. Silverstripe Search finds documents that have content matching the query. A query can consist of multiple terms (even multi-word terms)
- Term means one or more words in a query that Silverstripe Search is matching on. A term can be a single word term (e.g. cart), or a multi-word term (e.g. "horse-drawn cart")
- Document score is a number that represents how well a specific document matches the query.
Further support
Check the FAQ - Frequently asked questions.