Skip to content

Commit af171c8

Browse files
authored
Merge pull request #1526 from oracle-devrel/jb171224
Jb171224
2 parents d46bc7e + b4e8e8c commit af171c8

File tree

15 files changed

+148
-0
lines changed

15 files changed

+148
-0
lines changed
332 KB
Loading
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Copyright (c) 2024 Oracle and/or its affiliates.
2+
3+
The Universal Permissive License (UPL), Version 1.0
4+
5+
Subject to the condition set forth below, permission is hereby granted to any
6+
person obtaining a copy of this software, associated documentation and/or data
7+
(collectively the "Software"), free of charge and under any and all copyright
8+
rights in the Software, and any and all patent rights owned or freely
9+
licensable by each licensor hereunder covering either (i) the unmodified
10+
Software as contributed to or provided by such licensor, or (ii) the Larger
11+
Works (as defined below), to deal in both
12+
13+
(a) the Software, and
14+
(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
15+
one is included with the Software (each a "Larger Work" to which the Software
16+
is contributed by such licensors),
17+
18+
without restriction, including without limitation the rights to copy, create
19+
derivative works of, display, perform, and distribute the Software and make,
20+
use, sell, offer for sale, import, export, have made, and have sold the
21+
Software and the Larger Work(s), and to sublicense the foregoing rights on
22+
either these or other terms.
23+
24+
This license is subject to the following condition:
25+
The above copyright notice and either this complete permission notice or at
26+
a minimum a reference to the UPL must be included in all copies or
27+
substantial portions of the Software.
28+
29+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
31+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
32+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
33+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
34+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35+
SOFTWARE.
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# MindMapGenerator using OCI Generative AI & Visual Builder
2+
3+
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.
4+
5+
Reviewed: 17.12.2024
6+
7+
# **1. Prepare your user**
8+
9+
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.
10+
Generate API Keys using OCI Console
11+
To Generate the API Keys using OCI Console:
12+
13+
- Login into your OCI Account.
14+
![alt text]![alt text](mindmaps-md/ak1.png)
15+
- Click on the Profile icon at the top-right corner and select your Profile hyperlink.
16+
![alt text](mindmaps-md/ak2.png)
17+
- Under Resources section at the bottom-left, select API Keys and then click Add API Key.
18+
![alt text](mindmaps-md/ak3.png)
19+
- The Add API Key dialog is displayed. Select Generate API Key Pair to create a new key pair.
20+
![alt text](mindmaps-md/ak4.png)
21+
- 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.
22+
![alt text](mindmaps-md/ak5.png)
23+
24+
25+
26+
# **2.Pick you compartment**
27+
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)
28+
29+
# **3.Open Visual Builder**
30+
## Import Visual Builder project
31+
* Open Visual Builder and click on the "Import" button. Choose "Application from file".
32+
* Drop the zip project file
33+
* Provide a name and an ID, for example "MindMaps_Generator". Click on Import button.
34+
35+
36+
## Configure REST APIs authentication
37+
* Open the recently created project.
38+
39+
* Click on Services button (left side) and click on "Backends"
40+
![alt text](mindmaps-md/services.jpg)
41+
* Now, click on GenAI, and Servers to edit server authentication.
42+
* Click the pencil to provide the OCI Crendentials
43+
* Provide the crendentials you got during the step 1.
44+
![alt text](mindmaps-md/signature.jpg)
45+
46+
* Repeat the same process with the GenAI backend.
47+
48+
## Provide your compartmentId and all the required variables
49+
* Provide compartmentId default value in the project variable named "compartmentID" that you got during the step 2.
50+
![alt text](mindmaps-md/variables.jpg)
51+
Repeat the process with bucketName, cohereModel,namespace & prefix
52+
53+
## Provide JS libray to generate MindMaps
54+
* 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
55+
56+
# **4.Preview the application**
57+
* Now can provide a topic in the text area and click "generate" button.
58+
![alt text](mindmaps-md/preview.jpg)
59+
60+
* Automatically a mindmap will be created.
61+
![alt text](mindmaps-md/mindmap.jpg)
62+
63+
## Notes
64+
* 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.
65+
66+
## I hope you liked it.
67+
Author: Jesús Brasero
68+
69+
# License
70+
71+
Copyright (c) 2024 Oracle and/or its affiliates.
72+
73+
Licensed under the Universal Permissive License (UPL), Version 1.0.
74+
75+
See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/LICENSE) for more details.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Reporting security vulnerabilities
2+
3+
Oracle values the independent security research community and believes that
4+
responsible disclosure of security vulnerabilities helps us ensure the security
5+
and privacy of all our users.
6+
7+
Please do NOT raise a GitHub Issue to report a security vulnerability. If you
8+
believe you have found a security vulnerability, please submit a report to
9+
[[email protected]][1] preferably with a proof of concept. Please review
10+
some additional information on [how to report security vulnerabilities to Oracle][2].
11+
We encourage people who contact Oracle Security to use email encryption using
12+
[our encryption key][3].
13+
14+
We ask that you do not use other channels or contact the project maintainers
15+
directly.
16+
17+
Non-vulnerability related security issues including ideas for new or improved
18+
security features are welcome on GitHub Issues.
19+
20+
## Security updates, alerts and bulletins
21+
22+
Security updates will be released on a regular cadence. Many of our projects
23+
will typically release security fixes in conjunction with the
24+
Oracle Critical Patch Update program. Additional
25+
information, including past advisories, is available on our [security alerts][4]
26+
page.
27+
28+
## Security-related information
29+
30+
We will provide security related information such as a threat model, considerations
31+
for secure use, or any known security issues in our documentation. Please note
32+
that labs and sample code are intended to demonstrate a concept and may not be
33+
sufficiently hardened for production use.
34+
35+
[1]: mailto:[email protected]
36+
[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
37+
[3]: https://www.oracle.com/security-alerts/encryptionkey.html
38+
[4]: https://www.oracle.com/security-alerts/
Binary file not shown.
1.87 MB
Loading
316 KB
Loading
440 KB
Loading
185 KB
Loading
335 KB
Loading

0 commit comments

Comments
 (0)