All Products
Search
Document Center

Summary

Last Updated: Sep 09, 2021

Description

The information about a search result summary that is configured for a version of an OpenSearch application.

Example

{
    "name": "default",
    "meta": [{
        "field": "title",
        "len": 50,
        "element": "em",
        "ellipsis": "...",
        "snippet": 1
    }],
  "active": true
}

Structure

Field

Type

Description

name

String

The name of the search result summary. The value can only be default.

meta[]

Object

The settings of a search result summary. For more information, see meta.

active

Boolean

Indicates whether the search result summary is the default one.

meta

Field

Type

Description

field

String

The field for which the search result summary is configured.

len

Integer

The length of the search result summary. Valid values: [1,300].

element

String

The HTML tag that is used to highlight terms in red.

ellipsis

String

The connector that is used to connect segments.

snippet

Integer

The number of segments that are required in a search result summary. Valid values: [1,5].