Module Values.HighlightSource

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

Sourcetype nonrec t = {
  1. beginOffset : Integer.t option;
    (*

    The zero-based location in the response string where the highlight starts.

    *)
  2. endOffset : Integer.t option;
    (*

    The zero-based location in the response string where the highlight ends.

    *)
  3. topAnswer : Boolean.t option;
    (*

    Indicates whether the response is the best response. True if this is the best response; otherwise, false.

    *)
  4. type_ : HighlightType.t option;
    (*

    The highlight type.

    *)
}
Sourceval make : ?beginOffset:??? -> ?endOffset:??? -> ?topAnswer:??? -> ?type_:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t