This external adapter downloads image bytes from IPFS given the content hash and requests image moderation labels from the Amazon Rekognition cloud-based computer vision platform.
You will need an AWS account to be able to make requests to Amazon Rekognition. See Amazon's documentation for help on setting up an account.
Variable | Description | Example | |
---|---|---|---|
AWS_ACCESS_KEY_ID |
Required | The ID of your AWS access key | ABCDEFGABCDEFG |
AWS_SECRET_ACCESS_KEY |
Required | Your AWS secret access key | AbCdEfGaBcDeFgAbCdEfGaBcDeFg |
AWS_REGION |
Required | The AWS region you would like to use | eu-west-2 |
IPFS_GATEWAY_URL |
Required | The IPFS gateway you would like to use | ipfs.io |
IPFS_GATEWAY_SSL |
Optional | Access the gateway via SSL (https)? True/false (Default behaviour: true) | true |
hash
: The image's IPFS content hash
{
"jobRunID": 0,
"data": {
"ModerationLabels": [
{
"Confidence": 75.24210357666016,
"Name": "Suggestive",
"ParentName": ""
},
{
"Confidence": 75.24210357666016,
"Name": "Female Swimwear Or Underwear",
"ParentName": "Suggestive"
},
{
"Confidence": 74.70369720458984,
"Name": "Revealing Clothes",
"ParentName": "Suggestive"
}
],
"ModerationModelVersion": "4.0",
"result": "0,75,0,0,0"
},
"result": "0,75,0,0,0"
}
Install dependencies:
npm i
Run the local tests:
npm run test
Natively run the application (defaults to port 8080):
npm start
curl -X POST -H "content-type:application/json" "http://localhost:8080/" --data '{ "id": 0, "data": { "hash": "QmdT7hKV1EfuaXSAYa65KUZWJnxF96yRPZNS9WeG8gUsR2" } }'
If you wish to use Docker to run the adapter, you can build the image by running the following command:
docker build . -t external-adapter
Then run it with:
docker run -p 8080:8080 -it external-adapter:latest
After installing locally:
zip -r external-adapter.zip .
- In Lambda Functions, create function
- On the Create function page:
- Give the function a name
- Use Node.js 12.x for the runtime
- Choose an existing role or create a new one
- Click Create Function
- Under Function code, select "Upload a .zip file" from the Code entry type drop-down
- Click Upload and select the
external-adapter.zip
file - Handler:
- index.handler for REST API Gateways
- index.handlerv2 for HTTP API Gateways
- Add the environment variable (repeat for all environment variables):
- Key: API_KEY
- Value: Your_API_key
- Save
If using a HTTP API Gateway, Lambda's built-in Test will fail, but you will be able to externally call the function successfully.
- Click Add Trigger
- Select API Gateway in Trigger configuration
- Under API, click Create an API
- Choose HTTP API
- Select the security for the API
- Click Add
If using a REST API Gateway, you will need to disable the Lambda proxy integration for Lambda-based adapter to function.
- Click Add Trigger
- Select API Gateway in Trigger configuration
- Under API, click Create an API
- Choose REST API
- Select the security for the API
- Click Add
- Click the API Gateway trigger
- Click the name of the trigger (this is a link, a new window opens)
- Click Integration Request
- Uncheck Use Lamba Proxy integration
- Click OK on the two dialogs
- Return to your function
- Remove the API Gateway and Save
- Click Add Trigger and use the same API Gateway
- Select the deployment stage and security
- Click Add
- In Functions, create a new function, choose to ZIP upload
- Click Browse and select the
external-adapter.zip
file - Select a Storage Bucket to keep the zip in
- Function to execute: gcpservice
- Click More, Add variable (repeat for all environment variables)
- NAME: API_KEY
- VALUE: Your_API_key