feat/triples_plugins

[JarbasAl]

add base class for handling triples extraction from text

Summary by CodeRabbit

• New Features

  • Introduced a TriplesExtractor class for extracting semantic triples from documents.
  • Added functions for discovering, loading, and configuring triples plugins within the OVOS framework.
  • Expanded plugin types with new TRIPLES constants for enhanced plugin management.

• Bug Fixes

  • Improved plugin management capabilities to streamline integration of triples plugins.

• Documentation

  • Updated documentation to reflect new features and functionalities related to triples extraction and plugin management.

[coderabbitai]

Walkthrough

The recent changes introduce a new abstract class TriplesExtractor for extracting semantic triples from documents, along with functions for managing triples plugins in the OVOS framework. Additionally, two new constants, TRIPLES, are added to the PluginTypes and PluginConfigTypes enumerations to support the new triples functionality. This enhances the plugin management system, facilitating the integration of triples-related features.

Changes

Files	Change Summary
ovos_plugin_manager/templates/triples.py	Introduced TriplesExtractor class for extracting semantic triples with an abstract method.
ovos_plugin_manager/triples.py	Implemented functions for discovering, loading, and configuring triples plugins.
ovos_plugin_manager/utils/__init__.py	Added TRIPLES constant to PluginTypes and PluginConfigTypes enumerations.

Poem

🐇 In the meadow where ideas bloom,
A new class hops, dispelling gloom.
With triples to extract, oh what a sight,
Plugins now dance, in the soft moonlight.
Let's celebrate change, with a joyful cheer,
For the world of plugins, is now more clear! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[JarbasAl]

example usage TigreGotico/ovos-coreferee-plugin#1

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d89d0a0 and 4797f99.

Files selected for processing (3)

• ovos_plugin_manager/templates/triples.py (1 hunks)
• ovos_plugin_manager/triples.py (1 hunks)
• ovos_plugin_manager/utils/init.py (2 hunks)

Additional comments not posted (7)

ovos_plugin_manager/templates/triples.py (1)

6-14: Well-structured base class for triples extraction.

The TriplesExtractor class is well-defined with clear responsibilities:

• The constructor initializes configuration and sets a default token.
• The abstract method extract_triples is properly declared with a clear docstring and appropriate typing for its parameters and return type.

ovos_plugin_manager/triples.py (4)

5-11: Correct implementation of plugin discovery function.

The function find_triples_plugins is correctly implemented with appropriate documentation and usage of utility functions to find plugins of type COREFERENCE_SOLVER.

---

14-21: Properly implemented plugin loading function.

The function load_triples_plugin is well-documented and correctly uses a utility function to load a plugin based on the specified module name.

---

24-30: Correct implementation for retrieving plugin configurations.

The function get_triples_configs is correctly implemented with appropriate documentation and usage of utility functions to retrieve configurations for triples plugins.

---

33-40: Properly implemented function for retrieving specific plugin configurations.

The function get_triples_module_configs is well-documented and correctly uses a utility function to retrieve configurations for a specific triples plugin.

ovos_plugin_manager/utils/__init__.py (2)

25-25: Appropriate addition to the PluginTypes enumeration.

The new constant TRIPLES is correctly added with an appropriate value, following the existing naming conventions.

---

68-68: Appropriate addition to the PluginConfigTypes enumeration.

The new constant TRIPLES is correctly added with an appropriate value, following the existing naming conventions.