Share via


SearchHighlightsOutput interface

A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.

Properties

description

Description

entityType

Entity type

id

Id

name

Name

qualifiedName

Qualified name

Property Details

description

Description

description?: string[]

Property Value

string[]

entityType

Entity type

entityType?: string[]

Property Value

string[]

id

Id

id?: string[]

Property Value

string[]

name

Name

name?: string[]

Property Value

string[]

qualifiedName

Qualified name

qualifiedName?: string[]

Property Value

string[]