Create Tools

Tools refer to the various components, including both custom-built solutions and third-party APIs, that can be customized and integrated to perform specific tasks or functions within a Gen AI Asset/Agent. These tools are essential for enhancing the capabilities of the Gen AI platform and enabling it to address diverse business needs effectively.

Users must have a Gen AI User policy to create and manage the tools. 

The Platform allows you to create the following types of tools:

• Custom tool
• API tool

Create custom tool

This is a component or module specifically developed by the enterprise to fulfill unique requirements or address specific challenges. By customizing tools, businesses can fine-tune their AI solutions to align closely with their objectives and tailor them to their operational needs.

These tools enhance the efficiency and effectiveness of AI-powered workflows, enabling enterprises to automate repetitive tasks, improve decision-making processes, and enhance customer experiences.

For example, a custom tool could be developed to automatically find the account holder with the highest saving amount. 

1. Head to Gen AI Studio module, choose Tools.
   
   
   
   
2. In the Tools section, click Create Tool.
   
   
   
   
3. In the Create Tool asset window that appears, enter a unique Name and Description.
   
   
   
   
4. In Type, choose Custom option and then click Create. 
5. On the Custom tool page that appears, write the Python code for the tool that you wish to create, and then click Test.
   
   
   
   
6. In the response section, you can review the response. .
   
   
   
   
7. If you are satisfied with the response, click Submit to create the custom tool. 

Note: You can test with static inputs and validate the response. Incase you want to pass dynamic input while integrating the custom tool as an agent, please define the inputs as dynamic variables. You may receive an error if you are using dynamic variables in the code. This doesn’t necessarily mean the code is not functioning properly, as the custom tool will be integrated with the LLM models and will fetch the inputs from them.

Create API tool

APIs play a crucial role in integrating third-party services or functionalities into the Gen AI platform. Leveraging APIs allows enterprises to access state-of-the-art AI capabilities without needing to build everything from scratch, accelerating development timelines and reducing costs.

For example, you could leverage an API that allows the user to retrieve and update information from internal databases or customer relationship management (CRM) systems.  

1. Head to Gen AI Studio module, choose Tools.
   
   
   
   
2. In the Tools section, click Create Tool.
   
   
   
   
3. In the Create Tool asset window that appears, enter a unique Name and Description.
   
   
   
   
4. Click Create.  
5. In the Tool page that appears, choose any one of the following methods and enter the URL. 
   
   • GET : Choose this method if you wish to obtain information from the database or from a process. 
   • POST: Choose this method if you wish to send information, either to add information to a database or pass the input of an Asset. 
   • PUT: Choose this method if you wish to manage/update the information in the database. 
   • DELETE: Choose this method if you wish to Delete the information from the database.

6. Click Test to check the response. 
7. You can also enter the Headers, Body and Parameters information from the respective tabs.

Add Headers

1. In the Headers tab, enter the Key, Value, and Description information.
   
   
   
   
2. You can also use the Constant/Variable field against the Key values.
   • Constant field : Activate this option to restrict the users to change the Key values while accessing the API. 
   • Variable field: Activate this option to allow the users to change the Key values while accessing the API.
3. Click    if you wish to add more fields. 
4. Select the respective check boxes against the Key, Value, Description information that you wish to process for this API call.   

Note: If you do not select the checkboxes, the keys will not be processed during the API call. 

Add Body 

1. In the Body tab,  use any one of the following options.
   
   • None: Choose this option if you wish to process the API without body information.
   • JSON: Choose this option if you wish to process the API with the JSON code. 
   • Form-data: Choose this option if you wish to process the API with the Key, Type, Value and Description information.
     
     
     
     
     • You can use the following options against the Type.
       
       • Text: Choose this option if you wish to update the Value information as text format. 
         
         • You can use the Constant/Variable field against the Type.
           • Activate Constant field to restrict the users to change the Key values while accessing the API. 
           • Activate Variable field to allow the users to change the Key values while accessing the API.
             
       • File: Choose this option if you wish to update the Value information as File
         
         
     • Click if you wish to add more fields. 
     • Select the respective check boxes against the Key, Type,  Value, Description information that you wish to process for this API call. 

Note: If you do not select the checkboxes, the keys will not be processed during the API call. 

Add Parameter

1. In the Parameter tab, enter the Key, Value information.
   
   
   
   
2. You can also use the Constant/Variable field against the Key values.
   • Activate Constant field to restrict the users to change the Key values while accessing the API. 
   • Activate Variable field to allow the users to change the Key values while accessing the API.
   • Click if you wish to add more fields. 
   • Finally, select the respective check boxes against the Key, Value, Description information. 
3. Select the checkbox against the keys that you wish to process for this API call. 

Note: If you do not select the checkboxes, the keys will not be processed during the API call.

8. Click Submit to create an API tool.