List communities

GET

Lists all communities in the graph with pagination support.

Path parameters

collection_idstringRequired

The collection ID corresponding to the graph to get communities for.

Query parameters

offsetintegerOptional

Specifies the number of objects to skip. Defaults to 0.

limitintegerOptional

Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.

Response

Successful Response

resultslist of objects

total_entriesinteger

Errors

GET

1 from r2r import R2RClient
2 
3 client = R2RClient("http://localhost:7272")
4 # when using auth, do client.login(...)
5 
6 response = client.graphs.list_communities(collection_id="9fbe403b-c11c-5aae-8ade-ef22980c3ad1")

1 {
2   "results": [
3     {
4       "name": "name",
5       "summary": "summary",
6       "level": 1,
7       "findings": [
8         "findings"
9       ],
10       "id": 1,
11       "community_id": "community_id",
12       "collection_id": "collection_id",
13       "rating": 1.1,
14       "rating_explanation": "rating_explanation",
15       "description_embedding": [
16         1.1
17       ],
18       "attributes": {
19         "key": "value"
20       },
21       "created_at": "2024-01-15T09:30:00Z",
22       "updated_at": "2024-01-15T09:30:00Z"
23     }
24   ],
25   "total_entries": 1
26 }

Built with

1	from r2r import R2RClient
2
3	client = R2RClient("http://localhost:7272")
4	# when using auth, do client.login(...)
5
6	response = client.graphs.list_communities(collection_id="9fbe403b-c11c-5aae-8ade-ef22980c3ad1")

1	{
2	"results": [
3	{
4	"name": "name",
5	"summary": "summary",
6	"level": 1,
7	"findings": [
8	"findings"
9	],
10	"id": 1,
11	"community_id": "community_id",
12	"collection_id": "collection_id",
13	"rating": 1.1,
14	"rating_explanation": "rating_explanation",
15	"description_embedding": [
16	1.1
17	],
18	"attributes": {
19	"key": "value"
20	},
21	"created_at": "2024-01-15T09:30:00Z",
22	"updated_at": "2024-01-15T09:30:00Z"
23	}
24	],
25	"total_entries": 1
26	}