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.3.1b0.tar.gz
(10.3 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.3.1b0.tar.gz.
File metadata
- Download URL: exa_py-1.3.1b0.tar.gz
- Upload date:
- Size: 10.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ca3ce00c9a884a216b306f32cd6c56d2a7a017597c92c8aa8d7ea7e992afc031
|
|
| MD5 |
27489124040b40fff9de6b92bbba9166
|
|
| BLAKE2b-256 |
cb51d07b753dcf76ce129ed6f8f9ce91e6a60042a55929baf7cd17a496acbbcb
|
File details
Details for the file exa_py-1.3.1b0-py3-none-any.whl.
File metadata
- Download URL: exa_py-1.3.1b0-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 |
00ed3d0986418e93a75920ef4568f1e165728e9cda6d4b5fc3e7556aafd36953
|
|
| MD5 |
bc6d4312fec782636b4b45218bfa528f
|
|
| BLAKE2b-256 |
13d1f6f304107403070ef09c33aae88cee10ebe80e105aab9735e88a7136dd4b
|
