f535e7e · typeable/bloodhound

git.iko.soy/typeable/bloodhound

Add support for 'Phrase Suggester' (V5)

Adds the ability to attach a 'suggester' to a query. A few notes: * This commit is only V5. I hope to port it to V1 as well. * Only one suggestion request / response is supported per-query. * Suggestions are only supported on the '_search' endpoint (not the '_suggest' endpoint.

commitf535e7e99d5e43fab4e10085ca2a0447616b187d authorJosh Berman <berman.josh@gmail.com> dateWed 19 Apr 2017, 20:21 (9 years ago) parenta6d1114

3 files changed+94−13

compare with master

unifiedsplit

src/Database/V5/Bloodhound/Client.hs+3−3 src/Database/V5/Bloodhound/Types.hs+75−10 tests/V5/tests.hs+16

src/Database/V5/Bloodhound/Client.hs+3−3

@@ -1044,7 +1044,7 @@ scanSearch indexName mappingName search = do

10441044-- >>> mkSearch (Just query) Nothing

10451045-- Search {queryBody = Just (TermQuery (Term {termField = "user", termValue = "bitemyapp"}) Nothing), filterBody = Nothing, sortBody = Nothing, aggBody = Nothing, highlight = Nothing, trackSortScores = False, from = From 0, size = Size 10, searchType = SearchTypeQueryThenFetch, fields = Nothing, source = Nothing}

10461046mkSearch :: Maybe Query -> Maybe Filter -> Search

1047−mkSearch query filter = Search query filter Nothing Nothing Nothing False (From 0) (Size 10) SearchTypeQueryThenFetch Nothing Nothing

1047+mkSearch query filter = Search query filter Nothing Nothing Nothing False (From 0) (Size 10) SearchTypeQueryThenFetch Nothing Nothing Nothing

10481048

10491049-- | 'mkAggregateSearch' is a helper function that defaults everything in a 'Search' except for

10501050-- the 'Query' and the 'Aggregation'.

@@ -1054,7 +1054,7 @@ mkSearch query filter = Search query filter Nothing Nothing Nothing False (From

10541054-- TermsAgg (TermsAggregation {term = Left "user", termInclude = Nothing, termExclude = Nothing, termOrder = Nothing, termMinDocCount = Nothing, termSize = Nothing, termShardSize = Nothing, termCollectMode = Just BreadthFirst, termExecutionHint = Nothing, termAggs = Nothing})

10551055-- >>> let myAggregation = mkAggregateSearch Nothing $ mkAggregations "users" terms

10561056mkAggregateSearch :: Maybe Query -> Aggregations -> Search

1057−mkAggregateSearch query mkSearchAggs = Search query Nothing Nothing (Just mkSearchAggs) Nothing False (From 0) (Size 0) SearchTypeQueryThenFetch Nothing Nothing

1057+mkAggregateSearch query mkSearchAggs = Search query Nothing Nothing (Just mkSearchAggs) Nothing False (From 0) (Size 0) SearchTypeQueryThenFetch Nothing Nothing Nothing

10581058

10591059-- | 'mkHighlightSearch' is a helper function that defaults everything in a 'Search' except for

10601060-- the 'Query' and the 'Aggregation'.

@@ -1063,7 +1063,7 @@ mkAggregateSearch query mkSearchAggs = Search query Nothing Nothing (Just mkSear

10631063-- >>> let testHighlight = Highlights Nothing [FieldHighlight (FieldName "message") Nothing]

10641064-- >>> let search = mkHighlightSearch (Just query) testHighlight

10651065mkHighlightSearch :: Maybe Query -> Highlights -> Search

1066−mkHighlightSearch query searchHighlights = Search query Nothing Nothing Nothing (Just searchHighlights) False (From 0) (Size 10) SearchTypeQueryThenFetch Nothing Nothing

1066+mkHighlightSearch query searchHighlights = Search query Nothing Nothing Nothing (Just searchHighlights) False (From 0) (Size 10) SearchTypeQueryThenFetch Nothing Nothing Nothing

10671067

10681068-- | 'pageSearch' is a helper function that takes a search and assigns the from

10691069-- and size fields for the search. The from parameter defines the offset

src/Database/V5/Bloodhound/Types.hs+75−10

@@ -330,6 +330,10 @@ module Database.V5.Bloodhound.Types

330330 , PhraseSuggester(..)

331331 , PhraseSuggesterHighlighter(..)

332332 , PhraseSuggesterCollate(..)

333+ , mkPhraseSuggester

334+ , SuggestOptions(..)

335+ , SuggestResponse(..)

336+ , NamedSuggestionResponse(..)

333337

334338 , Aggregation(..)

335339 , Aggregations

@@ -1116,7 +1120,9 @@ data Search = Search { queryBody :: Maybe Query

11161120 , size :: Size

11171121 , searchType :: SearchType

11181122 , fields :: Maybe [FieldName]

1119− , source :: Maybe Source } deriving (Eq, Read, Show, Generic, Typeable)

1123+ , source :: Maybe Source

1124+ , suggestBody :: Maybe Suggest -- ^ Only one Suggestion request / response per Search is supported.

1125+ } deriving (Eq, Read, Show, Generic, Typeable)

11201126

11211127data SearchType = SearchTypeQueryThenFetch

11221128 | SearchTypeDfsQueryThenFetch

@@ -1663,13 +1669,17 @@ instance FromJSON TemplateQueryInline where

16631669 <$> o .: "inline"

16641670 <*> o .: "params"

16651671

1672+

16661673data SearchResult a =

16671674 SearchResult { took :: Int

16681675 , timedOut :: Bool

16691676 , shards :: ShardResult

16701677 , searchHits :: SearchHits a

16711678 , aggregations :: Maybe AggregationResults

1672− , scrollId :: Maybe ScrollId } deriving (Eq, Read, Show, Generic, Typeable)

1679+ , scrollId :: Maybe ScrollId

1680+ , suggest :: Maybe NamedSuggestionResponse -- ^ Only one Suggestion request / response per Search is supported.

1681+ }

1682+ deriving (Eq, Read, Show, Generic, Typeable)

16731683

16741684newtype ScrollId = ScrollId Text deriving (Eq, Read, Show, Generic, Ord, ToJSON, FromJSON)

16751685

@@ -3258,7 +3268,7 @@ instance FromJSON SearchAliasRouting where

32583268 where parse t = SearchAliasRouting <$> parseNEJSON (String <$> T.splitOn "," t)

32593269

32603270instance ToJSON Search where

3261− toJSON (Search mquery sFilter sort searchAggs highlight sTrackSortScores sFrom sSize _ sFields sSource) =

3271+ toJSON (Search mquery sFilter sort searchAggs highlight sTrackSortScores sFrom sSize _ sFields sSource sSuggest) =

32623272 omitNulls [ "query" .= query'

32633273 , "sort" .= sort

32643274 , "aggregations" .= searchAggs

@@ -3267,7 +3277,8 @@ instance ToJSON Search where

32673277 , "size" .= sSize

32683278 , "track_scores" .= sTrackSortScores

32693279 , "fields" .= sFields

3270− , "_source" .= sSource]

3280+ , "_source" .= sSource

3281+ , "suggest" .= sSuggest]

32713282

32723283 where query' = case sFilter of

32733284 Nothing -> mquery

@@ -3620,7 +3631,8 @@ instance (FromJSON a) => FromJSON (SearchResult a) where

36203631 v .: "_shards" <*>

36213632 v .: "hits" <*>

36223633 v .:? "aggregations" <*>

3623− v .:? "_scroll_id"

3634+ v .:? "_scroll_id" <*>

3635+ v .:? "suggest"

36243636 parseJSON _ = empty

36253637

36263638instance (FromJSON a) => FromJSON (SearchHits a) where

@@ -5106,7 +5118,7 @@ data Suggest = Suggest { suggestText :: Text

51065118 , suggestName :: Text

51075119 , suggestType :: SuggestType

51085120 }

5109− deriving (Show, Generic)

5121+ deriving (Show, Generic, Eq, Read)

51105122

51115123instance ToJSON Suggest where

51125124 toJSON Suggest{..} = object [ "text" .= suggestText

@@ -5125,7 +5137,7 @@ instance FromJSON Suggest where

51255137 parseJSON x = typeMismatch "Suggest" x

51265138

51275139data SuggestType = SuggestTypePhraseSuggester PhraseSuggester

5128− deriving (Show, Generic)

5140+ deriving (Show, Generic, Eq, Read)

51295141

51305142instance ToJSON SuggestType where

51315143 toJSON (SuggestTypePhraseSuggester x) = object ["phrase" .= x]

@@ -5149,7 +5161,7 @@ data PhraseSuggester =

51495161 , phraseSuggesterHighlight :: Maybe PhraseSuggesterHighlighter

51505162 , phraseSuggesterCollate :: Maybe PhraseSuggesterCollate

51515163 }

5152− deriving (Show, Generic)

5164+ deriving (Show, Generic, Eq, Read)

51535165

51545166instance ToJSON PhraseSuggester where

51555167 toJSON PhraseSuggester{..} = omitNulls [ "field" .= phraseSuggesterField

@@ -5180,11 +5192,16 @@ instance FromJSON PhraseSuggester where

51805192 <*> o .:? "highlight"

51815193 <*> o .:? "collate"

51825194

5195+mkPhraseSuggester :: FieldName -> PhraseSuggester

5196+mkPhraseSuggester fName =

5197+ PhraseSuggester fName Nothing Nothing Nothing Nothing Nothing Nothing

5198+ Nothing Nothing Nothing Nothing

5199+

51835200data PhraseSuggesterHighlighter =

51845201 PhraseSuggesterHighlighter { phraseSuggesterHighlighterPreTag :: Text

51855202 , phraseSuggesterHighlighterPostTag :: Text

51865203 }

5187− deriving (Show, Generic)

5204+ deriving (Show, Generic, Eq, Read)

51885205

51895206instance ToJSON PhraseSuggesterHighlighter where

51905207 toJSON PhraseSuggesterHighlighter{..} =

@@ -5202,7 +5219,7 @@ data PhraseSuggesterCollate =

52025219 PhraseSuggesterCollate { phraseSuggesterCollateTemplateQuery :: TemplateQueryInline

52035220 , phraseSuggesterCollatePrune :: Bool

52045221 }

5205− deriving (Show, Generic)

5222+ deriving (Show, Generic, Eq, Read)

52065223

52075224instance ToJSON PhraseSuggesterCollate where

52085225 toJSON PhraseSuggesterCollate{..} = object [ "query" .= object

@@ -5220,3 +5237,51 @@ instance FromJSON PhraseSuggesterCollate where

52205237 prune' <- o .:? "prune" .!= False

52215238 return $ PhraseSuggesterCollate (TemplateQueryInline inline' params') prune'

52225239 parseJSON x = typeMismatch "PhraseSuggesterCollate" x

5240+

5241+data SuggestOptions =

5242+ SuggestOptions { suggestOptionsText :: Text

5243+ , suggestOptionsScore :: Double

5244+ , suggestOptionsFreq :: Maybe Int

5245+ , suggestOptionsHighlighted :: Maybe Text

5246+ }

5247+ deriving (Eq, Read, Show)

5248+

5249+instance FromJSON SuggestOptions where

5250+ parseJSON = withObject "SuggestOptions" parse

5251+ where parse o = SuggestOptions

5252+ <$> o .: "text"

5253+ <*> o .: "score"

5254+ <*> o .:? "freq"

5255+ <*> o .:? "highlighted"

5256+

5257+data SuggestResponse =

5258+ SuggestResponse { suggestResponseText :: Text

5259+ , suggestResponseOffset :: Int

5260+ , suggestResponseLength :: Int

5261+ , suggestResponseOptions :: [SuggestOptions]

5262+ }

5263+ deriving (Eq, Read, Show)

5264+

5265+instance FromJSON SuggestResponse where

5266+ parseJSON = withObject "SuggestResponse" parse

5267+ where parse o = SuggestResponse

5268+ <$> o .: "text"

5269+ <*> o .: "offset"

5270+ <*> o .: "length"

5271+ <*> o .: "options"

5272+

5273+data NamedSuggestionResponse =

5274+ NamedSuggestionResponse { nsrName :: Text

5275+ , nsrResponses :: [SuggestResponse]

5276+ }

5277+ deriving (Eq, Read, Show)

5278+

5279+instance FromJSON NamedSuggestionResponse where

5280+ parseJSON (Object o) = do

5281+ suggestionName' <- case HM.toList o of

5282+ [(x, _)] -> return x

5283+ _ -> fail "error parsing NamedSuggestionResponse name"

5284+ suggestionResponses' <- o .: suggestionName'

5285+ return $ NamedSuggestionResponse suggestionName' suggestionResponses'

5286+

5287+ parseJSON x = typeMismatch "NamedSuggestionResponse" x

tests/V5/tests.hs+16

@@ -1144,6 +1144,7 @@ main = hspec $ do

11441144 let search = Search Nothing

11451145 Nothing (Just [sortSpec]) Nothing Nothing

11461146 False (From 0) (Size 10) SearchTypeQueryThenFetch Nothing Nothing

1147+ Nothing

11471148 result <- searchTweets search

11481149 let myTweet = grabFirst result

11491150 liftIO $

@@ -1582,6 +1583,21 @@ main = hspec $ do

15821583 resp <- forceMergeIndex (IndexList (testIndex :| [])) defaultForceMergeIndexSettings

15831584 liftIO $ validateStatus resp 200

15841585

1586+ describe "Suggest" $ do

1587+ it "returns a search suggestion using the phrase suggester" $ withTestEnv $ do

1588+ _ <- insertData

1589+ let query = QueryMatchNoneQuery

1590+ phraseSuggester = mkPhraseSuggester (FieldName "message")

1591+ namedSuggester = Suggest "Use haskel" "suggest_name" (SuggestTypePhraseSuggester phraseSuggester)

1592+ search' = mkSearch (Just query) Nothing

1593+ search = search' { suggestBody = Just namedSuggester }

1594+ expectedText = Just "use haskell"

1595+ resp <- searchByIndex testIndex search

1596+ parsed <- parseEsResponse resp :: BH IO (Either EsError (SearchResult Tweet))

1597+ case parsed of

1598+ Left e -> liftIO $ expectationFailure ("Expected an search suggestion but got " <> show e)

1599+ Right sr -> liftIO $ (suggestOptionsText . head . suggestResponseOptions . head . nsrResponses <$> suggest sr) `shouldBe` expectedText

1600+

15851601 describe "JSON instances" $ do

15861602 propJSON (Proxy :: Proxy Version)

15871603 propJSON (Proxy :: Proxy IndexName)