Skip to content

Commit

Permalink
docs: small formatting fixes (#427)
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanhalliday committed Feb 12, 2024
1 parent 155b1a1 commit adf7c5f
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/examples/action_items.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ In this guide, we'll walk through how to extract action items from meeting trans

!!! tips "Motivation"

Significant amount of time is dedicated to meetings, where action items are generated as the actionable outcomes of these discussions. Automating the extraction of action items can save time and guarantee that no critical tasks are overlooked.
Significant amount of time is dedicated to meetings, where action items are generated as the actionable outcomes of these discussions. Automating the extraction of action items can save time and guarantee that no critical tasks are overlooked.

## Defining the Structures

Expand Down
3 changes: 2 additions & 1 deletion docs/examples/entity_resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
In this guide, we demonstrate how to extract and resolve entities from a sample legal contract. Then, we visualize these entities and their dependencies as an entity graph. This approach can be invaluable for legal tech applications, aiding in the understanding of complex documents.

!!! tips "Motivation"
Legal contracts are full of intricate details and interconnected clauses. Automatically extracting and visualizing these elements can make it easier to understand the document's overall structure and terms.

Legal contracts are full of intricate details and interconnected clauses. Automatically extracting and visualizing these elements can make it easier to understand the document's overall structure and terms.

## Defining the Data Structures

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this example, we will demonstrate how to leverage the `MultiTask` and `enum.E

The `Search` class is a Pydantic model that defines the structure of the search query. It has three fields: `title`, `query`, and `type`. The `title` field is the title of the request, the `query` field is the query to search for relevant content, and the `type` field is the type of search. The `execute` method is used to execute the search query.

```python hl_line
```python
import instructor
from openai import OpenAI
from typing import Iterable
Expand Down

0 comments on commit adf7c5f

Please sign in to comment.