Values.SuggestRequestSourceSuggest 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.
type nonrec t = {queryText : SuggestRequestQueryTextString.t;The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form. The fields QueryText and QueryID are mutually exclusive.
*)maxResults : SuggestRequestMaxResultsInteger.t option;An optional limit for the number of results returned in a single call. Default value: 20
*)maxQueryRefinements : SuggestRequestMaxQueryRefinementsInteger.t option;Maximum number of query terms to be returned for use with a search text query. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)biasPosition : Position.t option;The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WGS 84 format. The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.
*)filter : SuggestFilter.t option;A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
*)additionalFeatures : SuggestAdditionalFeatureList.t option;A list of optional additional parameters, such as time zone, that can be requested for each result. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the Core and TimeZone values.
*)language : LanguageTag.t option;A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the following codes: en, id, km, lo, ms, my, pt, th, tl, vi, zh
*)politicalView : CountryCode.t option;The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)intendedUse : SuggestIntendedUse.t option;Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Currently, Suggest does not support storage of results.
*)key : ApiKey.t option;Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
*)}val make :
?maxResults:??? ->
?maxQueryRefinements:??? ->
?biasPosition:??? ->
?filter:??? ->
?additionalFeatures:??? ->
?language:??? ->
?politicalView:??? ->
?intendedUse:??? ->
?key:??? ->
queryText:SuggestRequestQueryTextString.t ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `Integer of SuggestRequestMaxResultsInteger.t
| `List of [> `Double of Double.t | `Enum of string ] list
| `String of SuggestRequestQueryTextString.t
| `Structure of
(string
* [> `List of
[> `Double of Double.t | `String of CountryCode.t ] list
| `Structure of
(string
* [> `List of [> `Double of Double.t ] list
| `Long of FilterCircleRadiusLong.t ])
list ])
list ])
list ]