Module Values.ExpandedResultItemSource

A single expanded result in a collapsed group of search results. An expanded result item contains information about an expanded result document within a collapsed group of search results. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

Sourcetype nonrec t = {
  1. id : ResultId.t option;
    (*

    The identifier for the expanded result.

    *)
  2. documentId : DocumentId.t option;
    (*

    The idenitifier of the document.

    *)
  3. documentTitle : TextWithHighlights.t option;
  4. documentExcerpt : TextWithHighlights.t option;
  5. documentURI : Url.t option;
    (*

    The URI of the original location of the document.

    *)
  6. documentAttributes : DocumentAttributeList.t option;
    (*

    An array of document attributes assigned to a document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.

    *)
}
Sourceval make : ?id:??? -> ?documentId:??? -> ?documentTitle:??? -> ?documentExcerpt:??? -> ?documentURI:??? -> ?documentAttributes:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of DocumentAttributeKey.t | `Structure of (string * [> `List of [> `String of String_.t ] list | `Long of Long.t | `String of DocumentAttributeStringValue.t | `Timestamp of Timestamp.t ]) list ]) list ] list | `String of ResultId.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t ]) list ] list | `String of String_.t ]) list ]) 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