Glossary

The glossary is a fundamental part of shaping your agent's understanding of its domain. It's like your agent's professional dictionary: a set of terms specific to your business or service context.

When to Use the Glossary

When you create an agent to handle specific tasks, it often needs to understand the unique vocabulary of your domain. For example, if your agent helps guests book rooms at the Boogie Nights hotel, it needs to know what "Boogie Nights" means in your context—in this case, that it's not just a movie title, but your hotel's name.

Creating Glossary Terms

Here's how to create a new glossary term:

await agent.create_term(
    name=TERM,
    description=DESCRIPTION,
    synonyms=[SYNONYM_1, SYNONYM_2, ...],
)

Structure of Terms

Each glossary entry consists of three components:

• Term: The word or phrase being defined
• Description: What this term means in your specific context
• Synonyms: Alternative ways users might refer to this term

For example:

await agent.create_term(
    name="Boogie Nights",
    description="Our luxury beachfront hotel located in Miami",
    synonyms=["BN Hotel", "The Boogie", "Boogie Hotel"],
)

How Agents Use the Glossary

The glossary serves two crucial purposes in agent interactions.

First, it helps your agent understand customers better when they interact with it. When a guest says "I'd like to stay at The Boogie," the agent knows they're referring to your hotel.

Second, it helps the agent interpret your guidelines correctly. Consider the following configuration:

await agent.create_guideline(
    condition="the user asks about Ocean View rooms",
    action="explain the Sunrise Package benefits",
)

await agent.create_term(
    name="Ocean View",
    description="Our premium rooms on floors 15-20 facing the Atlantic",
    synonyms=["seaside rooms", "beach view"],
)

await agent.create_term(
    name="Sunrise Package",
    description="Complimentary breakfast and early check-in for Ocean View bookings",
    synonyms=["morning special", "sunrise special"],
)

Here, both the condition as well as the action depend on the agent understanding what these terms mean.

If the Customer comes in and asks,

Customer: I heard you have some rooms with a view to the Atlantic. What are those?

The agent can understand, based on the glossary term, that the condition "the user asks about Ocean View rooms" is met, and it can then respond with the action "explain the Sunrise Package benefits".

Glossary vs Guidelines vs Agent Description

Each component serves a distinct purpose in shaping your agent's behavior:

1. The Glossary teaches your agent "what things are". For example, "A Club Member is a guest who has stayed with us more than 5 times." You can have as many terms as you want.
2. Guidelines teach your agent "how to act in situations". For example, "When speaking with Club Members, acknowledge their loyalty status." You can have as many guidelines as you want.
3. Agent Description provides overall context and personality. For example, "You are a helpful hotel booking assistant for Boogie Nights." The agent's description is static and limited.

Think of it this way: the glossary builds your agent's vocabulary, guidelines shape its behavior, and the agent description sets its overall context, role, personality and tone.

Glossary vs Tools

While both glossary terms and tools help your agent understand your domain, they serve fundamentally different purposes. The glossary provides static knowledge, while tools enable dynamic data access.

Consider a hotel booking scenario:

Glossary Term:

• Term: Club Member
• Description: A guest who has stayed with us more than 5 times
• Synonyms: loyal guest, regular guest

Tool: check_member_status(user_id) # Returns current stay count and benefits

The glossary term provides a consistent definition of what a Club Member is, while the tool can check a specific user's actual status in your database. Similarly:

Glossary Term:

• Term: Ocean View Room
• Description: Premium rooms on floors 15-20 facing the Atlantic
• Synonyms: seaside room, beach view

Tool: check_room_availability(room_type, dates) # Returns current availability and rates

The glossary helps your agent understand what an Ocean View Room is, while the tool provides real-time information about specific rooms' availability and pricing.

This separation between static knowledge (glossary) and dynamic data access (tools) helps create clear, maintainable agent implementations that can handle both general inquiries and specific, data-driven interactions.