From 5256e2441e020d6bcf106a25c101391318677756 Mon Sep 17 00:00:00 2001 From: Michael Bommarito Date: Sat, 9 Nov 2024 06:34:05 -0500 Subject: [PATCH] updated readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index e73eae1..8477f6b 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,9 @@ SOLI is an open, CC-BY licensed standard designed to represent universal element - Access detailed information about each class, including labels, definitions, and examples - Convert classes to OWL XML or Markdown format +## Changelog +The changelog can be found at [CHANGES.md](CHANGES.md). + ## Installation You can install the SOLI Python library using pip: @@ -58,6 +61,26 @@ for area in areas_of_law: print(area.label) ``` +## Searching with an LLM + +```python +# Search with an LLM +async def search_example(): + for result in await soli.parallel_search_by_llm( + "redline lease agreement", + search_sets=[ + soli.get_areas_of_law(max_depth=1), + soli.get_player_actors(max_depth=2), + ], + ): + print(result) + +import asyncio +asyncio.run(search_example()) +``` + +LLM search uses the `alea_llm_client` to provide abstraction across multiple APIs and providers. + ## Documentation For more detailed information about using the SOLI Python library, please refer to our [full documentation](https://soli-python.readthedocs.io/).