Python SDK for Exa API.
Project description
Exa
Exa (formerly Metaphor) API in Python
Note: This API is basically the same as metaphor-python but reflects new
features associated with Metaphor's rename to Exa. New site is https://exa.ai
Installation
pip install exa_py
Usage
Import the package and initialize the Exa client with your API key:
from exa_py import Exa
exa = Exa(api_key="your-api-key")
Common requests
# basic search
results = exa.search("This is a Exa query:")
# autoprompted search
results = exa.search("autopromptable query", use_autoprompt=True)
# keyword search (non-neural)
results = exa.search("Google-style query", type="keyword")
# search with date filters
results = exa.search("This is a Exa query:", start_published_date="2019-01-01", end_published_date="2019-01-31")
# search with domain filters
results = exa.search("This is a Exa query:", include_domains=["www.cnn.com", "www.nytimes.com"])
# search and get text contents
results = exa.search_and_contents("This is a Exa query:")
# search and get highlights
results = exa.search_and_contents("This is a Exa query:", highlights=True)
# search and get contents with contents options
results = exa.search_and_contents("This is a Exa query:",
text={"include_html_tags": True, "max_characters": 1000},
highlights={"highlights_per_url": 2, "num_sentences": 1, "query": "This is the highlight query:"})
# find similar documents
results = exa.find_similar("https://example.com")
# find similar excluding source domain
results = exa.find_similar("https://example.com", exclude_source_domain=True)
# find similar with contents
results = exa.find_similar_and_contents("https://example.com", text=True, highlights=True)
# get text contents
results = exa.get_contents(["urls"])
# get highlights
results = exa.get_contents(["urls"], highlights=True)
# get contents with contents options
results = exa.get_contents(["urls"],
text={"include_html_tags": True, "max_characters": 1000},
highlights={"highlights_per_url": 2, "num_sentences": 1, "query": "This is the highlight query:"})
# basic answer
response = exa.answer("This is a query to answer a question")
# answer with full text, using the exa-pro model (sends 2 expanded quries to exa search)
response = exa.answer("This is a query to answer a question", text=True, model="exa-pro")
# answer with streaming
response = exa.stream_answer("This is a query to answer:")
# Print each chunk as it arrives when using the stream_answer method
for chunk in response:
print(chunk, end='', flush=True)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
exa_py-1.8.9.tar.gz
(13.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
exa_py-1.8.9-py3-none-any.whl
(12.4 kB
view details)
File details
Details for the file exa_py-1.8.9.tar.gz.
File metadata
- Download URL: exa_py-1.8.9.tar.gz
- Upload date:
- Size: 13.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
03d9e31c71f86827007b5db581d02c808d88a7aaba1ad8422fc4425aabbaeb46
|
|
| MD5 |
47ccbf5697d6c19cd4c45a111a3a1972
|
|
| BLAKE2b-256 |
956362c208d54e195013a2b5c9b1439942b4afc69f95ad0815fe9a51d36a2383
|
File details
Details for the file exa_py-1.8.9-py3-none-any.whl.
File metadata
- Download URL: exa_py-1.8.9-py3-none-any.whl
- Upload date:
- Size: 12.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d3abe8f21d116dcfc59c9619f8ddc29fea171733500ed5a1050ac5d1675d973
|
|
| MD5 |
1f6819a211284ba2bdd8ed5ae70ca341
|
|
| BLAKE2b-256 |
ffe8fdbd91e6eb01aa38ae63a4ef16cb63b9bd467d105d3f81601439c7e0bab8
|
