Module
Method Summary
| Returns | Name | Description |
|---|---|---|
String | _type() | The type of ejs object. For internal use only. |
Object | explain(trueFalse) | Enable/Disable explanation of score for each hit. |
Object | fieldDataFields(Fields) | Allows to return the field data representation of a field for each hit. |
Object | from(from) | The offset from where the first hit to fetch in the returned regular search hits. |
Object | highlight(h) | Performs highlighting based on the |
Object | name(name) | The name to be used for the particular inner hit definition in the response. Useful when multiple inner hits have been defined in a single search request. The default depends in which query the inner hit is defined. For has_child query and filter this is the child type, has_parent query and filter this is the parent type and the nested query and filter this is the nested path.. |
Object | scriptField(oScriptField) | Computes a document property dynamically based on the supplied |
Object | size(size) | The maximum number of hits to return. By default the top three matching hits are returned. |
Object | sort(sort) | How the inner hits should be sorted. By default the hits are sorted by the score. |
Object | source(includes,excludes) | Allows to control how the _source field is returned with every hit. By default operations return the contents of the _source field unless you have used the fields parameter or if the _source field is disabled. Set the includes parameter to false to completely disable returning the source field. |
String | toJSON() | Retrieves the internal script object. This is typically used by
internal API functions so use with caution. |
Object | version(trueFalse) | Enable/Disable returning version number for each hit. |
Method Detail
explain
Object explain ( trueFalse )
Enable/Disable explanation of score for each hit.
|
fieldDataFields
Object fieldDataFields ( Fields )
Allows to return the field data representation of a field for each hit.
|
from
Object from ( from )
The offset from where the first hit to fetch in the returned regular search hits.
|
highlight
Object highlight ( h )
Performs highlighting based on the
|
name
Object name ( name )
The name to be used for the particular inner hit definition in the response. Useful when multiple inner hits have been defined in a single search request. The default depends in which query the inner hit is defined. For has_child query and filter this is the child type, has_parent query and filter this is the parent type and the nested query and filter this is the nested path..
|
scriptField
Object scriptField ( oScriptField )
Computes a document property dynamically based on the supplied
|
size
Object size ( size )
The maximum number of hits to return. By default the top three matching hits are returned.
|
sort
Object sort ( sort )
How the inner hits should be sorted. By default the hits are sorted by the score.
|
source
Object source ( includes, excludes )
Allows to control how the _source field is returned with every hit. By default operations return the contents of the _source field unless you have used the fields parameter or if the _source field is disabled. Set the includes parameter to false to completely disable returning the source field.
|
toJSON
String toJSON ( )
Retrieves the internal script object. This is typically used by
internal API functions so use with caution.
|
version
Object version ( trueFalse )
Enable/Disable returning version number for each hit.
|