Merge pull request #3381 from Yasas2000/internProjectDocumentProcessM…

…ediator Intern project document process mediator
wso2 · Jun 28, 2024 · 377035d · 377035d
2 parents 23da635 + 19b08a9
commit 377035d
Show file tree

Hide file tree

Showing 19 changed files with 969 additions and 0 deletions.
diff --git a/...ators/documentProcess-mediator/org.wso2.micro.integrator.mediator.documentProcess/pom.xml b/...ators/documentProcess-mediator/org.wso2.micro.integrator.mediator.documentProcess/pom.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+ ~ Copyright (c) 2019, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~      http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <parent>
+        <artifactId>mediators</artifactId>
+        <groupId>org.wso2.ei</groupId>
+        <version>4.3.0-SNAPSHOT</version>
+        <relativePath>../../pom.xml</relativePath>
+    </parent>
+
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>org.wso2.micro.integrator.mediator.documentProcess</artifactId>
+    <packaging>bundle</packaging>
+    <name>WSO2 Carbon - Document Process Mediator</name>
+    <url>http://wso2.org</url>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.apache.synapse</groupId>
+            <artifactId>synapse-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.wso2.org.ops4j.pax.logging</groupId>
+            <artifactId>pax-logging-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.wso2.ei</groupId>
+            <artifactId>org.wso2.micro.integrator.core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.synapse</groupId>
+            <artifactId>synapse-core</artifactId>
+            <version>4.0.0-wso2v110</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.pdfbox</groupId>
+            <artifactId>pdfbox</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.pdfbox</groupId>
+            <artifactId>fontbox</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.wso2.ei</groupId>
+            <artifactId>org.wso2.micro.integrator.registry</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+
+                <extensions>true</extensions>
+                <configuration>
+                    <instructions>
+                        <Bundle-SymbolicName>${project.artifactId}</Bundle-SymbolicName>
+                        <Bundle-Name>${project.artifactId}</Bundle-Name>
+                        <Export-Package>
+                            org.wso2.micro.integrator.mediator.documentProcess.*
+                        </Export-Package>
+                        <Import-Package>
+                        </Import-Package>
+                        <Fragment-Host>synapse-core</Fragment-Host>
+                    </instructions>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/...ain/java/org/wso2/micro/integrator/mediator/documentProcess/DocumentProcessConstants.java b/...ain/java/org/wso2/micro/integrator/mediator/documentProcess/DocumentProcessConstants.java
@@ -0,0 +1,92 @@
+/*
+ *  Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org) All Rights Reserved.
+ *
+ *  WSO2 LLC. licenses this file to you under the Apache License,
+ *  Version 2.0 (the "License"); you may not use this file except
+ *  in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied. See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+
+package org.wso2.micro.integrator.mediator.documentProcess;
+
+import org.apache.synapse.config.xml.XMLConfigConstants;
+
+import javax.xml.namespace.QName;
+
+public class DocumentProcessConstants {
+    /**
+     * QName of the cache mediator which will be used by the module.
+     */
+    public static final QName DOCUMENTPROCESS_Q = new QName(XMLConfigConstants.SYNAPSE_NAMESPACE,
+            DocumentProcessConstants.DOCUMENTPROCESS_LOCAL_NAME);
+
+    /**
+     * Local name of the visionAI mediator which will be used by the module.
+     */
+    public static final String DOCUMENTPROCESS_LOCAL_NAME = "documentProcess";
+
+    /**
+     * This holds the default amount of GPT Tokens  .
+     */
+    public static final int DEFAULT_TOKENS = 500;
+
+    /**
+     * Default GPT model
+     */
+    public static final String DEFAULT_GPT_MODEL = "gpt-4-turbo";
+
+    /**
+     * Following names represent the local names used in QNames in MediatorFactory, Serializer and the UI
+     * DocumentProcessMediator.
+     */
+    public static final String API_KEY_STRING = "api-key";
+    public static final String SCHEMA_STRING = "schema";
+    public static final String MAX_TOKENS_STRING = "max-tokens";
+    public static final String GPT_MODEL_STRING = "gpt-model";
+
+    /**
+     * API Endpoint for ChatGPT
+     */
+    public static final String GPT_API_ENDPOINT_STRING = "https://api.openai.com/v1/chat/completions";
+
+    /**
+     * Prompt String when schema is not provided
+     */
+    public static final String NO_SCHEMA_PROMPT_STRING = "Retrieve all form fields and values as JSON (get XML " +
+            "containing fields also not xml tags whole one as one field with actual field name in front it), return as " +
+            "JSON object {fieldName:FieldValue} including all fields . The key names should match the field names " +
+            "exactly and should be case sensitive. Scan the whole document and retrieve all fields.";
+
+    /**
+     * Prompt String when schema is provided
+     */
+    public static final String SCHEMA_PROMPT_STRING_1 = "Retrieve all form fields and  values as json (get XML " +
+            "containing fields also not xml tags whole one as one field with actual field name in front it), return " +
+            "as provided schema (Only values related to schema) ,";
+    public static final String SCHEMA_PROMPT_STRING_2 = " as json object {fieldName:FieldValue} only fields in " +
+            "schema, only return this object is enough, these are should be keys of the json under content, key " +
+            "names should be same as provided, case sensitive (scan whole document and check, get all fields there " +
+            "could be some lengthy fields,xml fields like value),Please return null if there is no matching attribute , schema to image.";
+
+    /**
+     * Quality of image , converted from pdf
+     * Use less dpi to save more space on the hard disk. For professional usage, you can use more than 300dpi
+     */
+    public static final int dpi = 300;
+
+    /**
+     * Regex to check file is image or not
+     */
+    public static final String IMAGE_TYPES_REGEX = "([^\\\\s]+\\.(gif|jpe?g|tiff?|png|webp|bmp)$)";
+
+
+}