diff --git a/README.md b/README.md index b72609b5b..35f230db6 100644 --- a/README.md +++ b/README.md @@ -110,12 +110,33 @@ poetry add cognee ## 💻 Usage +- Add a new piece of information to storage +``` +import cognee +cognee.add(data_path, file_name) +``` -```cognee.add()``` - Add a new piece of information to storage +- Use LLMs and cognee to create graphs + +``` +cognee.cognify(file_name) + ``` -```cognee.cognify() ``` - Use LLMs to create graphs +- Render the graph after adding your Graphistry credentials to .env -```cognee.search()``` - Query the graph for a piece of information +``` +graph_url = await render_graph(graph, graph_type = "networkx") +print(graph_url) +``` + +- Query the graph for a piece of information + +``` +query_params = { + SearchType.SIMILARITY: {'query': 'your search query here'} +} +cognee.search(graph, query_params) +``` ## Demo diff --git a/cognee/api/v1/search/search.py b/cognee/api/v1/search/search.py index 0655417b0..c128865ba 100644 --- a/cognee/api/v1/search/search.py +++ b/cognee/api/v1/search/search.py @@ -57,7 +57,7 @@ async def search(graph, query_params: Dict[SearchType, Dict[str, Any]]) -> List: # await graph_client.load_graph_from_file() # graph = graph_client.graph -# results = await complex_search(graph, query_params) +# results = await search(graph, query_params) # print(results) # asyncio.run(main())