DescribeQuerySuggestionsConfigResponse (u.bd1fbe2ccff02fd1cddfdcb5f1e38e71.awso.0.9.1.doc.awso.kendra.Awso_kendra.Values.DescribeQuerySuggestionsConfigResponse)

Sourcetype nonrec t = {

mode : Mode.t option;
(*
Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode. By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.
*)
status : QuerySuggestionsStatus.t option;
(*
Whether the status of query suggestions settings is currently ACTIVE or UPDATING. Active means the current settings apply and Updating means your changed settings are in the process of applying.
*)
queryLogLookBackWindowInDays : Integer.t option;
(*
How recent your queries are in your query log time window (in days).
*)
includeQueriesWithoutUserInformation : ObjectBoolean.t option;
(*
TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.
*)
minimumNumberOfQueryingUsers : MinimumNumberOfQueryingUsers.t option;
(*
The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
*)
minimumQueryCount : MinimumQueryCount.t option;
(*
The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
*)
lastSuggestionsBuildTime : Timestamp.t option;
(*
The Unix timestamp when query suggestions for an index was last updated. Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.
*)
lastClearTime : Timestamp.t option;
(*
The Unix timestamp when query suggestions for an index was last cleared. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.
*)
totalSuggestionsCount : Integer.t option;
(*
The current total count of query suggestions for an index. This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from. If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.
*)
attributeSuggestionsConfig : AttributeSuggestionsDescribeConfig.t option;
(*
Configuration information for the document fields/attributes that you want to base query suggestions on.
*)

}

Sourcetype nonrec error = [

| `AccessDeniedException of AccessDeniedException.t
| `InternalServerException of InternalServerException.t
| `ResourceNotFoundException of ResourceNotFoundException.t
| `ThrottlingException of ThrottlingException.t
| `ValidationException of ValidationException.t
| `Unknown_operation_error of string * string option

]

val make : 
  ?mode:??? ->
  ?status:??? ->
  ?queryLogLookBackWindowInDays:??? ->
  ?includeQueriesWithoutUserInformation:??? ->
  ?minimumNumberOfQueryingUsers:??? ->
  ?minimumQueryCount:??? ->
  ?lastSuggestionsBuildTime:??? ->
  ?lastClearTime:??? ->
  ?totalSuggestionsCount:??? ->
  ?attributeSuggestionsConfig:??? ->
  unit ->
  t

Source

val error_of_json : 
  string ->
  Yojson.Safe.t ->
  [> `AccessDeniedException of AccessDeniedException.t
  | `InternalServerException of InternalServerException.t
  | `ResourceNotFoundException of ResourceNotFoundException.t
  | `ThrottlingException of ThrottlingException.t
  | `Unknown_operation_error of string * string option
  | `ValidationException of ValidationException.t ]

Source

val error_of_xml : 
  string ->
  Awso.Xml.t ->
  [> `AccessDeniedException of AccessDeniedException.t
  | `InternalServerException of InternalServerException.t
  | `ResourceNotFoundException of ResourceNotFoundException.t
  | `ThrottlingException of ThrottlingException.t
  | `Unknown_operation_error of string * string option
  | `ValidationException of ValidationException.t ]

Sourceval error_to_json : error -> Yojson.Safe.t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `Boolean of ObjectBoolean.t
          | `Enum of string
          | `Integer of Integer.t
          | `Structure of
            (string
             * [> `Enum of string
               | `List of
                 [> `Structure of
                      (string
                       * [> `Boolean of ObjectBoolean.t
                         | `String of DocumentAttributeKey.t ])
                        list ]
                   list ])
              list
          | `Timestamp of Timestamp.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