Skip to content

Commit 4526010

Browse files
authored
Fixes & Redwood theme updates (#457)
* Update manifest.json * Update manifest.json * Update manifest.json * fixes * Update agentrun.md
1 parent d030782 commit 4526010

File tree

11 files changed

+72
-81
lines changed

11 files changed

+72
-81
lines changed

generative-ai-agent-adk/adk-installation/adk_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Introduction
44

5-
This lab will take you through the steps needed to install ADK using the Python installer. We recommend using an OCI Data Science-based notebook to run the operation, as it comes with all the necessary software in place. However, we have added optional steps to follow on a local machine for the ADK client setup.
5+
This lab guides you through installing ADK using the Python installer. We recommend using an *OCI Data Science* notebook, as it includes all necessary software. Optional steps are provided for installing the ADK client on a local machine.
66

77
Estimated Time: 30 minutes
88

generative-ai-agent-adk/agent-config/agentconfig.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@ This task imports various ADK Python modules as well as some optional libraries
3434
```
3535
3636
![](images/module_import.png)
37-
38-
3. For notebooks, you may use the Play button and run these commands. For Python scripts, you may use your editor or run using the python script.py format.
39-
37+
1. In notebooks, use the *Play* button to run these commands. For Python scripts, use your editor or run with the *python script.py* command.
4038
4139
## Task 2: Define variables.
4240
@@ -66,7 +64,7 @@ This task imports various ADK Python modules as well as some optional libraries
6664
6765
## Task 3: Define a custom tool based on function.
6866
69-
1. Use the below code to set a simple custom function-based tool, which will return the season based on a location.
67+
1. Use the code below to create a simple custom function-based tool that returns the season for a given location.
7068
7169
```
7270
<copy>
@@ -97,9 +95,9 @@ This task imports various ADK Python modules as well as some optional libraries
9795
9896
## Task 4: Define MCP call using stdIO mode.
9997
100-
* We are using an open-source MCP library to fetch information from the public internet.
101-
* The library details and credit goes to https://github.com/openbnb-org/mcp-server-airbnb.
102-
* If you are using local client execution, ensure Node.js and npx are available to run.
98+
* We use an open-source MCP library to fetch information from the public internet.
99+
* Library details and credit: https://github.com/openbnb-org/mcp-server-airbnb.
100+
* For local client execution, ensure Node.js and npx are available.
103101
104102
1. Copy the below to a notebook or local script to define the MCP.
105103
@@ -170,11 +168,10 @@ This task imports various ADK Python modules as well as some optional libraries
170168
171169
172170
173-
## Task 7: Initialize and set up the agent.
174-
During the process, the ADK will check the tools defined and associate them with the Agent.
175-
The process may take several minutes depending on the tools and their configuration.
171+
## Task 7: Initialize and setup the agent.
172+
During the process, ADK will check the defined tools and associate them with the Agent. This may take several minutes, depending on the tools and their configuration.
176173
177-
1. Run the below to set up and run a sample query. The setup process is only needed for the first time or for any configuration changes that need to be pushed from the local environment or notebook to agents. You may update your query as well.
174+
1. Run the following to set up and execute a sample query. Setup is required only the first time or when configuration changes need to be pushed from local or notebook to the agent. You may also update your query as needed.
178175
179176
```
180177
<copy>

generative-ai-agent-adk/agent-run/agentrun.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22

33
## Introduction
44

5-
This lab will provide various run modes with the Agent we have configured.
6-
5+
This lab demonstrates various run modes available with the configured *Agent*.
76

87
## Task 1: Run a query using RAG tool.
98

10-
1. Run the query below to fetch answers from the OCI Agent RAG tool based on the attached knowledge base.
9+
1. Run the query below to fetch answers from the OCI Agent RAG tool, using the attached knowledge base.
1110

1211
```
1312
<copy>
@@ -16,14 +15,15 @@ This lab will provide various run modes with the Agent we have configured.
1615
response.pretty_print()
1716
</copy>
1817
```
18+
* The agent will run and share the information based on the RAG tool.
1919
2020
The agent will run and share the information based on the RAG tool.
2121
2222
![Rag run](images/rag-run.png)
2323
2424
## Task 2: Validate SQL tool execution.
2525
26-
1. Run the query below to fetch information via the agent, which will retrieve and report the data from the Autonomous AI Database.
26+
1. Run the query below to fetch information through the agent, which will retrieve and report data from the Autonomous AI Database.
2727
2828
```
2929
<copy>
@@ -32,13 +32,13 @@ This lab will provide various run modes with the Agent we have configured.
3232
response.pretty_print()
3333
</copy>
3434
```
35-
* Here, the query about the secondary category will be translated to the product subcategory based on the column description defined during SQL tool setup.
35+
* Here, the query about secondary category will be mapped to the product subcategory, based on the column description defined during SQL Tool setup.
3636
3737
![SQL Run](images/sql-run.png)
3838
3939
## Task 3: Validate function execution.
4040
41-
1. Run the command below to see how the agent reacts based on the function tool we defined.
41+
1. Run the code below to see how the agent responds using the defined function tool.
4242
4343
```
4444
<copy>
@@ -50,10 +50,9 @@ This lab will provide various run modes with the Agent we have configured.
5050
![Custom tool run](images/custom_tool_run.png)
5151
5252
## Task 4 : Sample agent run using OCI SDK.
53+
Here, we use the OCI Python SDK to run the agent endpoint and fetch results.
5354
54-
Here we are using the OCI Python SDK to run the agent endpoint and fetch results.
55-
56-
1. Use the snippet below to fetch results using the OCI SDK. You may comment/uncomment the Auth section, region, and endpoint details accordingly.
55+
1. Use the snippet below to retrieve results with the OCI SDK. Comment or uncomment the authentication section, region, and endpoint details as needed.
5756
5857
```
5958
<copy>
@@ -117,7 +116,7 @@ Here we are using the OCI Python SDK to run the agent endpoint and fetch results
117116
```
118117
![SDK Run](images/sdk-run.png)
119118
120-
2. A sample execution result will be as follows. It is for demo purposes only, and the same can be achieved using ADK. As you may observe, the SDK operates at a lower API level, while ADK remains at a higher abstraction layer.
119+
1. A sample execution result is shown below for demonstration purposes. The same outcome can be achieved using ADK. The SDK operates at a lower API level, while ADK functions at a higher abstraction layer.
121120
122121
![SDK run output](images/sdk-output.png)
123122
@@ -134,4 +133,4 @@ Here we are using the OCI Python SDK to run the agent endpoint and fetch results
134133
* **Author**
135134
* **Rahul MR**, Prinicipal Solutions Architect - OCI
136135
* **Contributors**
137-
* **Sanjeeva Kalva**, Principal Data Scientist - OCI
136+
* **Sanjeeva Kalva**, Principal Data Scientist - OCI
5.24 KB
Loading
79.1 KB
Loading
-25.9 KB
Loading

generative-ai-agent-adk/agent-setup/setup.md

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Estimated Time: 30 minutes
1515

1616
## Task 1: Dynamic Group and Policy Definition
1717

18-
This task will help you ensure that the Dynamic Group and Policy are correctly defined.
18+
This task will help you setup and verify that the Dynamic Group and Policy are correctly defined.
1919

2020
1. Locate Domains under Identity & Security
2121

@@ -26,8 +26,7 @@ This task will help you ensure that the Dynamic Group and Policy are correctly d
2626
3. Click on Dynamic Groups, and then your Dynamic Group name.
2727

2828
![Dynamic group](images/domain_dg.png)
29-
30-
4. Click Create dynamic group. Provide a name and a description. Select the option Match any rules defined below.
29+
1. Click *Create Dynamic Group.* Provide a name and description, then select the "Match any rules defined below" option.
3130

3231
![Create Dynamic group](images/create_dg.png)
3332

@@ -51,7 +50,7 @@ This task will help you ensure that the Dynamic Group and Policy are correctly d
5150

5251
## Task 2: Create Policies
5352

54-
This task will help you associate necessary policies with the dynamic group.
53+
This task will help you associate the necessary policies with the dynamic group.
5554

5655
1. Select Policies from the Identity & Security section.
5756

@@ -65,9 +64,8 @@ This task will help you associate necessary policies with the dynamic group.
6564

6665
![create policy](images/create_policy.png)
6766

68-
5. Click the Show manual editor option.
69-
70-
6. Add the policy statements below, ensuring to update the OCIDs accordingly:
67+
1. Click *Show manual editor* option.
68+
1. Add below policy statements,ensure to update resource's OCIDs accordingly.
7169

7270
```
7371
<copy>
@@ -88,7 +86,7 @@ This task will help you associate necessary policies with the dynamic group.
8886

8987
## Task 3: Create Virtual Cloud Network and Subnet
9088

91-
This task allows you to create the VCN that we will use for various transactions.
89+
This task allows you to create the VCN that will be used for various transactions.
9290

9391
1. From OCI Console, select Networking > Virtual Cloud Networks
9492

@@ -102,15 +100,14 @@ This task allows you to create the VCN that we will use for various transactions
102100

103101
![VCN options](images/vcn_options.png)
104102

105-
4. Provide a name and description. Use the default information and create the VCN.
106-
107-
5. Wait for the VCN state to become Active.
103+
1. Provide a name and description, use the default settings, and create the VCN.
104+
1. Wait for the vcn state to be *Active*.
108105

109106
![VCN State](images/vcn_active.png)
110107

111108
## Task 4: Create Autonomous AI Database (ADB).
112109

113-
This task helps to create an ADB that we will use for NL2SQL tool usage.
110+
This task helps you create the ADB for use with the NL2SQL tool.
114111

115112
1. From OCI Console > Oracle AI Database > Autonomous AI Databases
116113

@@ -122,7 +119,7 @@ This task helps to create an ADB that we will use for NL2SQL tool usage.
122119

123120
![Create DB](images/create_db_basic.png)
124121

125-
4. Select version 26ai. Select other default configuration values.
122+
1. Select version as *26ai*.Select other default configuration values.
126123

127124
![ADB config](images/adb_base_config.png)
128125

@@ -142,22 +139,15 @@ This task helps to create an ADB that we will use for NL2SQL tool usage.
142139

143140
## Task 5: Create a Vault
144141

145-
This task helps to set up the OCI Vault.
146-
147-
1. From OCI Console > Identity & Security > Key Management & Secret Management > Vault
142+
This task helps you set up the OCI Vault.
148143

144+
1. From the OCI Console, go to *Identity & Security* > *Key Management & Secret Management* > *Vault*.
149145
![Create vault](images/create_vault.png)
150-
151-
2. Click Create Vault. Provide a name and click Create Vault.
152-
146+
1. Click *Create Vault*, provide a name, and click *Create Vault*.
153147
![Create vault](images/vault_master.png)
154-
155-
3. Click Create Master Key. Provide a name and use the default options. Click Create Key.
156-
157-
148+
1. Click *Create Master Key*, provide a name, use the default options, and click *Create Key*.
158149
![Create master key](images/create_vault_key.png)
159-
160-
4. Wait until the resources are in Active state before moving to the next section.
150+
1. Wait until the resources are in the active state before proceeding to the next section.
161151

162152
## Task 6: Create Database Connection
163153

@@ -167,7 +157,7 @@ This task allows you to create a DB connection for agent usage.
167157

168158
![DB connections](images/db_connection.png)
169159

170-
2. Click Create Connection. Provide a name for the connection. Always ensure the desired compartment is selected.
160+
1. Click *Create connection*.Provide name for the connection.Always ensure you have selected the desired compartment.
171161

172162
![DB connection create](images/connection_basics.png)
173163

generative-ai-agent-adk/introduction/introduction.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ Estimated Workshop Time: 2 hours
1414

1515
### Objectives
1616

17-
The objective of this workshop is to configure, build, deploy, and run OCI Generative AI Agents using the Agent Development Kit (ADK). The following services and features will be covered during the lab:
17+
The objective of this workshop is to configure, build, deploy, and run OCI Generative AI Agents using the Agent Development Kit (**ADK**). The following services and features will be covered during the lab:
18+
19+
* OCI Generative AI Agent build and deploy
20+
* Configure and use the inbuilt Retrieval Augmented Generation (**RAG**) tool
21+
* Configure and use the inbuilt Natural Language to SQL tool (**NL2SQL**)
22+
* Use Model Context Protocol (**MCP**) with OCI Generative AI Agent
23+
* Configure and use custom tools with OCI Generative AI Agents
1824

1925
- OCI Generative AI Agent build and deploy
2026
- Configure and use the inbuilt Retrieval Augmented Generation (RAG) tool
@@ -26,13 +32,13 @@ The objective of this workshop is to configure, build, deploy, and run OCI Gener
2632

2733
This lab assumes you have:
2834

29-
- An Oracle Cloud Account (non-Free Tier)
30-
- Access to OCI Generative AI Agents
31-
- Access to a region where the Agent service is available
32-
- Refer [here for more.](https://docs.oracle.com/en-us/iaas/Content/generative-ai-agents/overview.htm#regions)
33-
- An OCI compartment where we will allocate all the necessary resources
34-
- An Administrator account or permissions to manage several OCI services: Generative AI Agents, Autonomous Databases, Data Science, Object Storage, Network, Dynamic Groups, Policies, IDCS/Identity
35-
- Familiarity with Oracle Cloud Infrastructure (OCI) is helpful
35+
* An Oracle Cloud Account (Non-Free Tier).
36+
* Access to OCI Generative AI Agents.
37+
* Access to a region where the Agent service is available.
38+
* Refer [here for more.](https://docs.oracle.com/en-us/iaas/Content/generative-ai-agents/overview.htm#regions)
39+
* An OCI compartment for allocating all necessary resources.
40+
* An Administrator Account or permissions to manage the following OCI services: Generative AI Agents, Autonomous Databases, Data Science, Object Storage, Network, Dynamic Groups, Policies, IDCS/Identity
41+
* Familiarity with Oracle Cloud Infrastructure (OCI) is helpful.
3642

3743
## Learn More
3844

generative-ai-agent-adk/rag-tools/ragtools.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@
22

33
## Introduction
44

5-
This lab will take you through the steps needed to install, set up a knowledge base, configure a data source, and connect it with OCI Agents. The lab covers the following elements of OCI Generative AI Agents concepts:
5+
This lab will guide you through the steps to set up knowledge bases, configure data sources, and connect with OCI Agents. The lab covers the following OCI Generative AI Agent concepts:
66

7-
- RAG Tool – A RAG tool in Generative AI Agents retrieves information from one or more knowledge bases and aims to respond with relevant and context-aware information in natural language.
8-
- Knowledge Bases A knowledge base is the foundation for all the data sources that an agent can use to retrieve information for its chat answers. You can create a knowledge base in advance and then add it to an agent's RAG tool.
9-
- Data Source A data source points to the location of the data. After you add a data source to a knowledge base, you must ingest the data so agents using the knowledge base can access that information.
7+
* *RAG Tool* - In Generative AI Agents, a RAG tool retrieves information from one or more knowledge bases and provides relevant, context-aware responses in natural language.
8+
* *Knowledge Bases* - A knowledge base contains the data sources that an agent can use to retrieve information for chat responses. You can create a knowledge base in advance and then add it to an agent's RAG tool.
9+
* *Data Source* - A data source specifies where the data resides. After adding a data source to a knowledge base, you must ingest the data so that agents using the knowledge base can access it.
1010

1111
Estimated Time: 30 minutes
1212

1313
## Task 1: Download PDFs for the RAG usage.
1414

15-
1. Run the command below if using a Data Science notebook. Otherwise, move to the next step for ADK running on a local machine.
15+
1. Run the command below for the Data Science notebook, or proceed to the next step for running ADK on a local machine.
1616

17-
```
18-
<copy>
19-
mkdir pdfs
20-
wget https://docs.oracle.com/en/database/oracle/sql-developer-command-line/19.2/sqcug/oracle-sqlcl-users-guide.pdf -O pdfs/oracle-sqlcl-users-guide.pdf
21-
wget https://docs.oracle.com/en/database/oracle/oracle-database/23/vecse/ai-vector-search-users-guide.pdf -O pdfs/ai-vector-search-users-guide.pdf
22-
wget https://docs.oracle.com/en/operating-systems/oracle-linux/10/relnotes10.0/OL10-RELNOTES-10-0.pdf -O pdfs/OL10-RELNOTES-10-0.pdf
17+
```
18+
<copy>
19+
!mkdir pdfs
20+
!wget https://docs.oracle.com/en/database/oracle/sql-developer-command-line/19.2/sqcug/oracle-sqlcl-users-guide.pdf -O pdfs/oracle-sqlcl-users-guide.pdf
21+
!wget https://docs.oracle.com/en/database/oracle/oracle-database/26/vecse/ai-vector-search-users-guide.pdf -O pdfs/ai-vector-search-users-guide.pdf
22+
!wget https://docs.oracle.com/en/operating-systems/oracle-linux/10/relnotes10.0/OL10-RELNOTES-10-0.pdf -O pdfs/OL10-RELNOTES-10-0.pdf
2323
</copy>
2424
```
2525
@@ -31,7 +31,7 @@ Estimated Time: 30 minutes
3131
<copy>
3232
mkdir pdfs
3333
wget https://docs.oracle.com/en/database/oracle/sql-developer-command-line/19.2/sqcug/oracle-sqlcl-users-guide.pdf -O pdfs/oracle-sqlcl-users-guide.pdf
34-
wget https://docs.oracle.com/en/database/oracle/oracle-database/23/vecse/ai-vector-search-users-guide.pdf -O pdfs/ai-vector-search-users-guide.pdf
34+
wget https://docs.oracle.com/en/database/oracle/oracle-database/26/vecse/ai-vector-search-users-guide.pdf -O pdfs/ai-vector-search-users-guide.pdf
3535
wget https://docs.oracle.com/en/operating-systems/oracle-linux/10/relnotes10.0/OL10-RELNOTES-10-0.pdf -O pdfs/OL10-RELNOTES-10-0.pdf
3636
</copy>
3737
```
@@ -109,7 +109,7 @@ Estimated Time: 30 minutes
109109
110110
![KB progress](images/kb_in_progress.png)
111111
112-
14. Once it becomes active, make a note of the OCID for further steps.
112+
1. Once its become active,make a note of the OCID for further steps.
113113
114114
![KB final](images/kb_active.png)
115115

generative-ai-agent-adk/references/references.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# References
22

33
## Introduction
4+
The reference section provides sample snippets used in the lab, along with key links.
45

5-
This reference section provides the sample snippet that we used, as well as some of the key links.
6-
* The full sample used during the labs can be found below:
6+
* The complete sample used during the labs is provided below.
77

88
```
99
import nest_asyncio

0 commit comments

Comments
 (0)