Merge pull request #1526 from oracle-devrel/jb171224

Jb171224

ai/generative-ai-service/mindmaps/LICENSE

@@ -0,0 +1,35 @@
+Copyright (c) 2024 Oracle and/or its affiliates.
+
+The Universal Permissive License (UPL), Version 1.0
+
+Subject to the condition set forth below, permission is hereby granted to any
+person obtaining a copy of this software, associated documentation and/or data
+(collectively the "Software"), free of charge and under any and all copyright
+rights in the Software, and any and all patent rights owned or freely
+licensable by each licensor hereunder covering either (i) the unmodified
+Software as contributed to or provided by such licensor, or (ii) the Larger
+Works (as defined below), to deal in both
+
+(a) the Software, and
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+one is included with the Software (each a "Larger Work" to which the Software
+is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create
+derivative works of, display, perform, and distribute the Software and make,
+use, sell, offer for sale, import, export, have made, and have sold the
+Software and the Larger Work(s), and to sublicense the foregoing rights on
+either these or other terms.
+
+This license is subject to the following condition:
+The above copyright notice and either this complete permission notice or at
+a minimum a reference to the UPL must be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ai/generative-ai-service/mindmaps/README.md

@@ -0,0 +1,75 @@
+# MindMapGenerator using OCI Generative AI & Visual Builder
+
+MindMapGenerator, can take a text, analyze it, classify it into levels and sublevels, and generate a structured mind map based on the content using Generative AI. It also works with PDF documents by leveraging Oracle Document Understanding to analyze and extract information from the file before creating the mind map. Additionally, the demo can capture information in real-time using the Speech service, processing spoken input to generate an insightful and organized mind map on the fly. Can be complementary to AI Meetings or other different use cases.
+
+Reviewed: 17.12.2024
+
+# **1. Prepare your user**
+
+   In Oracle Cloud Infrastructure (OCI), API keys are used for secure authentication when accessing OCI resources through REST APIs. OCI API keys consist of two parts: a Public key and a Private key. You use the OCI console to generate the Private/Public key pair.
+   Generate API Keys using OCI Console
+    To Generate the API Keys using OCI Console:
+
+  - Login into your OCI Account.
+   ![alt text]![alt text](mindmaps-md/ak1.png)
+  - Click on the Profile icon at the top-right corner and select your Profile hyperlink.
+   ![alt text](mindmaps-md/ak2.png)
+  - Under Resources section at the bottom-left, select API Keys and then click Add API Key.
+   ![alt text](mindmaps-md/ak3.png)
+  - The Add API Key dialog is displayed. Select Generate API Key Pair to create a new key pair.
+  ![alt text](mindmaps-md/ak4.png)
+  - Click Download Private Key. A .pem file is saved to your local device. You do not need to download the public key and click Add button.
+  ![alt text](mindmaps-md/ak5.png)
+
+
+
+# **2.Pick you compartment**
+Identify the compartment you're currently working within. Navigate to 'Identity' -> 'Compartments'. Locate your compartment and make a note of its OCID (Oracle Cloud Identifier)
+
+# **3.Open Visual Builder**
+## Import Visual Builder project
+* Open Visual Builder and click on the "Import" button. Choose "Application from file".
+* Drop the zip project file
+* Provide a name and an ID, for example "MindMaps_Generator". Click on Import button.
+
+
+## Configure REST APIs authentication
+* Open the recently created project.
+
+* Click on Services button (left side) and click on "Backends"
+ ![alt text](mindmaps-md/services.jpg)
+* Now, click on GenAI, and Servers to edit server authentication.
+* Click the pencil to provide the OCI Crendentials
+* Provide the crendentials you got during the step 1.
+ ![alt text](mindmaps-md/signature.jpg)
+
+* Repeat the same process with the GenAI backend.
+
+## Provide your compartmentId and all the required variables
+* Provide compartmentId default value in the project variable named "compartmentID" that you got during the step 2.
+ ![alt text](mindmaps-md/variables.jpg)
+Repeat the process with bucketName, cohereModel,namespace & prefix
+
+## Provide JS libray to generate MindMaps
+* I developed this sample using go.js but you can replace by any other. Please update the html page in the application providing your library
+
+#  **4.Preview the application**
+* Now can provide a topic in the text area and click "generate" button. 
+ ![alt text](mindmaps-md/preview.jpg)
+
+* Automatically a mindmap will be created. 
+  ![alt text](mindmaps-md/mindmap.jpg)
+
+## Notes
+* It is important to note that, you can use any open source or licensed JS library to generate the MindMap. And you can do using Free Text & Documents Analysis. If you want to use Real Time Transcription you need to configure a Speech Bridge and modify the JS page.
+
+## I hope you liked it.
+Author: Jesús Brasero
+
+# License
+
+Copyright (c) 2024 Oracle and/or its affiliates.
+
+Licensed under the Universal Permissive License (UPL), Version 1.0.
+
+See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/LICENSE) for more details.

ai/generative-ai-service/mindmaps/SECURITY.md

@@ -0,0 +1,38 @@
+# Reporting security vulnerabilities
+
+Oracle values the independent security research community and believes that
+responsible disclosure of security vulnerabilities helps us ensure the security
+and privacy of all our users.
+
+Please do NOT raise a GitHub Issue to report a security vulnerability. If you
+believe you have found a security vulnerability, please submit a report to
+[[email protected]][1] preferably with a proof of concept. Please review
+some additional information on [how to report security vulnerabilities to Oracle][2].
+We encourage people who contact Oracle Security to use email encryption using
+[our encryption key][3].
+
+We ask that you do not use other channels or contact the project maintainers
+directly.
+
+Non-vulnerability related security issues including ideas for new or improved
+security features are welcome on GitHub Issues.
+
+## Security updates, alerts and bulletins
+
+Security updates will be released on a regular cadence. Many of our projects
+will typically release security fixes in conjunction with the
+Oracle Critical Patch Update program. Additional
+information, including past advisories, is available on our [security alerts][4]
+page.
+
+## Security-related information
+
+We will provide security related information such as a threat model, considerations
+for secure use, or any known security issues in our documentation. Please note
+that labs and sample code are intended to demonstrate a concept and may not be
+sufficiently hardened for production use.
+
+[1]: mailto:[email protected]
+[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
+[3]: https://www.oracle.com/security-alerts/encryptionkey.html
+[4]: https://www.oracle.com/security-alerts/