Overview

The APYHub API Connector for OutSystems enables seamless interaction with APYHub's comprehensive AI APIs. This connector allows you to integrate advanced AI functionalities into your OutSystems applications, enhancing their capabilities with various text and image processing features.

Key Features

• AI Summarize Documents: Summarize the content of documents.
• AI Summarize: Summarize input text.
• AI Image Landmark Detection: Detect landmarks in images.
• AI Image Face Detection: Detect faces in images.
• AI Image Explicit Content Detection: Detect explicit content in images.
• AI Image Objects Detection: Detect objects in images.
• AI Image Brand/Logo Detection: Detect brands and logos in images.
• AI Document Receipt Data Extraction: Extract data from receipts.
• AI Document Invoice Data Extraction: Extract data from invoices.
• AI Document ID Extraction: Extract data from identification documents.
• AI Document Data Extraction: Extract data from various documents.
• AI Document Multipage OCR Data Extraction: Perform OCR on multi-page documents.
• AI Document Table Data Extraction: Extract table data from documents.
• AI Text Entity Recognition: Recognize entities in text.
• AI Text Sentiment Analysis: Analyze the sentiment of text.
• AI Text Language Detection: Detect the language of text.
• AI Text Keyword Extraction: Extract keywords from text.
• AI Text Anonymization: Anonymize sensitive information in text.

Prerequisites

• An active APYHub account.
• Obtain an APY Token from the APYHub official site.

Installation

1. Download the APYHub API Connector from the OutSystems Forge.
2. Install the component in your OutSystems environment.
3. Configure the component by setting the APY Token in the API Connector settings.

Configuration

1. Navigate to the Service Center in your OutSystems environment.
2. Go to Applications and select the APYHub API Connector.
3. Open the APYHub API Connector configuration screen.
4. Enter your APY Token obtained from the APYHub official site.
5. Save the configuration.

Using the APYHub API Connector

Server Actions

AI Summarize Documents

Summarizes the content of a document.

Parameters:

• document (Text): The content of the document to be summarized.

AI Summarize

Summarizes the input text.

Parameters:

• text (Text): The text to be summarized.

AI Image Landmark Detection

Detects landmarks in images.

Parameters:

• image (Binary): The image file for landmark detection.

AI Image Face Detection

Detects faces in images.

Parameters:

• image (Binary): The image file for face detection.

AI Image Explicit Content Detection

Detects explicit content in images.

Parameters:

• image (Binary): The image file for explicit content detection.

AI Image Objects Detection

Detects objects in images.

Parameters:

• image (Binary): The image file for object detection.

AI Image Brand/Logo Detection

Detects brands and logos in images.

Parameters:

• image (Binary): The image file for brand/logo detection.

AI Document Receipt Data Extraction

Extracts data from receipts.

Parameters:

• document (Text): The content of the receipt document.

AI Document Invoice Data Extraction

Extracts data from invoices.

Parameters:

• document (Text): The content of the invoice document.

AI Document ID Extraction

Extracts data from identification documents.

Parameters:

• document (Text): The content of the identification document.

AI Document Data Extraction

Extracts data from various documents.

Parameters:

• document (Text): The content of the document.

AI Document Multipage OCR Data Extraction

Performs OCR on multi-page documents.

Parameters:

• document (Text): The content of the multi-page document.

AI Document Table Data Extraction

Extracts table data from documents.

Parameters:

• document (Text): The content of the document containing tables.

AI Text Entity Recognition

Recognizes entities in text.

Parameters:

• text (Text): The text for entity recognition.

AI Text Sentiment Analysis

Analyzes the sentiment of text.

Parameters:

• text (Text): The text for sentiment analysis.

AI Text Language Detection

Detects the language of text.

Parameters:

• text (Text): The text for language detection.

AI Text Keyword Extraction

Extracts keywords from text.

Parameters:

• text (Text): The text for keyword extraction.

AI Text Anonymization

Anonymizes sensitive information in text.

Parameters:

• text (Text): The text for anonymization.

Error Handling

• Invalid Token: Ensure that the APY Token is correctly configured. If invalid, request a new token from APYHub.
• API Limits: Keep track of your daily API usage to avoid exceeding the limit of 5 calls per day on the free version. Consider upgrading your APYHub plan if more calls are needed.
• Invalid Input: Ensure that the input data is correctly formatted and valid for the respective server action.

Best Practices

• Token Security: Store the APY Token securely and avoid exposing it in client-side code to prevent unauthorized use.
• Error Logging: Implement logging for API responses to monitor usage and handle errors effectively. Capture response codes and error messages for debugging.
• Optimize Calls: Minimize the number of API calls by caching results where possible to stay within usage limits. Use appropriate data structures and algorithms to reduce redundant calls.
• Input Validation: Validate and preprocess input data to ensure it is well-formed and suitable for processing.

Support

For any issues or further assistance, please refer to the APYHub documentation or contact their support team.

Conclusion

The APYHub API Connector for OutSystems is a powerful tool for integrating advanced AI capabilities into your applications. With features such as document summarization, text sentiment analysis, image detection, and data extraction, this connector provides a comprehensive solution for enhancing your applications' functionality. By following the installation and configuration steps, you can quickly set up the connector and start leveraging APYHub's AI APIs efficiently.