Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CaptionResult

Package version

Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'..

Hierarchy

  • CaptionResult

Indexable

[property: string]: any

Describes unknown properties. The value of an unknown property can be of "any" type.

Index

Properties

Properties

Optional highlights

highlights: undefined | string

Same text passage as in the Text property with highlighted phrases most relevant to the query. NOTE: This property will not be serialized. It can only be populated by the server.

Optional text

text: undefined | string

A representative text passage extracted from the document most relevant to the search query. NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc