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(["ids"])
# get highlights
results = exa.get_contents(["ids"], highlights=True)
# get contents with contents options
results = exa.get_contents(["ids"],
text={"include_html_tags": True, "max_characters": 1000},
highlights={"highlights_per_url": 2, "num_sentences": 1, "query": "This is the highlight query:"})
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.1.7.tar.gz
(10.4 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
File details
Details for the file exa_py-1.1.7.tar.gz.
File metadata
- Download URL: exa_py-1.1.7.tar.gz
- Upload date:
- Size: 10.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1f4666e7238e0fad5cfed864ad0ea0c39a444b7be32c53e695135e2238265189
|
|
| MD5 |
31f61d591c6a9b8069d15fe2edafbecb
|
|
| BLAKE2b-256 |
070fdbb932a078aa68d5b645e147fafc9348405b1f920ef0454b44d5a0dd321a
|
File details
Details for the file exa_py-1.1.7-py3-none-any.whl.
File metadata
- Download URL: exa_py-1.1.7-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a8d734ba8153614455e4f6035a29db19a3ef58dc62816a6d90da071dc179e4fd
|
|
| MD5 |
52c73f578a6acb7b5acf7d10aa02bd25
|
|
| BLAKE2b-256 |
8769cd17a77df669ead8139aca6e881fce9e1b040c53a2e6e998f07672b111d1
|
