<commit_before># Algolia Search API Client for Laravel

[Algolia Search](https://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.

[![Build Status](https://img.shields.io/travis/algolia/algoliasearch-laravel/master.svg?style=flat)](https://travis-ci.org/algolia/algoliasearch-laravel)
[![Latest Version](https://img.shields.io/github/release/algolia/algoliasearch-laravel.svg?style=flat)](https://github.com/algolia/algoliasearch-laravel/releases)
[![License](https://img.shields.io/packagist/l/algolia/algoliasearch-laravel.svg?style=flat)](https://packagist.org/packages/algolia/algoliasearch-laravel)


This PHP package integrates the Algolia Search API to the Laravel Eloquent ORM. It's based on the [algoliasearch-client-php](https://github.com/algolia/algoliasearch-client-php) package.

**Note:** If you're using Laravel 4, checkout the [algoliasearch-laravel-4](https://github.com/algolia/algoliasearch-laravel-4) repository.




## API Documentation

You can find the full reference on the [Algolia's website](https://www.algolia.com/doc/api-client/laravel/).


## Table of Contents


1. **[Install](#install)**

    * [Install via composer](#install-via-composer)
    * [Service provider](#service-provider)
    * [Publish vendor](#publish-vendor)

1. **[Quick Start](#quick-start)**

    * [Quick Start](#quick-start)
    * [Ranking & Relevance](#ranking--relevance)
    * [Frontend Search (realtime experience)](#frontend-search-realtime-experience)
    * [Backend Search](#backend-search)

1. **[Options](#options)**

    * [Auto-indexing & Asynchronism](#auto-indexing--asynchronism)
    * [Custom Index Name](#custom-index-name)
    * [Per-environment Indexes](#per-environment-indexes)
    * [Custom `objectID`](#custom-objectid)
    * [Restrict Indexing to a Subset of Your Data](#restrict-indexing-to-a-subset-of-your-data)<commit_msg>Update README [skip ci] (#134)<commit_after># Algolia Search API Client for Laravel

[Algolia Search](https://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.

[![Build Status](https://img.shields.io/travis/algolia/algoliasearch-laravel/master.svg?style=flat)](https://travis-ci.org/algolia/algoliasearch-laravel)
[![Latest Version](https://img.shields.io/github/release/algolia/algoliasearch-laravel.svg?style=flat)](https://github.com/algolia/algoliasearch-laravel/releases)
[![License](https://img.shields.io/packagist/l/algolia/algoliasearch-laravel.svg?style=flat)](https://packagist.org/packages/algolia/algoliasearch-laravel)


This PHP package integrates the Algolia Search API to the Laravel Eloquent ORM. It's based on the [algoliasearch-client-php](https://github.com/algolia/algoliasearch-client-php) package.

**Note:** If you're using Laravel 4, checkout the [algoliasearch-laravel-4](https://github.com/algolia/algoliasearch-laravel-4) repository.




## API Documentation

You can find the full reference on [Algolia's website](https://www.algolia.com/doc/api-client/laravel/).


## Table of Contents


1. **[Install](#install)**

    * [Install via composer](#install-via-composer)
    * [Service provider](#service-provider)
    * [Publish vendor](#publish-vendor)

1. **[Quick Start](#quick-start)**

    * [Quick Start](#quick-start)
    * [Ranking & Relevance](#ranking--relevance)
    * [Frontend Search (realtime experience)](#frontend-search-realtime-experience)
    * [Backend Search](#backend-search)

1. **[Options](#options)**

    * [Auto-indexing & Asynchronism](#auto-indexing--asynchronism)
    * [Custom Index Name](#custom-index-name)
    * [Per-environment Indexes](#per-environment-indexes)
    * [Custom `objectID`](#custom-objectid)
    * [Restrict Indexing to a Subset of Your Data](#restrict-indexing-to-a-subset-of-your-data)
{'fraction_non_alphanumeric': 0.1564660691421255, 'fraction_numerical': 0.0038412291933418692, 'mean_word_length': 5.08411214953271, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 20, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1901522', 'n_tokens_mistral': 1338, 'n_tokens_neox': 1240, 'n_words': 236}