rlugojr / algoliasearch-client-python

Algolia Search API Client for Python

Algolia Search API Client for Python

Algolia Search is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke. The Algolia Search API Client for Python lets you easily use the Algolia Search REST API from your Python code.

We implemented an asynchronous version of the client that may suit your need if you are using a framework such as aiohttp in your backend. This version can be found here.

API Documentation

You can find the full reference on Algolia's website.

Table of Contents

1. Install

2. Quick Start

   • Initialize the client
   • Push data
   • Search
   • Configure
   • Frontend search

3. Getting Help

Getting Started

Install

Install AlgoliaSearch using pip:

pip install --upgrade algoliasearch

Quick Start

In 30 seconds, this quick start tutorial will show you how to index and search objects.

Initialize the client

You first need to initialize the client. For that you need your Application ID and API Key. You can find both of them on your Algolia account.

from algoliasearch import algoliasearch

client = algoliasearch.Client("YourApplicationID", 'YourAPIKey')

Note: If you use this API Client with Google AppEngine (Thanks @apassant), it will use urlfetch instead of using the request module. Please be aware of urlfetch's limits, and note that SSL certificates will not be verified for calls to domains other than algolia.net due to the lack of SNI support in urlfetch. To run unit tests on the AppEngine stub, please define an APPENGINE_RUNTIME enviroment variable.

Push data

Without any prior configuration, you can start indexing 500 contacts in the contacts index using the following code:

index = client.init_index("contact")
batch = json.load(open('contacts.json'))
index.add_objects(batch)

Search

You can now search for contacts using firstname, lastname, company, etc. (even with typos):

# search by firstname
print index.search("jimmie")
# search a firstname with typo
print index.search("jimie")
# search for a company
print index.search("california paint")
# search for a firstname & company
print index.search("jimmie paint")

Configure

Settings can be customized to tune the search behavior. For example, you can add a custom sort by number of followers to the already great built-in relevance:

index.set_settings({"customRanking": ["desc(followers)"]})

You can also configure the list of attributes you want to index by order of importance (first = most important):

Note: Since the engine is designed to suggest results as you type, you'll generally search by prefix. In this case the order of attributes is very important to decide which hit is the best:

index.set_settings({"searchableAttributes": ["lastname", "firstname", "company",
                                         "email", "city", "address"]})

Frontend search

Note: If you are building a web application, you may be more interested in using our JavaScript client to perform queries.

It brings two benefits:

• Your users get a better response time by not going through your servers
• It will offload unnecessary tasks from your servers

<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
<script>
var client = algoliasearch('ApplicationID', 'apiKey');
var index = client.initIndex('indexName');

// perform query "jim"
index.search('jim', searchCallback);

// the last optional argument can be used to add search parameters
index.search(
  'jim', {
    hitsPerPage: 5,
    facets: '*',
    maxValuesPerFacet: 10
  },
  searchCallback
);

function searchCallback(err, content) {
  if (err) {
    console.error(err);
    return;
  }

  console.log(content);
}
</script>

Getting Help

• Need help? Ask a question to the Algolia Community or on Stack Overflow.
• Found a bug? You can open a GitHub issue.