Skip to main content
This quickstart explains how to create an embeddable AI agent. Agent Studio provides a simple interface for quickly creating an intelligent agent that can answer customer questions right inside your website. For a video walkthrough of the setup steps for a new agent, click Get Started below:
Here’s how it works:
1

Define your use case

What business goals will this agent help you meet? In what context will customers encounter this agent? What types of questions do your customers ask?Knowing the answers to these questions helps you choose the right type of agent and the right content to train it for maximum effectiveness.
2

Format your training data

Agent Studio reads data directly from a GCS bucket, not from Fusion.Your data must be in JSONL and PDF format.In a JSONL file, each line is a complete JSON expression representing a single document, as in the example below:
{"name": "Puffy Winter Jacket", "product_id": "7a45q835", "description": "This classic down-filled jacket provides maximum insulation combined with lightweight comfort.", "documents": ["https://storage.googleapis.com/my-storage/puffy-winter-jacket.pdf"]}
3

Select an agent from the Agent Studio library

Your library includes one or more pre-built agent templates, depending on your Lucidworks subscription. Just click Create Custom Agent to open the library and locate the agent that’s best suited for your use case.You can contact Lucidworks if you need additional agent templates for the evolving needs of your business.
4

Configure your agent

Agent Studio guides you through some simple setup steps to connect your agent to your data. You can also configure options that help train your agent to provide the most helpful answers for your customers, such as the industry domain and the AI model to use.When you finish configuring your agent, Lucidworks AI needs some time to perform the initial training that fully enables it. While training is in progress, you can update your website code as explained in the final step below.You can also preview and test your agent right inside Agent Studio. Just click on the agent, then click the Preview tab and enter the required parameters to see the agent’s output.Preview tabYou can interact with the agent (in this case by clicking on one of the questions) to see additional output.
5

Embed the agent code on your site

Now you’re ready to embed the agent where your customers will see it. Click Get Agent Code to get ready-to-use code snippets that you can copy and paste into your site code:
  • Copy the <script> code snippet and paste it into the <head> of your web page. Script tag example
    Your exact code snippet will be unique to your custom agent.
  • Copy the <lw-template> snippet and paste it into the <body> of your web page where you want the agent to appear. Component markup example
    You’ll need to modify this snippet to include a product ID.
  • Copy the CSS snippet and paste it into your site’s stylesheet. You can modify it to control the look of your agent. Component markup example
Once you’ve tested the embedded agent in your development environment, you’re ready to launch it into production where it can begin driving conversions and revenue.
⌘I