Create, configure, and run an AI agent

On this page

In this article, you will learn how to create, configure, and run an AI agent tailored to your specific business needs.

Create an AI agent

An AI agent is a component that uses artificial intelligence to analyze data, provide suggestions, and perform actions on your golden records. It consists of jobs—operational units within an AI agent that define what the agent should do.

To create an AI agent

  1. On the navigation pane, go to AI Agents (or, Management > AI Agents).

  2. Select Create Agent.

  3. Enter a user-friendly Name of the AI agent.

  4. Provide a user-friendly Description for the AI agent that helps everyone understand what the purpose of this AI agent is. This text will be displayed in the CluedIn UI.

  5. Provide Instructions for the AI agent. Think of instructions as a job description that tells your AI agent what you’d like it to do. For example, Fix incorrect date formats or Check for out-of-range transaction amounts.

    These instructions will apply to all jobs that the AI agent performs (this way, you won’t have to repeat the instructions in each job).

    create_agent_pane.png

  6. Select Create.

    After you created an AI agent, proceed to configure it by adding jobs.

Configure an AI agent job

To enable an AI agent to perform a specific task, you must create and configure one or more AI agent jobs. A job defines a specific task assigned to the agent—such as detecting duplicates, identifying and resolving data quality issues, or generating rules—based on a specific set of golden records.

Setting up an AI agent job involves the following steps:

  1. Creating a job – add a new job for an AI agent.

  2. Adding a data source – specify a set of golden records the agent should operate on.

  3. Configuring a prompt – define the instructions the agent should follow to complete the task.

  4. Testing the job – verify the job’s setup by running a preliminary test on a subset of golden records to ensure the agent performs as expected.

  5. Running the job – execute the job on the full set of data according to the provided instructions to produce AI suggestions.

Create a job

A job is the operational unit within an AI agent. It defines what the agent should do and which golden records it should work on.

To create a job

  1. On the navigation pane, go to AI Agents (or, Management > AI Agents).

  2. Select the AI agent for which you want to add a job.

  3. Select Create Job.

  4. Enter a user-friendly Name of the job.

  5. Provide the Description of the job, focusing on the details about what this job will do, its purpose, or any special instructions.

  6. Select the Endpoint that the job will use. This is the API endpoint of a specific deployed AI model that your job will call to perform its task. Choosing the correct endpoint ensures the job uses the right AI capabilities.

    create_pane.png

  7. Select Create.

    Once you added a job, proceed to add a data source to specify the set of golden records the job will operate on.

Add a data source

A data source within a job refers to a specific set of golden records that the job will operate on. The data source defines the input data for the AI agent, ensuring that the job processes the correct records for a specific task.

To add a data source

  1. On the navigation pane, go to AI Agents (or, Management > AI Agents).

  2. Select the AI agent for which you added the job. Then, select the job.

  3. On the Configuration tab of the job page, in the Data section, select Add data source.

    click_add_data_source_btn.png

  4. On the Create Data Source pane, do the following:

    1. Enter a user-friendly Name of the data source.

    2. If you want to limit the number of golden records in the data source, select the Sampling checkbox. Then, in Sampling Size, enter the desired number of records that you want to use.

    3. Use the Modified Since Last Run option to define if the AI agent job should consider only updated records. When the option is enabled, the AI agent job will process only the records that were modified since the last successful job run. Otherwise, the job will process all records.

    4. In the Conditions section, add a filter to define which golden records should be included in the data source.

    5. In the Vocabulary Keys section, select one or more vocabulary keys that the job will analyze and process.

    6. Select Create.

      create_data_source_pane.png

    Once you added the needed data source, proceed to configure the prompt that the job should follow to complete the task.

Configure a prompt

A prompt in an AI agent job is a set of instructions or natural language input that tells the AI agent what task to perform and how to perform it on the selected data source. It acts as the core logic of the job, guiding the AI agent’s behavior based on your business goals.

To configure a prompt

  1. On the navigation pane, go to AI Agents (or, Management > AI Agents).

  2. Select the AI agent for which you added the job. Then, select the job.

  3. On the Configuration tab of the job page, in the Skills section, select the skill that the agent should use to perform the job.

    select_skill.png

  4. In the Instructions section, enter a prompt instructing the agent what task it must perform.

    Then, select the data source on which the job should run. To do this, drag the needed data source from the Data section onto the Instructions section.

    prompt.png

    Once you configured the prompt, test the job configuration to make sure that the results meet your expectations and the task is performed correctly.

Test the job

Testing a job is an important step because it helps achieve the following:

  • Ensure the agent performs accurately on a smaller subset of golden records, helping to catch errors early and prevent costly mistakes before processing the full data source.

  • Validate that the job configuration and instructions align with the expected outcomes.

When you test the job, no changes are made to the your golden records. The purpose of testing is solely to provide a preview of the results that will be generated when the job is run.

To test the job

  1. On the navigation pane, go to AI Agents (or, Management > AI Agents).

  2. Select the AI agent for which you added the job. Then, select the job.

  3. In the upper-right corner of the job page, select Test Now. The testing process may take some time depending on the amount of data to be processed.

    click_test_job_btn.png

  4. When testing is completed, review the testing results:

    1. Go to the Runs tab. Locate the job run with the Test label and the time corresponding to when you did the test run. Wait until the test run status is Completed.

      The layout of the Runs tab changes depending on the skill selected when configuring the prompt. In this example, the images are for the Fix Data Quality Issues skill.

      locate_the_test_run.png

    2. Select the test run. You can now review the preliminary suggestions generated during the test run. The values that the AI agent suggested to change are highlighted in green.

      test_run_results.png

      If the test run returns no results, try adjusting the job settings as described in Troubleshoot an AI agent job.

    3. To view the AI agent suggestions, locate a cell highlighted in green. Then, hover over the information icon in that cell to view the current golden record value and how the AI agent suggests to change it.

      view_suggestion_details.png

  5. To view input and output data exchanged between CluedIn and the large language model (LLM), go to the Configuration tab of the job. Then, expand the Logs section.

    view_logs_sp.png

    If the corresponding setting is enabled, the Logs sections will include the Show Raw Data button. The button reveals the raw JSON data for requests and responses exchanged between CluedIn and the LLM. This feature is useful for fine-tuning prompts but is best suited for users with a strong technical background in LLMs and JSON.

    view_logs_show_raw_data_sp.png

    Once you’re satisfied with the job configuration and preliminary suggestions generated by the AI agent, proceed to run the job.

Run the job

Running a job is how you put your AI agent configuration into action, allowing you to generate tangible results that you can validate and apply. When you run the job, it processes the entire set of golden records defined in the job’s data source configuration. Depending on the size of the data and the AI model’s performance, the job can take anywhere from a few seconds to several hours to several days to complete.

You can run the job:

  • Manually now.

  • Automatically on a specific schedule. You can have the job running once every N hours, days, or minutes.

To run a job

  1. On the navigation pane, go to AI Agents (or, Management > AI Agents).

  2. Select the AI agent for which you added the job. Then, select the job.

  3. On the job page, turn on the status toggle to enable the job.

    enable_the_job.png

  4. To run the job now, in the upper-right corner of the job page, select Run Now.

    run_the_job.png

  5. To run the job on a schedule, do the following:

    1. On the job page, go to the Settings tab.

    2. In the Recurring Schedule section, select Enable.

    3. Specify the schedule for job. You can have the job running once every N hours, days, or minutes.

      specify_a_schedule.png

  6. In the upper-right corner of the job page, select Save.

  7. When the job completes, proceed to review the results returned by the AI agent.

    The recommended approach is to work iteratively – run the job, review the results, then run the job and review the results again. Repeat this process until the AI agent produces all expected suggestions.

  8. To view input and output data exchanged between CluedIn and the large language model (LLM), go to the Configuration tab of the job. Then, expand the Logs section.

    view_logs_sp.png

    If the corresponding setting is enabled, the Logs sections will include the Show Raw Data button. The button reveals the raw JSON data for requests and responses exchanged between CluedIn and the LLM. This feature is useful for fine-tuning prompts but is best suited for users with a strong technical background in LLMs and JSON.

    view_logs_show_raw_data_sp.png

Troubleshoot an AI agent job

If, after configuring and testing the prompt, the Test History pane doesn’t display any suggestions, the AI agent might be using an incorrect endpoint to communicate with the deployed AI model on the platform. You can fix this by selecting another endpoint for the AI agent configuration.

To troubleshoot an AI agent job

  1. On the navigation pane, go to AI Agents (or, Management > AI Agents).

  2. Select the AI agent for which you added the job. Then, select the job.

  3. On the job page, go to the Settings tab.

  4. In the Endpoint list, select the endpoint that you want to use for the AI agent.

    select_endpoint.png

  5. In the upper-right corner of the job page, select Save.

    You can now retest and rerun the job.