This Search API command performs searches on the Exalead CloudView index. It is available at http://SEARCH_API_HOST:SEARCH_API_PORT/search-api/search. You can use it from the Java SearchClient and the .NET SearchClient classes.
Global Parameters
sl or logic
• String, monovalued.
• Must reference a valid logic, defined in the search logics list.
Example: print the query ast and not the ellql
q=job&sl=sl0 q=job&logic=sl0
st or target
• String, monovalued.
• Must reference a valid search target
Example: print the query ast and not the ellql
q=job&st=st0 q=job&target=st0
c or context
The context contains the encoded version of previous arguments to chain queries.
d or debug
Turns on various debugging flags for this query.
Value is a comma-separated list of the following parameters:
Parameter
Description
query
Logs query parsing and execution info
synthesis
Logs synthesis info
ph
Logs partial hit info (for example, scoring/collapsing keys)
fh
Logs full hit info (metas, hit categories)
ast
Puts the query ast in answer info
ellql
Puts the ellql in answer info (enabled by default)
context
Puts the context in answer info (enabled by default)
executor
Puts the executor in answer info. When a query execution requires several executions (disjunctive facets refinements, spell) they are all displayed.
all
All of the above
qp:int
queryprocessing debug level (0 to 3=all)
Note: You can disable flags using the - prefix.
Example: print the query ast and not the ellql
d=ast,-ellql
Example: print everything except the logs full hit info (fh)
d=all,-fh
Example: print everything except the context (context)
d=all,-context
hit_infos; hit_info, hi
Puts additional info in the hit to debug the ranking. The following info is supported:
Parameter
Description
ast
Computes the index AST for each hit.
rankings
Displays the ranking keys for each hit.
all
All of the above
Note: You can disable flags using "-" prefix.
Example: search for word "vacation" and enable ranking info for ast. You can cumulate the options.
q=vacation&hi=ast q=vacation&hi=ast,rankings
applicationId
In V6.x, you can create multiple applications using the Mashup Builder. This parameter is the Mashup application ID passed by the API client.
Important: It is also required by the Business Console, since the Business Logic is directly embedded as a prelinguistic Business Processor into the Search Server.
To trigger the Business Processor at runtime, you have to pass the applicationId parameter and optionally, the stagingMode parameter:
Parameter
Description
applicationId
Represents your application identifier (for example, "default")
stagingMode
Accepts two values:
• true - to use the application configuration and compile the Business Console resources at query time (so you do not have to apply your configuration).
• false - to use the application configuration and precompiled Business Console resources.
Examples:
• http://SEARCH_API_HOST:SEARCH_API_PORT/search-api/search?q=test&applicationId=default&stagingMode=false - The Business Processor uses the "default" application configuration and precompiled resources.
• http://SEARCH_API_HOST:SEARCH_API_PORT/search-api/search?q=test&applicationId=default&stagingMode=true - The Business Processor uses the "default" application configuration and compile resources at query-time.
• http://SEARCH_API_HOST:SEARCH_API_PORT/search-api/search?q=test&applicationId=default - The Business Processor will use the "default" application configuration and precompiled resources.
• http://SEARCH_API_HOST:SEARCH_API_PORT/search-api/search?q=test - The Business Processor is not triggered.
Checkpoints
The list of checkpoint values to retrieve on each slice, stored in the answer's slice info.
Value is a comma-separated list of checkpoint names.
Origin
This parameter has no impact on query treatment. However, it is logged in the search.csv file and can help you identify the origin of the query, when you analyze user queries using the search-reporting reporter with a CSV publisher. It is useful for better traceability and debugging.
Sorting and Grouping Parameters
s or sort
Sort is declared through several parameters:
Parameter
Description
sort=STRING
Comma-separated list of asc([sort id]) or desc([sort id]), that defines the order of the hits.
s=STRING
Same as sort.
sort.[sort id].expr=STRING
An existing index field, an existing virtual field or a symbolic name, used to compare hits. Set to [sort id] by default.
sort.[sort id].lsb=INTEGER
Position of the least significant within [0,63] to be considered. For integer field only. 0 by default.
sort.[sort id].msb=INTEGER
Position of the most significant within [lsb,63] to be considered. For integer field only. 63 by default.
sort.[sort id].limit=INTEGER
Maximum number of byte used to compare character string. 0 means that the strings are compared till the end. 0 by default.
sort.[sort id].min=INTEGER
If the field is an integer, only keeps hits for which the expr is at least INT.
Example: sort alphabetically by region and then by price
s=asc(document_region),desc(document_price)
Example: sort alphabetically by increasing price, decreasing score and then by increasing file size. 'myprice' and 'myscore' are '[sort id]' [sort id] can not contain any space, or comma, or closing parenthesis, nor point. If such characters are required, use the expanded syntax.
Name of the field or expression where the aggregation result is written. It can then be used to be displayed (combined with add_hit_meta) or to perform sort (combined with sort) for example.
group.[group id].topn=INTEGER
Number of hits to keep for each group.
group.[group id].sort=STRING
Defines the order of hits within each group to keep the top n best. See sort=.
group.[group id].s=STRING
Same as group.[group id].sort. See sort=.
group.[group id].sort.[sort criterion id].*
Sort criterion parameters. See sort=.
By default, a group pass has a single group dimension defined with expr set to [group identifier]. [group id] and [criterion id] can neither contain comma, nor point. If such characters are required in the expression, use the expanded syntax.
Example: Keep one document for each state. The best one is selected according to the ranking sort, the others are discarded.
group=document_region
Example: Keep the five best documents for each state.
Example: Keep the best noted hit per region, sort regions per hit count, and display the count. This example relies on the constant virtual expression 1.
Example: Keep no more than five hit per region, and no more that eight times the same product. This configuration creates two independent collapsing passes. The result set may contain fewer than 5 hits per region because document_product_name removes hits of the groups made by document_region pass.
Example: Keep one record for each firstname, lastname pair, select most recently updated hit, and get the average note in document_note and the total expense in total_expense. Finally results are sorted alphabetically.
Score actions that combine the ranking values for a group. POLICY can be add, max, min or best. For each grouping key, there can be one action for each ranking element. best by default.
Example: Keep one document for each state. The best one is selected according to the ranking sort, the others are discarded.
collapsing=document_region
Example: Keep the five best documents for each state.
Example: Keep no more than five hits per region, and no more that eight times the same product. This configuration creates two independent collapsing passes. The result set may contain fewer than 5 hits per region because document_product_name remove hits of the groups made by document_region pass.
• This parameter does not restrict searches to documents in this language. It only controls the language used for computing linguistic expansions, spell checking, and summarization.
Example: search for word "vacation" in text field in English language
q=vacation&l=en
r or refine
• Adds a refinement.
• The combination of refines which creates a named query called "refines".
Example: search for word "vacation" in text field and refine on source category "corpus"
q=vacation&r=f/source/corpus
cr or cancel_refine
Cancels a refinement completely.
Example: search for word "vacation" in text field, refine on source category "corpus" and cancel this refine
q=vacation&r=f/source/corpus&cr=f/source/corpus
zr or zap_refine
Removes a refinement and refines on the father, if applicable. For example, if we have refinement on "Top/MyPath/A/B/C", zapping this refinement replaces it with a refinement on "Top/MyPath/A/B"
Example: search for word "vacation" in text field, refine on source category "corpus" and zap this refine.
If true, when a r=f/unknownfacet/refine is specified, returns 0 results rather than an error. Default: false
UQL Interpretation
dp or default_prefix
Sets the default prefix handler. The default value is the one specified in the search logic. Can be restricted to a particular named query using dp.NAMED_QUERY_NAME or default_prefix.NAMED_QUERY_NAME.
Example: search for word "vacation" and set default prefix handler to "title", so "vacation" is searched in the title field.
q=vacation&dp=title
qec,query_expansion_config
Sets the QueryExpansionConfig for a given prefix.
The argument name can be specified as:
Parameter
Description
qec=SPEC
Sets the QEC of the default prefix
qec.PREFIX=SPEC
Sets the QEC on a given prefix
qec.ALL=SPEC
Sets the QEC on all semantic prefixes
q.QUERY.qec=SPEC
Sets the QEC on a named query
q.QUERY.qec.PREFIX=SPEC
Sets the QEC on a given prefix only on a named query
The argument value (SPEC) is specified as a QEC specification.
Note: Specifications are cumulative.
Examples:
• name=spellslike spec=phonetic
• name=text spec=synonyms1
• name=spells2 spec=phonetic{m=3}
• text:spellslike:foo will do phonetic + synonyms1
• text:spellslike:spell2:foo will do phonetic{m=3} + synonyms1
pal or patterns_all_languages
Sets whether pattern expansions are performed in all languages (Boolean parameter).
Limits Parameters
Limits
Defines search limits. This parameter is specified as a KV Map.
The basic keys are:
• max_fetched_hits
• max_fetched_hits_per_slice
• max_query_time
• max_total_time
• hits_sampling
Advanced keys are:
• max_kept_hits
• main_heap_flush_interval
• slice_heap_flush_interval
• interrupt_grace_delay
• full_grace_delay
Detailed documentation of these parameters can be found in SearchLogic / LimitsConfig in XML Configuration Reference
Shortcut for the limits parameter. When you want to set a timeout, unlike the max_total_time parameter, the timeout=X parameter also sets the value of max_query_time parameter.
• timeout=INT - Sets the global timeout. Query timeout is 75% of the global value.
• timeout=INT,INT - Sets the query and global timeouts.
nhits
Shortcut for limits=max_kept_hits:INT
hf or full_hits,nresults
Number of full hits. hf=0 disables full hits fetch.
b or start
First full hit index. For example, to search on the:
• first page: b=0&hf=10
• second page: b=10&hf=10
Hit Meta Parameters
use_logic_hit_metas
• true/false - (Optional) Removes all metas defined in the search logic. Default is true.
• metaname1,metaname2,metaname3 - Keeps only this list of metas. Be careful they must exist in search logic unless allow_unknown_hit_meta is true.
allow_unknown_hit_meta
Allows you to set an unknown meta in the list provided in use_logic_hit_metas , which is silently discarded. Default is false.
add_hit_meta
Add a new hit meta to the query result. Use multiple add_hit_meta clauses to add multiple metas. The value is a list of key:value separated by commas:
key:value
Description
name:string
The name of the meta
index_field:string
Name of the index field used to retrieve the meta value from, when different from the meta name. Default is name.
multi_field:string
Name of the index multiple fields (a.k.a. csv field) used to retrieve the values.
dynamic_field:string
Name of the index dynamic field used to retrieve the values.
context_name:string
For dynamic_field use only, specify the context to extract from the dynamic field. If empty, it is assumed that context_name has name value
highlight:boolean
When true, the meta value is highlighted in the summary. false by default.
summarize:boolean
false by default.
select_values:boolean
This parameter only works for value and alphanum fields.
It allows you to configure the number of values displayed for metas in hit content. This is typically useful to restrict the number of values retrieved from multivalued fields when you do not want to clutter hit content with too many values for a given meta.
You can specify a min and a max values to this operation with the min_values and max_values attributes. For example, if a multivalued foo field has 10 values, 5 of which matching the query, you can display N of these values in a new bar meta by adding the following Search API HTTP parameters:
This operation uses the query to determine whether a given value is a match or not, you therefore have to add another parameter like <property_name>:<value_to_match> to your query to select only the values matching value_to_match for the property_name meta.
Note: If the property has no value matching value_to_match, you lose a search result.
Note: index_field, multi_field, dynamic_field are exclusive. By default the meta value is extracted from an index_field with the same name as the meta. Dynamic fields, and multi fields contain multiple keys and values, the values matching the meta name are returned.
There is a compact syntax for add_hit_meta that supports only index_fields and highlighting:
• name - Name of the index field
• name,hl - Name of the index field, highlight:Boolean
Example: Simplified syntax
add_hit_meta=document_field_name,hl
is the same as: add_hit_meta=index_field:document_field_name,highlight:true
Example: Extracts color and value from the dynamic property named document_dynamic_field.
Example: You could also extract color from the dynamic property named document_dynamic_field and output its value in meta named property using a virtual expression:
• hit_meta.name.expr=expr - where name can contain any character, and expr is a virtual expression.
Add meta specific operation:
• First, you have to define the type of your operation, using the following syntax: (add_)hit_meta.META_NAME.operation.OPERATION_ID.type
• Then, you can associate properties to a given operation: (add_)hit_meta.META_NAME.operation.OPERATION_ID.property.OPERATION_PROPERTY
The following tables list available properties associated by type:
Type
Properties
custom
• class_id:string - the fully-qualified name of the class performing the operation
• YOUR_KEY:string - a KV passed to your operation
date_format
output_format:string - default is %m/%d/%Y
highlight
• facet_ids:string
• extra_prefix_handlers:string
printf
output_format:string
snippet
Makes a single value of a meta shorter when at least one of the meta's values matches. The typical use case for snippet is long, mono-valued, text metas. For short, multi-valued string metas, use select_values.
This operation uses the query to determine whether a given value is a match or not, you therefore have to add another parameter like <property_name>:<value_to_match> to your query to select only the values matching value_to_match for the property_name meta.
Note: If the property has no value matching value_to_match, you lose a search result.
• min_length:int - default is 1
• max_length:int - default is 150
• max_sentence_segment_length:int - default is 150
• max_sentence_segments:int - default is 3
• split_on_sentence:boolean - default is true
• remove_duplicate_segments:boolean - default is false
• if_meta:string - is a fallback meta if one of the if_metas_match:string meta matches the query. When both parameters are used, if a match is found, the summary is filled with the if_Meta value.
• if_metas_match:string - allows you to specify a comma-separated list of metas to test against the user query
• highlight_facet_ids:string
• highlight_extra_prefix_handlers:string
standard_decoding
• encoding:string - accepted values are url or idna
time_format
• output_format:string - default is %m/%d/%Y %H:%M:%S
truncate
• max_length:int
• strict:boolean - default is false
Example: Adds a meta hello from the field document_polite with a truncate processor named truncate_hello with max_length=10, strict=true
Extract all values from a multivalued field. It applies to multi fields (a.k.a. csv fields) and dynamic fields. The value is a key:value list separated by comma.
For dynamic fields only, you can also:
• Select a subset of contexts if you specify match rules (available rules: "exact", "prefix", "suffix", "substring"). You have to use them as key, the associated value being the pattern you are looking for.
Note: You can associate several rules. In this case, the hit meta is displayed if its name matches at least one rule.
• Specify the name of the meta that receives all the content of the dynamic field. If not set, for each pair key:value stored in the field, a meta named as the key is created.
Parameter
Description
multi_field:string
Name of the index field used to retrieve the meta names and values. Used by default.
Example: dynamic field with name (if dyn_[first:value1 first:value1] and dyn_[second:value2 second:value2] are stored, displays metagroup:value1,value2)
In the search logic, metas are identified by their names in the HitConfig object. When you remove a meta, this removes all sources and all processors attached to this meta. Value = meta name
add_highlight
Highlights an existing meta. Value = meta name
add_summary
Summarizes an existing meta. Value = meta name
hit_meta_order
Comma-separated list specifying in which order to display metas. Applicable only to CSV output.
All metas not present in the list are displayed after the metas present in the list.
Note: The following metas are not affected and are always displayed first, in the following order: did, url, buildGroup, source, slice, score, mask, sort
Faceting Parameters
Synthesis
• enabled/disabled
• Defaults to search logic config value.
synthesis_hits
• Number of hits used for category synthesis.
• Defaults to the value in the search logic.
use_logic_facets
Specifies the search logic facets to use and disables all other facets. For the specified facets, the configuration is read in the search logic.
• true - keeps all (default value)
• false - removes all
• facet_id1,facet_id2,...,facet_idN - keeps only this list of facets
remove_facet
One argument: facet_id.
f.* or facet.*
Creates a facet. Facets are specified as multiple parameters, like facet.FACET_ID.key=value where FACET_ID is the facet id (_a-zA-Z0-9).
Keys for ALL facets
Key
Description
type
Specifies the facet type (default is category), which can be:
• category (aka "cat")
• value
• date
• dyndate
• num_explicit (Numerical explicit ranges)
• num_fixed (Numerical fixed ranges)
• num_dynamic (Numerical dynamic ranges)
• geo
• autotile
• multi
• 2D or matrix
• enum
min_docs:long
Min number of docs that have the facet value (default is 1)
max_elements:uint
Max number of categories (default is 0=unlimited)
max_per_slice
Specifies the max number of different facets returned by a single slice.
in_hits:boolean
Default is true
in_synthesis:boolean
Default is true
sort
Specifies the sorting function (default is count), which can be:
• aggregation - Sorts the categories using the aggregation function specified with the sort_agg_fun: string key (see below). Default sorting direction is descending.
• alphanum - Sorts the categories lexicographically. The category path is used here, not the title. Default sorting direction is ascending.
• count - Sorts the categories by decreasing order, with the number of documents matching the query and having this facet.
• date - Sorts the categories by:
◦ Default with decreasing year, increasing month, increasing day
◦ Reverse (with -date) with increasing year, decreasing month, decreasing day
• explicit - Sorts the categories using an explicit order. Use a comma-separated list of values.
• Lat - Sorts the categories by latitude, using the average of points.
• Lng - Sorts the categories by longitude, using the average of points.
• Num - Tries to parse the category path as an integer, and sorts decreasingly. If the category is prefixed by a number it parses the prefix. In case of failure, it fallbacks to lexicographical sorting. Default sorting direction is ascending.
• range - If the categories are ranges in the form [a;b], it sorts the categories per increasing midrange value. Default sorting direction is ascending.
• relevancy - Sorts the categories by decreasing relevance. Relevance is defined by taking into account both the number of documents matching the query and having this facet, and the total number of documents having the facet. The idea is to use a method of ponderation similar to the classical TF-IDF.
To reverse the sorting order, prefix the sorting function with -, for example, -aggregation.
sort_agg_fun: string
Sort aggregation function id. (requires sort=aggregation)
explicit_sort_order_values: string
Comma-separated list of values defining the explicit sort order.
Note: You also need to configure properly sort parameter to use this feature.
implem
Implementation must be cpu, mem or auto. (default is auto)
refinement_policy:string
Refinement policy exclusive, disjunctive or norefine. (default is exclusive)
Keys for category facets
Key
Description
form:string
exact/lowercase/normalized (default is normalized)
root:string
Required
field:string
Category field (Required)
max_depth:uint
Max depth from refine (default is 0=unlimited)
max_depth_from_root:uint
Default 0=unlimited
max_per_level:uint
Default 100
Example: Standard facet with aggregation - Use this for the default Exalead CloudView index schema, which includes a categories field.
CONSTANT virtual expression that evaluates to the time when the synthesis starts
end:string
CONSTANT virtual expression that evaluates to the time when the synthesis ends
before_start:bool
Creates a virtual category for all dates before start (default is false)
after_end:bool
Creates a virtual category for all dates after end (default is false)
year:bool
Creates a virtual category for each (default is true)
year_desc:bool
Defines sort order for year (default is true)
month:bool
Creates a virtual category for each month (default is true)
month_desc:bool
Defines sort order for month (default is false)
week:bool
Creates a virtual category for each week (default is false)
week_desc:bool
Defines sort order for week (default is false)
day:bool
Creates a virtual category for each day (default is true)
day_desc:bool
Defines sort order for day (default is false)
hh:bool
Creates a virtual category for each hour (default is false)
hh_desc:bool
Defines sort order for hour (default is false)
mm:bool
Creates a virtual category for each minute (default is false)
mm_desc:bool
Defines sort order for minute (default is false)
ss:bool
Creates a virtual category for each second (default is false)
ss_desc:bool
Defines sort order for second (default is false)
max_depth:int
Default is 0
max_depth_from_root:int
Default is 0
Keys for dynamic date facets
Key
Description
vroot:string
(Required)
expr:string
(Required)
missing_intervals:boolean
Generates the missing intervals ensuring the dates are contiguous
year_fmt:string
Defines year-based generated category format
quarter_fmt:string
Defines quarter-based generated category format
month_fmt:string
Defines month-based generated category format
week_fmt:string
Defines week-based generated category format
day_fmt:string
Defines day-based generated category format
hour_fmt:string
Defines hour-based generated category format
min_fmt:string
Defines minute-based generated category format
sec_fmt:string
Defines second-based generated category format
enable_year:boolean
Enables the year level
enable_quarter:boolean
Enables the quarter level
enable_month:boolean
Enables the month level
enable_week:boolean
Enables the week level
enable_day:boolean
Enables the day level
enable_hour:boolean
Enables the hour level
enable_min:boolean
Enables the minute level
enable_sec:boolean
Enables the second level
enable_iso8601:boolean
Enables the iso8601 norm for date representation
Virtual numerical facets are used to organize search results in ranges.
Numerical range facets
Key
Description
num_explicit
Create ranges manually
num_fixed
Create ranges that are the same size
num_dynamic
Create ranges automatically
Generic keys for numerical range facets
Key
Description
vroot:string
(Required)
expr:string
(Required) see Virtual Expression Syntax reference page.
range
(0 to N times) min,max,title, for example "-1,1,my title"
min:double
Default is 0
max:double
Default is 2^63
lsb:int
Default is 0
msb:int
Default is 63
default_precision:int
Default is 2
num_fixed specific keys
Key
Description
rsize:double
Range size (def 0=one range per distinct value).
below_min:bool
Creates a range for values below min.
above_max:bool
Creates a range for values above max.
fmt_range
Sets the range title format.
fmt_above
Sets the above title format.
fmt_below
Sets the below title format.
fmt_single
Sets the singleton title format.
num_dynamic specific keys
Key
Description
fmt_range
Sets the range title format.
nb_ranges:int
The maximum number of ranges to output (dynamic).
policy:enum
The policy to generate the ranges.
adjust_ranges:bool
Tries to adjust the ranges on multiples of 10 (deprecated).
more_accurate:bool
Better linear/geometrical ranges, but slower (deprecated).
mrsize:bool
Size of each bin used to compute cardinality.
exclusiveRightBracket:bool
In the case of dynamic ranges, this parameter determines if the facet is exclusive or inclusive from the right side (true means [a,b[, and false means [a,b])
Example: Define custom price ranges and titles for each range
Defines a search target. The search target is specified with multiple parameters, like st.TARGET_NAME.key=value or target.TARGET_NAME.key=value where TARGET_NAME is the search target name (_a-zA-Z0-9).
The following keys are supported by all search targets:
• type:string - "local", "simple"
• watch_dog_connect_timeout_ms:int
• watch_dog_read_timeout_ms:int
The local search target supports the following key: build_groups:string
The simple search target requires the definition of target slices. Target slices are specified with multiple parameters, like st.TARGET_NAME.target_slices.TARGET_ID.key=value or target.TARGET_NAME.target_slices.TARGET_ID.key=value where TARGET_NAME is the search target name (_a-zA-Z0-9) and TARGET_ID is a number (0-9). The following keys are supported:
Boolean parameter to enable all relevance computation.
Globally disabling relevance computation disables the following features:
• term scoring
• proximity scoring
• sorting
• node properties
• using ranking elements for faceting
• using ranking elements for facet aggregations
• retrieving ranking elements
Note: If your query contains grouping, either by a Search API parameter or in the product configuration set in the Administration Console > Search Logic, the relevance feature is forced to true.
Note: If your query contains a refinement on a disjunctive facet, the relevance feature is forced to true.
proximity_max_distance
Maximum distance for proximity matching.
ts (term score)
Sets the term score algorithm. Value must be one of the available algorithms:
• NO_RANKING
• RANK
• TFIDF
• IDF
• RANK_IDF
• RANK_TFIDF
• BM25
• BM25F
• CUSTOM - for this term score algorithm, you must define ts.expr to specify the custom expression.
Unranked search mode
Streaming
Boolean parameter. If true, all sorts and all limits are ignored.
The answer is NOT cacheable, and is streamed. It is efficient as the synthesis and full hits are computed on-the-fly. It is therefore especially adapted to fetch large results sets without much memory consumption.
In streaming mode, you must iterate over all returned hits, so do not use the getHits() method but getHitsIterator() instead, and read hits using the hasNext and next subcalls.
Note: In streaming mode, the hf parameter does not control the maximum total number of returned full hits, but the maximum number of returned hits per slice. Therefore, with 4 slices, streaming=true, hf=2000, up to 8000 hits can be returned.
allow_skip_nhits
Boolean parameter. If true, Exalead CloudView stops counting hits that match the query as soon as possible. The nhits value is allowed to be incorrect.
This advanced parameter must be used for high performance unranked exports without synthesis.
Search Logic Editing
Search API parameters are the preferred way to change the search logic at query time.
Yet, when modifications made to the search logic are not covered by standard Search API parameters, the *search logic editing* (a.k.a. sle) can be used as a generic way to set, add, or remove values in the search logic.
Unlike Search API parameters, the sle upward compatibility is not guaranteed. Any change made to the search logic during product upgrade may affect the sle.
Add an sle
It is possible to add one or more sle to the search URL with the following query parameters:
• set:[path]=[new value] - where path identifies the object field or list element to be replaced by the new value. The previous value is deleted.
Example: The following example set the performMAX Boolean of the query prefix handler named profiles to true
• add:[path]=[new list element] - where path identifies the list element before which the new value is inserted. The list element and any subsequent elements are shifted to the right.
Digits optionally preceded by a minus sign. For example, 314, -5
double
Floating point value. For example, 3.14, -.5, 1.23E9
string
Sequence of characters between double quotes. Double quotes have to be escaped with \". For example, "abc", "say \"hello\""
list
Sequence of values separated by commas, between brackets. For example, [1, 42, 5], ["a","c"]
object
Serialization of a new object. For example, SortBy(name="myobject",expr="title",limit=100,order="asc")
Note:
• values "5" and 5 are not equivalent. The first is a string whereas the second is an integer.
• values "" and null are not equivalent. The first is an empty string whereas the second is a null value.
sle Path
The *path* is an element sequence that identifies either an object field or a list element.
The XML representation of the search logic is not representative. There may be missing nodes or case discrepancy.
The path must be built using the javadoc sdk/java-customcode/docs/api/com/exalead/mercury/mami/search/v20/SearchLogic.html.
Parameter
Description
hitConfig.meta[name="title"]
Stands for the first element with name equal to "title" in the meta list of the hitConfig object in the Search Logic.
virtualFieldDefinition[0]
Stands for the first element of the virtualFieldDefinition list in the Search Logic.
Object serialization
The *object serialization* is made of two parts: [class](key=value, ...)
• The java class identifier can either be the full qualified name of a java class using . as package separator and '$' for inner classes. For convenience, the simple class name is accepted, and the full name is deduced from the path.
For example, com.exalead.search.v30.VirtualFieldDefinition or VirtualFieldDefinition
• The initializers is a comma-separated sequence of assignment.
For example, SnippetOperation(highlightFacetIds="Event,Person",highlightExtraPrefixHandlers="soundslike,spellslike", maxSentenceSegmentLength=210,maxLength=500)