Integration Connector tools

Connector tools can be used by an agent to perform actions using your Connections configured in Integration Connectors. Each connector tool is configured with a single Connection and one or more actions. If needed, multiple tools can be created for a single Connection to group different actions together for your agent to use.

The connector tool supports the following Connector types:

Create a connection

To create a connection:

  • Navigate from the agent builder to the Tools > Create
  • Select the Integration connector tool type
  • Select your chosen connector type
  • Use the Create Connection button.

This will navigate you to Integration Connectors creation with a number of fields pre-filled.

Alternatively, you can navigate to Integration Connectors and follow the instructions to create a connection.

Connector actions

For each connector tool, there are two types of actions that can be made available to your agent (see Entities, operations, and actions for more information):

  1. Entity CRUD operations

    Each of your Connections have "entities" corresponding to the objects of that data source (for BigQuery, these are tables; for Salesforce, these are objects, like 'Order' or 'Case').

    You can perform CRUD operations on each entity:

    • Create: creates an entity with specified field values
    • List: filter-based search of entity instances
    • Update: filter-based method for altering entity field values
    • Delete: deletes an entity
    • Get retrieves a single entity using the entityId

    Learn more about entity CRUD operations details in the Connectors docs.

  2. Connector-specific actions

    Many Connectors support an 'ExecuteCustomQuery' action, which allows for executing a SQL query against the data source, where each of the data source entities can be referenced as tables. See this list for supported connectors.

    Additional actions differ based on the connector type - for example, see the BigQuery connector actions or the Salesforce connector actions.

Configuring input / output fields for CRUD operations

By selecting specific input or output fields for your connector tool action to use, you can limit the complexity of these actions for the agent.

For example, if you only need to create an entity with a subset of its fields, configuring this set of fields in your action simplifies the action for the agent.

Specifying a set of output fields reduces the tool response size (helpful if token limits are a concern) and simplifies the agent's handling of the output by exposing only the relevant fields.

Authentication

If the connection you're using is configured to allow authentication override, then the tool can be configured to pass through credentials from specified session parameters.

You as the agent builder are responsible for how these credentials are populated to the session parameters and the tool will automatically pass them through to the data source to use for authentication when the tool's actions are called.