You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: generative-ai-agent-adk/adk-installation/adk_install.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Introduction
4
4
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.
Copy file name to clipboardExpand all lines: generative-ai-agent-adk/agent-config/agentconfig.md
+8-11Lines changed: 8 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,9 +34,7 @@ This task imports various ADK Python modules as well as some optional libraries
34
34
```
35
35
36
36

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.
40
38
41
39
## Task 2: Define variables.
42
40
@@ -66,7 +64,7 @@ This task imports various ADK Python modules as well as some optional libraries
66
64
67
65
## Task 3: Define a custom tool based on function.
68
66
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.
70
68
71
69
```
72
70
<copy>
@@ -97,9 +95,9 @@ This task imports various ADK Python modules as well as some optional libraries
97
95
98
96
## Task 4: Define MCP call using stdIO mode.
99
97
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.
103
101
104
102
1. Copy the below to a notebook or local script to define the MCP.
105
103
@@ -170,11 +168,10 @@ This task imports various ADK Python modules as well as some optional libraries
170
168
171
169
172
170
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.
176
173
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.
Copy file name to clipboardExpand all lines: generative-ai-agent-adk/agent-run/agentrun.md
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,11 @@
2
2
3
3
## Introduction
4
4
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*.
7
6
8
7
## Task 1: Run a query using RAG tool.
9
8
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.
11
10
12
11
```
13
12
<copy>
@@ -16,14 +15,15 @@ This lab will provide various run modes with the Agent we have configured.
16
15
response.pretty_print()
17
16
</copy>
18
17
```
18
+
* The agent will run and share the information based on the RAG tool.
19
19
20
20
The agent will run and share the information based on the RAG tool.
21
21
22
22

23
23
24
24
## Task 2: Validate SQL tool execution.
25
25
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.
27
27
28
28
```
29
29
<copy>
@@ -32,13 +32,13 @@ This lab will provide various run modes with the Agent we have configured.
32
32
response.pretty_print()
33
33
</copy>
34
34
```
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.
36
36
37
37

38
38
39
39
## Task 3: Validate function execution.
40
40
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.
42
42
43
43
```
44
44
<copy>
@@ -50,10 +50,9 @@ This lab will provide various run modes with the Agent we have configured.
50
50

51
51
52
52
## Task 4 : Sample agent run using OCI SDK.
53
+
Here, we use the OCI Python SDK to run the agent endpoint and fetch results.
53
54
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.
57
56
58
57
```
59
58
<copy>
@@ -117,7 +116,7 @@ Here we are using the OCI Python SDK to run the agent endpoint and fetch results
117
116
```
118
117

119
118
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.
121
120
122
121

123
122
@@ -134,4 +133,4 @@ Here we are using the OCI Python SDK to run the agent endpoint and fetch results
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
18
24
19
25
- OCI Generative AI Agent build and deploy
20
26
- 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
26
32
27
33
This lab assumes you have:
28
34
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.
Copy file name to clipboardExpand all lines: generative-ai-agent-adk/rag-tools/ragtools.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,24 +2,24 @@
2
2
3
3
## Introduction
4
4
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:
6
6
7
-
-RAG Tool – A RAG tool in Generative AI Agentsretrieves 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.
10
10
11
11
Estimated Time: 30 minutes
12
12
13
13
## Task 1: Download PDFs for the RAG usage.
14
14
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.
0 commit comments