Skip to main content

[Beta] Python SDK for Exa API.

Project description

exa-py (Beta)

For the official, stable version of Exa's Python SDK, please go to https://pypi.org/project/exa-py/

Installation

pip install exa-py-beta

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

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_beta-1.0.16b2.tar.gz (9.9 kB view hashes)

Uploaded Source

Built Distribution

exa_py_beta-1.0.16b2-py3-none-any.whl (9.2 kB view hashes)

Uploaded Python 3

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