Highlight#

class langchain_aws.retrievers.kendra.Highlight[source]#

Bases: BaseModel

Information that highlights the keywords in the excerpt.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

param BeginOffset: int [Required]#: The zero-based location in the excerpt where the highlight starts.

param EndOffset: int [Required]#: The zero-based location in the excerpt where the highlight ends.

param TopAnswer: bool | None = None#: Indicates whether the result is the best one.

param Type: str | None = None#: The highlight type: STANDARD or THESAURUS_SYNONYM.