Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for retrieving user preferences and memories using Mem0 #1209

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Add support for retrieving user preferences and memories using Mem0 #1209

wants to merge 11 commits into from

Conversation

Dev-Khant
Copy link
Contributor

Changes

  • Introduce a new memory type in CrewAI called 'UserMemory' which basically fetches the user's preferences and past memories based on the action that agent is going to take. Eg: in case of a travel planner agent, if the user prefers to stay in Airbnb over Hotel, the agent will be provided user preferences and the Agent response will be more personalized.
  • Short Term Memory uses Mem0
  • Entity Memory uses Mem0
  • Update Embedchain package and Mem0 package
  • Demonstrated improved personalization in Travel Planner Agent output when using memory

Comparison

User preferences provided through Mem0:

m = Memory.from_config(config)
m.add("I like to stay in Airbnb rather than hotels during Travel.", user_id="deshraj")
m.add("I like to eat Indian and Italian food", user_id="deshraj")
m.add("I like beaches over mountains", user_id="deshraj")
m.add("I like to watch bollywood movies over hollywood", user_id="deshraj")

TL;DR

Agent with UserMemory shows significant improvements in personalization:

  • Recommends Airbnb options instead of hotels, aligning with user's stated preference
  • Includes a dedicated section for beaches, reflecting user's preference for beaches over mountains
  • Suggests Bollywood movie theaters, matching user's preference for Bollywood over Hollywood
  • Provides more diverse dining options, including Indian cuisine, based on user's food preferences
  • Overall, the recommendations are more tailored to the user's specific interests and preferences, demonstrating the effectiveness of the new UserMemory feature

This TL;DR highlights the key differences between the agent outputs, specifically showing how the agent with memory provides more personalized and relevant recommendations based on the user preferences you provided in the example.

Travel Planner Agent Output without Memory

 
#### **Places to Live (Accommodations)**

1. **Palace Hotel, a Luxury Collection Hotel, San Francisco**
   - Address: 2 New Montgomery St, San Francisco, CA 94105
   - Description: A historic luxury hotel known for its opulent interiors and exceptional service.
   - Website: [Palace Hotel](https://www.marriott.com/hotels/travel/sfolc-palace-hotel-a-luxury-collection-hotel-san-francisco/)

2. **The St. Regis San Francisco**
   - Address: 125 3rd St, San Francisco, CA 94103
   - Description: A high-end hotel renowned for its modern elegance and prime location near Yerba Buena Gardens.
   - Website: [The St. Regis San Francisco](https://www.marriott.com/hotels/travel/sfoxr-the-st-regis-san-francisco/)

3. **Omni San Francisco Hotel**
   - Address: 500 California St, San Francisco, CA 94104
   - Description: Located in the Financial District, this hotel offers luxurious accommodations with a classic ambiance.
   - Website: [Omni San Francisco Hotel](https://www.omnihotels.com/hotels/san-francisco)

4. **Four Seasons Hotel San Francisco**
   - Address: 757 Market St, San Francisco, CA 94103
   - Description: A plush hotel offering refined rooms and suites with stunning city views.
   - Website: [Four Seasons Hotel San Francisco](https://www.fourseasons.com/sanfrancisco/)

5. **InterContinental San Francisco, an IHG Hotel**
   - Address: 888 Howard St, San Francisco, CA 94103
   - Description: Known for its modern design and excellent amenities, perfect for both business and leisure travelers.
   - Website: [InterContinental San Francisco](https://www.ihg.com/intercontinental/hotels/us/en/san-francisco/sfohb/hoteldetail)

#### **Places to Eat (Dining)**

1. **Tartine Bakery**
   - Address: 600 Guerrero St, San Francisco, CA 94110
   - Description: Famous for its artisanal bread, pastries, and coffee, a must-visit for breakfast or a sweet treat.
   - Website: [Tartine Bakery](https://tartinebakery.com/)

2. **Zuni Café**
   - Address: 1658 Market St, San Francisco, CA 94102
   - Description: An iconic restaurant known for its roast chicken and eclectic menu featuring local ingredients.
   - Website: [Zuni Café](https://zunicafe.com/)

3. **Swan Oyster Depot**
   - Address: 1517 Polk St, San Francisco, CA 94109
   - Description: A historic seafood counter offering fresh oysters, crab, and clam chowder.
   - Website: [Swan Oyster Depot](https://swanoysterdepot.us/)

4. **House of Prime Rib**
   - Address: 1906 Van Ness Ave, San Francisco, CA 94109
   - Description: A classic steakhouse serving prime rib in a traditional setting.
   - Website: [House of Prime Rib](https://houseofprimerib.net/)

5. **State Bird Provisions**
   - Address: 1529 Fillmore St, San Francisco, CA 94115
   - Description: Known for its innovative small plates and dim sum-style service.
   - Website: [State Bird Provisions](https://statebirdsf.com/)

#### **Places to Visit (Attractions)**

1. **Golden Gate Bridge**
   - Location: Golden Gate Bridge, San Francisco, CA
   - Description: An iconic suspension bridge offering breathtaking views of the bay and the city.

2. **Alcatraz Island**
   - Location: San Francisco, CA 94133
   - Description: A historic island featuring the infamous former prison, accessible by ferry.
   - Website: [Alcatraz Island](https://www.nps.gov/alca/index.htm)

3. **Fisherman's Wharf**
   - Location: San Francisco, CA 94133
   - Description: A bustling waterfront area with shops, restaurants, and attractions like Pier 39.

4. **Golden Gate Park**
   - Location: San Francisco, CA
   - Description: A vast urban park home to gardens, museums, and recreational facilities.
   - Website: [Golden Gate Park](https://sfrecpark.org/512/Golden-Gate-Park)

5. **Exploratorium**
   - Address: Pier 15, The Embarcadero, San Francisco, CA 94111
   - Description: An interactive science museum perfect for visitors of all ages.
   - Website: [Exploratorium](https://www.exploratorium.edu/)

6. **Chinatown**
   - Location: Grant Ave, San Francisco, CA 94108
   - Description: One of the oldest and most vibrant Chinatowns in the U.S., with shops, eateries, and cultural sites.

7. **Lombard Street**
   - Location: Lombard St, San Francisco, CA 94133
   - Description: Known as the "crookedest street in the world," famous for its steep, winding turns.

8. **Muir Woods National Monument**
   - Address: 1 Muir Woods Rd, Mill Valley, CA 94941
   - Description: A serene forest with towering redwoods, located just outside the city.
   - Website: [Muir Woods National Monument](https://www.nps.gov/muwo/index.htm)

Travel Planner Agent Output with Memory

 
## Detailed 5-Day Travel Plan to San Francisco

### Accommodations (Airbnb)
Based on the search results, here are some highly-rated Airbnb options in San Francisco:

1. **Ocean-Front Home in Pacifica**
   - Description: Stunning ocean views with modern amenities.
   - [Link](https://www.timeout.com/san-francisco/hotels/best-airbnb-san-francisco-rentals)

2. **Bernal Heights Studio**
   - Description: Cozy and private studio in a quiet neighborhood.
   - [Link](https://www.timeout.com/san-francisco/hotels/best-airbnb-san-francisco-rentals)

3. **Contemporary Villa on Mount Sutro**
   - Description: Modern villa with panoramic city views.
   - [Link](https://www.timeout.com/san-francisco/hotels/best-airbnb-san-francisco-rentals)

4. **Minimalist Suite in Outer Sunset**
   - Description: Simple and elegant suite near the beach.
   - [Link](https://www.cntraveler.com/gallery/best-airbnbs-in-san-francisco)

5. **Guest Suite in Outer Sunset**
   - Description: Comfortable and spacious guest suite close to the beach.
   - [Link](https://www.airbnb.com/san-francisco-ca/stays)

### Beaches to Visit
Given the preference for beaches, here are some top beach destinations in San Francisco:

1. **Baker Beach**
   - Description: Offers stunning views of the Golden Gate Bridge and is great for picnics and sunbathing.
   - Activities: Picnicking, walking, photography.

2. **Ocean Beach**
   - Description: A long stretch of beach popular for surfing and bonfires.
   - Activities: Surfing, beachcombing, bonfires.

3. **China Beach**
   - Description: A hidden gem with beautiful views and a more secluded atmosphere.
   - Activities: Sunbathing, picnicking.

4. **Crissy Field Beach**
   - Description: Located in the Presidio, it offers views of the Golden Gate Bridge and ample space for outdoor activities.
   - Activities: Walking, cycling, picnics.

### Bollywood Movie Theaters
Since you prefer Bollywood movies over Hollywood movies, here are some theaters that screen Bollywood movies in San Francisco:

1. **Cine Lounge Fremont 7**
   - Description: A popular theater for Bollywood films, located a short drive from San Francisco.
   - [Link](https://www.cinelounge.net)

2. **Towne 3 Cinemas**
   - Description: Located in San Jose, this theater often screens Bollywood movies.
   - [Link](https://www.towne3.com)

3. **Naz 8 Cinemas**
   - Description: Located in Fremont, known for screening the latest Bollywood films.
   - [Link](https://www.naz8.com)

### Restaurants to Dine At
Here are some renowned restaurants to enjoy diverse culinary experiences in San Francisco:

1. **Tadich Grill**
   - Cuisine: Seafood
   - Description: One of the oldest restaurants in San Francisco, famous for its seafood dishes.
   - [Link](https://www.tadichgrill.com)

2. **Zuni Café**
   - Cuisine: Mediterranean
   - Description: Known for its roast chicken and seasonal dishes.
   - [Link](https://www.zunicafe.com)

3. **Nopa**
   - Cuisine: Californian
   - Description: Offers a farm-to-table dining experience with a focus on organic ingredients.
   - [Link](https://www.nopasf.com)

4. **La Taqueria**
   - Cuisine: Mexican
   - Description: Famous for its Mission-style burritos and tacos.
   - [Link](https://www.lataqueriasf.com)

5. **Foreign Cinema**
   - Cuisine: American
   - Description: Combines dining with a unique experience of watching films in an outdoor courtyard.
   - [Link](https://www.foreigncinema.com)

@Dev-Khant Dev-Khant changed the title Intergrate mem0 Add support for retrieving user preferences and memories using Mem0 Aug 20, 2024
@theCyberTech theCyberTech self-assigned this Aug 30, 2024
@theCyberTech theCyberTech added the Under review Feature requests under review label Aug 30, 2024
joaomdmoura
joaomdmoura requested changes Sep 22, 2024
View reviewed changes
src/crewai/memory/contextual/contextual_memory.py
)
return f"Entities:\n{formatted_results}" if em_results else ""

def _fetch_user_memories(self, query) -> str:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is never being called?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, there was a pending local commit for this. Pushed now.

@Dev-Khant
Copy link
Contributor Author

Hey @joaomdmoura @theCyberTech could you please add the Mem0 API key to the CI variables to enable the Mem0 tests to run?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joaomdmoura joaomdmoura joaomdmoura requested changes

Requested changes must be addressed to merge this pull request.

Assignees

@theCyberTech theCyberTech

Labels
Under review Feature requests under review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Dev-Khant @joaomdmoura @theCyberTech