[Beta] Python SDK for Exa API.
Project description
exa-py (Beta)
For the official, stable version of Exa's Python SDK, please go to https://pypi.org/project/exa-py/
Installation
pip install exa-py-beta
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:"},
livecrawl="always" # livecrawl options: 'never', 'fallback', 'always'
filter_empty_results=True # boolean; default True
)
# 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,
livecrawl="always" # livecrawl options: 'never', 'fallback', 'always'
filter_empty_results=False # boolean; default False
)
# 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:"},
livecrawl="always" # livecrawl options: 'never', 'fallback', 'always'
filter_empty_results=True # boolean; default True
)
Project details
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_beta-1.0.16b2.tar.gz
(9.9 kB
view details)
Built Distribution
File details
Details for the file exa_py_beta-1.0.16b2.tar.gz
.
File metadata
- Download URL: exa_py_beta-1.0.16b2.tar.gz
- Upload date:
- Size: 9.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6b9d5e58e11735e700fddb1139bbe13c08aaca4fcaf67d2136529e33452acb2 |
|
MD5 | 071e8307e4d459ecd3db7f213fe862d2 |
|
BLAKE2b-256 | fafc83c9ad4e71319630b36e8ac3e417ab54c3b7117d3252967a43e17c3f34bc |
File details
Details for the file exa_py_beta-1.0.16b2-py3-none-any.whl
.
File metadata
- Download URL: exa_py_beta-1.0.16b2-py3-none-any.whl
- Upload date:
- Size: 9.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e48c0dd7904c1a2ba1f2148bfecef4296eab7599ead2ef4bd374c4a1fd5cb66 |
|
MD5 | 4e9621d339ed678d93a5ec50d59f4ab6 |
|
BLAKE2b-256 | f8dbf8355e4288d8eda0e1ebda43cff8495efb7ce51ace5481c4d107a04b7fad |