googlevisionapibundle's Introduction

GoogleVisionApiBundle

GoogleVisionApiBundle is a Symfony2/3 Bundle for use the API Google Vision simply (https://cloud.google.com/vision/)

Installation

Via Composer

$ composer require headoo/google-vision-api-bundle

or in composer.json file

"headoo/google-vision-api-bundle": "dev-master"

public function registerBundles()
{
    return array(
        // ...
        new Headoo\GoogleVisionApiBundle\HeadooGoogleVisionApiBundle(),
        // ...
    );
}

Configuration

Configure the google api key in your config.yml :

headoo_google_vision_api:
    api_key: '%apikey%'

Usage

It works like a service. On a Controller you can call like this:

	$google_vision = $this->container->get('headoo_google_vision_api.helper');

You can use all detections functionality with 1 endpoint:

	$google_vision->vision($image, $type);

Your $image must be base64 encoded, or via an URL , or an absolute path.

Available $type are :

TYPE_UNSPECIFIED
FACE_DETECTION
LANDMARK_DETECTION
LOGO_DETECTION
LABEL_DETECTION
TEXT_DETECTION
SAFE_SEARCH_DETECTION
IMAGE_PROPERTIES
WEB_DETECTION

Return

You will receive an array with http_code, raw_response and a parsed_response.

http_code : Google Http Code Response (often 200 for OK, and 400 for error)
raw_response : Google Vision Api Response Raw, without manipulation
parsed_response : Parsed response with objects, easier to use for a PHP user.

Security

If you discover a security vulnerability , please email instead of using the issue tracker. All security vulnerabilities will be promptly addressed.

Standalone Test

How to test

clone repo : $ sudo git clone https://github.com/Headoo/GoogleVisionApiBundle.git
go into directory : $ cd GoogleVisionApiBundle/
install composer as explained here : https://getcomposer.org/download/
launch composer update : $ ./composer.phar update
modify headoo_google_vision_api.api_key in Tests/App/config.yml
launch test : $ ./vendor/phpunit/phpunit/phpunit

License

This Bundle is open-sourced software licensed under the MIT license

googlevisionapibundle's People

Contributors

Stargazers

Watchers

googlevisionapibundle's Issues

Web detection

Hello, nice to have web detection type too.
https://cloud.google.com/vision/docs/internet-detection

Add support for multiple features in single call

Hello,

I would suggest adding support for launching calls with multiple detection types, since some of them are free if used in conjunction with another. For example, Safe Search Detection is free with Label Detection or Crop Hints, which is free if used with Image Properties.

Check this link: https://cloud.google.com/vision/pricing#prices to better understand my point.

In order to achieve this I've changed the GoogleVisionApiHelper::_request() like this:

private function _request($base64Image, $types){
        
        if (empty($types)) {
            throw new \InvalidArgumentException('Type missing from request.');
        }
        
        $url    = $this->_url . $this->_api_key;
        $json   ='{
			  	"requests": [
					{
					  "image": {
					    "content":"' .$base64Image. '"
					  },
					  "features": [';
        
        $lastType = end($types);
        
        foreach ($types as $type) {
            
            $json .= '
                            {
                                "type": "' .$type. '",
                                "maxResults": 200
                            }';
            if ($type !== $lastType) {
                $json .= ',';
            }
        }
					 
        $json .= '    ]
					}
				]
			}';

        $data                       = $this->_makeCall($url,$json);
        $jsonResponse               = json_decode($data['raw_response']);
        
        if($data['http_code'] !== 200){
            $data['status']          = $jsonResponse->error->status;
            $data['message']         = $jsonResponse->error->message;
            $data['error']           = $jsonResponse->error;
            $data['parsed_response'] = [];
        }else{
            
            foreach ($types as $type) {
                $_type                  = strtolower($type);
                $_type                  = str_replace('_', ' ', $_type);
                $_type                  = ucwords($_type);
                $_type                  = str_replace(' ', '', $_type);
                $parseFunction          = '_parse' . $_type;
                $data['parsed_response'][$type] = $this->$parseFunction($jsonResponse->responses[0]);
            }

            $data['raw_response'] = $jsonResponse->responses;
        }

        return $data;
    }

Hope it helps!