Skip to content

Commit 01094be

Browse files
authored
WMS 11892 QA Fixes (#426)
* QA Fixes Clarified instructions, QA * Minor QA Fixes More QA fixes
1 parent 750dafd commit 01094be

File tree

6 files changed

+60
-50
lines changed

6 files changed

+60
-50
lines changed

atom-agent-multi-tool/deploy-agent-tools/deploy-agent-tools.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ This lab will go through the steps on configuring the GenAI Agent tools. First w
66

77
The following agent tools will be configured:
88
* General LLM Chat (Built-in)
9-
* Document Understanding
109
* Weather
1110
* RAG
1211
* SQL
@@ -115,11 +114,9 @@ This task will help you ensure that the Dynamic Group and Policy are correctly d
115114
116115
This task will help you to create a VCN and private subnet in your compartment. This will be used for the ADB for the SQL Tool.
117116
118-
1. Go to Networking -> Virtual cloud networks and Create VCN. Provide IPv4 CIDR Blocks as 10.0.0.0/16
117+
1. Go to Networking -> Virtual cloud networks and select the VCN created in Lab 1.
119118
120-
2. Go to the newly created VCN and click on Create Subnet. Provide IPv4 CIDR Block as 10.0.1.0/24 and click on Private Subnet. You can leave rest as default. Click on Create Subnet.
121-
122-
3. Click on newly created subnet and go to the Security List. Add following ingress rules in the security list. Make sure to have the ingress rule to access database port 1521-1522
119+
2. Click on the private subnet and go to the Security List. Add following ingress rules in the security list. Make sure to have the ingress rule to access database port 1521-1522
123120
124121
![Ingress Rules](images/adb/ingress_rules.png)
125122
@@ -248,7 +245,13 @@ CREATE TABLE Employees (
248245
</copy>
249246
```
250247

251-
> **Note** If you are using your own table, you can get a better idea of the schema by running DESC table_name;
248+
> **Note** If using your own table, to get a better idea of the schema run
249+
250+
```sql
251+
DESC table_name;
252+
```
253+
254+
in SQL Developer.
252255

253256
![Create SQL Tool](images/sqltool/create-tool.png)
254257

@@ -265,17 +268,17 @@ CREATE TABLE Employees (
265268

266269
![Test SQL Tool](./images/sql/test-sql-tool-2.png)
267270

268-
> * **Note** If your sql tool is not returning the correct response, it can be helpful to provide an in-line example to the tool. Also see [SQL Tool Guidelines](https://docs.oracle.com/en-us/iaas/Content/generative-ai-agents/sqltool-guidelines.htm#sqltool-iclexamples)
271+
> * **Note** If the sql tool is not returning the correct response, it can be helpful to provide an in-line example to the tool. Also see [SQL Tool Guidelines](https://docs.oracle.com/en-us/iaas/Content/generative-ai-agents/sqltool-guidelines.htm#sqltool-iclexamples)
269272
270-
> * **Note** Also make sure your agent is using the correct tool for the job. If the agent is using the wrong tool, make sure to add a more detailed description and/or routing instructions.
273+
> * **Note** Also make sure the agent is using the correct tool for the job. If the agent is using the wrong tool, make sure to add a more detailed description and/or routing instructions.
271274
272-
> * **Note** If you are getting 404 errors, you are likely missing a policy. Refer back to Task 1 step 6.
275+
> * **Note** If returning 404 errors, there is likely a missing policy. Refer back to [Task 2 step 6](./deploy-agent-tools.md#task-2-dynamic-group-and-policy-definition-for-adb-and-db-tools-connection).
273276
274-
> * **Note** If you are querying a large table and getting 100+ rows of results, the query will fail. Try adding more filters to your query to reduce size of response.
277+
> * **Note** If querying a large table and getting 100+ rows of results, the query will fail. Try adding more filters to the query to reduce size of response.
275278
276279
## Task 9: Create a Weather Tool
277280

278-
1. Navigate to your agent tools and create a new tool called "get_weather"
281+
1. Navigate to the agent tools and create a new custom function tool called "get_weather"
279282

280283
- Give the following description -
281284

@@ -306,7 +309,7 @@ In this section, we will delve into the process of creating and deploying an Ora
306309
307310
2. Navigate back to your function application created in the previous lab.
308311
309-
3. Select Getting Started > Cloud setup and take note of the steps to login and deploy the functions.
312+
3. Select Application > Cloud shell setup > View guide and take note of the steps to login and deploy the functions.
310313
311314
![Fn Cloud Setup](images/fn-deploy/cloud-shell.png)
312315
@@ -315,7 +318,7 @@ In this section, we will delve into the process of creating and deploying an Ora
315318
- Logging in to the container registry
316319
- Deploying the function to your application
317320
318-
> **Note:** You don't need to run the last invoke command. We will be invoking the function later from ODA.
321+
> **Note:** The init command doesn't need to be run since the fn is already provided. The last invoke command also doesn't need to be ran. We will be invoking the function later from ODA.
319322
320323
4. At the top right of the oci console, open a new cloud shell
321324
@@ -357,15 +360,23 @@ In this section, we will delve into the process of creating and deploying an Ora
357360
</copy>
358361
```
359362

360-
- Take note of the function invoke endpoint once created
363+
- Take note of the function invoke endpoint once created.
361364

362365
![Deployed Function](images/fn-deploy/deploy_function.png)
363366

364-
> **Note** If you get an error with the architecture, you can change the architecture from the cloud shell
367+
> **Note** If there is an error with the architecture, the architecture can be changed from the cloud shell.
368+
369+
> **Note** If you run into space issues, you can delete any unused containers with
370+
371+
```bash
372+
$ docker image prune
373+
or
374+
$ docker image prune -a
375+
```
365376

366377
![Change Architecture](images/fn-deploy/change-architecture-cs.png)
367378

368-
> **Note** Functions can sometimes time out when invoked for the first time (cold start). To avoid this, you can enable provisioned concurrency on your function to enable hot starts.
379+
> **Note** Functions can sometimes time out when invoked for the first time (cold start). To avoid this, enable provisioned concurrency on the function to enable hot starts.
369380
370381
![Provisioned Concurrency](images/fn-deploy/provisioned-concurrency.png)
371382

@@ -388,4 +399,4 @@ In this section, we will delve into the process of creating and deploying an Ora
388399
* **Abhinav Jain**, Senior Cloud Engineer, NACIE
389400

390401
**Last Updated By/Date**
391-
* **Luke Farley**, Senior Cloud Engineer, NACIE, May 2025
402+
* **Luke Farley**, Senior Cloud Engineer, NACIE, Sept 2025
-196 KB
Loading

atom-agent-multi-tool/integrate-digital-assistant/integrate-digital-assistant.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This task will help you to create Oracle Digital Assistant under your chosen com
3434

3535
![Navigate to Digital Assistant](images/oda/oda_provision_1.png)
3636

37-
> **Note:** You can find Digital Assistant under the AI Services.
37+
> **Note:** Digital Assistant can be found under AI Services.
3838
3939
2. Provide the information for **Compartment**, **Name** , **Description** (optional) & **Shape**. Click **Create**
4040

@@ -87,7 +87,8 @@ Rule 3
8787
```text
8888
<copy>
8989
Allow any-user to use fn-invocation in tenancy where request.principal.id='ocid1.odainstance.oc1.us-chicago-1.XXXXXXXXXXXXXXXXXXXX'
90-
Allow dynamic-group odaDynamicGroup to use fn-invocation in tenancy
90+
Allow dynamic-group <your-dynamic-group> to use fn-invocation in tenancy
91+
Allow dynamic-group <your-dynamic-group> to manage genai-agent-family in tenancy
9192
</copy>
9293
```
9394
@@ -107,11 +108,11 @@ Rule 3
107108
108109
3. Test the connection. If successful, you should get a 200 response with a session id. Note the session id for the next Task.
109110
110-
> **Note** If you get a 404 error, that likely means a policy is missing or misconfigured. Check Task 2 and make sure the ODA service can connect to the agent service.
111+
> **Note** If it's throwing a 404 error, that likely means a policy is missing or misconfigured. Check [Task 2](./integrate-digital-assistant.md#task-2-dynamic-group--policy-creation-for-oracle-digital-assistant) and make sure the ODA service can connect to the agent service.
111112
112113
## Task 4: Configure API Endpoint to Agent Function
113114
114-
1. Open your ODA service console provisioned in Task 1 and navigate to API services > Add Service
115+
1. Open the ODA service console provisioned in Task 1 and navigate to API services > Add Service
115116
116117
![API Services](images/oda/oda-configure-fn.png)
117118
@@ -128,17 +129,21 @@ Rule 3
128129
</copy>
129130
```
130131
131-
3. If configured correctly, you should get a success response
132+
> * **Note** Be sure to include OCI Resource Principal as authentication.
133+
134+
3. If configured correctly, there should be a success response
132135
133136
![200 Response](images/oda/success-response.png)
134137
135-
> * **Note** 404 responses usually indicate a policy is missing/misconfigured. Please refer back to Task 2.
138+
> * **Note** 404 responses usually indicate a policy is missing/misconfigured. Please refer back to [Task 2](./integrate-digital-assistant.md#task-2-dynamic-group--policy-creation-for-oracle-digital-assistant).
139+
140+
> * **Note** Session IDs by default last for one hour. After one hour a new session id will have to be created.
136141
137-
> * **Note** Session IDs by default last for one hour. After one hour you will have to generate a new session id.
142+
> * **Note** If the function isn't enabled to have hot starts, the function might need to be invoked twice before getting a 200 response.
138143
139144
## Task 5: Import Skill
140145
141-
1. Import the following skill
146+
1. Import the following skill under Development > Skills > Import Skill (top right)
142147
143148
[genai-agent-adk-livelab](https://idb6enfdcxbl.objectstorage.us-chicago-1.oci.customer-oci.com/n/idb6enfdcxbl/b/Livelabs/o/atom-multi-tool-livelab%2Fgenaiagentadklivelab(1.0).zip)
144149
@@ -150,7 +155,7 @@ Rule 3
150155
151156
4. Open the 'UnresolvedIntent' flow and select the 'callAgent' state
152157
153-
5. In the REST service select your own function api endpoint
158+
5. In the REST service select the function api endpoint
154159
155160
![Configure Agent Fn](images/oda/skill-config-fn.png)
156161
@@ -165,17 +170,19 @@ Rule 3
165170
</copy>
166171
```
167172
168-
7. Train the bot and select preview (top right). Ask a question such as 'How are you'. If everything was configured correctly, you should get a response.
173+
7. Set the Result variable to 'agentResult'.
169174
170-
> **Note** You can review any unexpected behavior in the preview of ODA to diagnose any issues.
175+
8. Train the bot and select preview (top right). Ask a question such as 'How are you'. If everything was configured correctly, you should get a response.
176+
177+
> **Note** Any unexpected behavior can be reviewed in the preview of ODA to diagnose issues.
171178
172179
## Task 6: Configure & Expose Skill
173180
174181
1. Navigate to Development > Channels and select 'Add Channel'
175182
176183
![Add Channel](images/oda/add-channel.png)
177184
178-
2. Select Oracle Web, disable client authentication, and put '*' as allowed domains
185+
2. Select Oracle Web, disable client authentication, and put '*' as allowed domains. Also make sure the channel is routed to the skill and enabled.
179186
180187
![Create Channel](images/oda/create-channel.png)
181188
@@ -217,7 +224,7 @@ Rule 3
217224
218225
* **URI** = '<https://oda-XXXXXXXXXXXXXXXXXXXXXX.data.digitalassistant.oci.oraclecloud.com/>'
219226
* **channelId** = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX'
220-
* Please change value of initUserHiddenMessage on Line 32 from 'what can you do' to 'Hello'
227+
* Please make sure the initUserHiddenMessage on Line 32 is 'Hello'
221228
222229
![Create Channel](images/vb/vb_config.png)
223230
@@ -235,15 +242,17 @@ Rule 3
235242
236243
![Invoke Tools](images/vb/chat-sql.png)
237244
238-
> * **Note** If you are using your own tables with lots of data and it occasionally throws 'Oops' errors, this can be fixed by optimizing your sql queries. This can be done by filtering your results to remove unnecessary columns, specifically by providing in-line sql example to the sql tool. Refer back to the previous lab on creating sql tools.
245+
> * **Note** If using your own tables with lots of data and it occasionally throws 'Oops' errors, this can be fixed by optimizing the sql queries. This can be done by filtering the results to remove unnecessary columns, specifically by providing in-line sql example to the sql tool. Refer back to the [previous lab](../deploy-agent-tools/deploy-agent-tools.md#task-8-create-sql-tool) on creating sql tools.
239246
240247
* You can also invoke the raq tool or ask general questions
241248
242249
![RAG and General Questions](images/vb/chat-3.png)
243250
244251
**Troubleshooting**
245252
246-
1. If you get 404 errors, it's likely a permission issue. Please review the policies.
253+
1. If there are 404 errors, it's likely a permission issue. Please review the policies.
254+
255+
2. For other errors, logging can be enabled in the function application under Monitoring > Function Invocation logs.
247256
248257
## Acknowledgements
249258
@@ -255,4 +264,4 @@ Rule 3
255264
* **Abhinav Jain**, Senior Cloud Engineer, NACIE
256265
257266
**Last Updated By/Date:**
258-
* **Luke Farley**, Senior Cloud Engineer, NACIE, May 2025
267+
* **Luke Farley**, Senior Cloud Engineer, NACIE, Sept 2025
-26.3 KB
Loading
-17.3 KB
Loading

atom-agent-multi-tool/provision-agent/provision-agent.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -170,26 +170,14 @@ This task will help you to create Oracle Object Storage Bucket under your chosen
170170

171171
**Note:** The Gen AI Agents service currently supports .pdf and .txt file formats
172172

173-
<!--TODO: should we provide a sample dataset? -->
173+
If you would like to use a sample pdf, click [here](https://objectstorage.us-chicago-1.oraclecloud.com/p/FGxCnVLMgA-0O62bDnhbQCc-0dHHE8nbUaWpCGITsYtkeX3LA8dXp7NYeL_F609R/n/idb6enfdcxbl/b/Livelabs/o/atom-multi-tool-livelab/Design%20Considerations%20for%20GenAI%20Apps.pdf)
174174

175175
![object storage select files](images/kb/os_file_select.png)
176176

177177
2. Click Upload -> Close to upload the PDF file in the Object Storage Bucket.
178178

179179
![object storage upload files](images/kb/os_upload.png)
180180

181-
3. Create a PAR (Pre-Authenticated Request) for your newly created bucket.
182-
183-
![create par](images/kb/create_par.png)
184-
185-
4. Create this PAR at the bucket level and not the object level. Also, change the expiration date to a future date preferably 4-5 years from now.
186-
187-
![create par bucket](images/kb/create_par_bucket.png)
188-
189-
5. Copy over the PAR URL highlighted in the image below. Please copy over the second URL and not the first one.
190-
191-
![par url](images/kb/par_url.png)
192-
193181
## Task 6: Provision Knowledge Base
194182

195183
This task will help you to create Oracle Generative AI Agent’s Knowledge Base under your chosen compartment.
@@ -244,6 +232,8 @@ This task will help you to create Oracle Generative AI Agent under your chosen c
244232

245233
![agent creation wizard](images/agent/agent_wizard.png)
246234

235+
> **Note** The agent tools will be configured in the next lab.
236+
247237
3. In few minutes the status of recently created Agent will change from Creating to Active
248238

249239
Click on “Endpoints” menu item in the left panel and then the Endpoint link in the right panel.
@@ -269,7 +259,7 @@ In this section, we will deploy a VCN, OCI Function application, and a serverles
269259

270260
![Create VCN](images/functions/networking-vcn.png)
271261

272-
- Select 'Start VCN Wizard'
262+
- Select Actions > 'Start VCN Wizard'
273263

274264
![Start VCN Wizard](images/functions/vcn-wizard.png)
275265

@@ -283,7 +273,7 @@ In this section, we will deploy a VCN, OCI Function application, and a serverles
283273

284274
- Navigate to Review and Create and select 'Create'
285275

286-
3. Create function application using subnet in previous step
276+
3. Create function application using the public subnet in previous step
287277

288278
- From the Cloud Console, navigate to Developer Services > Functions > Applications
289279

@@ -293,7 +283,7 @@ In this section, we will deploy a VCN, OCI Function application, and a serverles
293283

294284
![Fn App Config](images/functions/fn-app-config.png)
295285

296-
4. You may now **proceed to the next lab*
286+
4. You may now **proceed to the next lab**
297287

298288
## Learn More
299289

@@ -314,4 +304,4 @@ In this section, we will deploy a VCN, OCI Function application, and a serverles
314304
* **Yanir Shahak**, Senior Principal Software Engineer
315305

316306
**Last Updated By/Date:**
317-
* **Luke Farley**, Senior Cloud Engineer, NACIE, May 2025
307+
* **Luke Farley**, Senior Cloud Engineer, NACIE, Sept 2025

0 commit comments

Comments
 (0)