Skip to content

Commit

Permalink
WMS ID: #11732 (#347)
Browse files Browse the repository at this point in the history
* Added ATOM steps

* Update manifest.json

* Updated images

* update manifest.json

* Update manifest.json

* Added zip files

* Updated few links

* Update introduction.md

* Updated files

* Updated files

* updated intro

* Update provision.md

* Update introduction.md

* Updated files

* completed first draft of intro

* Updated files

* Updated files

* Updated files

* Updated files

* Update provision.md

* Updated need help links

* Update provision.md

* Update provision.md

* Deleted images from sample workshop

* Updated Provision.md

* Updated Provision.md

* Updated Provision.md and addded and image

* Update provision.md

* Update provision.md

* Update provision.md

* added a couple new labs and started working on filling in the content for them

* Updated files

* Added another lab

Added another lab

* Update provision.md

Updated few steps

* Updated names

* Updated

Updated

* Updated

* Updated files

* Updated file

Updated

* Updated instructions

Updated instructions

* added new workshop for generative-ai-agent-oda

* started work on outlining the labs

* moved content from word to git for intro and agent lab. updated manifests

* updated terraform lab

* created functions lab

* moved oda and vb labs from word to markdown

* Add files via upload

* Update introduction.md

* Add files via upload

* Update agent.md

* Add files via upload

* Update agent.md

* Add files via upload

* Update agent.md

* updated genai agent oda lab. updated screenshots and linked to hosted artifacts

* updated manifest files and added link to atom livelab

* removed learn more section from all but intro lab

* lots of minor fixes.

* added instructions to view ODA analytics and add users to VB app

* Updated files

Updated files

* Updated files

Updated files

* updated vb instructions for promoting app to live and adding users to app

* Updated date

* added optional instructions to customize ODA chat

* clarified oda instructions

* worked through some TODOs and started user lab

* minor formatting fixes

* trying copy codeblock without specified language

* trying new codeblock syntax

* updated all codeblocks to be copyable

* updating instructions

* lots of minor tweaks going through qa checklist

* Update oda.md

* updated vb lab

* updated par links

* updated syntax for oda lab

* updated docs and images to reflect new solution artifacts and feature enhancements

* Update oda.md

* Update oda.md

* Add files via upload

* Add files via upload

* Update oda.md

* Update oda.md

* Add files via upload

* Update oda.md

* Add files via upload

* Add files via upload

* Update oda.md

* updated link to oda artifacts

* Add files via upload

* Update oda.md

* Add files via upload

* Update oda.md

* Add files via upload

* Update oda.md

* Update agent.md

* added resolution to issue when vb needs to be upgraded

* updated all labs for publishing along with updated artifact links

* removed changes to files in atom workshop

---------

Co-authored-by: abhinavoracle <43648968+abhinavoracle@users.noreply.github.com>
Co-authored-by: kaushik-kundu <kaushik.kundu@oracle.com>
  • Loading branch information
3 people authored Oct 8, 2024
1 parent 3d539a0 commit 7f2b3fb
Show file tree
Hide file tree
Showing 48 changed files with 207 additions and 147 deletions.
7 changes: 3 additions & 4 deletions generative-ai-agent-oda/agent/agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ In this lab, you will:
This lab assumes you have:

* All previous labs successfully completed
* Approval for [OCI Gen AI Agents Beta for RAG](https://apexadb.oracle.com/ords/f?p=108:501:508002131060566::::P501_SELF_NOMINATION:Self-Nomination)
* Permissions to manage OCI Services: Generative AI Agents, Object Storage
* Access to a Region where the Agent service is available: Chicago, Frankfurt

Expand Down Expand Up @@ -65,7 +64,7 @@ This task will help you to create Oracle Object Storage Bucket under your chosen

This task will help you to create Oracle Generative AI Agent’s Knowledge Base under your chosen compartment.

1. Locate Generative AI Agents (new Beta) under AI Services
1. Locate Generative AI Agents under AI Services

![genai agent navigation](images/agent_nav.png)

Expand Down Expand Up @@ -109,7 +108,7 @@ This task will help you to create Oracle Generative AI Agent under your chosen c

2. Specify the agent name, ensure the correct compartment is selected and indicate a suitable welcome message

Select the Knowledge Base that you created in the previous task
Select the Knowledge Base that you created in the previous task. Provide a Welcome message.

Click the “Create” button.

Expand Down Expand Up @@ -164,5 +163,5 @@ You may want to update your agent's knowledge base for a variety of reasons in t
* **Contributors**
* **Abhinav Jain**, Senior Cloud Engineer, NACIE
* **Last Updated By/Date**
* **JB Anderson**, Senior Cloud Engineer, NACIE, August 2024
* **JB Anderson**, Senior Cloud Engineer, NACIE, October 2024

70 changes: 34 additions & 36 deletions generative-ai-agent-oda/functions/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This task is mostly the same as when we deployed the Stack in lab 2. The only re
<!-- https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Tasks/deploybutton.htm
TODO: update package url when available
-->
[![Deploy to Oracle Cloud](https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg)](https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://objectstorage.us-ashburn-1.oraclecloud.com/p/OOL_2RmaYtzKH1cwpwYzo0eLGE1kIKSTywmoJdYa5YN6zVEnBAw7th9E2pa-LxSU/n/c4u02/b/hosted_workshops/o/generative_ai_agent_oda/agent-terraform-livelabs.zip)
[![Deploy to Oracle Cloud](https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg)](https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://objectstorage.us-ashburn-1.oraclecloud.com/p/OOL_2RmaYtzKH1cwpwYzo0eLGE1kIKSTywmoJdYa5YN6zVEnBAw7th9E2pa-LxSU/n/c4u02/b/hosted_workshops/o/generative_ai_agent_oda/agent-terraform-livelabs-1.1.zip)

Clicking this button will direct you to log in to your tenancy and then to Resource Manager's **Create Stack** page

Expand All @@ -47,48 +47,20 @@ This task is mostly the same as when we deployed the Stack in lab 2. The only re
* Optionally, update the name and description of the stack.
* Click Next

3. General Configuration

![variables general configuration](images/variables_general.png)
3. Functions Configuration

* Optionally, You can select another compartment to deploy your resources in
* Customize the prefix used to name resources
* It is required to use a different **prefix** from your first stack to avoid name collisions in a single compartment
* Setting up IAM will enable a policy that allows all ODA instances to talk to functions and all functions to talk to the genai agent service in this compartment.
* These are required to be deployed in your home region
* Setting up Functions will deploy a function application enabled with logging and tracing on top of a Network
Setup the variables in the stack like you did before except for two

4. GenAI Agent Configuration

![variables genai agent configuration](../terraform/images/variables_agent.png)

* Supply the Regional url for the GenAI Agent Endpoint. Chicago's is provided by default
* Provide the OCID for the Agent's Endpoint that was created in lab 1 <!-- should we have this be it's own task or ask reader to write down this value when resource is created in lab 1>

5. Functions Configuration
* It is recommended to use a different **prefix** in the General configuration at the top

![variables functions configuration](images/variables_functions.png)

* Change the **Function Deployment Method** to **fn_cli**
* Optionally you can increase log retention

6. VCN

You have the choice of creating a new vcn or choosing an existing one.

![variables create vcn](../terraform/images/variables_create_vcn.png)

* If you are creating a vcn, You can customize the cidr block ranges

![variables existing vcn](../terraform/images/variables_existing_vcn.png)

* You can also choosing an existing vcn and subnet

<!--TODO: validate what the networking requirements are. Currently provide a SGW and very minimal traffic rules. Not sure we even need that. How many ip addresses does a function application require?-->
* In the functions section at the bottom, click the box to **Manually Deploy Functions**

Click Next

7. Review and Create
4. Review and Create

![stack review](../terraform/images/stack_review.png)

Expand Down Expand Up @@ -193,7 +165,7 @@ The rest of the the instructions in this task expand upon the directions provide

1. Download and unzip Function code

[genai-agent-function](https://objectstorage.us-ashburn-1.oraclecloud.com/p/OOL_2RmaYtzKH1cwpwYzo0eLGE1kIKSTywmoJdYa5YN6zVEnBAw7th9E2pa-LxSU/n/c4u02/b/hosted_workshops/o/generative_ai_agent_oda/agent-function-livelabs.zip)
[genai-agent-function](https://objectstorage.us-ashburn-1.oraclecloud.com/p/OOL_2RmaYtzKH1cwpwYzo0eLGE1kIKSTywmoJdYa5YN6zVEnBAw7th9E2pa-LxSU/n/c4u02/b/hosted_workshops/o/generative_ai_agent_oda/agent-function-livelabs-1.1.zip)

2. In a terminal, navigate to the recently unzipped folder

Expand All @@ -203,6 +175,13 @@ The rest of the the instructions in this task expand upon the directions provide
4. Install requirements
Navigate to the function code folder, activate your virtual environment, and run `pip install -r requirements.txt`

The Following Tasks showcase how to set up the Agent-ODA Chat integration function used in an earlier version of this lab. There are additional functions available in the source code including:

- Chat (default/root folder)
- create_agent (Terraform stand-in)
- auto_ingest (Coming Soon)


## task 5: Test Function Locally

1. Setup local environment variables
Expand Down Expand Up @@ -297,6 +276,25 @@ The rest of the the instructions in this task expand upon the directions provide

<!-- X. Explore Logs and Traces (optional) TODO: create-->

## task 8: (optional) Get the details of an API call including the opc-request-id

![Look up API call through Console Browser including OPC request ID](images/console_opc_request_id.png)
The screenshot above shows how to find the opc request id for a chat message

- When you execute operations on the console, they are transformed into api calls.
- You can view these calls by using the dev tools built into your browser.
- For Firefox,
- right click -> inspect will bring up dev tools
- if you go to the network tab, you can see any api requests
- After the network tab is open, perform the action you want more info on in the console window.
- It is helpful to filter to just the service you are interested in
- agent cp: agent.generativeai
- agent dp: agent-runtime.generativeai
- you should see a stream of api requests. You need to identify what api request you care about based on the status, method, and file columns
- After you click on an individual request, you can see details on the right hand side including the Request and Response Payloads
- The opc-request-id is located in the headers section. You can filter for it


## Acknowledgements

* **Author**
Expand All @@ -305,4 +303,4 @@ The rest of the the instructions in this task expand upon the directions provide
* **Contributors**
* **Abhinav Jain**, Senior Cloud Engineer, NACIE
* **Last Updated By/Date**
* **JB Anderson**, Senior Cloud Engineer, NACIE, August 2024
* **JB Anderson**, Senior Cloud Engineer, NACIE, October 2024
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified generative-ai-agent-oda/functions/images/variables_functions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified generative-ai-agent-oda/introduction/images/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 2 additions & 5 deletions generative-ai-agent-oda/introduction/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ Objective of this workshop is to set-up the required OCI services to create a fu
Users can then upload their own unstructured PDF manuals / documents in those buckets.
* OCI Generative AI Agent Service – Users can configure OCI Generative AI Agent Service (create and configure Knowledge Bases and Agents).
Users can then ingest and perform RAG on the user’s documents in OCI Object Storage, using OCI Generative AI Agent Service.
* OCI Functions – Users can configure OCI Functions, using the provided automation scripts.
Users can then connect to OCI Generative AI Agent Service using OCI Functions. The OCI Functions can be exposed as a Rest Service
* OCI Functions – Users can optionally enable some automation features using the provided OCI Function code
* OCI Digital Assistant (ODA) – Users can create ODA instance and import the provided ODA Skill.
Users can then connect from ODA chatbot to OCI Generative AI Agent Service, leveraging OCI Functions Rest Service.
* OCI Visual Builder (VB) ATOM Application – User can create OCI Visual Builder (VB) instance and import ATOM VB web application.
Expand All @@ -35,7 +34,6 @@ In this workshop, you will learn how to:

* Create Object Storage Buckets, and upload custom PDF documents in those buckets
* Setup & configure Generative AI Agent Service (Knowledge Bases and Agents)
* Setup & configure Functions to connect to Generative AI Agent Service
* Setup & configure ODA as an LLM powered chatbot
* Setup & configure Visual Builder as a frontend channel for ODA
* Test out the features and capabilities of this ATOM application
Expand All @@ -45,7 +43,6 @@ In this workshop, you will learn how to:
This lab assumes you have:

* An Oracle Cloud Account
* Enrolled in Beta for [OCI Generative AI Agents for RAG](https://apexadb.oracle.com/ords/f?p=108:501:508002131060566::::P501_SELF_NOMINATION:Self-Nomination)
* Access to a Region where the Agent service is available: Chicago, Frankfurt
* Must have an Administrator Account or Permissions to manage several OCI Services: Generative AI Agents, Digital Assistant, Visual Builder, Object Storage, Functions, OCIR, Logging, APM, Network, Dynamic Groups, Policies, IDCS/Identity Domain Confidential Applications, Resource Manager
* Familiarity with Oracle Cloud Infrastructure (OCI) is helpful
Expand All @@ -68,5 +65,5 @@ This lab assumes you have:
* **Contributors**
* **Abhinav Jain**, Senior Cloud Engineer, NACIE
* **Last Updated By/Date**
* **JB Anderson**, Senior Cloud Engineer, NACIE, August 2024
* **JB Anderson**, Senior Cloud Engineer, NACIE, October 2024

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added generative-ai-agent-oda/oda/images/click_dg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified generative-ai-agent-oda/oda/images/flow_update_citations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified generative-ai-agent-oda/oda/images/flow_update_endpoint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 7f2b3fb

Please sign in to comment.