answear/wide-eyes-bundle

API Client for WideEyes.

3.0.0 2024-10-03 07:49 UTC

Requires

• php: ^8.2
• ext-json: *
• guzzlehttp/guzzle: ^7.0
• symfony/http-kernel: ^6.0|^7.0
• webmozart/assert: ^1.11

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.64
• phpro/grumphp: ^2.8
• phpstan/phpstan: ^1.12
• phpstan/phpstan-webmozart-assert: ^1.2
• phpunit/phpunit: ^10.5
• roave/security-advisories: dev-master
• symfony/phpunit-bridge: 6.4|^7.0

MIT

README

Wide Eyes integration for Symfony.
Documentation of the API can be found here: https://wideeyes.ai/.

Installation

• install with Composer

composer require answear/wide-eyes-bundle

Answear\WideEyesBundle\AnswearWideEyesBundle::class => ['all' => true],
should be added automatically to your config/bundles.php file by Symfony Flex.

Setup

• provide required config data: privateKey

# config/packages/answear_wide_eyes.yaml
answear_wide_eyes:
    publicKey: 'your_public_key'

config will be passed to \Answear\WideEyesBundle\Service\ConfigProvider class.

Usage

Similar recommendations

For similar recommendations use SimilarClient and its method getSimilar.

use Answear\WideEyesBundle\Service\SimilarClient;

$similarResponse = $similarClient->getSimilar('uid', 'country');

Your agruments are: uid - your unique id for product and country - country for which products your asking. In result you're getting SimilarResponse that has getUids method - with similar uids returned by api.

Search by image

For search by image use SearchByImageClient.

Detect and features

To detect products on image and find theirs features use detectAndFeatures

use Answear\WideEyesBundle\Service\SearchByImageClient;

$detectAndFeturesResponse = $searchByImageClient->getSimilar('url');

Your agrument is: url - url to the image on which you want to detect products and features. In result you're getting DetectAndFeaturesResponse that contains all detection returned by api.

Search by feature

To search products with previously found feature use searchByFeature

use Answear\WideEyesBundle\Service\SearchByImageClient;

$detectAndFeturesResponse = $searchByImageClient->searchByFeature('featureId', 'label', 'gender', 'filters', 'maxNumResults');

Your agruments are:

• featureId - featureId you got form DetectAndFeatures
• label - label you got form DetectAndFeatures
• gender - gender you got from DetectAndFeatures (optional)
• filters - result filters (optional)
• maxNumResults - maximal number of return products (optional)

In result you're getting SearchByFeatureResponse that contains all found products uids meeting your criteria.

Final notes

Feel free to open pull requests with new features, improvements or bug fixes. The Answear team will be grateful for any comments.