Class: Spacy::Matcher

Inherits:

Object

• Object
• Spacy::Matcher

Defined in:

lib/ruby-spacy.rb

Overview

See also spaCy Python API document for Matcher.

Instance Attribute Summary

• #py_matcher ⇒ Object readonly

  A Python Matcher instance accessible via PyCall.

Instance Method Summary

• #add(text, pattern) ⇒ Object

  Adds a label string and a text pattern.

• #initialize(nlp) ⇒ Matcher constructor

  Creates a Matcher instance.

• #match(doc) ⇒ Array<Hash{:match_id => Integer, :start_index => Integer, :end_index => Integer}>

  Execute the match.

Constructor Details

#initialize(nlp) ⇒ Matcher

Creates a Spacy::Matcher instance

Parameters:

• nlp (Language) —

  an instance of Language class

# File 'lib/ruby-spacy.rb', line 682

def initialize(nlp)
  @py_matcher = PyMatcher.call(nlp.vocab)
end

Instance Attribute Details

#py_matcher ⇒ Object (readonly)

Returns a Python Matcher instance accessible via PyCall.

Returns:

• (Object) —

  a Python Matcher instance accessible via PyCall

# File 'lib/ruby-spacy.rb', line 678

def py_matcher
  @py_matcher
end

Instance Method Details

#add(text, pattern) ⇒ Object

Adds a label string and a text pattern.

Parameters:

• text (String) —

  a label string given to the pattern

• pattern (Array<Array<Hash>>) —

  sequences of text patterns that are alternative to each other

# File 'lib/ruby-spacy.rb', line 689

def add(text, pattern)
  @py_matcher.add(text, pattern)
end

#match(doc) ⇒ Array<Hash{:match_id => Integer, :start_index => Integer, :end_index => Integer}>

Execute the match.

Parameters:

• doc (Doc) —

  an Doc instance

Returns:

• (Array<Hash{:match_id => Integer, :start_index => Integer, :end_index => Integer}>) —

  the id of the matched pattern, the starting position, and the end position

# File 'lib/ruby-spacy.rb', line 696

def match(doc)
  PyCall::List.call(@py_matcher.call(doc.py_doc)).map do |py_match|
    { match_id: py_match[0].to_i, start_index: py_match[1].to_i, end_index: py_match[2].to_i - 1 }
  end
end