# exa-py (Beta)
For the official, stable version of Exa's Python SDK, please go to https://pypi.org/project/exa-py/
## Installation
```bash
pip install exa-py-beta
```
## Usage
Import the package and initialize the Exa client with your API key:
```python
from exa_py import Exa
exa = Exa(api_key="your-api-key")
```
## Common requests
```python
# 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
)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/exa-labs/exa-py-beta",
"name": "exa-py-beta",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Exa",
"author_email": "hello@exa.ai",
"download_url": "https://files.pythonhosted.org/packages/fa/fc/83c9ad4e71319630b36e8ac3e417ab54c3b7117d3252967a43e17c3f34bc/exa_py_beta-1.0.16b2.tar.gz",
"platform": null,
"description": "# exa-py (Beta)\n\nFor the official, stable version of Exa's Python SDK, please go to https://pypi.org/project/exa-py/\n\n## Installation\n\n```bash\npip install exa-py-beta\n```\n\n## Usage\n\nImport the package and initialize the Exa client with your API key:\n\n```python\nfrom exa_py import Exa\n\nexa = Exa(api_key=\"your-api-key\")\n```\n\n## Common requests\n\n```python\n\n # basic search\n results = exa.search(\"This is a Exa query:\")\n\n # autoprompted search\n results = exa.search(\"autopromptable query\", use_autoprompt=True)\n\n # keyword search (non-neural)\n results = exa.search(\"Google-style query\", type=\"keyword\")\n\n # search with date filters\n results = exa.search(\"This is a Exa query:\", start_published_date=\"2019-01-01\", end_published_date=\"2019-01-31\")\n\n # search with domain filters\n results = exa.search(\"This is a Exa query:\", include_domains=[\"www.cnn.com\", \"www.nytimes.com\"])\n\n # search and get text contents\n results = exa.search_and_contents(\"This is a Exa query:\")\n\n # search and get highlights\n results = exa.search_and_contents(\"This is a Exa query:\", highlights=True)\n\n # search and get contents with contents options\n results = exa.search_and_contents(\"This is a Exa query:\",\n text={\"include_html_tags\": True, \"max_characters\": 1000},\n highlights={\"highlights_per_url\": 2, \"num_sentences\": 1, \"query\": \"This is the highlight query:\"},\n livecrawl=\"always\" # livecrawl options: 'never', 'fallback', 'always'\n filter_empty_results=True # boolean; default True\n )\n\n\n # find similar documents\n results = exa.find_similar(\"https://example.com\")\n\n # find similar excluding source domain\n results = exa.find_similar(\"https://example.com\", exclude_source_domain=True)\n\n # find similar with contents\n results = exa.find_similar_and_contents(\"https://example.com\",\n text=True,\n highlights=True,\n livecrawl=\"always\" # livecrawl options: 'never', 'fallback', 'always'\n filter_empty_results=False # boolean; default False\n )\n\n # get text contents\n results = exa.get_contents([\"ids\"])\n\n # get highlights\n results = exa.get_contents([\"ids\"], highlights=True)\n\n # get contents with contents options\n results = exa.get_contents([\"ids\"],\n text={\"include_html_tags\": True, \"max_characters\": 1000},\n highlights={\"highlights_per_url\": 2, \"num_sentences\": 1, \"query\": \"This is the highlight query:\"},\n livecrawl=\"always\" # livecrawl options: 'never', 'fallback', 'always'\n filter_empty_results=True # boolean; default True\n )\n```\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "[Beta] Python SDK for Exa API.",
"version": "1.0.16b2",
"project_urls": {
"Homepage": "https://github.com/exa-labs/exa-py-beta"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8dbf8355e4288d8eda0e1ebda43cff8495efb7ce51ace5481c4d107a04b7fad",
"md5": "4e9621d339ed678d93a5ec50d59f4ab6",
"sha256": "0e48c0dd7904c1a2ba1f2148bfecef4296eab7599ead2ef4bd374c4a1fd5cb66"
},
"downloads": -1,
"filename": "exa_py_beta-1.0.16b2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e9621d339ed678d93a5ec50d59f4ab6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9210,
"upload_time": "2024-07-25T21:22:57",
"upload_time_iso_8601": "2024-07-25T21:22:57.255820Z",
"url": "https://files.pythonhosted.org/packages/f8/db/f8355e4288d8eda0e1ebda43cff8495efb7ce51ace5481c4d107a04b7fad/exa_py_beta-1.0.16b2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fafc83c9ad4e71319630b36e8ac3e417ab54c3b7117d3252967a43e17c3f34bc",
"md5": "071e8307e4d459ecd3db7f213fe862d2",
"sha256": "e6b9d5e58e11735e700fddb1139bbe13c08aaca4fcaf67d2136529e33452acb2"
},
"downloads": -1,
"filename": "exa_py_beta-1.0.16b2.tar.gz",
"has_sig": false,
"md5_digest": "071e8307e4d459ecd3db7f213fe862d2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9856,
"upload_time": "2024-07-25T21:22:59",
"upload_time_iso_8601": "2024-07-25T21:22:59.105102Z",
"url": "https://files.pythonhosted.org/packages/fa/fc/83c9ad4e71319630b36e8ac3e417ab54c3b7117d3252967a43e17c3f34bc/exa_py_beta-1.0.16b2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-25 21:22:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "exa-labs",
"github_project": "exa-py-beta",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "exa-py-beta"
}
JSON
