This guide provides a step-by-step approach to creating and configuring an intelligent agent using the Lyzr Agent API integrated with IBM watsonx for advanced natural language processing and AI capabilities. This example sets up an environment for a financial advisor agent, demonstrating how to process queries related to investment strategies and financial planning.
1. Setup
First, make sure you have the lyzr_agent_api
package installed. If not, install it using:
pip install lyzr_agent_api
Import the necessary classes:
from lyzr_agent_api.client import AgentAPI
from lyzr_agent_api.models.environment import EnvironmentConfig, FeatureConfig
from lyzr_agent_api.models.agents import AgentConfig
from lyzr_agent_api.models.chat import ChatRequest
Initialize the Lyzr Agent API client with your API key:
client = AgentAPI(x_api_key="LYZR-AGENT-API-KEY")
2. Setup Environment
Configure the environment where your agent will operate, enabling features like short-term memory and setting up the IBM watsonx model:
environment_config = EnvironmentConfig(
name="Test Environment",
features=[
FeatureConfig(
type="SHORT_TERM_MEMORY",
config={},
priority=0,
)
],
tools=[],
llm_config={
"provider": "ibm",
"model": "watsonx/ibm/granite-13b-chat-v2",
"config": {
"temperature": 0.5,
"top_p": 0.9,
},
"env": {
"WATSONX_URL": "",
"WATSONX_APIKEY": "",
"WATSONX_TOKEN": ""
"WATSONX_PROJECT_ID": ""
"WATSONX_DEPLOYMENT_SPACE_ID": ""
}
},
)
environment = client.create_environment_endpoint(json_body=environment_config)
print(environment)
See here for more information on how to get an access token to authenticate to watsonx.ai.
3. Create Agent
Create an agent with specific attributes, such as name, description, and behavioral prompts:
agent_config = AgentConfig(
env_id="your-environment-id",
system_prompt="Act like an experienced financial advisor with 20 years of expertise in wealth management, retirement planning, and investment strategies. Your clients range from individuals to small business owners seeking guidance on optimizing their financial health. Provide comprehensive, step-by-step advice that takes into account both short-term needs and long-term goals.",
name="Financial Advisor Agent",
agent_description="This agent provides expert financial guidance, offering tailored strategies for wealth management, retirement planning, and investment growth.",
)
agent = client.create_agent_endpoint(json_body=agent_config)
print(agent)
4. Interact with Agent
Initiate a chat session with the agent, providing your user ID, the agent ID, and your query:
response = client.chat_with_agent(
json_body=ChatRequest(
user_id="user-id",
agent_id="your-agent-id",
message="What are the best investment strategies for balancing short-term liquidity needs with long-term wealth growth?",
session_id="session-id",
)
)
print(response)
By following these steps, you can effectively integrate Lyzr Agent API with IBM watsonx to create a customized intelligent agent capable of providing expert advice and handling specific user queries in the financial domain. Adjust configurations and system prompts to tailor the agent’s behavior and optimize user interactions.