Skip to main content

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:"})

Project details


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.6.0.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

exa_py-1.6.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file exa_py-1.6.0.tar.gz.

File metadata

  • Download URL: exa_py-1.6.0.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for exa_py-1.6.0.tar.gz
Algorithm Hash digest
SHA256 eab27dbb1fa83023668b60f497852aaaf0890ab88827d9811f09395f2d49087c
MD5 bbe77be0826f4a8c2859bd35072ccaae
BLAKE2b-256 b7bda45aa993e755081ddd4ece195dcc6d65a4f1decc3dc09e56e671ac7b9231

See more details on using hashes here.

File details

Details for the file exa_py-1.6.0-py3-none-any.whl.

File metadata

  • Download URL: exa_py-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for exa_py-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a6a873212272f9430ba832e77ac4a1bd7923e806af30ecea40f750f88bb1896f
MD5 b6125e76b336beba5460cfc5398e6f49
BLAKE2b-256 459b1476923d145c864a0301fe71147a31b4b75d2eb1f61c768a99309a2be9ce

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page