Set graph ontology | Zep Documentation

1 from zep_cloud.client import Zep 2 from zep_cloud.external_clients.ontology import EntityModel, EntityText, EdgeModel 3 from zep_cloud import EntityEdgeSourceTarget 4 from pydantic import Field 5 6 class Restaurant(EntityModel): 7 cuisine_type: EntityText = Field(description="The cuisine type", default=None) 8 9 class RestaurantVisit(EdgeModel): 10 restaurant_name: EntityText = Field(description="Restaurant name", default=None) 11 12 client = Zep( 13 api_key="YOUR_API_KEY", 14 ) 15 client.graph.set_ontology( 16 entities={ 17 "Restaurant": Restaurant, 18 }, 19 edges={ 20 "RESTAURANT_VISIT": ( 21 RestaurantVisit, 22 [EntityEdgeSourceTarget(source="User", target="Restaurant")] 23 ), 24 } 25 )

1 { 2 "message": "message" 3 }

Sets custom entity and edge types for your graph. This wrapper method provides a clean interface for defining your graph schema with custom entity and edge types.

See the full documentation for details.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

Request

This endpoint expects an object.

entitiesmap from strings to anyOptional

Dictionary mapping entity type names to their definitions

edgesmap from strings to anyOptional

Dictionary mapping edge type names to their definitions with source/target constraints

user_idslist of stringsOptional

Optional list of user IDs to apply ontology to

graph_idslist of stringsOptional

Optional list of graph IDs to apply ontology to

Response

Ontology set successfully

messagestring or null