Tool Use - Pipeline

Overview

Using the Pipeline Tool Use, your Agent will call the desired pipeline when the right conditions are met.

Configuration

Basic fields

Let's configure a basic Pipeline Tool Use, for this example we will use a pipeline that generates and sends emails.

In the following example we used a meaningful name and description to make sure the Agent understands when to use this tool.

Choose the 'Pipeline' option and choose the pipeline you want to run when this tool is called, in this example we chose a pipeline called 'Email Sender'

Parameters

In the parameters section we can configure the information we want to send to the pipeline, with each parameter being a key - value pair of information.

The key value must be formatted in "snake_case" (only lowercase letters and underscores) and it represents the name of the value we want to pass to the pipeline.

The description value will tell the Agent how to generate the actual value of the parameter, a meaningful description will help the Agent understand how to generate the value better.

The type option field represents the type of value that will be passed to the pipeline, it can be string, number, boolean, array or object.

The required field tells the Agent if the parameter is required or optional in order to call the pipeline.

When your parameter configuration is done, press the 'Add' button in the bottom right corner to add the parameter.

After that you will see the parameter you just created in the parameters list, where you can choose to edit or delete it if needed.