From e42110f7206a9efe44ad521a49023a8d89b7cdf7 Mon Sep 17 00:00:00 2001 From: Danny McAteer Date: Sun, 25 Feb 2024 21:53:47 -0500 Subject: [PATCH] docs: Additional examples for partners/exa README (#18081) **Description:** Add additional examples for other modules to partners/exa README **Issue:** #17545 **Dependencies:** None **Twitter handle:** @DannyMcAteer8 --------- Co-authored-by: Daniel McAteer Co-authored-by: Daniel McAteer --- libs/partners/exa/README.md | 42 +++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/libs/partners/exa/README.md b/libs/partners/exa/README.md index 0b5c089078..e0bcfa223d 100644 --- a/libs/partners/exa/README.md +++ b/libs/partners/exa/README.md @@ -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) ``` \ No newline at end of file