Skip to content

Commit

Permalink
docs: Additional examples for partners/exa README (langchain-ai#18081)
Browse files Browse the repository at this point in the history
**Description:** Add additional examples for other modules to
partners/exa README
**Issue:** langchain-ai#17545
**Dependencies:** None
**Twitter handle:** @DannyMcAteer8

---------

Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MBP.attlocal.net>
Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MacBook-Pro.local>
  • Loading branch information
3 people authored and joakimeriksson committed Feb 26, 2024
1 parent 43e1aba commit 1e6c79a
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions libs/partners/exa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,46 @@ results = exa.get_relevant_documents(query="What is the capital of France?")

# Print the results
print(results)
```

## Exa Search Results

You can run the ExaSearchResults module as follows

```python
from langchain_exa import ExaSearchResults

# Initialize the ExaSearchResults tool
search_tool = ExaSearchResults(exa_api_key="YOUR API KEY")

# Perform a search query
search_results = search_tool._run(
query="When was the last time the New York Knicks won the NBA Championship?",
num_results=5,
text_contents_options=True,
highlights=True
)

print("Search Results:", search_results)
```

## Exa Find Similar Results

You can run the ExaFindSimilarResults module as follows

```python
from langchain_exa import ExaFindSimilarResults

# Initialize the ExaFindSimilarResults tool
find_similar_tool = ExaFindSimilarResults(exa_api_key="YOUR API KEY")

# Find similar results based on a URL
similar_results = find_similar_tool._run(
url="http://espn.com",
num_results=5,
text_contents_options=True,
highlights=True
)

print("Similar Results:", similar_results)
```

0 comments on commit 1e6c79a

Please sign in to comment.