Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Fetches the queries that are suggested to your users.
GetQuerySuggestions
is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
Synopsis
- data GetQuerySuggestions = GetQuerySuggestions' {}
- newGetQuerySuggestions :: Text -> Text -> GetQuerySuggestions
- getQuerySuggestions_maxSuggestionsCount :: Lens' GetQuerySuggestions (Maybe Int)
- getQuerySuggestions_indexId :: Lens' GetQuerySuggestions Text
- getQuerySuggestions_queryText :: Lens' GetQuerySuggestions Text
- data GetQuerySuggestionsResponse = GetQuerySuggestionsResponse' {}
- newGetQuerySuggestionsResponse :: Int -> GetQuerySuggestionsResponse
- getQuerySuggestionsResponse_querySuggestionsId :: Lens' GetQuerySuggestionsResponse (Maybe Text)
- getQuerySuggestionsResponse_suggestions :: Lens' GetQuerySuggestionsResponse (Maybe [Suggestion])
- getQuerySuggestionsResponse_httpStatus :: Lens' GetQuerySuggestionsResponse Int
Creating a Request
data GetQuerySuggestions Source #
See: newGetQuerySuggestions
smart constructor.
GetQuerySuggestions' | |
|
Instances
newGetQuerySuggestions Source #
:: Text | |
-> Text | |
-> GetQuerySuggestions |
Create a value of GetQuerySuggestions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxSuggestionsCount:GetQuerySuggestions'
, getQuerySuggestions_maxSuggestionsCount
- The maximum number of query suggestions you want to show to your users.
$sel:indexId:GetQuerySuggestions'
, getQuerySuggestions_indexId
- The identifier of the index you want to get query suggestions from.
$sel:queryText:GetQuerySuggestions'
, getQuerySuggestions_queryText
- 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.
Request Lenses
getQuerySuggestions_maxSuggestionsCount :: Lens' GetQuerySuggestions (Maybe Int) Source #
The maximum number of query suggestions you want to show to your users.
getQuerySuggestions_indexId :: Lens' GetQuerySuggestions Text Source #
The identifier of the index you want to get query suggestions from.
getQuerySuggestions_queryText :: Lens' GetQuerySuggestions Text Source #
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.
Destructuring the Response
data GetQuerySuggestionsResponse Source #
See: newGetQuerySuggestionsResponse
smart constructor.
GetQuerySuggestionsResponse' | |
|
Instances
newGetQuerySuggestionsResponse Source #
Create a value of GetQuerySuggestionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:querySuggestionsId:GetQuerySuggestionsResponse'
, getQuerySuggestionsResponse_querySuggestionsId
- The identifier for a list of query suggestions for an index.
$sel:suggestions:GetQuerySuggestionsResponse'
, getQuerySuggestionsResponse_suggestions
- A list of query suggestions for an index.
$sel:httpStatus:GetQuerySuggestionsResponse'
, getQuerySuggestionsResponse_httpStatus
- The response's http status code.
Response Lenses
getQuerySuggestionsResponse_querySuggestionsId :: Lens' GetQuerySuggestionsResponse (Maybe Text) Source #
The identifier for a list of query suggestions for an index.
getQuerySuggestionsResponse_suggestions :: Lens' GetQuerySuggestionsResponse (Maybe [Suggestion]) Source #
A list of query suggestions for an index.
getQuerySuggestionsResponse_httpStatus :: Lens' GetQuerySuggestionsResponse Int Source #
The response's http status code.