textboxtally

Documentation

Index

• type Entity
• type Keyword
• type Tally
  • func New() *Tally
  • func (t *Tally) Add(analysis *textbox.Analysis)
  • func (t *Tally) AllEntities() map[string][]Entity
  • func (t *Tally) AllKeywords() []Keyword
  • func (t *Tally) Count() int
  • func (t *Tally) SentimentAverage() float64
  • func (t *Tally) TopEntities() map[string][]Entity
  • func (t *Tally) TopKeywords() []Keyword

Types

type Entity

type Entity struct {
	Text  string `json:"text"`
	Count int    `json:"count"`
}

Entity represents a single entity.

type Keyword

type Keyword struct {
	Keyword string `json:"keyword"`
	Count   int    `json:"count"`
}

Keyword represents a keyword with frequency.

type Tally

type Tally struct {
	// contains filtered or unexported fields
}

Tally keeps a summary of textbox.Analysis objects.

func New

func New() *Tally

New makes a new Tally.

func (*Tally) Add

func (t *Tally) Add(analysis *textbox.Analysis)

Add adds the textbox.Analysis to this tally.

func (*Tally) AllEntities

func (t *Tally) AllEntities() map[string][]Entity

AllEntities gets all entities mapped by their type.

func (*Tally) AllKeywords

func (t *Tally) AllKeywords() []Keyword

AllKeywords gets an unordered list of keywords.

May be sorted with:

sort.SliceStable(keywords, func(i, j int) bool {
	return keywords[j].Count < keywords[i].Count
})

func (*Tally) Count

func (t *Tally) Count() int

Count gets the number of textbox.Analysis objects that have been included.

func (*Tally) SentimentAverage

func (t *Tally) SentimentAverage() float64

SentimentAverage is the average sentiment of all sentences seen so far.

func (*Tally) TopEntities

func (t *Tally) TopEntities() map[string][]Entity

TopEntities gets the top ten entities sorted by most frequent, mapped on their type.

func (*Tally) TopKeywords

func (t *Tally) TopKeywords() []Keyword

TopKeywords gets the top ten keywords sorted by most frequent.