From acc488b5c3b6aa0aef1d973e6261724b86c4c71a Mon Sep 17 00:00:00 2001 From: API4AI Team Date: Thu, 18 Apr 2024 14:49:52 +0300 Subject: [PATCH] =?UTF-8?q?api4ai=20=E2=80=93=20Updated=20READMEs=20to=20c?= =?UTF-8?q?onform=20to=20guidelines.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- components/api4ai/README.md | 38 +++++++++++++++++-- .../alcohol-label-recognition/README.md | 28 ++++---------- .../actions/background-removal/README.md | 28 ++++---------- .../actions/brand-recognition/README.md | 28 ++++---------- .../car-image-background-removal/README.md | 28 ++++---------- .../README.md | 28 ++++---------- .../actions/image-anonymization/README.md | 28 ++++---------- .../actions/nsfw-image-recognition/README.md | 28 ++++---------- 8 files changed, 84 insertions(+), 150 deletions(-) diff --git a/components/api4ai/README.md b/components/api4ai/README.md index 9ef00a9eccd3d..d088b99522db5 100644 --- a/components/api4ai/README.md +++ b/components/api4ai/README.md @@ -1,11 +1,43 @@ # Overview -The api4ai API offers a suite of AI-powered image and video recognition services. Using this API, you can enhance Pipedream workflows with capabilities such as object detection, face recognition, and text extraction from images. It's a powerhouse for automations that require visual data interpretation, enabling you to analyze media, automate content categorization, or even create interactive user experiences. +API4AI offers a range of artificial intelligence solutions and APIs for diverse applications, including content moderation, image recognition, and text analysis. Built on a robust cloud technology stack, our APIs guarantee seamless operability, scalability, and reliable uptime. Our aim is to provide standalone AI solutions that effortlessly integrate into any application with minimal setup required. + +All [API4AI](https://api4.ai) APIs are subscription-based and managed through [RapidAPI](https://rapidapi.com/api4ai-api4ai-default). + + +👉ī¸ī¸ Website: https://api4.ai +📩 Email: hello@api4.ai +đŸ’Ŧ Chat: https://t.me/a4a_support_bot + + + +# Getting Started + +## 🚀 Register and Subscribe to API4AI APIs on RapidAPI + +To access our APIs, begin at RapidAPI, a renowned API marketplace. Here, you'll find solutions by [API4AI](https://rapidapi.com/api4ai-api4ai-default) and other vendors, available through a subscription model, including free plans. Simply register on RapidAPI and subscribe to preferred API4AI API to start. + + +## 📖 Detailed documentation for specific actions + +- [Alcohol Label Recognition](actions/alcohol-label-recognition) +- [Brand Recognition](actions/brand-recognition) +- [Background Removal](actions/background-removal) +- [Car Image Background Removal](actions/car-image-background-removal) +- [Furniture & Household Item Recognition](actions/furniture-and-household-item-recognition) +- [Image Anonymization](actions/image-anonymization) +- [NSFW Image Recognition](actions/nsfw-image-recognition) + + # Example Use Cases - **Content Moderation Automation**: Integrate api4ai with a social media platform like Twitter on Pipedream to automatically detect and flag inappropriate or sensitive content in images or videos. When media is uploaded, api4ai can analyze it and trigger an alert or an automatic removal process if unwanted content is detected. -- **User Onboarding KYC Verification**: Implement a Know Your Customer (KYC) process by connecting api4ai with a customer relationship management app like Salesforce. Use api4ai to verify identity by analyzing user-submitted documents and portraits, minimizing the risk of fraud and speeding up the onboarding process. +- **Car dealerships**: Utilize api4ai background removal algorithm to efficiently remove backgrounds from car images and enhance them with natural shadow effects. Then, simply apply any background of your choice, and your car ad placement is ready for deployment. + +- **Automating Commercial Offer Drafts**: By integrating furniture and household items recognition solution from api4ai, the Moving companies can automate the estimation process by using photos provided by the client, leveraging AI to identify and list items quickly. This rapid response can prevent customers from turning to competitors and improve operational efficiency by reducing the workload on staff. Read step-by-step guide ["Low-Code Automation for Image Workflows with Pipedream"](http://api4.ai/blog/low-code-automation-for-image-workflows-with-pipedream-the-step-by-step-guide) to learn more about this use case. + +- **Product identification app**: Enhance your application for product identification by integrating an api4ai alcohol label recognition with a vast database of beverages and labels. -- **Real-Time Visual Data Analytics**: Combine api4ai with a database service like Airtable on Pipedream to create a visual data pipeline. Use api4ai for real-time analysis of surveillance camera feeds or user-generated content, extracting insights and storing them in Airtable for reporting and decision-making. +- **Marketing campaigns**: Use api4ai to estimate if the appearance of the needed brand is sufficient for your marketing purposes and is in alignment with your request. diff --git a/components/api4ai/actions/alcohol-label-recognition/README.md b/components/api4ai/actions/alcohol-label-recognition/README.md index 39db1066e5aa8..04e57633dcde5 100644 --- a/components/api4ai/actions/alcohol-label-recognition/README.md +++ b/components/api4ai/actions/alcohol-label-recognition/README.md @@ -1,6 +1,6 @@ -# ⭐ī¸ Alcohol Label Recognition +# Overview -Advanced label scanning API, powered by cutting-edge computer vision and neural network technology, designed to accurately identify various alcoholic beverages from their labels. +⭐ī¸ **Alcohol Label Recognition** – is a advanced label scanning API, powered by cutting-edge computer vision and neural network technology, designed to accurately identify various alcoholic beverages from their labels. This solution analyzes an image containing one or several alcohol labels and provides detailed information about the type of each beverage, along with its unique properties. @@ -63,16 +63,15 @@ This solution analyzes an image containing one or several alcohol labels and pro - -# 🤖 Demo +## 🤖 Demo Explore the Alcohol Label Recognition Web demo for free before delving into the details (no registration is required): https://api4.ai/apis/household-stuff#demo-wrapper -# 🚀 Getting started +# Getting started -## Subscribe and get API key +## 🚀 Subscribe and get API key To use Alcohol Label Recognition, start at [RapidAPI](https://rapidapi.com/), a well-known API hub. Register, subscribe to begin, and obtain an API key: @@ -81,7 +80,7 @@ To use Alcohol Label Recognition, start at [RapidAPI](https://rapidapi.com/), a 3. In the "Header Parameters" section, your API Key will be shown in the `X-RapidAPI-Key` field. -## Parameters +## 🛠 Parameters ### API Key @@ -115,7 +114,7 @@ Input image. Various types are accepted: ``` -## Returned values +## ↩ī¸ Returned values The "Alcohol Label Recognition" action returns the following value: @@ -148,16 +147,3 @@ The other properties of a label object depends on kind of the drink. For example } ] ``` - - - -# 📌 Contacts and social links - -👉ī¸ī¸ Website: https://api4.ai -🤖 Web demo: https://api4.ai/apis/household-stuff#demo-wrapper -📩 Email: hello@api4.ai -đŸ’Ŧ Chat: https://t.me/a4a_support_bot -🔗 Instagram: https://www.instagram.com/api4ai -🔗 Facebook: https://www.facebook.com/api4ai.solution -🔗 X (twitter): https://twitter.com/api4ai -🔗 LinkedIn: https://www.linkedin.com/company/api4ai/ diff --git a/components/api4ai/actions/background-removal/README.md b/components/api4ai/actions/background-removal/README.md index 203bd1a55d387..45af5aea24899 100644 --- a/components/api4ai/actions/background-removal/README.md +++ b/components/api4ai/actions/background-removal/README.md @@ -1,20 +1,19 @@ -# ⭐ī¸ Background Removal +# Overview -Background Removal offers advanced image analysis for foreground segmentation and effortless background removal. +⭐ī¸ **Background Removal** offers advanced image analysis for foreground segmentation and effortless background removal. ![bg-removal](https://storage.googleapis.com/api4ai-static/rapidapi/background-removal/bg-removal.png) - -# 🤖 Demo +## 🤖 Demo Discover the Background Removal Web demo for free and get a feel for its capabilities before diving deeper. No registration is required: https://api4.ai/apis/bg-removal#demo-wrapper -# 🚀 Getting started +# Getting started -## Subscribe and get API key +## 🚀 Subscribe and get API key To use Background Removal, start at [RapidAPI](https://rapidapi.com/), a well-known API hub. Register, subscribe to begin, and obtain an API key: @@ -23,7 +22,7 @@ To use Background Removal, start at [RapidAPI](https://rapidapi.com/), a well-kn 3. In the "Header Parameters" section, your API Key will be shown in the `X-RapidAPI-Key` field. -## Parameters +## 🛠 Parameters ### API Key @@ -81,7 +80,7 @@ By default, the Background Removal returns a PNG image with the background remov ![image-vs-mask](https://storage.googleapis.com/api4ai-static/rapidapi/background-removal/image-vs-mask.png) -## Returned values +## ↩ī¸ Returned values The "Background removal" action returns a set of values which can be used to obtain processing results: @@ -113,16 +112,3 @@ Where: Bounding box coordinates are normalized, meaning they range from `0.0` to `1.0`. Multiply `X` and `W` by the image's width and `Y` and `H` by the image's height to convert to pixels. ℹī¸ **Note**: Currently, the "Background Removal" always returns only one object – `opaque-content`, corresponding to the area of opaque content in the result image. The content outside this area in the result image is fully transparent. - - - -# 📌 Contacts and social links - -👉ī¸ī¸ Website: https://api4.ai -🤖 Web demo: https://api4.ai/apis/bg-removal#demo-wrapper -📩 Email: hello@api4.ai -đŸ’Ŧ Chat: https://t.me/a4a_support_bot -🔗 Instagram: https://www.instagram.com/api4ai -🔗 Facebook: https://www.facebook.com/api4ai.solution -🔗 X (twitter): https://twitter.com/api4ai -🔗 LinkedIn: https://www.linkedin.com/company/api4ai/ diff --git a/components/api4ai/actions/brand-recognition/README.md b/components/api4ai/actions/brand-recognition/README.md index 0b3e58d6b5b37..195810f528fd4 100644 --- a/components/api4ai/actions/brand-recognition/README.md +++ b/components/api4ai/actions/brand-recognition/README.md @@ -1,6 +1,6 @@ -# ⭐ī¸ Brand Recognition +# Overview -Ready-to-Use solution for the identification of thousands of brand marks and logos within images. +⭐ī¸ **Brand Recognition** – is a ready-to-Use solution for the identification of thousands of brand marks and logos within images. Brand Recognition provides AI-powered image processing designed for analyzing the presence of brands in the pictures. @@ -10,16 +10,15 @@ Brand Recognition provides AI-powered image processing designed for analyzing th ✅ This solution provides out-of-the-box support for an extensive range of brands, encompassing a vast array of logos and trademarks. Furthermore, it incorporates advanced, sophisticated logic designed to automatically identify unknown ones. - -# 🤖 Demo +## 🤖 Demo Explore the Brand Recognition Web demo for free before delving into the details (no registration is required): https://api4.ai/apis/brand-recognition#demo-wrapper -# 🚀 Getting started +# Getting started -## Subscribe and get API key +## 🚀 Subscribe and get API key To use Brand Recognition, start at [RapidAPI](https://rapidapi.com/), a well-known API hub. Register, subscribe to begin, and obtain an API key: @@ -28,7 +27,7 @@ To use Brand Recognition, start at [RapidAPI](https://rapidapi.com/), a well-kno 3. In the "Header Parameters" section, your API Key will be shown in the `X-RapidAPI-Key` field. -## Parameters +## 🛠 Parameters ### API Key @@ -62,21 +61,8 @@ Input image. Various types are accepted: ``` -## Returned values +## ↩ī¸ Returned values The "Brand Recognition" action returns the following value: * `brands` (array) – An array of brands (represented as strings) identified in an input image. - - - -# 📌 Contacts and social links - -👉ī¸ī¸ Website: https://api4.ai -🤖 Web demo: https://api4.ai/apis/brand-recognition#demo-wrapper -📩 Email: hello@api4.ai -đŸ’Ŧ Chat: https://t.me/a4a_support_bot -🔗 Instagram: https://www.instagram.com/api4ai -🔗 Facebook: https://www.facebook.com/api4ai.solution -🔗 X (twitter): https://twitter.com/api4ai -🔗 LinkedIn: https://www.linkedin.com/company/api4ai/ diff --git a/components/api4ai/actions/car-image-background-removal/README.md b/components/api4ai/actions/car-image-background-removal/README.md index 947d1971e82a1..809db1ea5beb4 100644 --- a/components/api4ai/actions/car-image-background-removal/README.md +++ b/components/api4ai/actions/car-image-background-removal/README.md @@ -1,20 +1,19 @@ -# ⭐ī¸ Cars Image Background Removal +# Overview -Car image editing solution designed to enhance automotive imagery, featuring high-accuracy segmentation, background removal, shadow effects, license plate blurring, and custom background replacement. +⭐ī¸ **Cars Image Background Removal** designed to enhance automotive imagery, featuring high-accuracy segmentation, background removal, shadow effects, license plate blurring, and custom background replacement. ![car-bg-removal](https://storage.googleapis.com/api4ai-static/rapidapi/cars-image-background-removal/car-bg-removal.png) - -# 🤖 Demo +## 🤖 Demo Discover the Cars Image Background Removal Web demo for free and get a feel for its capabilities before diving deeper. No registration is required: https://api4.ai/apis/car-bg-removal#demo-wrapper -# 🚀 Getting started +# Getting started -## Subscribe and get API key +## 🚀 Subscribe and get API key To use Cars Image Background Removal, start at [RapidAPI](https://rapidapi.com/), a well-known API hub. Register, subscribe to begin, and obtain an API key: @@ -23,7 +22,7 @@ To use Cars Image Background Removal, start at [RapidAPI](https://rapidapi.com/) 3. In the "Header Parameters" section, your API Key will be shown in the `X-RapidAPI-Key` field. -## Parameters +## 🛠 Parameters ### API Key @@ -99,7 +98,7 @@ The Car Image Background Removal offer an advanced blurring feature for license ℹī¸ **Note**: Enabling this feature may slightly degrade performance. -## Returned values +## ↩ī¸ Returned values The "Car Image Background Removal" action returns a set of values which can be used to obtain processing results: @@ -133,16 +132,3 @@ Bounding box coordinates are normalized, meaning they range from `0.0` to `1.0`. Possible classes: * `opaque-content`. The "Cars Image Background Removal" always returns this object, corresponding to the area of opaque content in the result image. The content outside this area in the result image is fully transparent. * `license plate`. Returned when "Hide car license plates" is enabled and car license plate(s) are detected. - - - -# 📌 Contacts and social links - -👉ī¸ī¸ Website: https://api4.ai -🤖 Web demo: https://api4.ai/apis/car-bg-removal#demo-wrapper -📩 Email: hello@api4.ai -đŸ’Ŧ Chat: https://t.me/a4a_support_bot -🔗 Instagram: https://www.instagram.com/api4ai -🔗 Facebook: https://www.facebook.com/api4ai.solution -🔗 X (twitter): https://twitter.com/api4ai -🔗 LinkedIn: https://www.linkedin.com/company/api4ai/ diff --git a/components/api4ai/actions/furniture-and-household-item-recognition/README.md b/components/api4ai/actions/furniture-and-household-item-recognition/README.md index 1a450eff53e24..c9ee07e4ec8f5 100644 --- a/components/api4ai/actions/furniture-and-household-item-recognition/README.md +++ b/components/api4ai/actions/furniture-and-household-item-recognition/README.md @@ -1,6 +1,6 @@ -# ⭐ī¸ Furniture & Household Items Recognition +# Overview -Accurate identification of furniture and household items with advanced intelligent detection, categorization, and counting technologies. +⭐ī¸ **Furniture & Household Items Recognition** – is an accurate identification of furniture and household items with advanced intelligent detection, categorization, and counting technologies. The Furniture & Household Items Recognition offers AI-driven image analysis, ideal for identifying household items in photos. It streamlines inventory management for interior design, real estate, retail, and enhances service efficiency for moving companies. @@ -10,16 +10,15 @@ The Furniture & Household Items Recognition offers AI-driven image analysis, ide ✅ The algorithm employs advanced logic to automatically count items, seamlessly integrating this capability. Consequently, our API meticulously generates a comprehensive JSON output, detailing each identified item along with its precise corresponding quantities. - -# 🤖 Demo +## 🤖 Demo Explore the Furniture & Household Items Recognition Web demo for free before delving into the details (no registration is required): https://api4.ai/apis/household-stuff#demo-wrapper -# 🚀 Getting started +# Getting started -## Subscribe and get API key +## 🚀 Subscribe and get API key To use Furniture & Household Items Recognition, start at [RapidAPI](https://rapidapi.com/), a well-known API hub. Register, subscribe to begin, and obtain an API key: @@ -28,7 +27,7 @@ To use Furniture & Household Items Recognition, start at [RapidAPI](https://rapi 3. In the "Header Parameters" section, your API Key will be shown in the `X-RapidAPI-Key` field. -## Parameters +## 🛠 Parameters ### API Key @@ -62,7 +61,7 @@ Input image. Various types are accepted: ``` -## Returned values +## ↩ī¸ Returned values The "Furniture & Household Items Recognition" action returns the following value: @@ -80,16 +79,3 @@ The "Furniture & Household Items Recognition" action returns the following value "Table": 1 } ``` - - - -# 📌 Contacts and social links - -👉ī¸ī¸ Website: https://api4.ai -🤖 Web demo: https://api4.ai/apis/household-stuff#demo-wrapper -📩 Email: hello@api4.ai -đŸ’Ŧ Chat: https://t.me/a4a_support_bot -🔗 Instagram: https://www.instagram.com/api4ai -🔗 Facebook: https://www.facebook.com/api4ai.solution -🔗 X (twitter): https://twitter.com/api4ai -🔗 LinkedIn: https://www.linkedin.com/company/api4ai/ diff --git a/components/api4ai/actions/image-anonymization/README.md b/components/api4ai/actions/image-anonymization/README.md index b08da550721d3..d13116c41079e 100644 --- a/components/api4ai/actions/image-anonymization/README.md +++ b/components/api4ai/actions/image-anonymization/README.md @@ -1,20 +1,19 @@ -# ⭐ī¸ Image Anonymization +# Overview -High-Accuracy solution for automatic detection and blurring of sensitive areas in images. Cloud-based Image Anonymization API detects and blurs faces and license plates in photos, ensuring sensitive information remains unrecognizable for secure privacy protection. +⭐ī¸ **Image Anonymization** – is a high-Accuracy solution for automatic detection and blurring of sensitive areas in images. Cloud-based Image Anonymization API detects and blurs faces and license plates in photos, ensuring sensitive information remains unrecognizable for secure privacy protection. ![image-anonymization](https://storage.googleapis.com/api4ai-static/rapidapi/img_anonymization_0.gif) - -# 🤖 Demo +## 🤖 Demo Discover the Image Anonymization Web demo for free and get a feel for its capabilities before diving deeper. No registration is required: https://api4.ai/apis/image-anonymization/#demo-wrapper -# 🚀 Getting started +# Getting started -## Subscribe and get API key +## 🚀 Subscribe and get API key To use Image Anonymization, start at [RapidAPI](https://rapidapi.com/), a well-known API hub. Register, subscribe to begin, and obtain an API key: @@ -23,7 +22,7 @@ To use Image Anonymization, start at [RapidAPI](https://rapidapi.com/), a well-k 3. In the "Header Parameters" section, your API Key will be shown in the `X-RapidAPI-Key` field. -## Parameters +## 🛠 Parameters ### API Key @@ -86,7 +85,7 @@ By default, Image Anonymization detects and hides both faces and license plates. 💡 **Hint**: Enabling the `Faces only` or `Licence plates only` mode may also improve overall performance. -## Returned values +## ↩ī¸ Returned values The "Image Anonymization" action returns a set of values which can be used to obtain processing results: @@ -121,16 +120,3 @@ Bounding box coordinates are normalized, meaning they range from `0.0` to `1.0`. Possible classes: * `Face` * `License plate` - - - -# 📌 Contacts and social links - -👉ī¸ī¸ Website: https://api4.ai -🤖 Web demo: https://api4.ai/apis/image-anonymization#demo-wrapper -📩 Email: hello@api4.ai -đŸ’Ŧ Chat: https://t.me/a4a_support_bot -🔗 Instagram: https://www.instagram.com/api4ai -🔗 Facebook: https://www.facebook.com/api4ai.solution -🔗 X (twitter): https://twitter.com/api4ai -🔗 LinkedIn: https://www.linkedin.com/company/api4ai/ diff --git a/components/api4ai/actions/nsfw-image-recognition/README.md b/components/api4ai/actions/nsfw-image-recognition/README.md index 095320c7b4fed..17d8a2aa0b476 100644 --- a/components/api4ai/actions/nsfw-image-recognition/README.md +++ b/components/api4ai/actions/nsfw-image-recognition/README.md @@ -1,22 +1,21 @@ -# ⭐ī¸ NSFW Image Recognition +# Overview -Content moderation solution for NSFW (Not Safe For Work) sexual images identification. +⭐ī¸ **NSFW Image Recognition** – is a content moderation solution for NSFW (Not Safe For Work) sexual images identification. Leveraging AI-powered technology this solution recognizes potentially offensive content in the image that may be inappropriate for public places or workspace viewing. It provides a confidence level to indicate how certain it is that the content is NSFW. ![sfw](https://storage.googleapis.com/api4ai-static/rapidapi/nsfw/sfw.png) - -# 🤖 Demo +## 🤖 Demo Explore the NSFW Image Recognition Web demo for free before delving into the details (no registration is required): https://api4.ai/apis/nsfw#demo-wrapper -# 🚀 Getting started +# Getting started -## Subscribe and get API key +## 🚀 Subscribe and get API key To use NSFW Image Recognition, start at [RapidAPI](https://rapidapi.com/), a well-known API hub. Register, subscribe to begin, and obtain an API key: @@ -25,7 +24,7 @@ To use NSFW Image Recognition, start at [RapidAPI](https://rapidapi.com/), a wel 3. In the "Header Parameters" section, your API Key will be shown in the `X-RapidAPI-Key` field. -## Parameters +## 🛠 Parameters ### API Key @@ -67,21 +66,8 @@ By default algorithms is as strict as possible (strictness `1.0`) and even photo ![strictness](https://storage.googleapis.com/api4ai-static/rapidapi/nsfw/strictness.png) -## Returned values +## ↩ī¸ Returned values The "NSFW Image Recognition" action returns the following value: * `nsfw` (number) – Represents the NSFW probability. Is a number, typically ranging from `0.0` (safe) to `1.0` (not safe). A special negative value `-1.0` used to indicate processing error. - - - -# 📌 Contacts and social links - -👉ī¸ī¸ Website: https://api4.ai -🤖 Web demo: https://api4.ai/apis/nsfw#demo-wrapper -📩 Email: hello@api4.ai -đŸ’Ŧ Chat: https://t.me/a4a_support_bot -🔗 Instagram: https://www.instagram.com/api4ai -🔗 Facebook: https://www.facebook.com/api4ai.solution -🔗 X (twitter): https://twitter.com/api4ai -🔗 LinkedIn: https://www.linkedin.com/company/api4ai/