Inner Hits Field

The Inner Hits Field is used for nested field matches in Elasticsearch or OpenSearch, this field allows you to display the hit with its corresponding inner hits.

Schema Details

Property	Type	Description	Required	Default	Enum
type	string	The type of field.	No	inner_hits	inner_hits
label	string/null	Label to show for this field.	No	null
css_style	object/null	Style to apply in the HTML of the UI.	No	null
css_class	string/null	CSS class to apply in the HTML component.	No	null
translate	string/null	Translation key for the field.	No	null
translate_label	string/null	Translation key for the label.	No	null
analytics	object/null	Analytics configuration.	No	null
if_not_exist	string/null	Show only if the specified field doesn't exist.	No	null
if_exist	string/null	Show only if the specified field does exist.	No	null
only_on_highlight	boolean	Show only when the value is highlighted.	No	false
display	array/any/null	Value from the field.	No	null
field	string	Name of the inner_hits.	Yes
field_highlight	string/null	Path to highlight field from which to retrieve the value, in case it is not the same as the field parameter (in JMESPath format).	No	null
default	any	Default value to use in case no value was found for the field.	No	null
transform	array/string/null	List of transformations to apply to the displayed values.	No	null
suffix	string/null	Suffix to append to the value or values.	No	null
prefix	string/null	Prefix to append to the value or values.	No	null
suffix_label	string/null	Suffix to append to the label of the field.	No	null
prefix_label	string/null	Prefix to append to the label of the field.	No	null
sort	string/boolean	Sort order for values in an array.	No	false	asc, desc
unique	boolean	If the values are in an array, remove the duplicates.	No	false
show_blank	boolean	If there is no value, or value is null, and show_blank is true, keep the field.	No	false
replacement	string/null	Replacement string for matches in the transformations `Transformation.REPLACE_FIRST`, `Transformation.REPLACE_LAST`, and `Transformation.REPLACE_ALL`.	No	null
pattern	string/null	Pattern used to look for matches in the transformations `Transformation.REPLACE_FIRST`, `Transformation.REPLACE_LAST`, and `Transformation.REPLACE_ALL`.	No	null
body_grid	array/array/null	Body defined as a grid (list of lists).	No	null
body_list	array/object/null	Body defined as a single list.	No	null

Example JSON Representation

{
  "type": "inner_hits",
  "label": "Related Items",
  "display": ,
  "field": "related_items",
  "field_highlight": null,
  "default": null,
  "transform": null,
  "suffix": null,
  "prefix": null,
  "suffix_label": null,
  "prefix_label": null,
  "sort": false,
  "unique": false,
  "show_blank": false,
  "replacement": null,
  "pattern": null,
  "body_grid": [
	{
	  "type": "text",
	  "label": "Name",
	  "display": "Will",
	  "field": "name"
	},
	{
	  "type": "text",
	  "label": "Name",
	  "display": "Grace",
	  "field": "name"
	},
],
  "body_list": null
}

Code Example of Usage

inner_hits_field_example = InnerHits(field='field', 
	body_grid=[
		[TextField(...), UrlField(...), BoolField(...)],
		[TextField(...), BoolField],
		.
		.
		.
	],
)


or

inner_hits_field_example = InnerHits(field='field', body_list=[TextField(...), UrlField(...), BoolField(...), ...])

Space shortcuts

Page tree

Schema Details

Example JSON Representation

Code Example of Usage