Query a graph
Experimental. Retrieves the graph records for a natural-language question about a graph with a read-only retrieval loop. By default, the response has the retrieved records and no answer. Set generate_answer to true to also get an answer that a model writes from the records, with the cited graph items. Set stream to true to get the retrieval calls as server-sent events. The default mode is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. The operation is experimental and in closed release. Zep enables the operation only for select accounts. The request, the response, the events, and the modes of the operation can change. A request from an account without access returns 404 not_found. To get access, contact support@getzep.com.
Authentication
Type “Api-Key” followed by a space and the project API key.
Request
The natural-language question about the graph.
When true, return the retrieval calls as server-sent events.
When true, a model also writes an answer from the retrieved records. The default is false: the response has the records and no answer.
The retrieval mode. The default is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep.
Response
The answer with citation handles removed. Present only when the request sets generate_answer to true.