Developing a Tool Using Tool Designer

Create custom tools with specific functionality using the Tool Designer’s Code Runner feature in Arivonix.

Accessing the Tool Designer

To access and work with the Tool Designer:

1. Log into the Arivonix application.
2. Navigate to AI forge Studio.
3. Select the Tools Designer tab.
4. Search for your desired tool or create a new one.

This guide uses a pre-created tool named Named Entity Recognition, which is a Code Runner tool developed using Python functions.

Editing a Code Runner Tool

1. Locate your tool in the Tool Designer.
2. Click on Edit for the Code Runner tool.
3. This opens the editing interface.

Working with Code Cells

When the Code Runner opens, you will see predefined cells with template code:

1. Click on a cell to select it.
2. Use the Run button to execute the selected cell.

Tool Structure

• Tools Parameters Class: Define any parameters needed for the tool.
  • Example: Adding a mandatory parameter called Type.
  • Parameter values are accepted from users when the tool is used.
• Input Record and Output Record Classes: Predefined classes that typically don’t need modification.
• Execute Method: The main method where custom logic is implemented.

Installing External Packages

To add external packages required by your tool:

1. Add a new cell with a pip install command (e.g., for NLTK package).
2. Click the Run button to install the package.

Adding Custom Code

1. To add a new cell, click the Plus button.
2. Create necessary methods for your tool’s functionality (e.g., LabelInputText method for named entity recognition).
3. Modify the Execute method to process inputs and return results.
4. Run the cell to test the method with sample inputs.

Understanding Tool Inputs

The Code Runner tool can process three types of inputs:

1. Source Input: When a tool is used inside the Agentic AI Designer within Dataforge Studio’s Pipeline Designer, the input to the agent is considered the source input.
2. Workflow Input: Parameters added to an agent for its execution. Use workflow inputs to utilize any Agentic parameters inside the tool runner.
3. Records Input: Data passed from previous nodes in an Agentic AI Designer workflow. For example, when a previous node returns a list of strings as input to the current tool.

Saving and Versioning

1. After completing development, click the Save button at the top to save your code.
2. View the list of saved versions in the top right corner.
3. To roll back to a previous version, click on the appropriate version.

Summary

The Tool Designer provides a structured environment for developing custom tools with:

• Predefined code templates that can be customized with specific logic.
• Multiple input types for seamless integration with the Agentic AI Designer.
• Code saving and versioning capabilities for managing development changes.