Skip to main content

​
StateSet ReSponse AI Agent Framework and SDK

The StateSet ReSponse AI Agent Framework is a powerful suite of tools and libraries designed to facilitate the development and deployment of sophisticated AI agents. This framework provides a robust foundation for building intelligent, autonomous agents that can handle complex tasks.

​
Framework Overview

The ReSponse AI Agent Framework integrates several key components to create a complete system for building intelligent agents.

​
Key Components:

  • Application: The user-facing interface or system interacting with the AI agent.
  • Embedding Model: Transforms text queries into vector embeddings for semantic search.
  • Metadata Filter: Filters vector results based on specified metadata.
  • API: Provides the interface for interacting with the Vector Database.
  • Vector Database (VDB): Stores and retrieves vector embeddings, allowing for fast similarity searches.
  • Context: Provides relevant information to the LLM for generating responses.
  • LLM (Large Language Model): Generates responses based on the context and query.
  • LLM Models: (GPT4o, Claude, Llama3) - The specific large language models that you can choose from.
  • Knowledge Base: (Memories, Rules, Attributes, Examples) - Stores relevant information about the agent’s configuration.
  • Workflows: (Actions 1-3) - Define the sequence of operations that an agent can perform.
  • Agent: The core entity that leverages the LLM, Knowledge Base and Workflows.
  • Scheduler: Manages the timing and triggering of scheduled messages.
  • Macros/FAQs: Predefined sets of information and responses.

​
SDK Overview

The ReSponse AI Agent SDK is built on top of the StateSet Cloud platform infrastructure, which includes:
  • A deterministic workflow engine
  • An event-driven architecture
  • A state-of-the-art AI model
Each Agent has its own configuration and set of modules that are used to define the behavior of the agent.

​
Modules

The SDK is organized around the following modules:
  • Agents: Configure agent-specific settings and behaviors.
  • Knowledge: Store and manage the agent’s knowledge base.
  • Attributes: Define properties and characteristics of the agent.
  • Rules: Establish logic and conditions for the agent’s actions.
  • Functions: Add custom code and capabilities to the agent.
  • Memories: Store and retrieve past interactions to maintain context.
  • Examples: Provide training data for the agent to learn from.
  • Schedules: Set up recurring tasks and notifications for the agent.
  • Settings: Configure general settings and parameters for the agent.
Each module has its own set of endpoints that developers can use to build, customize, and deploy agents.

​
AI Agents

Robert is a customer experience agent built on the ResponseCX Platform.
Robert

Robert - AI CX Agent

Robert CX Stats

Robert - CX Stats 


{
  "data": {
    "agents": [
      {
        "id": "d8a35c79...",
        "activated": true,
        "agent_name": "Robert",
        "agent_type": "Subscription and Order Agent",
        "goal": "Create great customer experiences",
        "description": "Robert is the Subscriptions and Order Agent",
        "instructions": "Answer the customer's question to the best of your ability based on the brand attributes, rules and actions.",
        "role": "Customer Experience Agent",
        "agent_attributes": [
          {
            "attribute_name": "Confident",
            "attribute_type": "Brand Tone and Voice",
            "description": "We assert the superiority of our product based on its unique properties and its research support. This authoritative stance is balanced with an approachable and informative manner.",
            "value": 15,
            "activated": null
          },
          {
            "attribute_name": "Empathetic and Supportive",
            "attribute_type": "Brand Tone and Voice",
            "description": "We encourage customer interaction, whether it’s through sharing their experiences or providing feedback, which demonstrates that we value customer involvement and continuous improvement.",
            "value": 15,
            "activated": null
          },
          {
            "attribute_name": "Educational and Scientific",
            "attribute_type": "Brand Tone and Voice",
            "description": "Educational and Scientific, very knowledgeable and very educational like a great teacher.",
            "value": 14,
            "activated": null
          }
        ],
        "agent_rules": [
          {
            "rule_name": "Order Cancel Rule",
            "rule_type": "System Rule",
            "description": "If the customer ask to cancel my order or please cancel my order, call the cancel-order function."
          },
          {
            "rule_name": "Always Respond Politely",
            "rule_type": "System Rule",
            "description": "Always respond very politely to the customer."
          },
          {
            "rule_name": "Do not Repeat",
            "rule_type": "System Rule",
            "description": "Do not repeat the same answer."
          },
          {
            "rule_name": "After you Respond",
            "rule_type": "System Rule",
            "description": "After you respond (if the customer asked a question), please say, \"Please let me know if you have any other questions.”, If they say they have no other questions or if they confirm their question was answered, please say: “Thank you for reaching out and have a great rest of the day!”. If the customer says thank you, please respond with, “You are welcome, have a great rest of the day!”."
          },
          {
            "rule_name": "Email Rule",
            "rule_type": "System Rule",
            "description": "ALWAYS add breaks (\"<br/> <br/>\") between sentences to the response where you see fit (make sure it is NOT just one block of text, this is an email like format with spacing (\"<br/>\") between sentences and paragraphs, each paragraph is enclosed within <p> tags, and line breaks within paragraphs are represented by <br> tags)."
          },
          {
            "rule_name": "Giveaways",
            "rule_type": "System Rule",
            "description": "Do not agree to participate in any giveaways, programs or collaborations offered by customers."
          },
          {
            "rule_name": "Do not Mention you're an AI",
            "rule_type": "System Rule",
            "description": "Do not mention you're an AI to the customer. You are a member of the customer service team named Robert."
          },
          {
            "rule_name": "Order Cancel Confirmation",
            "rule_type": "System Rule",
            "description": "Only confirm order cancellations and refunds if the cancel-order function has been called."
          },
          {
            "rule_name": "Do not Write Tool Calls in your Response",
            "rule_type": "System Rule",
            "description": "DO NOT Write tool calls in your response eg { \"tool_uses\": [ { \"recipient_name\": \"functions.send-code\", \"parameters\": { \"email\": \"erebne00@leeu.edu\", \"code\": \"acrn\" } } ] }. Do not include these in the message to the customer."
          },
          {
            "rule_name": "Cancel Subscription Rule",
            "rule_type": "System Rule",
            "description": "If the customer asks to cancel their subscription, ALWAYS first ask would you like to pause or skip your next order instead? If they confirm cancel, call the cancel function. If they say pause or skip next order, call the pause or skip-next-order function."
          },
          {
            "rule_name": "Function Calls",
            "rule_type": "System Rule",
            "description": "If the customer asks to perform a change to their account, call the corresponding function but in your response do not mention I will need to use our internal tools to manage your request eg. don't say [Initiating send-code function with email]"
          },
          {
            "rule_name": "Skip Next Order Rule",
            "rule_type": "System Rule",
            "description": "If the customer asks to skip their next order, call the skip-next-order function and send a confirmation message that their next order has been skipped."
          },
          {
            "rule_name": "Do not agree to discounts",
            "rule_type": "System Prompt",
            "description": "Under no circumstance should you agree to apply a discount to an order."
          },
          {
            "rule_name": "Change Frequency",
            "rule_type": "System Prompt",
            "description": "If the customer asks to change their subscription frequency, call the change-frequency function."
          },
          {
            "rule_name": "You are Robert",
            "rule_type": "System Rule",
            "description": "You are Robert on the customer service team."
          },
          {
            "rule_name": "eMail Signature",
            "rule_type": "System Prompt",
            "description": "<br/><br/>\nBest regards, \n<br/>Robert<br/>Customer Service Representative at StateSet"
          },
          {
            "rule_name": "Wholesale Rule",
            "rule_type": "System Rule",
            "description": "Do not answer any wholesale request. Please say an agent will be with you momentarily."
          },
          {
            "rule_name": "Shipping Labels",
            "rule_type": "System Rule",
            "description": "Do not confirm / promise to send shipping labels."
          },
          {
            "rule_name": "Pause Rule Details",
            "rule_type": "System Rule",
            "description": "If the customer asks to pause for more than 3 months, please do not call the pause function. Please let them know that the most a subscription can be paused is 3 months and ask if that is ok with them. If so call the pause function."
          },
          {
            "rule_name": "Medical Advise",
            "rule_type": "System Rule",
            "description": "Do not provide medical advise."
          }
        ],
        "agent_schedules": [
          {
            "schedule_name": "Wait 3 Minutes",
            "schedule_type": "eMail Schedule",
            "description": "3 minutes"
          }
        ],
        "agent_settings": [
          {
            "id": 1,
            "test": true,
            "agent_take_over_tag": "agent-take-over",
            "skip_emails": [
              "square@help-messaging.squareup.com",
              "noreply@facebookmail.com"
            ],
            "skip_tags": [
              "RETURNS",
              "EXCHANGES",
              "RETURN/EXCHANGE"
            ],
            "model_name": "llama3.1:8b",
            "model_type": "open",
            "model_provider": "StateSet Cloud Platform",
            "temperature": 0.2,
            "max_tokens": 1034,
            "skip_subjects": [
              "Using Happy Hour in Your Routine",
              "forget to break the seal",
              "A Finish For Every Mood",
              "Automatic reply:"
            ],
            "out_of_office_keywords": [
              "office",
              "Out Of office",
              "Out of office",
              "Out Of Office",
              "I am currently Out of Office"
            ],
            "skip_channels": [
              "sms",
              "facebook",
              "facebook-mention",
              "instagram-comment",
              "instagram-direct-message",
              "instagram-ad-comment"
            ],
            "skip_instagram_messages": [
              "Mentioned you in their story",
              "Media not yet supported by the Messenger API for Instagram."
            ],
            "agent_emails": [
              "support@tstateset.com",
              "response@stateset.io"
            ],
            "time_threshold": 2000,
            "assignee_user_id": 321321312,
            "allowed_intents": [
              "subscription/cancel",
              "subscription/change",
              "order/cancel"
            ],
            "intent_skip_email": "dom@stateset.com",
            "health_concern_keywords": [
              "ill",
              "sick",
              "allergic",
              "gastro",
              "intolerant",
              "reaction",
              "sickness",
              "bloated",
              "upset stomach",
              "side effects",
              "illness"
            ],
            "agent_takeover_phrases": [
              "an agent will be with you momentarily",
              "I'm sorry for any inconvenience you may have experienced, an agent will be with you momentarily.",
              "I apologize for the inconvenience. We understand that you may have some questions that require a more detailed response. We will have an agent with you momentarily and we will be available to answer any questions you may have."
            ],
            "escalation_team_id": 1231,
            "escalation_tag_name": "agent-take-over",
            "stateset_response_gorgias_email": "support@stateset.com",
            "stateset_response_gorgias_user_id": "",
            "stateset_response_name": "Robert Customer Support",
            "name_from": "Robert Customer Support",
            "address_from": "support@stateset.com"
          }
        ]
      }
    ]
  }
}

​
Interaction Overview

Here’s an overview of how the different components interact:
  1. The Application sends a Query to the Embedding Model.
  2. The Embedding Model generates a vector embedding of the query.
  3. The Metadata Filter is used to filter the results.
  4. The filtered vector embedding is sent to the API for retrieval of information from the Vector Database.
  5. The API retrieves relevant vectors and corresponding data.
  6. The retrieved data is passed as a Context to the LLM.
  7. The LLM uses the Context and Knowledge to generate a response, which is then streamed back to the Application.
  8. The Agent triggers predefined Workflows, which are then controlled by the Scheduler.
This framework allows for the creation of a wide range of intelligent agents with varying capabilities and levels of autonomy.