Repository files navigation

⚠️ This client is deprecated⚠️

As of Enterprise Search version 7.13.0, we are directing users to the newEnterprise Search PHP Client anddeprecating this client.

This client will be compatible with all Enterprise Search 7.x releases, but will not be compatible with 8.x releases. Our development effort on this project willbe limited to bug fixes. All future enhancements will be focused on the Enterprise Search PHP Client.

Thank you! - Elastic

A first-party PHP client for building excellent, relevant search experiences withElastic App Search.

• Getting started
• Usage
• Development
• FAQ
• Contribute
• License

Using this client assumes that you have already an instance of Elastic App Search up and running.

You can find more information about Elastic App Search at :https://www.elastic.co/app-search.

You can install the client in your project by using composer:

composer require elastic/app-search

This client is versioned and released alongside App Search.

To guarantee compatibility, use the most recent version of this library within the major version of the corresponding App Search implementation.

For example, for App Search7.3, use7.3 of this library or above, but not8.0.

If you are using theSaaS version available on swiftype.com of App Search, you should use the version 7.5.x of the client.

To instantiate a new client you can use\Elastic\AppSearch\Client\ClientBuilder:

$apiEndpoint   ='http://localhost:3002/';$apiKey        ='private-XXXXXXXXXXXX';$clientBuilder = \Elastic\AppSearch\Client\ClientBuilder::create($apiEndpoint,$apiKey);$client =$clientBuilder->build();

Notes:

• The resulting client will be of type\Elastic\AppSearch\Client\Client

• You can find the API endpoint and your API key URL in the credentials sections of the App Search dashboard.

• You can use any type of API Key (private, public or admin). The client will throw an exception if you try to execute an action that is not authorized for the key used.

Most methods of the API require that you have access to an Engine.

To check if an Engine exists and retrieve its configuration, you can use theClient::getEngine method :

$engine =$client->getEngine('my-engine');

If the Engine does not exists yet, you can create it by using theClient::createEngine method :

$engine =$client->createEngine('my-engine','en');

The second parameter ($language) is optional. Set it tonull to apply theuniversal language.

Read more about language support.

You can use theClient::indexDocuments method to index some documents into the Engine:

$documents = [      ['id' =>'first-document','name' =>'Document name','description' =>'Document description'],      ['id' =>'other-document','name' =>'Other document name','description' =>'Other description'],    ];$indexingResults =$client->indexDocuments('my-engine',$documents);

The$indexingResults array will contain the result of the indexation of each documents. You should always check the content of the result.

Read more about document indexing.

You can use theClient::search method to search in your Engine:

$searchParams = ['page'  => ['current' =>1,'size' =>10]    ];$searchResponse =$client->search('my-engine','search text',$searchParams);

If you want to match all documents you can use and empty search query'' as second parameter ($queryText).

The$searchRequestParams parameter is optional and can be used to use advanced search features. Allowed params are :

The search response will contains at least a meta field and a results field as shown in this example:

['meta' => ['warnings' => [],'page' => ['current' =>1,'total_pages' =>1,'total_results' =>1,'size' =>10      ],'request_id' =>'feff7cf2359a6f6da84586969ef0ca89'    ],'results' => [      ['id' => ['raw' =>'first-document'],'name' => ['raw' =>'Document name'],'description' => ['raw' => ['Document description']      ]    ]  ]]

Code for the endpoints is generated automatically using a custom version ofOpenAPI Generator.

To regenerate endpoints, use the docker laucher packaged invendor/bin:

./vendor/bin/elastic-openapi-codegen.sh

The custom generator will be built and launched using the following Open API spec file :resources/api/api-spec.yml.

You can then commit and PR the modified api-spec file and your endpoints code files.

The client class and readme may be changed in some cases. Do not forget to include them in your commit!

If something is not working as expected, please open anissue.

Your best bet is to read thedocumentation.

You can checkout theElastic community discuss forums.

We welcome contributors to the project. Before you begin, a couple notes...

• Before opening a pull request, please create an issue todiscuss the scope of your proposal.
• Please write simple code and concise documentation, when appropriate.

Apache 2.0 ©Elastic

Thank you to all thecontributors!