Search Graph | Zep Documentation

1 from zep_cloud.client 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 "valid_at": "valid_at" 19 } 20 ], 21 "episodes": [ 22 { 23 "content": "content", 24 "created_at": "created_at", 25 "uuid": "uuid", 26 "processed": true, 27 "role": "role", 28 "role_type": "norole", 29 "session_id": "session_id", 30 "source": "text", 31 "source_description": "source_description" 32 } 33 ], 34 "nodes": [ 35 { 36 "created_at": "created_at", 37 "name": "name", 38 "summary": "summary", 39 "uuid": "uuid", 40 "attributes": { 41 "key": "value" 42 }, 43 "labels": [ 44 "labels" 45 ] 46 } 47 ] 48 }

Perform a graph search query.

Request

This endpoint expects an object.

querystringRequired<=256 characters

The string to search for (required)

center_node_uuidstringOptional

Node to rerank around for node distance reranking

group_idstringOptional

one of user_id or group_id must be provided

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

one of user_id or group_id must be provided

Response

Graph search results

edgeslist of objectsOptional

episodeslist of objectsOptional

nodeslist of objectsOptional

Request

Response

Errors