Class: Spacy::Span

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/ruby-spacy.rb

Overview

See also spaCy Python API document for [‘Span`](spacy.io/api/span).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(doc, py_span: nil, start_index: nil, end_index: nil, options: {}) ⇒ Span

It is recommended to use Doc#span method to create a span. If you need to create one using #initialize, there are two method signatures: ‘Span.new(doc, py_span: Object)` or `Span.new(doc, start_index: Integer, end_index: Integer, options: Hash)`.

Parameters:

  • doc (Doc) —

    the document to which this span belongs to

  • start_index (Integer) (defaults to: nil) —

    the index of the item starting the span inside a doc

  • end_index (Integer) (defaults to: nil) —

    the index of the item ending the span inside a doc

  • options (Hash) (defaults to: {}) —

    options (‘:label`, `:kb_id`, `:vector`)



521
522
523
524
 
# File 'lib/ruby-spacy.rb', line 521

def initialize(doc, py_span: nil, start_index: nil, end_index: nil, options: {})
  @doc = doc
  @py_span = py_span || @py_span = PySpan.call(@doc.py_doc, start_index, end_index + 1, options)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object

Methods defined in Python but not wrapped in ruby-spacy can be called by this dynamic method handling mechanism.



659
660
661
 
# File 'lib/ruby-spacy.rb', line 659

def method_missing(name, *args)
  @py_span.send(name, *args)
end

Instance Attribute Details

#doc ⇒ Doc (readonly)

Returns the document to which the span belongs.

Returns:

  • (Doc) —

    the document to which the span belongs



506
507
508
 
# File 'lib/ruby-spacy.rb', line 506

def doc
  @doc
end

#py_span ⇒ Object (readonly)

Returns a Python ‘Span` instance accessible via `PyCall`.

Returns:

  • (Object) —

    a Python ‘Span` instance accessible via `PyCall`



503
504
505
 
# File 'lib/ruby-spacy.rb', line 503

def py_span
  @py_span
end

Instance Method Details

#[](range) ⇒ Object

Returns a span if a range object is given or a token if an integer representing the position of the doc is given.

Parameters:

  • range (Range) —

    an ordinary Ruby’s range object such as ‘0..3`, `1…4`, or `3 .. -1`



590
591
592
593
594
595
596
597
 
# File 'lib/ruby-spacy.rb', line 590

def [](range)
  if range.is_a?(Range)
    py_span = @py_span[range]
    Span.new(@doc, start_index: py_span.start, end_index: py_span.end - 1)
  else
    Token.new(@py_span[range])
  end
end

#as_doc ⇒ Doc

Creates a document instance from the span

Returns:



608
609
610
 
# File 'lib/ruby-spacy.rb', line 608

def as_doc
  Doc.new(@doc.py_nlp, text: text)
end

#conjuncts ⇒ Array<Token>

Returns tokens conjugated to the root of the span.

Returns:

  • (Array<Token>) —

    an array of tokens



614
615
616
617
618
619
620
 
# File 'lib/ruby-spacy.rb', line 614

def conjuncts
  conjunct_array = []
  PyCall::List.call(@py_span.conjuncts).each do |py_conjunct|
    conjunct_array << Token.new(py_conjunct)
  end
  conjunct_array
end

#each ⇒ Object

Iterates over the elements in the span yielding a token instance each time.



537
538
539
540
541
 
# File 'lib/ruby-spacy.rb', line 537

def each
  PyCall::List.call(@py_span).each do |py_token|
    yield Token.new(py_token)
  end
end

#ents ⇒ Array<Span>

Returns an array of spans that represents named entities.

Returns:



573
574
575
576
577
578
579
 
# File 'lib/ruby-spacy.rb', line 573

def ents
  ent_array = []
  PyCall::List.call(@py_span.ents).each do |py_span|
    ent_array << Span.new(@doc, py_span: py_span)
  end
  ent_array
end

#label ⇒ String

Returns the label

Returns:

  • (String) 


654
655
656
 
# File 'lib/ruby-spacy.rb', line 654

def label
  @py_span.label_
end

#lefts ⇒ Array<Token>

Returns tokens that are to the left of the span, whose heads are within the span.

Returns:

  • (Array<Token>) —

    an array of tokens



624
625
626
627
628
629
630
 
# File 'lib/ruby-spacy.rb', line 624

def lefts
  left_array = []
  PyCall::List.call(@py_span.lefts).each do |py_left|
    left_array << Token.new(py_left)
  end
  left_array
end

#noun_chunks ⇒ Array<Span>

Returns an array of spans of noun chunks.

Returns:



545
546
547
548
549
550
551
552
 
# File 'lib/ruby-spacy.rb', line 545

def noun_chunks
  chunk_array = []
  py_chunks = PyCall::List.call(@py_span.noun_chunks)
  py_chunks.each do |py_span|
    chunk_array << Span.new(@doc, py_span: py_span)
  end
  chunk_array
end

#respond_to_missing?(sym) ⇒ Boolean

Returns:

  • (Boolean) 


663
664
665
 
# File 'lib/ruby-spacy.rb', line 663

def respond_to_missing?(sym)
  sym ? true : super
end

#rights ⇒ Array<Token>

Returns Tokens that are to the right of the span, whose heads are within the span.

Returns:

  • (Array<Token>) —

    an array of Tokens



634
635
636
637
638
639
640
 
# File 'lib/ruby-spacy.rb', line 634

def rights
  right_array = []
  PyCall::List.call(@py_span.rights).each do |py_right|
    right_array << Token.new(py_right)
  end
  right_array
end

#root ⇒ Token

Returns the head token

Returns:



556
557
558
 
# File 'lib/ruby-spacy.rb', line 556

def root
  Token.new(@py_span.root)
end

#sent ⇒ Span

Returns a span that represents the sentence that the given span is part of.

Returns:



583
584
585
586
 
# File 'lib/ruby-spacy.rb', line 583

def sent
  py_span = @py_span.sent
  Span.new(@doc, py_span: py_span)
end

#sents ⇒ Array<Span>

Returns an array of spans that represents sentences.

Returns:



562
563
564
565
566
567
568
569
 
# File 'lib/ruby-spacy.rb', line 562

def sents
  sentence_array = []
  py_sentences = PyCall::List.call(@py_span.sents)
  py_sentences.each do |py_span|
    sentence_array << Span.new(@doc, py_span: py_span)
  end
  sentence_array
end

#similarity(other) ⇒ Float

Returns a semantic similarity estimate.

Parameters:

  • other (Span) —

    the other span to which a similarity estimation is conducted

Returns:

  • (Float) 


602
603
604
 
# File 'lib/ruby-spacy.rb', line 602

def similarity(other)
  py_span.similarity(other.py_span)
end

#subtree ⇒ Array<Token>

Returns Tokens that are within the span and tokens that descend from them.

Returns:

  • (Array<Token>) —

    an array of tokens



644
645
646
647
648
649
650
 
# File 'lib/ruby-spacy.rb', line 644

def subtree
  subtree_array = []
  PyCall::List.call(@py_span.subtree).each do |py_subtree|
    subtree_array << Token.new(py_subtree)
  end
  subtree_array
end

#tokens ⇒ Array<Token>

Returns an array of tokens contained in the span.

Returns:



528
529
530
531
532
533
534
 
# File 'lib/ruby-spacy.rb', line 528

def tokens
  results = []
  PyCall::List.call(@py_span).each do |py_token|
    results << Token.new(py_token)
  end
  results
end