keyword_extraction 1.5.0

Collection of algorithms for keyword extraction from text
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

// Copyright (C) 2023 Afonso Barracha
//
// Rust Keyword Extraction is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Rust Keyword Extraction is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Rust Keyword Extraction. If not, see <http://www.gnu.org/licenses/>.

use std::collections::HashMap;

mod rake_logic;
pub mod rake_params;
use rake_logic::RakeLogic;
pub use rake_params::RakeParams;

use crate::common::{get_ranked_scores, get_ranked_strings};

pub struct Rake {
    word_scores: HashMap<String, f32>,
    phrase_scores: HashMap<String, f32>,
}

impl Rake {
    /// Create a new Rake instance.
    pub fn new(params: RakeParams) -> Self {
        let (text, stopwords, punctuation, phrase_len) = params.get_rake_params();
        let (word_scores, phrase_scores) =
            RakeLogic::build_rake(text, stopwords, punctuation, phrase_len);

        Self {
            phrase_scores,
            word_scores,
        }
    }

    /// Gets the top n words with the highest score.
    pub fn get_ranked_keyword(&self, n: usize) -> Vec<String> {
        get_ranked_strings(&self.word_scores, n)
    }

    /// Gets the top n words with the highest score and their score.
    pub fn get_ranked_keyword_scores(&self, n: usize) -> Vec<(String, f32)> {
        get_ranked_scores(&self.word_scores, n)
    }

    /// Gets the top n phrases with the highest score.
    pub fn get_ranked_phrases(&self, n: usize) -> Vec<String> {
        get_ranked_strings(&self.phrase_scores, n)
    }

    /// Gets the top n phrases with the highest score and their scores.
    pub fn get_ranked_phrases_scores(&self, n: usize) -> Vec<(String, f32)> {
        get_ranked_scores(&self.phrase_scores, n)
    }

    /// Gets the score of a word.
    pub fn get_keyword_score(&self, word: &str) -> f32 {
        *self.word_scores.get(word).unwrap_or(&0.0)
    }

    /// Gets the score of a phrase.
    pub fn get_phrase_score(&self, phrase: &str) -> f32 {
        *self.phrase_scores.get(phrase).unwrap_or(&0.0)
    }

    /// Gets the base hashmap of words and their score.
    pub fn get_word_scores_map(&self) -> &HashMap<String, f32> {
        &self.word_scores
    }

    /// Gets the base hashmap of phrases and their score.
    pub fn get_phrase_scores_map(&self) -> &HashMap<String, f32> {
        &self.phrase_scores
    }
}