BI1 - README

Description

This project is designed to use the image analysis API from providers such as Google (Vision), Amazon (Rekognition) or Azure (AI Vision).

The user will be able to customize the output by passing an image, the maximum number of results and the minimum level of confidence.

This project also introduces the concept of BI (Business Intelligence) by converting image analysis data into a SQL file that will be stocked on the provider's cloud storage.

Getting started

Prerequisites

Tools with versions that were used to realize this project. Versions may be subject to change as the project was realized exclusively on MacOS system.

• IDE : Visual Studio Code 1.85.1
• Langages :
  • PHP 8.3.0
  • MySQL (from 11.1.3-MariaDB)
• Package Manager : Composer 2.4.4

Configuration

Env

Some data must remain private such as the API crendentials JSON file or bucket URI.

In order to do so, copy and rename the .env.example file.

• cp .env.example .env
• Open the file and fill the variables with your data

Database Model

In order to verify/test the conversion of the analyzed data to a SQL script :

• Open and run create_model.sql in your prefered SQL client to create the Database
• Run the sequence php index.php to analyze and generate
• Run the generated SQL file in your prefered SQL client

Deployment

Dependencies

Composer dependencies used to realize and test the project.

• Dev
  • google/apiclient : ^2.15
  • google/cloud-vision : ^1.7
  • google/cloud-storage : ^1.36
• Tests
  • phpunit/phpunit : ^10.5

To install the project

• Clone the repo locally

  • git clone https://github.com/ThomasGrossmann/BI1/
    cd BI1

• Install Composer dependencies
  • composer install

    To run the tests

• DataObject Tests
  • ./vendor/bin/phpunit tests/DataObjectTests.php
• LabelDetector Tests
  • ./vendor/bin/phpunit tests/LabelDetectorTests.php

    Directory structure

    ├── LICENSE
    ├── README.md
    ├── composer.json
    ├── composer.lock
    ├── create_model.sql
    ├── docs
    │   ├── RIA2.drawio
    │   └── RIA2.png
    ├── images
    │   ├── objectToRemove.jpeg
    │   └── sample.jpeg
    ├── index.php
    ├── src
    │   ├── GoogleDataObjectImpl.php
    │   ├── IDataObject.php
    │   ├── ILabelDetector.php
    │   ├── LabelDetectorImpl.php
    │   └── exceptions
    │       ├── ObjectAlreadyExistsException.php
    │       └── ObjectNotFoundException.php
    └── tests
    ├── DataObjectTest.php
    └── LabelDetectorTest.php

License

LICENSE

Contact

• Teams
• Email
• Create an issue in the repo