Search Graph | Zep Documentation

1 from zep_cloud import Zep 2 3 client = Zep( 4 api_key="YOUR_API_KEY", 5 ) 6 client.graph.search( 7 query="query", 8 )

1 { 2 "edges": [ 3 { 4 "created_at": "created_at", 5 "fact": "fact", 6 "name": "name", 7 "source_node_uuid": "source_node_uuid", 8 "target_node_uuid": "target_node_uuid", 9 "uuid": "uuid", 10 "attributes": { 11 "key": "value" 12 }, 13 "episodes": [ 14 "episodes" 15 ], 16 "expired_at": "expired_at", 17 "invalid_at": "invalid_at", 18 "score": 1.1, 19 "valid_at": "valid_at" 20 } 21 ], 22 "episodes": [ 23 { 24 "content": "content", 25 "created_at": "created_at", 26 "uuid": "uuid", 27 "processed": true, 28 "role": "role", 29 "role_type": "norole", 30 "score": 1.1, 31 "session_id": "session_id", 32 "source": "text", 33 "source_description": "source_description" 34 } 35 ], 36 "nodes": [ 37 { 38 "created_at": "created_at", 39 "name": "name", 40 "summary": "summary", 41 "uuid": "uuid", 42 "attributes": { 43 "key": "value" 44 }, 45 "labels": [ 46 "labels" 47 ], 48 "score": 1.1 49 } 50 ] 51 }

Perform a graph search query.

Request

This endpoint expects an object.

querystringRequired<=400 characters

The string to search for (required)

bfs_origin_node_uuidslist of stringsOptional

Nodes that are the origins of the BFS searches

center_node_uuidstringOptional

Node to rerank around for node distance reranking

graph_idstringOptional

The graph_id to search in. When searching user graph, please use user_id instead.

limitintegerOptional<=50

The maximum number of facts to retrieve. Defaults to 10. Limited to 50.

min_fact_ratingdoubleOptional

The minimum rating by which to filter relevant facts

min_scoredoubleOptional

Deprecated

mmr_lambdadoubleOptional

weighting for maximal marginal relevance

rerankerenumOptional

Defaults to RRF

Allowed values:

scopeenumOptional

Defaults to Edges. Communities will be added in the future.

Allowed values:

search_filtersobjectOptional

Search filters to apply to the search

user_idstringOptional

The user_id when searching user graph. If not searching user graph, please use graph_id instead.

Response

Graph search results

edgeslist of objects or null

episodeslist of objects or null

nodeslist of objects or null

Request

Response

Errors