All Products
Search
Document Center

OpenSearch:Summary

Last Updated:Apr 01, 2026

The configuration of a search result summary for a version of an OpenSearch application.

Example

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

Structure

FieldTypeDescription
nameStringThe name of the search result summary. The only valid value is default.
meta[]ObjectThe settings of the search result summary. For more information, see meta.
activeBooleanIndicates whether the search result summary is the default one.

meta

FieldTypeDescription
fieldStringThe field for which the search result summary is configured.
lenIntegerThe length of the search result summary. Valid values: 1 to 300.
elementStringThe HTML tag used to highlight matched terms in red.
ellipsisStringThe connector used to join summary segments.
snippetIntegerThe number of segments to include in the search result summary. Valid values: 1 to 5.