Repository files navigation

Official Ruby API client forElastic Enterprise Search. Use this gem to integrate App Search and Workplace Search into your Ruby code.

Install theelastic-enterprise-search gem fromRubygems:

$ gem install elastic-enterprise-search

Or add it to your project's Gemfile:

gem'elastic-enterprise-search','VERSION'

The Enterprise Search client is implemented withelastic-transport as the HTTP layer, which usesFaraday. Faraday supports severaladapters and will useNet::HTTP by default. For optimal performance with the Enterprise Search API, we suggest using an HTTP library which supports persistent ("keep-alive") connections. For the standard Ruby implementation, this could beNet::HTTP::Persistent,patron orTyphoeus. For JRuby,Manticore is a great option as well. Require the library for the adapter in your code and then pass in the:adapter parameter to the client when you initialize it:

require'elastic-enterprise-search'require'faraday/net_http_persistent'client=Elastic::EnterpriseSearch::Client.new(adapter::net_http_persistent)

If an adapter is not specified, the client will try to auto-detect available libraries and use the best available HTTP client.

See the documentation for usage, code examples, configuring the client, and an API reference.

See code examples of usage for theEnterprise Search,App Search andWorkplace Search APIs.

We follow Ruby’s own maintenance policy and officially support all currently maintained versions perRuby Maintenance Branches.

SeeCONTRIBUTING.

This software is licensed under theApache 2 license. SeeNOTICE.