Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mjbommar committed Nov 9, 2024
1 parent 98d91ee commit 5256e24
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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/).
Expand Down

0 comments on commit 5256e24

Please sign in to comment.