Module Values.CollapseConfigurationSource

Specifies how to group results by document attribute value, and how to display them collapsed/expanded under a designated primary document for each group.

Sourcetype nonrec t = {
  1. documentAttributeKey : DocumentAttributeKey.t;
    (*

    The document attribute used to group search results. You can use any attribute that has the Sortable flag set to true. You can also sort by any of the following built-in attributes:"_category","_created_at", "_last_updated_at", "_version", "_view_count".

    *)
  2. sortingConfigurations : SortingConfigurationList.t option;
    (*

    A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.

    *)
  3. missingAttributeKeyStrategy : MissingAttributeKeyStrategy.t option;
    (*

    Specifies the behavior for documents without a value for the collapse attribute. Amazon Kendra offers three customization options: Choose to COLLAPSE all documents with null or missing values in one group. This is the default configuration. Choose to IGNORE documents with null or missing values. Ignored documents will not appear in query results. Choose to EXPAND each document with a null or missing value into a group of its own.

    *)
  4. expand : Boolean.t option;
    (*

    Specifies whether to expand the collapsed results.

    *)
  5. expandConfiguration : ExpandConfiguration.t option;
    (*

    Provides configuration information to customize expansion options for a collapsed group.

    *)
}
Sourceval context_ : string
Sourceval make : ?sortingConfigurations:??? -> ?missingAttributeKeyStrategy:??? -> ?expand:??? -> ?expandConfiguration:??? -> documentAttributeKey:DocumentAttributeKey.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of DocumentAttributeKey.t ]) list ] list | `String of DocumentAttributeKey.t | `Structure of (string * [> `Integer of Integer.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