select_ai documentation

select_ai is a Python module which enables integrating DBMS_CLOUD_AI PL/SQL package into Python workflows. It bridges the gap between PL/SQL package’s AI capabilities and Python’s rich ecosystem.

Getting Started

• 1. Introduction to Select AI for Python
  • 1.1. What you can build
  • 1.2. Core concepts
  • 1.3. Synchronous and asynchronous APIs
  • 1.4. Supported Python versions
• 2. Installing select_ai
  • 2.1. Installation requirements
  • 2.2. select_ai installation
  • 2.3. Connection smoke test
  • 2.4. Install documentation dependencies
• 3. Connecting to Oracle Database
  • 3.1. Synchronous connection
  • 3.2. Asynchronous connection
  • 3.3. Connection Pool
  • 3.4. Connection health
  • 3.5. Wallet connections

Actions

• 1. Supported Actions
  • 1.1. Action methods
  • 1.2. Choosing an action
  • 1.3. Examples
  • 1.4. Streaming

Privileges

• 1. Grant privilege
• 2. Revoke privilege
• 3. Grant network access
• 4. Revoke network access

Provider

• 1. Provider
  • 1.1. Examples
  • 1.2. Provider
    • Provider
  • 1.3. AnthropicProvider
    • AnthropicProvider
  • 1.4. AzureProvider
    • AzureProvider
  • 1.5. AWSProvider
    • AWSProvider
  • 1.6. CohereProvider
    • CohereProvider
  • 1.7. OpenAIProvider
    • OpenAIProvider
  • 1.8. OCIGenAIProvider
    • OCIGenAIProvider
  • 1.9. GoogleProvider
    • GoogleProvider
  • 1.10. HuggingFaceProvider
    • HuggingFaceProvider
  • 1.11. Enable AI service provider
    • 1.11.1. Enable using Sync API
    • 1.11.2. Enable using Async API
  • 1.12. Disable AI service provider
    • 1.12.1. Disable using Sync API
    • 1.12.2. Disable using Async API

Credential

• 1. Create credential
  • 1.1. Sync API
  • 1.2. Async API
• 2. Delete credential
  • 2.1. Sync API
  • 2.2. Async API

Profile Attributes

• 1. ProfileAttributes
  • 1.1. Common required attributes
  • 1.2. Attribute groups
  • 1.3. Object list examples
  • 1.4. Generation controls
    • ProfileAttributes

Profile

• 1. Profile lifecycle
• 2. Profile actions
  • 2.1. Profile Object Model
  • 2.2. Base Profile API
    • BaseProfile
  • 2.3. Profile API
    • Profile
  • 2.4. Create Profile
  • 2.5. Reuse Profile
  • 2.6. Update Profile
  • 2.7. Delete Profile
  • 2.8. Narrate
  • 2.9. Show SQL
  • 2.10. Explain SQL
  • 2.11. Show Prompt
  • 2.12. Run SQL
  • 2.13. Chat
  • 2.14. Streaming chat
  • 2.15. Summarize
  • 2.16. Translate
  • 2.17. List profiles

Async Profile

• 1. Async profile lifecycle
• 2. Async profile actions
  • 2.1. AsyncProfile API
    • AsyncProfile
  • 2.2. Async Profile creation
  • 2.3. Reuse Async Profile
  • 2.4. Update Async Profile
  • 2.5. Delete Async Profile
  • 2.6. Async explain SQL
  • 2.7. Async run SQL
  • 2.8. Async show SQL
  • 2.9. Async show prompt
  • 2.10. Async concurrent SQL
  • 2.11. Async chat
  • 2.12. Async streaming chat
  • 2.13. Summarize
  • 2.14. Translate
  • 2.15. Async pipeline
  • 2.16. List profiles asynchronously

Conversation

• 1. Conversation Object model
• 2. ConversationAttributes
  • ConversationAttributes
• 3. Conversation API
  • Conversation
    • Conversation.create()
    • Conversation.delete()
    • Conversation.fetch()
    • Conversation.get_attributes()
    • Conversation.list()
    • Conversation.set_attributes()
  • 3.1. Create conversation
  • 3.2. Chat session
  • 3.3. List conversations
  • 3.4. Delete conversation
• 4. AsyncConversation API
  • AsyncConversation
    • AsyncConversation.create()
    • AsyncConversation.delete()
    • AsyncConversation.fetch()
    • AsyncConversation.get_attributes()
    • AsyncConversation.list()
    • AsyncConversation.set_attributes()
  • 4.1. Async chat session
  • 4.2. Async list conversations

Vector Index

• 1. Vector Index
• 2. VectorIndex Object Model
• 3. VectorIndexAttributes
  • VectorIndexAttributes
  • 3.1. OracleVectorIndexAttributes
    • OracleVectorIndexAttributes
• 4. VectorIndex API
  • VectorIndex
    • VectorIndex.create()
    • VectorIndex.delete()
    • VectorIndex.delete_index()
    • VectorIndex.disable()
    • VectorIndex.enable()
    • VectorIndex.fetch()
    • VectorIndex.get_attributes()
    • VectorIndex.get_next_refresh_timestamp()
    • VectorIndex.get_profile()
    • VectorIndex.list()
    • VectorIndex.set_attribute()
    • VectorIndex.set_attributes()
  • 4.1. Create vector index
  • 4.2. List vector index
  • 4.3. Fetch vector index
  • 4.4. Update vector index attributes
  • 4.5. RAG using vector index
  • 4.6. Delete vector index
• 5. AsyncVectorIndex API
  • AsyncVectorIndex
    • AsyncVectorIndex.create()
    • AsyncVectorIndex.delete()
    • AsyncVectorIndex.delete_index()
    • AsyncVectorIndex.disable()
    • AsyncVectorIndex.enable()
    • AsyncVectorIndex.fetch()
    • AsyncVectorIndex.get_attributes()
    • AsyncVectorIndex.get_next_refresh_timestamp()
    • AsyncVectorIndex.get_profile()
    • AsyncVectorIndex.list()
    • AsyncVectorIndex.set_attribute()
    • AsyncVectorIndex.set_attributes()
  • 5.1. Async create vector index
  • 5.2. Async list vector index
  • 5.3. Async fetch vector index
  • 5.4. Async update vector index attributes
  • 5.5. Async RAG using vector index

Synthetic Data

• 1. Generation modes
• 2. Generation parameters
• 3. Sync and async APIs
  • 3.1. SyntheticDataAttributes
    • SyntheticDataAttributes
  • 3.2. SyntheticDataParams
    • SyntheticDataParams
  • 3.3. Single table synthetic data
    • 3.3.1. Single Table Sync API
    • 3.3.2. Single Table Async API
  • 3.4. Multi table synthetic data
    • 3.4.1. Multi table Sync API
    • 3.4.2. Multi table Async API

Summary

• 1. Inline content
• 2. Content from a URI
• 3. Content from object storage
• 4. Summary parameters
• 5. Async summary
• 6. Validation
  • 6.1. SummaryParams
    • SummaryParams
  • 6.2. ChunkProcessingMethod
    • ChunkProcessingMethod
  • 6.3. ExtractivenessLevel
    • ExtractivenessLevel
  • 6.4. SummaryStyle
    • Style

AI Agent

• 1. Tool
  • 1.1. Supported Tools
  • 1.2. Tool selection
    • ToolAttributes
    • ToolParams
    • Tool
  • 1.3. Create Tool
  • 1.4. List Tools
• 2. Task
  • TaskAttributes
  • Task
    • Task.create()
    • Task.delete()
    • Task.delete_task()
    • Task.disable()
    • Task.enable()
    • Task.fetch()
    • Task.list()
    • Task.set_attribute()
    • Task.set_attributes()
  • 2.1. Create Task
  • 2.2. List Tasks
• 3. Agent
  • AgentAttributes
  • Agent
    • Agent.create()
    • Agent.delete()
    • Agent.delete_agent()
    • Agent.disable()
    • Agent.enable()
    • Agent.fetch()
    • Agent.list()
    • Agent.set_attribute()
    • Agent.set_attributes()
  • 3.1. Create Agent
• 4. Team
  • TeamAttributes
  • Team
    • Team.create()
    • Team.delete()
    • Team.delete_team()
    • Team.disable()
    • Team.enable()
    • Team.export()
    • Team.export_team()
    • Team.fetch()
    • Team.import_team()
    • Team.list()
    • Team.run()
    • Team.set_attribute()
    • Team.set_attributes()
  • 4.1. Run Team
  • 4.2. Export and Import Team
  • 4.3. Lifecycle helpers
• 5. AI agent examples
  • 5.1. Web Search Agent using OpenAI’s GPT model

Async AI Agent

• 1. AsyncTool
  • AsyncTool
    • AsyncTool.create()
    • AsyncTool.create_built_in_tool()
    • AsyncTool.create_email_notification_tool()
    • AsyncTool.create_pl_sql_tool()
    • AsyncTool.create_rag_tool()
    • AsyncTool.create_slack_notification_tool()
    • AsyncTool.create_sql_tool()
    • AsyncTool.create_websearch_tool()
    • AsyncTool.delete()
    • AsyncTool.delete_tool()
    • AsyncTool.disable()
    • AsyncTool.enable()
    • AsyncTool.fetch()
    • AsyncTool.list()
    • AsyncTool.set_attribute()
    • AsyncTool.set_attributes()
  • 1.1. Create Tool
  • 1.2. List Tools
• 2. AsyncTask
  • AsyncTask
    • AsyncTask.create()
    • AsyncTask.delete()
    • AsyncTask.delete_task()
    • AsyncTask.disable()
    • AsyncTask.enable()
    • AsyncTask.fetch()
    • AsyncTask.list()
    • AsyncTask.set_attribute()
    • AsyncTask.set_attributes()
  • 2.1. Create Task
  • 2.2. List Tasks
• 3. AsyncAgent
  • AsyncAgent
    • AsyncAgent.create()
    • AsyncAgent.delete()
    • AsyncAgent.delete_agent()
    • AsyncAgent.disable()
    • AsyncAgent.enable()
    • AsyncAgent.fetch()
    • AsyncAgent.list()
    • AsyncAgent.set_attribute()
    • AsyncAgent.set_attributes()
  • 3.1. Create Agent
  • 3.2. List Agents
• 4. AsyncTeam
  • AsyncTeam
    • AsyncTeam.create()
    • AsyncTeam.delete()
    • AsyncTeam.delete_team()
    • AsyncTeam.disable()
    • AsyncTeam.enable()
    • AsyncTeam.export()
    • AsyncTeam.export_team()
    • AsyncTeam.fetch()
    • AsyncTeam.import_team()
    • AsyncTeam.list()
    • AsyncTeam.run()
    • AsyncTeam.set_attribute()
    • AsyncTeam.set_attributes()
  • 4.1. Run Team
  • 4.2. Export and Import Team
  • 4.3. Lifecycle helpers
  • 4.4. List Teams
• 5. Async AI agent examples
  • 5.1. Web Search Agent using OpenAI’s GPT model

Command Line Interface

• 1. Command line interface
  • 1.1. Connection options
  • 1.2. Interactive chat
  • 1.3. SQL commands
  • 1.4. Profile commands
  • 1.5. Command summary

Web Frameworks

• 1. Using select_ai with Python web frameworks
  • 1.1. Framework patterns
  • 1.2. Install dependencies
  • 1.3. FastAPI synchronous endpoints
  • 1.4. FastAPI asynchronous endpoints
  • 1.5. Flask example
  • 1.6. Django example
  • 1.7. Pool sizing
  • 1.8. Pool wait behavior
  • 1.9. Request handling

Concurrent Prompt Processing

• 1. Concurrent prompt processing
  • 1.1. Recipe summary
  • 1.2. Environment variables
  • 1.3. sync_thread_pool.py
  • 1.4. sync_ordered_results.py
  • 1.5. sync_queue_workers.py
  • 1.6. async_gather.py
  • 1.7. async_as_completed.py
  • 1.8. async_pipeline.py
  • 1.9. async_queue_workers.py
  • 1.10. Pool sizing