Merge pull request #33 from snipsco/release/0.7.0

Release 0.7.0

Author: adrienball

CHANGELOG.md

@@ -1,19 +1,25 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.7.0] - 2019-04-16
+### Added
+- Add API to prepend entity values [#31](https://github.com/snipsco/gazetteer-entity-parser/pull/31)
+- Add matched value in API output [#32](https://github.com/snipsco/gazetteer-entity-parser/pull/32)
+
 ## [0.6.0] - 2018-11-09
 ### Changed
-- Optimize memory usage
-- Simpler pattern for errors
+- Optimize memory usage [#27](https://github.com/snipsco/gazetteer-entity-parser/pull/27)
+- Simpler pattern for errors [#27](https://github.com/snipsco/gazetteer-entity-parser/pull/27)
 
 ## [0.5.1] - 2018-10-15
 ### Changed
-- Fix bug affecting the backward expansion of possible matches starting with stop words
+- Fix bug affecting the backward expansion of possible matches starting with stop words [#25](https://github.com/snipsco/gazetteer-entity-parser/pull/25)
 
 ## [0.5.0] - 2018-10-01
 ### Changed
 - Clearer `ParserBuilder`'s API 
 
+[0.7.0]: https://github.com/snipsco/gazetteer-entity-parser/compare/0.6.0...0.7.0
 [0.6.0]: https://github.com/snipsco/gazetteer-entity-parser/compare/0.5.1...0.6.0
 [0.5.1]: https://github.com/snipsco/gazetteer-entity-parser/compare/0.5.0...0.5.1
 [0.5.0]: https://github.com/snipsco/gazetteer-entity-parser/compare/0.4.2...0.5.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "gazetteer-entity-parser"
-version = "0.6.0"
+version = "0.7.0"
 authors = ["Alaa Saade <alaa.saade@snips.ai>"]
 
 [profile.bench]

README.rst

@@ -42,19 +42,21 @@ Example
             .build()
             .unwrap();
 
-        let sentence = "My favourite artists are the stones and the fab four";
+        let sentence = "My favourite artists are the stones and the amazing fab four";
         let extracted_entities = parser.run(sentence).unwrap();
         assert_eq!(extracted_entities,
                    vec![
                        ParsedValue {
                            raw_value: "the stones".to_string(),
+                           matched_value: "the rolling stones".to_string(),
                            resolved_value: "The Rolling Stones".to_string(),
                            range: 25..35,
                        },
                        ParsedValue {
-                           raw_value: "the fab four".to_string(),
+                           raw_value: "fab four".to_string(),
+                           matched_value: "the fab four".to_string(),
                            resolved_value: "The Beatles".to_string(),
-                           range: 40..52,
+                           range: 52..60,
                        }]);
     }
 

examples/entity_parsing_from_scratch.rs

@@ -28,18 +28,20 @@ fn main() {
         .build()
         .unwrap();
 
-    let sentence = "My favourite artists are the stones and the fab four";
+    let sentence = "My favourite artists are the stones and fab four";
     let extracted_entities = parser.run(sentence).unwrap();
     assert_eq!(extracted_entities,
                vec![
                    ParsedValue {
                        raw_value: "the stones".to_string(),
                        resolved_value: "The Rolling Stones".to_string(),
                        range: 25..35,
+                       matched_value: "the rolling stones".to_string()
                    },
                    ParsedValue {
-                       raw_value: "the fab four".to_string(),
+                       raw_value: "fab four".to_string(),
                        resolved_value: "The Beatles".to_string(),
-                       range: 40..52,
+                       range: 40..48,
+                       matched_value: "the fab four".to_string(),
                    }]);
 }

src/lib.rs

@@ -53,6 +53,7 @@
 //!     vec![ParsedValue {
 //!         raw_value: "the stones".to_string(),
 //!         resolved_value: "The Rolling Stones".to_string(),
+//!         matched_value: "the rolling stones".to_string(),
 //!         range: 20..30,
 //!     }]
 //! );
@@ -64,6 +65,7 @@
 //!     vec![ParsedValue {
 //!         raw_value: "brel".to_string(),
 //!         resolved_value: "Jacques Brel".to_string(),
+//!         matched_value: "jacques brel".to_string(),
 //!         range: 20..24,
 //!     }]
 //! );