Module Values.SuggestResponseSource

Suggest provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for further searching. The API provides options for filtering results by location and other attributes, and allows for additional features like phonemes and timezones. The response includes refined query terms and detailed place information. For more information, see Suggest in the Amazon Location Service Developer Guide.

Sourcetype nonrec t = {
  1. pricingBucket : String_.t option;
    (*

    The pricing bucket for which the query is charged at. For more information on pricing, please visit Amazon Location Service Pricing.

    *)
  2. resultItems : SuggestResultItemList.t option;
    (*

    List of places or results returned for a query.

    *)
  3. queryRefinements : QueryRefinementList.t option;
    (*

    Maximum number of query terms to be returned for use with a search text query. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ThrottlingException of ThrottlingException.t
  4. | `ValidationException of ValidationException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?pricingBucket:??? -> ?resultItems:??? -> ?queryRefinements:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `Integer of QueryRefinementStartIndexInteger.t | `String of SuggestResultItemTitleString.t | `Structure of (string * [> `Enum of string | `List of [> `Double of Double.t | `Structure of (string * [> `Boolean of SensitiveBoolean.t | `Integer of HighlightStartIndexInteger.t | `List of [> `Double of Double.t | `Structure of (string * [> `Boolean of SensitiveBoolean.t | `String of CategoryIdString.t ]) list ] list | `String of CategoryIdString.t ]) list ] list | `Long of DistanceMeters.t | `String of SuggestPlaceResultPlaceIdString.t | `Structure of (string * [> `List of [> `String of IntersectionStreet.t | `Structure of (string * [> `Boolean of SensitiveBoolean.t | `Enum of string | `Integer of HighlightStartIndexInteger.t | `String of StreetComponentsBaseNameString.t ]) list ] list | `Long of TimeZoneOffsetSecondsLong.t | `String of AddressLabelString.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Boolean of SensitiveBoolean.t | `String of PhonemeTranscriptionValueString.t ]) list ] list | `String of CountryCode2.t ]) list ]) list ]) list ]) list ] list | `String of String_.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