SearchSuggestionSpec
class SearchSuggestionSpec
This class represents the specification logic for AppSearch. It can be used to set the filter and settings of search a suggestions.
| See also | |
|---|---|
searchSuggestionAsync |
Summary
Nested types |
|---|
|
Builder for |
Constants |
|
|---|---|
const Int |
Ranked by the document count that contains the term. |
const Int |
No Ranking, results are returned in arbitrary order. |
const Int |
Ranked by the term appear frequency. |
Public functions |
|
|---|---|
(Mutable)Map<String!, (Mutable)List<String!>!> |
Returns the map of namespace and target document ids to search over. |
(Mutable)List<String!> |
Returns the list of namespaces to search over. |
(Mutable)Map<String!, (Mutable)List<String!>!> |
Returns the map of schema and target properties to search over. |
(Mutable)List<String!> |
Returns the list of schema to search the suggestion over. |
Int |
Returns the maximum number of wanted suggestion that will be returned in the result object. |
Int |
Returns the ranking strategy. |
(Mutable)List<String!> |
Returns the list of String parameters that can be referenced in the query through the "getSearchStringParameter({index})" function. |
Constants
SUGGESTION_RANKING_STRATEGY_DOCUMENT_COUNT
const val SUGGESTION_RANKING_STRATEGY_DOCUMENT_COUNT = 0: Int
Ranked by the document count that contains the term.
Suppose the following document is in the index.
Doc1 contains: term1 term2 term2 term2
Doc2 contains: term1
Then, suppose that a search suggestion for "t" is issued with the DOCUMENT_COUNT, the returned SearchSuggestionResults will be: term1, term2. The term1 will have higher score and appear in the results first.
SUGGESTION_RANKING_STRATEGY_NONE
const val SUGGESTION_RANKING_STRATEGY_NONE = 2: Int
No Ranking, results are returned in arbitrary order.
SUGGESTION_RANKING_STRATEGY_TERM_FREQUENCY
const val SUGGESTION_RANKING_STRATEGY_TERM_FREQUENCY = 1: Int
Ranked by the term appear frequency.
Suppose the following document is in the index.
Doc1 contains: term1 term2 term2 term2
Doc2 contains: term1
Then, suppose that a search suggestion for "t" is issued with the TERM_FREQUENCY, the returned SearchSuggestionResults will be: term2, term1. The term2 will have higher score and appear in the results first.
Public functions
getFilterDocumentIds
fun getFilterDocumentIds(): (Mutable)Map<String!, (Mutable)List<String!>!>
Returns the map of namespace and target document ids to search over.
The keys of the returned map are namespaces, and the values are the target document ids in that namespace to search over.
If addFilterDocumentIds was never called, returns an empty map. In this case AppSearch will search over all namespace and document ids.
Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.
getFilterNamespaces
fun getFilterNamespaces(): (Mutable)List<String!>
Returns the list of namespaces to search over.
If empty, will search over all namespaces.
getFilterProperties
fun getFilterProperties(): (Mutable)Map<String!, (Mutable)List<String!>!>
Returns the map of schema and target properties to search over.
The keys of the returned map are schema types, and the values are the target property path in that schema to search over.
If addFilterPropertyPaths was never called, returns an empty map. In this case AppSearch will search over all schemas and properties.
Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.
getFilterSchemas
fun getFilterSchemas(): (Mutable)List<String!>
Returns the list of schema to search the suggestion over.
If empty, will search over all schemas.
getMaximumResultCount
fun getMaximumResultCount(): Int
Returns the maximum number of wanted suggestion that will be returned in the result object.
getRankingStrategy
fun getRankingStrategy(): Int
Returns the ranking strategy.
getSearchStringParameters
fun getSearchStringParameters(): (Mutable)List<String!>
Returns the list of String parameters that can be referenced in the query through the "getSearchStringParameter({index})" function.
| See also | |
|---|---|
search |