Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchResult

SearchResult.

Hierarchy

  • SearchResult

Index

Properties

Optional answers

An array specifying segments of text within the result that were identified as direct answers to the search query. Currently, only the single answer with the highest confidence (if any) is returned.

Note: This property uses the answer finding beta feature, and is available only if the search skill is connected to a Discovery v2 service instance.

Optional body

body: string

A description of the search result. This is taken from an abstract, summary, or highlight field in the Discovery service response, as specified in the search skill configuration.

Optional highlight

An object containing segments of text from search results with query-matching text highlighted using HTML <em> tags.

id

id: string

The unique identifier of the document in the Discovery service collection.

This property is included in responses from search skills, which are available only to Plus or Enterprise plan users.

result_metadata

result_metadata: SearchResultMetadata

An object containing search result metadata from the Discovery service.

Optional title

title: string

The title of the search result. This is taken from a title or name field in the Discovery service response, as specified in the search skill configuration.

Optional url

url: string

The URL of the original data object in its native data source.

Generated using TypeDoc