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:")
# 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 contents with contents options
results = exa.search_and_contents("This is a Exa query:",
text={"include_html_tags": True, "max_characters": 1000})
# 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)
# get text contents
results = exa.get_contents(["tesla.com"])
# get contents with contents options
results = exa.get_contents(["urls"],
text={"include_html_tags": True, "max_characters": 1000})
# 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)
# research task example – answer a question with citations
# Example prompt & schema inspired by the TypeScript example.
QUESTION = (
"Summarize the history of San Francisco highlighting one or two major events "
"for each decade from 1850 to 1950"
)
OUTPUT_SCHEMA: Dict[str, Any] = {
"type": "object",
"required": ["timeline"],
"properties": {
"timeline": {
"type": "array",
"items": {
"type": "object",
"required": ["decade", "notableEvents"],
"properties": {
"decade": {
"type": "string",
"description": 'Decade label e.g. "1850s"',
},
"notableEvents": {
"type": "string",
"description": "A summary of notable events.",
},
},
},
},
},
}
resp = exa.research.create_task(
instructions=QUESTION,
model="exa-research",
output_schema=OUTPUT_SCHEMA,
)
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.14.2.tar.gz
(28.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
exa_py-1.14.2-py3-none-any.whl
(35.7 kB
view details)
File details
Details for the file exa_py-1.14.2.tar.gz.
File metadata
- Download URL: exa_py-1.14.2.tar.gz
- Upload date:
- Size: 28.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b1b6e18949c33a60fd67a895b6eca4a1f48c49f085e67860d0eac60d6a6ec88e
|
|
| MD5 |
46fd4a274c2ba2b4ea5b81dcea955064
|
|
| BLAKE2b-256 |
e5e16171e246b8a5aa57a3f089aaa2a4f7d0f195abd65e27b042e700009d8b94
|
File details
Details for the file exa_py-1.14.2-py3-none-any.whl.
File metadata
- Download URL: exa_py-1.14.2-py3-none-any.whl
- Upload date:
- Size: 35.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
26aff3464d29eade1f45496b8cea8a7f4d11e886d2b5fd8f7c43b1692049047c
|
|
| MD5 |
8c9d4a872ea4e5228a6891c522f46418
|
|
| BLAKE2b-256 |
28bd23f7c0d93840a5c9a6ed5735dea5c4630a44e1d246b79a89bf50991df536
|
