| Class | Description |
|---|---|
| ApproximateModule |
Serve as a function for query expansion config in query prefix handlers.
|
| BaseFetchCommand |
Abstract class for a fetch command.
|
| BaseNumericalPrefixHandler |
Base class to configure a prefix handler targeting an index field.
|
| BaseSearchCommand |
Search API command
|
| BaseSearchCommand.CustomRunnerFactoryParams | |
| BuildableSuggest |
Suggest based class for buildable suggests.
A buildable suggest is a suggest than can be built programmatically. |
| BuildGroupConfig |
Build group configuration.
|
| BuildGroupException |
No documentation for this element.
|
| BuildSuggest |
No documentation for this element.
|
| CategoryPathSuggest |
Takes category paths of one category index field.
|
| CategoryPrefixHandler |
Searches for paths in a category field
|
| CategorySuggest |
Takes a category index field.
|
| CategoryTitleSuggest |
Takes category titles of one category index field.
|
| Command |
Search API command
|
| CompileSuggestXMLFile |
No documentation for this element.
|
| ConsistentSearchCache |
This cache is always fully evicted each time a new generation
of the index is available.
Warmup starts shortly afterwards, and is restarted for each new generation. |
| ContentGroupConfig |
Content group configuration.
|
| ContentRestriction |
No documentation for this element.
|
| CreateSuggestXMLFile |
Output the suggest data to an XML file.
|
| CronSuggestBuildTrigger |
Triggers a suggest build based on a Quartz Cron expression
|
| CSVIndexFieldSuggest |
Takes one value from a multi-encoded CSV field.
|
| CustomPrefixHandler |
Prefix handler implemented using custom Java code.
|
| CustomProcessor |
No documentation for this element.
|
| CustomQueryExpansionModule |
Serve as a function for query expansion config in query prefix handlers.
|
| DailyStaticReport |
Static report for a given day
|
| DatePrefixHandler |
Searches for dates and/or times in a date field.
|
| DictionaryCommand |
Search API command
|
| DocumentFetchCommand |
Abstract class for a fetch command.
|
| DynamicDatePrefixHandler |
Searches for dates and/or times in a dynamic field.
|
| DynamicFieldSuggest |
Takes the value from a subset of a dynamic index field to build a suggest.
|
| DynamicFullTextPrefixHandler | Deprecated |
| DynamicIndexFieldPrefixHandler |
Base class to configure a prefix handler targeting an index field.
|
| DynamicNumericalPrefixHandler |
Searches for numerical values in a dynamic field.
|
| DynamicRawTextPrefixHandler |
Root class for prefix handlers searching for alphanumerical values in a dynamic field.
|
| DynamicTextPrefixHandler |
Root class for prefix handlers searching for alphanumerical values in a dynamic field.
|
| EnoviaSecureDynamicFieldSuggest |
Retrieve enovia-specific tokens from the index and uses the value of an index field and the associated security tokens to build a suggest.
|
| EnumFacetPrefixHandler |
No documentation for this element.
|
| ExprElement |
No documentation for this element.
|
| ExprElementList |
Class returned by the search-api introspection method "/expr_elements"
|
| FacetDesc |
No documentation for this element.
|
| FacetDescList |
Class returned by the search-api introspection method "/facets"
|
| FullTextPrefixHandler |
Searches in alphanumerical fields (both static and dynamic ones).
|
| GenerateStaticApplicationReport |
Generate application related reports
|
| GenerateStaticReport |
Generate global static report
|
| GeoCommand |
Search API command
|
| GeoPrefixHandler |
Sets the geographic field for WITHIN and DISTANCE searches
|
| GetSearchAPIConfigList |
Get the SearchAPIConfigList configuration.
|
| GetSearchAPIConfigListByVersion |
Get the SearchAPIConfigList configuration for a store version.
|
| GetSearchLogicList |
Get the SearchLogicList configuration.
|
| GetSearchLogicListByVersion |
Get the SearchLogicList configuration for a store version.
|
| GetSearchTargetList |
Get the SearchTargetList configuration.
|
| GetSearchTargetListByVersion |
Get the SearchTargetList configuration for a store version.
|
| GetStaticReportList |
Get a generated StaticReportList
|
| GetStaticReportStatusList |
No documentation for this element.
|
| GetSuggestConfig |
Get the Suggest configuration.
|
| GetSuggestConfigByVersion |
Get the Suggest configuration for a store version.
|
| GetSuggestStatusList |
No documentation for this element.
|
| GlobalIntrospectionAnswer |
Introspection answer object
|
| IndexFieldPrefixHandler |
Base class to configure a prefix handler targeting an index field.
|
| IndexFieldSuggest |
Takes the value of an index field to build a suggest.
|
| IsAliveCommand |
Search API command
|
| KeywordPrefixHandler |
Searches for a specific Related Term resolving its indexed identifier (internal) by querying the dictionary.
|
| LegacySearchTarget | Deprecated |
| LemmatizationModule |
Semantic module expanding the query using the lemmatized forms of terms.
The lemmatized form is the semantic root of a word. |
| LinguisticOptionsPrefixHandler |
Sets a query expansion config on the prefix handler content, but does not actually perform search.
|
| LocalOnlySearchTarget |
No documentation for this element.
|
| LocalThumbnailsCache |
The local thumbnails cache configuration.
|
| LogicRunnerCustomization |
No documentation for this element.
|
| LogicRunnerCustomization.GlobalFinalProcessors | |
| LogicRunnerCustomization.GlobalPostParseProcessors | |
| LogicRunnerCustomization.GlobalPreParseProcessors | |
| LogicRunnerCustomization.PostMapProcessors | |
| LogicRunnerCustomization.PreLinguisticProcessors | |
| LogicRunnerCustomization.PreMapProcessors | |
| LogicRunnerCustomization.PreParseProcessors | |
| LogicRunnerCustomization.PreTransformProcessors | |
| MetaDesc |
Description of a meta that can be returned by the search
|
| MetaDescList |
Class returned by the search-api introspection method "/metas"
|
| MonthlyStaticReport |
Static report for a given month
|
| MultiQueryPrefixHandler |
Prefix handler dispatching a query to several other prefix handlers.
|
| NGramModule |
Serve as a function for query expansion config in query prefix handlers.
|
| NodeRestrictionConfig |
Configure node restriction policy for search queries
|
| NormalizationExceptionsModule |
Defines a list of words that should not be normalized.
|
| NumericalPrefixHandler |
Searches for numerical values in a numerical field (integer or double)
|
| ObjectFactory | |
| OperatorCountRestrictionConfig |
Configure operator count restriction policy for search queries
|
| OperatorRestrictionConfig |
Configure operator restriction policy for search queries
|
| PhoneticModule |
Expands the query using a phonetic resource.
|
| PositionPrefixHandler |
Searches in an alphanumerical field using the anchoring position (i.e.
restricting the match to be at a specific position). |
| PossibleSort |
No documentation for this element.
|
| PossibleSortsList |
Class returned by the search-api introspection method "/sorts"
|
| PostFilterConfig |
No documentation for this element.
|
| PredicateLineage |
No documentation for this element.
|
| PrefixHandlerSuggestPair |
Maps a prefix handler to a suggest dictionary.
|
| PreviewCommand |
Retrieves rich HTML preview of the documents.
|
| QuarterlyStaticReport |
Static report for a given quarter
|
| QueryExpansionCommand |
A BaseSearchCommand used for query expansion
|
| QueryExpansionModule |
Serve as a function for query expansion config in query prefix handlers.
|
| QueryPrefixHandler |
No documentation for this element.
|
| QueryPrefixHandler.FromDataModel | |
| QueryPrefixHandlerList |
Class returned by the search-api introspection method "/prefixes"
|
| QueryReportingSuggest |
Takes the user queries stored for query reporting to build a suggest automatically.
|
| QueryRestrictionConfig |
No documentation for this element.
|
| QueryTermCountRestrictionConfig |
Configure term count restriction policy for search queries
|
| RawTextPrefixHandler |
No documentation for this element.
|
| RefinePrefixHandler |
Base class to configure a prefix handler targeting an index field.
|
| RelatedTermModule |
Expands the query using related terms.
Related terms are popular ngrams detected at indexing time. |
| RelatedTermsSuggest |
Takes the value of the 'keyword' index field.
|
| RestrictedNode |
Restrict occurences of a given node within a search query
|
| RestrictedOperator |
Restrict occurrences of a given operator within a search query
|
| SearchAPIConfig |
No documentation for this element.
|
| SearchAPIConfigList |
No documentation for this element.
|
| SearchBasedSuggest |
Base class for suggests retrieving their data through a search client
|
| SearchCache |
Cache for Search API queries.
|
| SearchCommand |
Search API command
|
| SearchCommand.IsAliveQueries | |
| SearchLogic |
Controls how searches are processed.
|
| SearchLogicList |
No documentation for this element.
|
| SearchTarget |
No documentation for this element.
|
| SearchTargetList |
Returns a list of Search Target
|
| SecurityCommand |
Search API command
|
| SemanticProcessorModule |
Query expansion module embedding a semantic processing pipeline.
The resulting annotation can be used to expand the query. |
| SemanticQueryAnalysisConfig |
No documentation for this element.
|
| SetSearchAPIConfigList |
Set the SearchAPIConfigList configuration.
|
| SetSearchLogicList |
Set the SearchLogicList configuration.
|
| SetSearchTargetList |
Set the SearchTargetList configuration.
|
| SetSuggestConfig |
Set the Suggest configuration.
|
| SimilarDocumentPrefixHandler |
Manually looks up similar values in documents.
|
| SimpleSearchTarget |
The search server evenly distributes search requests among all available index replicas.
|
| SimpleSuggestBuildTrigger |
Triggers a suggest build at a given time interval
|
| SitePrefixHandler |
Searches for parts of URLs.
|
| SpellCheckCommand |
Search API command
|
| SplitPrefixHandler |
Searches for expressions, within the bounds of separators.
For example, with a Split prefix handler named "mypage" using separator INPAGE, mypage:(a AND b) will only match if "a" and "b" appear on the same page in the document. |
| StaticAllQueryCountReportResult |
Total number of queries
|
| StaticCountReportResult |
Base class for report providing a count
|
| StaticLongQueryCountReportResult |
Total number of queries with exec time > 1s
|
| StaticNoResultQueryCountReportResult |
Total number of queries without results
|
| StaticOpenedDocCountReportResult |
Total number of doc opened
|
| StaticQueryCountReportResult |
Base class for report providing a query count
|
| StaticReport |
Base class representing a static report for a given period (daily, weekly, monthly, or quarterly)
|
| StaticReportBuildStatus |
Status/Stats after a static report build has successfully finished
|
| StaticReportList |
No documentation for this element.
|
| StaticReportResult |
No documentation for this element.
|
| StaticReportStatus |
No documentation for this element.
|
| StaticReportStatusList |
No documentation for this element.
|
| StaticResourceSuggest |
Takes an already compiled resource as parameter.
This suggest can neither be scheduled nor built. |
| StaticTopLongQueryReportResult |
Provides the top longest queries, ordered by count.
|
| StaticTopNoResultQueryReportResult |
Provides the top queries without results, ordered by count.
|
| StaticTopOpenedDocReportResult |
Provides the top opened documents, ordered by count.
|
| StaticTopQueryReportResult |
Provides the top queries, ordered by count.
|
| StaticUniqueUserCountReportResult |
Total number of unique users
|
| StaticVeryLongQueryCountReportResult |
Total number of queries with exec time > 10s
|
| StaticXMLSuggest |
Takes a suggest XML file as parameter and compiles it.
This suggest cannot be scheduled. Build options are read directly from the suggest XML file. |
| StemmingModule |
Extracts the root of a word.
|
| Suggest |
Suggest Base Class
|
| SuggestBuildConfig |
Suggest build options
|
| SuggestBuildStatus |
Status/Stats after a suggest build has successfully finished
|
| SuggestBuildTrigger |
Base class for suggest build trigger
|
| SuggestCommand |
Search API command
|
| SuggestConfig |
List of Suggest and SuggestDispatcher
|
| SuggestDispatcher |
A SuggestDispatcher associates prefix handlers to Suggests.
It may be used by the SuggestCommand to dispatch a relevant part of a query to the right suggest. For example, given a query "title: test", it will send "test" to the Suggest attached to the "title" prefix handler. |
| SuggestDispatcher.DesignedForLogics | |
| SuggestQueryConfig |
Defines default suggest-time options
|
| SuggestStatus |
No documentation for this element.
|
| SuggestStatusList |
No documentation for this element.
|
| SynonymsModule |
Synonyms module broadening the scope of a user query.
|
| TargetSlices |
No documentation for this element.
|
| TemplatePrefixHandler |
Replaces its content with the expansion of its template attribute, in which
the __QUERY__ placeholder has itself been replaced by the content. This prefix handler can be used as default prefix handler with some limitations (not compatible with linguistic prefix handlers like spellslike:). |
| TextPrefixHandler |
No documentation for this element.
|
| ThumbnailCommand |
Abstract class for a fetch command.
|
| ThumbnailsCache |
Cache for thumbnails computed on the fly
|
| TimeBasedSearchCache |
The elements of this cache are evicted based on time policy.
They are not evicted each time a new generation of the index is available. |
| TimezoneConfig |
No documentation for this element.
|
| TopOpenedDoc |
A document in the list of most opened ones.
|
| TopQuery |
No documentation for this element.
|
| UnitsOfMeasurementPrefixHandler |
Searches for documents by resolving and converting values in the required unit of measurement
|
| UnixTimestampPrefixHandler |
Searches for dates and/or times in a date field, in Unix Timestamp format.
|
| UQLConfig |
No documentation for this element.
|
| URLMatcherModule |
Serve as a function for query expansion config in query prefix handlers.
|
| WarmUpQuery |
Query that will automatically be cached.
|
| WeeklyStaticReport |
Static report for a given week
|
Copyright © 2021 Dassault Systèmes, All Rights Reserved.