Skip to content

Commit a8253fc

Browse files
committed
Updated README files
1 parent fb65ad6 commit a8253fc

File tree

5 files changed

+122
-61
lines changed

5 files changed

+122
-61
lines changed

autonomous-ai-agents/README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,67 @@ The repository is organized to align with the Select AI Agent framework:
6464

6565
---
6666

67+
## Agent Configuration (`SELECTAI_AGENT_CONFIG`)
68+
69+
### Overview
70+
71+
Select AI agents use a shared configuration table named `SELECTAI_AGENT_CONFIG` to store **agent-specific configuration parameters**.
72+
73+
The table is generic and can be used by any Select AI agent (for example, NL2SQL data retrieval agents or other domain-specific agents). Each agent persists only the configuration keys it requires, while default behavior applies when values are not provided.
74+
75+
---
76+
77+
### Column Description
78+
79+
| Column | Description |
80+
|------|------------|
81+
| `ID` | System-generated unique identifier |
82+
| `KEY` | Configuration parameter name |
83+
| `VALUE` | Configuration value (stored as CLOB) |
84+
| `AGENT` | Logical name of the Select AI agent(Available in tools) |
85+
86+
Configuration entries are uniquely identified by the combination of `KEY` and `AGENT`.
87+
88+
---
89+
90+
### Writing Configuration Entries
91+
92+
Configuration values are written during agent installation or setup.
93+
Only explicitly provided values are persisted; agents apply internal defaults when values are absent.
94+
95+
---
96+
97+
### Example Configuration Entries
98+
99+
#### NL2SQL Data Retrieval Agent
100+
101+
```sql
102+
INSERT INTO SELECTAI_AGENT_CONFIG ("KEY", "VALUE", "AGENT")
103+
VALUES ('ENABLE_RESOURCE_PRINCIPAL', 'YES', 'NL2SQL_DATA_RETRIEVAL_AGENT');
104+
105+
INSERT INTO SELECTAI_AGENT_CONFIG ("KEY", "VALUE", "AGENT")
106+
VALUES ('CREDENTIAL_NAME', 'MY_DB_CREDENTIAL', 'NL2SQL_DATA_RETRIEVAL_AGENT');
107+
```
108+
109+
### JSON-Based Configuration Input
110+
111+
Agent installers may accept configuration as JSON input.
112+
113+
Example:
114+
115+
```{
116+
"use_resource_principal": true,
117+
"credential_name": "MY_DB_CREDENTIAL"
118+
}
119+
```
120+
121+
The installer parses the JSON and stores the relevant values in SELECTAI_AGENT_CONFIG.
122+
123+
### Reading Configuration at Runtime
124+
125+
At runtime, agents read their configuration from SELECTAI_AGENT_CONFIG and consume it as structured JSON. This allows configuration changes without modifying agent code.
126+
127+
67128
## Supported Use Cases
68129

69130
This framework can be used to build Select AI agents for:

autonomous-ai-agents/nl2sql_data_retrieval/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ into a **single autonomous agent workflow**.
3232
| External web search |||
3333
| URL content validation |||
3434
| Chart generation |||
35-
| Config-driven & extensible |||
35+
| Config-driven and extensible |||
3636

3737
> **Result:** Higher accuracy, fewer hallucinations, accurate SQL, and richer analytical answers.
3838
@@ -100,10 +100,10 @@ All credentials are resolved **securely at runtime from OCI Vault**.
100100
- https://console.cloud.google.com
101101

102102
### Step 2: Enable Custom Search API
103-
- APIs & Services → Library → **Custom Search API**
103+
- APIs and Services → Library → **Custom Search API**
104104

105105
### Step 3: Create API Key
106-
- APIs & Services → Credentials → **Create API Key**
106+
- APIs and Services → Credentials → **Create API Key**
107107

108108
### Step 4: Create Custom Search Engine (CX)
109109
- https://programmablesearchengine.google.com
@@ -126,7 +126,7 @@ Run as ADMIN (or privileged user):
126126
```sql
127127
sqlplus admin@db @nl2sql_data_retrieval_tools.sql
128128
```
129-
### Input Parameters required to run.
129+
### Input Parameters required to run
130130
- Target schema name (Schema where to the agent team needs to be installed)
131131
- Cloud Config Parameters required for Websearch (This is mandatory to enable Websearch)
132132
- Google Search API Keys needs to be stored in OCI Vault
@@ -211,7 +211,7 @@ sqlplus admin@db @nl2sql_data_retrieval_tools.sql
211211

212212
---
213213

214-
## Installation – Agent & Team
214+
## Installation – Agent and Team
215215

216216
Run:
217217

@@ -259,7 +259,7 @@ Specialize agents using tasks.**
259259
| Data Retrieval Team | All tools | General analytics |
260260
| Finance Analytics Team | SQL + RANGE | Financial reporting |
261261
| Research Agent Team | WEBSEARCH | External intelligence |
262-
| Visualization Team | SQL + CHART | Dashboards & insights |
262+
| Visualization Team | SQL + CHART | Dashboards and insights |
263263

264264
### Why This Scales Well
265265
- Tools are reusable

autonomous-ai-agents/oci_autonomous_database/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Select AI - OCI Autonomous Database AI Agent & Tools
1+
# Select AI - OCI Autonomous Database AI Agent and Tools
22

33
## Overview
44

@@ -33,12 +33,12 @@ User Request
3333
3434
OCI Autonomous Database Task
3535
36-
Agent Reasoning & Validation
36+
Agent Reasoning and Validation
3737
├── Discovery Tools (Regions, Compartments, Databases)
3838
├── Provisioning Tools
3939
├── Lifecycle Management Tools
40-
├── Configuration & Scaling Tools
41-
└── Maintenance & Backup Tools
40+
├── Configuration and Scaling Tools
41+
└── Maintenance and Backup Tools
4242
4343
Confirmed OCI Operation + Result
4444
```
@@ -51,7 +51,7 @@ Confirmed OCI Operation + Result
5151
.
5252
├── oci_autonomous_database_tools.sql
5353
│ ├── PL/SQL OCI wrapper package
54-
│ ├── OCI authentication & config handling
54+
│ ├── OCI authentication and config handling
5555
│ ├── Autonomous Database lifecycle functions
5656
│ └── AI tool registrations
5757
@@ -84,7 +84,7 @@ Run as ADMIN (or privileged user):
8484
sqlplus admin@db @oci_autonomous_database_tools.sql
8585
```
8686

87-
### Input Parameters required to run.
87+
### Input Parameters required to run
8888
- Target schema name (Schema where to the agent team needs to be installed)
8989
- Cloud Config Parameters.
9090
- OCI Credentials - Required to access to Object Storage buckets.
@@ -113,29 +113,29 @@ sqlplus admin@db @oci_autonomous_database_tools.sql
113113

114114
## Available AI Tools (High Level)
115115

116-
### 🔍 Discovery & Metadata
116+
### 🔍 Discovery and Metadata
117117
- List subscribed regions
118118
- List compartments
119119
- Resolve compartment OCID by name
120120
- List Autonomous Databases
121121
- Get Autonomous Database details
122122

123-
### Provisioning & Lifecycle
123+
### Provisioning and Lifecycle
124124
- Provision Autonomous Database
125125
- Start / Stop / Restart database
126126
- Scale CPU and storage
127127
- Enable / manage autoscaling
128128
- Shrink database
129129
- Delete Autonomous Database (confirmed)
130130

131-
### Configuration & Updates
131+
### Configuration and Updates
132132
- Update database attributes
133133
- Manage power model
134134
- Modify workload and edition
135135
- Update network and security settings
136136
- Manage tags
137137

138-
### Maintenance & Backup
138+
### Maintenance and Backup
139139
- List maintenance run history
140140
- List Autonomous Database backups
141141
- List DB homes
@@ -144,7 +144,7 @@ sqlplus admin@db @oci_autonomous_database_tools.sql
144144

145145
---
146146

147-
## Installation – Agent & Team
147+
## Installation – Agent and Team
148148

149149
Run:
150150

@@ -177,7 +177,7 @@ The task enforces:
177177

178178
---
179179

180-
## Extending & Generalizing the Agent
180+
## Extending and Generalizing the Agent
181181

182182
### Recommended Pattern
183183

@@ -207,23 +207,23 @@ Bind profiles at agent level.**
207207

208208
After creating the Oracle Autonomous Database AI Agent, users can interact with it using prompts such as:
209209

210-
### Discovery & Setup
210+
### Discovery and Setup
211211
- “List all OCI regions I am subscribed to.”
212212
- “Show all compartments in my tenancy.”
213213

214214
### Provisioning Autonomous Databases
215215
- “Help me to Provision a new Autonomous Transaction Processing database"
216216

217-
### Listing & Inspecting Databases
217+
### Listing and Inspecting Databases
218218
- “List all Autonomous Databases in the `Finance` compartment in the Mumbai region.”
219219
- “Get detailed information for the Autonomous Database with OCID `<db_ocid>`.”
220220

221-
### Power & Lifecycle Management
221+
### Power and Lifecycle Management
222222
- “Start the Autonomous Database with OCID `<db_ocid>` in the Mumbai region.”
223223
- “Stop the Autonomous Database with OCID `<db_ocid>`.”
224224
- “Restart the Autonomous Database with OCID `<db_ocid>`.”
225225

226-
### Scaling & Resource Management
226+
### Scaling and Resource Management
227227
- “Increase the CPU count of the Autonomous Database `<db_ocid>` to 8 cores.”
228228
- “Update the storage size of the Autonomous Database `<db_ocid>` to 2 TB.”
229229
- “Shrink the Autonomous Database `<db_ocid>` to optimize storage usage.”
@@ -232,7 +232,7 @@ After creating the Oracle Autonomous Database AI Agent, users can interact with
232232
- “Enable auto-scaling and update the display name for the Autonomous Database `<db_ocid>`.”
233233
- “Update backup retention to 30 days for the Autonomous Database `<db_ocid>`.”
234234

235-
### Maintenance & Backups
235+
### Maintenance and Backups
236236
- “Show maintenance run history for maintenance run ID `<maintenance_id>`.”
237237
- “List all backups for the Autonomous Database `<db_ocid>` in the `Finance` compartment.”
238238

autonomous-ai-agents/oci_network_load_balancer/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Select AI - OCI Network Load Balancer AI Agent & Tools
1+
# Select AI - OCI Network Load Balancer AI Agent and Tools
22

33
## Overview
44

@@ -38,12 +38,12 @@ User Request
3838
3939
OCI Network Load Balancer Task
4040
41-
Agent Reasoning & Validation
42-
├── Region & Compartment Discovery
43-
├── NLB Inventory & Inspection
41+
Agent Reasoning and Validation
42+
├── Region and Compartment Discovery
43+
├── NLB Inventory and Inspection
4444
├── Listener Management
45-
├── Backend Set & Backend Inspection
46-
├── Health & Policy Discovery
45+
├── Backend Set and Backend Inspection
46+
├── Health and Policy Discovery
4747
└── Destructive Action Confirmation
4848
4949
Confirmed NLB Operation + Result
@@ -80,15 +80,15 @@ Confirmed NLB Operation + Result
8080

8181
---
8282

83-
## Installation – Agent & Team
83+
## Installation – Agent and Team
8484

8585
Run as ADMIN (or privileged user):
8686

8787
```sql
8888
sqlplus admin@db @oci_network_load_balancer_agent.sql
8989
```
9090

91-
### Input Parameters required to run.
91+
### Input Parameters required to run
9292
- Target schema name (Schema where to the agent team needs to be installed)
9393
- AI Profile name (Select AI Profile name that needs to be used with the Agent)
9494

@@ -132,13 +132,13 @@ sqlplus admin@db @oci_network_load_balancer_agent.sql
132132
- Update listener
133133
- Delete listener
134134

135-
### Backend & Health
135+
### Backend and Health
136136
- Create backend sets
137137
- List backend sets
138138
- List backends
139139
- Inspect health checks
140140

141-
### Metadata & Capabilities
141+
### Metadata and Capabilities
142142
- List supported NLB policies
143143
- List supported protocols
144144
- Review NLB health summaries
@@ -167,7 +167,7 @@ Bind permissions via AI profiles.**
167167

168168
### Example Extensions
169169
- Read-only NLB inventory agent
170-
- Health monitoring & diagnostics agent
170+
- Health monitoring and diagnostics agent
171171
- Automated NLB provisioning agent
172172
- Multi-compartment governance agent
173173

@@ -187,15 +187,15 @@ Bind permissions via AI profiles.**
187187

188188
After creating the OCI Network Load Balancer AI Agent, users can interact with it using prompts such as:
189189

190-
### Discovery & Setup
190+
### Discovery and Setup
191191
- “List all OCI regions I am subscribed to.”
192192
- “Show all compartments in my tenancy.”
193193

194194
### Network Load Balancer Provisioning
195195
- “Create a public Network Load Balancer named `orders-nlb` in the `Finance` compartment in the Mumbai region with a TCP listener on port 443, a backend set using ROUND_ROBIN policy, and health checks enabled.”
196196
- “Create a private Network Load Balancer in the `Finance` compartment with preserved source IP and IPv4 enabled.”
197197

198-
### Listing & Inspecting Network Load Balancers
198+
### Listing and Inspecting Network Load Balancers
199199
- “List all Network Load Balancers in the `Finance` compartment in the Mumbai region.”
200200
- “Get details of the Network Load Balancer with OCID `<nlb_ocid>`.”
201201

@@ -206,12 +206,12 @@ After creating the OCI Network Load Balancer AI Agent, users can interact with i
206206
- “Update the listener `https-listener` to use a different backend set.”
207207
- “Delete the listener named `https-listener` from the Network Load Balancer `<nlb_ocid>`.”
208208

209-
### Backend Sets & Backends
209+
### Backend Sets and Backends
210210
- “List all backend sets for the Network Load Balancer `<nlb_ocid>`.”
211211
- “Create a backend set named `orders-backend-set` with ROUND_ROBIN policy on port 8080.”
212212
- “List all backends in the backend set `orders-backend-set` for the Network Load Balancer `<nlb_ocid>`.”
213213

214-
### Health, Policies & Protocols
214+
### Health, Policies and Protocols
215215
- “Show health status of all Network Load Balancers in the `Finance` compartment.”
216216
- “List all supported Network Load Balancer policies.”
217217
- “List all supported Network Load Balancer protocols.”
@@ -234,12 +234,12 @@ https://oss.oracle.com/licenses/upl/
234234

235235
---
236236

237-
## ✨ Final Thought
237+
## ✨ Final Thoughts
238238

239239
The OCI Network Load Balancer AI Agent transforms complex networking operations into a **guided, and auditable conversational workflow**, reducing risk while accelerating infrastructure management.
240240

241241
Designed for:
242-
- Platform & networking teams
242+
- Platform and networking teams
243243
- Cloud operations engineers
244244
- Secure infrastructure automation
245245
- Enterprise OCI environments

0 commit comments

Comments
 (0)