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

Amazonka.Wisdom.QueryAssistant

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

This operation returns paginated results.

Creating a Request

data QueryAssistant Source #

See: newQueryAssistant smart constructor.

Constructors

QueryAssistant'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per page.
nextToken :: Maybe Text
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
assistantId :: Text
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
queryText :: Sensitive Text
The text to search for.

Instances

Instances details

ToJSON QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods toJSON :: QueryAssistant -> Value # toEncoding :: QueryAssistant -> Encoding # toJSONList :: [QueryAssistant] -> Value # toEncodingList :: [QueryAssistant] -> Encoding #
ToHeaders QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods toHeaders :: QueryAssistant -> [Header] #
ToPath QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods toPath :: QueryAssistant -> ByteString #
ToQuery QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods toQuery :: QueryAssistant -> QueryString #
AWSPager QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods page :: QueryAssistant -> AWSResponse QueryAssistant -> Maybe QueryAssistant #
AWSRequest QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Associated Types type AWSResponse QueryAssistant # Methods request :: (Service -> Service) -> QueryAssistant -> Request QueryAssistant # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy QueryAssistant -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse QueryAssistant))) #
Generic QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Associated Types type Rep QueryAssistant :: Type -> Type # Methods from :: QueryAssistant -> Rep QueryAssistant x # to :: Rep QueryAssistant x -> QueryAssistant #
Show QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods showsPrec :: Int -> QueryAssistant -> ShowS # show :: QueryAssistant -> String # showList :: [QueryAssistant] -> ShowS #
NFData QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods rnf :: QueryAssistant -> () #
Eq QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods (==) :: QueryAssistant -> QueryAssistant -> Bool # (/=) :: QueryAssistant -> QueryAssistant -> Bool #
Hashable QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods hashWithSalt :: Int -> QueryAssistant -> Int # hash :: QueryAssistant -> Int #
type AWSResponse QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant type AWSResponse QueryAssistant = QueryAssistantResponse
type Rep QueryAssistant Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant type Rep QueryAssistant = D1 ('MetaData "QueryAssistant" "Amazonka.Wisdom.QueryAssistant" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "QueryAssistant'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "assistantId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "queryText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))

newQueryAssistant Source #

Arguments

:: Text	`QueryAssistant`
-> Text	`$sel:queryText:QueryAssistant'`
-> QueryAssistant

Create a value of QueryAssistant 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:maxResults:QueryAssistant', queryAssistant_maxResults - The maximum number of results to return per page.

QueryAssistant, queryAssistant_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

QueryAssistant, queryAssistant_assistantId - The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

$sel:queryText:QueryAssistant', queryAssistant_queryText - The text to search for.

Request Lenses

queryAssistant_maxResults :: Lens' QueryAssistant (Maybe Natural) Source #

The maximum number of results to return per page.

queryAssistant_nextToken :: Lens' QueryAssistant (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

queryAssistant_assistantId :: Lens' QueryAssistant Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

queryAssistant_queryText :: Lens' QueryAssistant Text Source #

The text to search for.

Destructuring the Response

data QueryAssistantResponse Source #

See: newQueryAssistantResponse smart constructor.

Constructors

QueryAssistantResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. httpStatus :: Int The response's http status code. results :: [ResultData] The results of the query.

Instances

Instances details

Generic QueryAssistantResponse Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Associated Types type Rep QueryAssistantResponse :: Type -> Type # Methods from :: QueryAssistantResponse -> Rep QueryAssistantResponse x # to :: Rep QueryAssistantResponse x -> QueryAssistantResponse #
Show QueryAssistantResponse Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods showsPrec :: Int -> QueryAssistantResponse -> ShowS # show :: QueryAssistantResponse -> String # showList :: [QueryAssistantResponse] -> ShowS #
NFData QueryAssistantResponse Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods rnf :: QueryAssistantResponse -> () #
Eq QueryAssistantResponse Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant Methods (==) :: QueryAssistantResponse -> QueryAssistantResponse -> Bool # (/=) :: QueryAssistantResponse -> QueryAssistantResponse -> Bool #
type Rep QueryAssistantResponse Source #
Instance details Defined in Amazonka.Wisdom.QueryAssistant type Rep QueryAssistantResponse = D1 ('MetaData "QueryAssistantResponse" "Amazonka.Wisdom.QueryAssistant" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "QueryAssistantResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ResultData]))))

newQueryAssistantResponse Source #

Arguments

:: Int	`$sel:httpStatus:QueryAssistantResponse'`
-> QueryAssistantResponse

Create a value of QueryAssistantResponse 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:

QueryAssistant, queryAssistantResponse_nextToken - If there are additional results, this is the token for the next set of results.

$sel:httpStatus:QueryAssistantResponse', queryAssistantResponse_httpStatus - The response's http status code.

$sel:results:QueryAssistantResponse', queryAssistantResponse_results - The results of the query.

Response Lenses

queryAssistantResponse_nextToken :: Lens' QueryAssistantResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

queryAssistantResponse_httpStatus :: Lens' QueryAssistantResponse Int Source #

The response's http status code.

queryAssistantResponse_results :: Lens' QueryAssistantResponse [ResultData] Source #

The results of the query.