List graph ontology

GET

https://api.getzep.com/api/v2/graph/list-ontology

GET

/api/v2/graph/list-ontology

1 from zep_cloud.client import Zep
2 
3 client = Zep(
4     api_key="YOUR_API_KEY",
5 )
6 ontology = client.graph.list_ontology()
7 print("Entity types:", ontology.entity_types)
8 print("Edge types:", ontology.edge_types)

1 {
2   "edge_types": [
3     {
4       "description": "Represents a friendship relationship between two users in the social graph.",
5       "name": "Friendship",
6       "properties": [
7         {
8           "description": "The date when the friendship was established.",
9           "name": "since",
10           "type": "Text"
11         }
12       ],
13       "source_targets": [
14         {
15           "source": "User",
16           "target": "User"
17         }
18       ]
19     }
20   ],
21   "entity_types": [
22     {
23       "description": "A user entity representing a person in the social network.",
24       "name": "User",
25       "identity_properties": [
26         "user_id"
27       ],
28       "properties": [
29         {
30           "description": "The unique identifier for the user.",
31           "name": "user_id",
32           "type": "Text"
33         },
34         {
35           "description": "The user's full name.",
36           "name": "full_name",
37           "type": "Text"
38         },
39         {
40           "description": "The user's age in years.",
41           "name": "age",
42           "type": "Int"
43         },
44         {
45           "description": "Indicates if the user has a verified account.",
46           "name": "is_verified",
47           "type": "Boolean"
48         }
49       ]
50     }
51   ]
52 }

Retrieves the current entity and edge types configured for your graph.

See the full documentation for details.

Response

Current ontology

edge_typeslist of objectsOptional

entity_typeslist of objectsOptional

Errors

404

Not Found Error

500

Internal Server Error