README

++++++++++++++++++++++++ Searchperience Api Client ++++++++++++++++++++++++

Author: Michael Klapper <michael.klapper@aoemedia.de>
Author: AOE media <dev@aoemedia.com>
Description: PHP Library to communicate with the searchperience RestFul API
Homepage: http://www.searchperience.com
Build status

Searchperience API Client basics ========================

Overview

The PHPApi client can be used to read and write entities from and to searchperience. The single entrypoint in your code is in the idea case the Factory class, that is able to create all repositories with all dependencies:

You can use them in a static context:

SearchperienceCommonFactory::get<Service>

will retrieve an instance of the repository that you want.

By now the following entities can be handles:

DocumentRepository (Documents):

The most important entity that represents every crawled or imported documents.

DocumentService:

Used to execute service operations on documents, like mark them for ReCrawling or ReIndexing

EnrichmentRepository (Enrichments):

RuleSets that can be used to "attach" data or boosting to documents based on matching rules. You can used them for example to attach searchterms to documents that do not contain them in there original data source.

UrlQueueItemRepository (UrlQueueItems)

Queue of the crawler that contains urls that should be crawled next or can not be crawled because they throw errors or are bloecked for some other reason.

UrlQueueStatusRepository (UrlQueueStatus):

Status information about the urlqueue.

Add or update documents -----------

$document = new \Searchperience\Api\Client\Domain\Document\Document();
$document->setContent('some content');
$document->setForeignId(12);
$document->setUrl('http://www.some.test/product/detail');
$document->setMimeType('text/xml');
$document->setSource('magento');

$documentRepository = \Searchperience\Common\Factory::getDocumentRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');
$documentRepository->add($document);

Get document from indexer -----------

Get documents by foreign id

$documentRepository = \Searchperience\Common\Factory::getDocumentRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');
$document = $documentRepository->getByForeignId(12);

Get documents by query and filters

$documentRepository = \Searchperience\Common\Factory::getDocumentRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');
$document = $documentRepository->getAllByFilters(
    0,
    10,
    array(
        'crawl' => array(
            'crawlStart' => new DateTime(),
            'crawlEnd' =>  new DateTime()
        ),
        'source' => array(
            'source' => 'magento'
        ),
        'query' => array(
            'queryString' => 'test',
            'queryFields' => 'id,url'
        ),
        'boostFactor' => array(
            'boostFactorEnd' => 123.00
        ),
        'pageRank' => array(
            'pageRankStart' => 0.00,
            'pageRankEnd' => 123.00
        ),
        'lastProcessed' => array(
            'processStart' =>  new DateTime(),
            'processEnd' =>  new DateTime()
        ),
        'notifications' => array(
            'isduplicateof' => false,
            'lasterror' => true,
            'processingthreadid' => true
        )
    )
);

Delete document from indexer -----------

$documentRepository = \Searchperience\Common\Factory::getDocumentRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');
$documentRepository->deleteByForeignId(12);

Get the status of the document repository from searchperience. ------------

You can retrieve a status object with the searchperience api to get the amount of all documents, deleted, processed, processing and document that have an error.

$documentStatusRepository = \Searchperience\Common\Factory::getDocumentStatusRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');
$status = $documentStatusRepository->get();
echo $status->getErrorCount();

Promotions

In Searchperience you are able to add special document types. One of them is the "Promotion" document. Depending on the setup of your instance the promotion is rendered in a special way in the frontend.

To create a promotion you can just instanciate am "Promotion" object instead of ad "Document" object and add/update/delete it with the document repository.

The promotion object has some promotion specific methods and creates the xml document that is send to searcperience in the conventional way.

$promotion = new Promotion();
$promotion->setPromotionTitle("Special discount");
$promotion->setPromotionContent("<hr/> This is our special offer");

$documentRepository = \Searchperience\Common\Factory::getDocumentRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');
$documentRepository->add($promotion);

UrlQueueItems -----------

$urlQueueItemRepository = \Searchperience\Common\Factory::getUrlQueueItemRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');
$firstTen = $urlQueueItemRepository->getAllByFilters(0,10);

UrlQueueStatus ------------

$urlQueueStatusRepository = \Searchperience\Common\Factory::getUrlQueueStatusRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');

$status = $urlQueueStatusRepository->get();

echo $status->getErrorCount();

The example above shows all documents that have an error.

Enrichments

$enrichmentRepository = \Searchperience\Common\Factory::getEnrichmentRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');

$enrichment = new Enrichment();
$enrichment->setTitle("test enrichment");

$matchingRule = new MatchingRule();
$matchingRule->setFieldname("brand_s");
$matchingRule->setOperator(MatchingRule::OPERATOR_CONTAINS);
$matchingRule->setOperandValue("aoe");

$enrichment->addMatchingRule($matchingRule);

$fieldEnrichment = new FieldEnrichment();
$fieldEnrichment->setFieldName('highboost_words_sm');
$fieldEnrichment->setContent('php');

$enrichment->addFieldEnrichment($fieldEnrichment);
$enrichment->setEnabled(true);

$enrichmentRepository->add($enrichment);

The example above shows the creation of an enrichment for a document that contains "aoe" in the brand and adds "php" as a word to the field "highboost_words_sm" that is configured as highly relevant for the search.

Synonyms

Sometimes it is useful to replace search terms with its synonyms on index or search time. In searchperience we provide an api to maintain these synonyms.

Depending on the project there can be multiple "instances" of synonym collections, to be able to handle multiple use cases. Each of this "instances" or "synonym collections" are represented by a tag.

You can use two types of Synonyms:

grouping - where all synonyms are interchangeable (e.g. by searching for one synonym, you effectively search for all)
mapping - where synonyms are replaced by mapped words (e.g. by searching fore a synonym, you effectively search for its mapped words)

Note:

Synonym field 'synonyms' is a string that can be written as a comm separated list
Synonym field 'mappedWords' is a string that can be written as a comm separated list

To figure out which synonym instances exist you can use the SynonymTagRepository to get them:

/* Return SynonymTagRepository, all tags related to synonyms */
$synonymTagRepository = \Searchperience\Common\Factory::getSynonymTagRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');
$allTags = $synonymTagRepository->getAll();
foreach($allTags as $tag) {
    var_dump($tag->getTagName());
}

Get synonyms:

/* initialization of synonym repository */
$synonymRepository = \Searchperience\Common\Factory::getSynonymRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');

/* get all, return synonyms collection for all existing tags */
$synonymRepository->getAll();

/* get all by tag name, return synonyms collection for defined tag name */
$synonymRepository->getAllByTagName("en");

/* get by synonyms, return synonym collection */
$synonymRepository->getBySynonyms("bike", "en");

When you push new Synonyms or Update existing once, you can instantiate a synonym object, with synonyms, tag and mapped words and push them:

$synonymRepository = \Searchperience\Common\Factory::getSynonymRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');

$synonym = new \Searchperience\Api\Client\Domain\Synonym\Synonym();
$synonym->setSynonyms("bike");
$synonym->setTagName("en");
$synonym->setMappedWords("bicycle");

$synonymRepository->add($synonym);

How to delete synonyms:

/* initialization of synonym repository */
$synonymRepository = \Searchperience\Common\Factory::getSynonymRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');

/* delete all */
$synonymRepository->deleteAll();

/* delete with synonym object */
$synonym = new \Searchperience\Api\Client\Domain\Synonym\Synonym();
$synonym->setSynonyms("bike");
$synonym->setTagName("en");
$synonymRepository->delete($synonym);

/* delete with synonyms */
$synonymRepository->deleteBySynonyms("bike", "en");

Stopwords

In searchperience we provide an api to maintain stopwords .

Depending on the project there can be multiple "instances" of stopwords collections, to be able to handle multiple use cases. Each of this "instances" or "stopwords collections" are represented by a tag .

To figure out which stopword instances exist you can use the StopwordTagRepository to get them:

/* Return StopwordTagRepository, all tags related to stopwords */
$stopwordTagRepository = \Searchperience\Common\Factory::getStopwordTagRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');
$allTags = $stopwordTagRepository->getAll();
foreach ($allTags as $tag) {
    var_dump($tag->getTagName());
}

Get stopwords:

/* initialization of stopword repository */
$stopwordRepository = \Searchperience\Common\Factory::getStopwordRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');

/* get all, return stopwords collection for all existing tags */
$stopwordRepository->getAll();

/* get all by tag name, return stopwords collection for defined tag name */
$stopwordRepository->getAllByTagName("en");

/* get by main word, return stopword collection */
$stopwordRepository->getByWord("apple", "en");

When you push new Stopword or Update existing once, you can instantiate a stopword object, with word and tag, and push them:

$stopwordRepository = \Searchperience\Common\Factory::getStopwordRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');

$stopword = new \Searchperience\Api\Client\Domain\Stopword\Stopword();
$stopword->setWord("apple");
$stopword->setTagName("en");
$stopwordRepository->add($stopword);

How to delete stopwords:

/* initialization of stopword repository */
$stopwordRepository = \Searchperience\Common\Factory::getStopwordRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');

/* delete all */
$stopwordRepository->deleteAll();

/* delete with stopword object */
$stopword = new \Searchperience\Api\Client\Domain\Stopword\Stopword();
$stopword->setWord("apple");
$stopword->setTagName("en");
$stopwordRepository->delete($stopword);

/* delete with word */
$stopwordRepository->deleteByWord("apple", "en");

Insights

Searchperience Insights provide overview information about various statistical data inside the system. Currently only TopsellerArtifact type is supported.

Usage example:

use Searchperience\Common\Factory;

$this->artifactTypeRepository = Factory::getArtifactTypeRepository(
    $this->apiEndpointUrl,
    $this->apiConfigurationName,
    $this->apiUser,
    $this->apiPassword
);

//get all artifact types
$artifactTypeCollection = $this->artifactTypeRepository->getAll();
$firstArtifactType = $artifactTypeCollection[0];

$this->artifactRepository = Factory::getArtifactRepository(
    $this->apiEndpointUrl,
    $this->apiConfigurationName,
    $this->apiUser,
    $this->apiPassword
);

//colllection of all artifact by given type
$artifactCollection = $this->artifactRepository->getAllByType($firstArtifactType);
//get first artifact
$firstArtifact = $artifactCollection[0];
$artifact = $this->artifactRepository->getOne($firstArtifact);

Bulk operation

In Searchperience API we added support of bulk operations over REST API. For example UrlQueueItems now support re-crawl/remove operations for multiple items at once:

Re-crawl multiple items:

use Searchperience\Common\Factory;
use Searchperience\Api\Client\Domain\Command\AddToUrlQueueCommand;

$this->commandExecutionService = Factory::getCommandExecutionService(
    $this->apiEndpointUrl,
    $this->apiConfigurationName,
    $this->apiUser,
    $this->apiPassword
);


$command = new AddToUrlQueueCommand();
$command->addDocumentId(1111);
$command->addDocumentId(2222);
$command->addDocumentId(3333);

$this->commandExecutionService->execute($command);

Delete multiple UrlQueueItems:

use Searchperience\Common\Factory;
use Searchperience\Api\Client\Domain\Command\RemoveFromCrawlerQueueCommand;

$this->commandExecutionService = Factory::getCommandExecutionService(
    $this->apiEndpointUrl,
    $this->apiConfigurationName,
    $this->apiUser,
    $this->apiPassword
);


$command = new RemoveFromCrawlerQueueCommand();
$command->addDocumentId(1);
$command->addDocumentId(2);
$command->addDocumentId(3);

$this->commandExecutionService->execute($command);

ReIndex multiple Documents:

use Searchperience\Common\Factory;
use Searchperience\Api\Client\Domain\Command\ReIndexCommand;

$this->commandExecutionService = Factory::getCommandExecutionService(
    $this->apiEndpointUrl,
    $this->apiConfigurationName,
    $this->apiUser,
    $this->apiPassword
);


$command = new ReIndexCommand();
$command->addDocumentId(1);
$command->addDocumentId(2);
$command->addDocumentId(3);

$this->commandExecutionService->execute($command);

AdminSearches

To maintain you search you can use the admin search. This endpoint will return you all admin search instances with a title, description and url.

You can use it in the following way:

use Searchperience\Common\Factory;

$adminSearchRepository = Factory::getAdminSearchRepository(
    $this->apiEndpointUrl,
    $this->apiConfigurationName,
    $this->apiUser,
    $this->apiPassword
);

$adminSearches = $adminSearchRepository->getAll();

Each adminSearch object provides an url, title and description.

Command Logs

Command logs provide you information about all indexer commands runs from logs table

You can use it in the following way:

use Searchperience\Common\Factory;

$commandLogRepository = Factory::getCommandLogRepository(
    $this->apiEndpointUrl,
    $this->apiConfigurationName,
    $this->apiUser,
    $this->apiPassword
);

$commandLogs = $commandLogRepository->getAllByFilters(0,10);

Get command logs by query and filters

$commandLogRepository = \Searchperience\Common\Factory::getCommandLogRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');
$commandLogs = $commandLogRepository->getAllByFilters(
    0,
    10,
    array(
        'time' => array(
            'startTime' => new DateTime(),
            'endTime'   => new DateTime()
        ),
        'duration' =>  array(
            'duration'     => 80, // in seconds, filter equal
            'durationFrom' => 60,
            'durationTo'   => 120,
        ),
        'query' => array(
            'queryString' => 'crawler',
            'queryFields' => 'processid,log,binary,command'
        ),
        'status' => array(
            'status' => "finished"
        ),
    )
);

Each $commandLogs object provides an command name, log message, binary, start and end time, execution time and status.

Activity Logs

Activity logs provide you information about all activitys

You can use it in the following way:

use Searchperience\Common\Factory;

$activityLogsRepository = Factory::getActivityLogsRepository(
    $this->apiEndpointUrl,
    $this->apiConfigurationName,
    $this->apiUser,
    $this->apiPassword
);

$activityLogs = $activityLogsRepository->getAllByFilters(0,10);

Get activity logs by query and filters

$activityLogsRepository = \Searchperience\Common\Factory::getActivityLogsRepository('http://api.searchperience.com/', 'customerKey', 'username', 'password');
$activityLogs = $activityLogsRepository->getAllByFilters(
    0,
    10,
    array(
        'sevirity' => array(
                'severityStart' => 1, 
                'severityEnd'   => 3
            ),
        'logTime'  => array(
                'logtimeStart'  => new DateTime(), 
                'logtimeEnd'    => new DateTime()
            ),
        'query'    => array(
                'queryString'   => 'LinkAnalyser',
                'queryFields'   => 'id,message,classname,methodname,processid,tag'
            ),
    )
);

Each $activityLogs object provides an id, message, processid, severity, classname, methodname, additionaldata, tag and logtime.

Option requests

API provides self-descriptive interface by sending OPTIONS requests for any specified(valid) route:

OPTIONS api.searchperience.me/###yourinstancename###

Example:

OPTIONS http://demo:demo@api.searchperience.me/###yourinstancename###/documents

<?xml version="1.0"?>
<api>
    <add>
        <link href="documents?mimeType=_mime_&amp;amp;content=_content_&amp;amp;foreignId=_foreignId_&amp;amp;generalPriority=_generalPriority_&amp;amp;temporaryPriority=_temporaryPriority_&amp;amp;source=_source_&amp;amp;url=_url_&amp;amp;noIndex=_noIndex_&amp;amp;isProminent=_isProminent_&amp;amp;boostFactor=_boostFactor_" title="Adds a document"/>
    </add>
    <get>
        <link href="documents" title="Get all documents. Also here can be used additional filters like: 'query', 'crawlStart', 'crawlEnd', 'boostFactorStart', 'boostFactorEnd', 'pageRankStart', 'pageRankEnd', 'processStart', 'processEnd', 'isduplicateof', 'lasterror', 'processingthreadid', 'queryFields'"/>
        <link href="documents?foreignId=xyz" title="Get document by foreignId. Usually max 1 document should be in result collection"/>
        <link href="documents?url=http://www.url.de/" title="Get document by Url. Usually max 1 document should be in result collection"/>
    </get>
    <delete>
        <link href="documents?source=foo" title="deletes a document by source"/>
    </delete>
</api>

Currently OPTIONS request supported by following routes:

/###yourinstancename###/documents
/###yourinstancename###/urlqueueitems
/###yourinstancename###/enrichments
/###yourinstancename###/status/urlqueue
/###yourinstancename###/status/document

Trouble shooting

There is a HTTP_DEBUG mode which can be easy enabled.

\Searchperience\Common\Factory::$HTTP_DEBUG = TRUE;

Installing via Composer

The recommended way to install Searchperience API client is through [Composer](http://getcomposer.org).

Add aoemedia/searchperience-api-client as a dependency in your project's composer.json file:

{
    "require": {
        "aoepeople/searchperience-api-client": "*"
    },
    "require-dev": {
        "guzzle/plugin-log": "*"
    }
}

Consider tightening your dependencies to a known version when deploying mission critical applications (e.g. 1.0.*).

Download and install Composer:

curl -s http://getcomposer.org/installer | php

Install your dependencies:

php composer.phar install

Require Composer's autoloader

Composer also prepares an autoload file that's capable of autoloading all of the classes in any of the libraries that it downloads. To use it, just add the following line to your code's bootstrap process:

require 'vendor/autoload.php';

You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at http://getcomposer.org.

aoemedia / searchperience-api-client

Maintainers

Details

README

Overview

Promotions

Enrichments

Synonyms

Stopwords

Insights

Bulk operation

AdminSearches

Command Logs

Activity Logs

Option requests

Trouble shooting

Installing via Composer