Module Values.GetQuerySuggestionsRequestSource

Fetches the queries that are suggested to your users. GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Sourcetype nonrec t = {
  1. indexId : IndexId.t;
    (*

    The identifier of the index you want to get query suggestions from.

    *)
  2. queryText : SuggestionQueryText.t;
    (*

    The text of a user's query to generate query suggestions. A query is suggested if the query prefix matches what a user starts to type as their query. Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

    *)
  3. maxSuggestionsCount : Integer.t option;
    (*

    The maximum number of query suggestions you want to show to your users.

    *)
  4. suggestionTypes : SuggestionTypes.t option;
    (*

    The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other. If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history. If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.

    *)
  5. attributeSuggestionsConfig : AttributeSuggestionsGetConfig.t option;
    (*

    Configuration information for the document fields/attributes that you want to base query suggestions on.

    *)
}
Sourceval context_ : string
Sourceval make : ?maxSuggestionsCount:??? -> ?suggestionTypes:??? -> ?attributeSuggestionsConfig:??? -> indexId:IndexId.t -> queryText:SuggestionQueryText.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of Integer.t | `List of [> `Enum of string ] list | `String of IndexId.t | `Structure of (string * Awso.Botodata.value) 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