Groups

A user graph is tied to a specific user; a group graph is just like a user graph, except it is not tied to a specific user. It is best thought of as an “arbitrary graph” which, for example, can be used as memory for a group of users, or for a more complex use case.

For example, a group graph could store information about a company’s product, which you might not want to add to every user’s graph, because that would be redundant. And when your chatbot responds, it could utilize a memory context string from both that user’s graph as well as from the product group graph. See our cookbook on this for an example.

A more complicated use case could be to create a group graph which is used when a certain topic is mentioned as opposed to when certain users require a response. For instance, anytime any user mentions “pizza” in a chat, that could trigger a call to a group graph about pizza.

Creating a Group

group = client.group.add(
    group_id="some-group-id", 
    description="This is a description.", 
    name="Group Name"
)

Adding Data to a Group Graph

Adding data to a group graph requires using the graph.add method. Below is an example, and for more on this method, see Adding Data to the Graph and our SDK Reference.

client.graph.add(
    group_id=group_id,
    data="Hello world!",
    type="text",
)

Searching a Group Graph

Searching a group graph requires using the graph.search method. Below is an example, and for more on this method, see Searching the Graph and our SDK Reference.

search_results = client.graph.search(
    group_id=group_id,
    query="Banana",
    scope="nodes",
)

Deleting a Group

client.group.delete(group_id)