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(
input_instructions=QUESTION,
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.12.4.tar.gz
(25.9 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.12.4-py3-none-any.whl
(31.8 kB
view details)
File details
Details for the file exa_py-1.12.4.tar.gz.
File metadata
- Download URL: exa_py-1.12.4.tar.gz
- Upload date:
- Size: 25.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
45475c3748c8be41db14bd16e8b7dad4e10eb41f6e327a163f24bf25faa7e3b6
|
|
| MD5 |
64741802783c8043dafb69a64c57fa9a
|
|
| BLAKE2b-256 |
b2ab5da4a4b2f93c15511e3feac1c4e61ac7072417b7d9edb99f8a440ae43bea
|
File details
Details for the file exa_py-1.12.4-py3-none-any.whl.
File metadata
- Download URL: exa_py-1.12.4-py3-none-any.whl
- Upload date:
- Size: 31.8 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 |
d41cad34dad3de4735cdb483cf4738036bbb66744e692cca1104b753d929f0e3
|
|
| MD5 |
0de8144f37e129da54f785eed02d83d6
|
|
| BLAKE2b-256 |
191e0742230702c5eefbb74890c686acdf9c1ac3d514ee71b9c720e42f71e8a4
|
