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
• 2. Installing select_ai
  • 2.1. Installation requirements
  • 2.2. select_ai installation
• 3. Connecting to Oracle Database
  • 3.1. Synchronous connection
  • 3.2. Asynchronous connection
  • 3.3. Connection Pool

Actions

• 1. Supported Actions

Privileges

• 1. Grant privilege
• 2. Revoke privilege

Provider

• 1. Provider
  • Provider
• 2. AnthropicProvider
  • AnthropicProvider
• 3. AzureProvider
  • AzureProvider
• 4. AWSProvider
  • AWSProvider
• 5. CohereProvider
  • CohereProvider
• 6. OpenAIProvider
  • OpenAIProvider
• 7. OCIGenAIProvider
  • OCIGenAIProvider
• 8. GoogleProvider
  • GoogleProvider
• 9. HuggingFaceProvider
  • HuggingFaceProvider
• 10. Enable AI service provider
  • 10.1. Enable using Sync API
  • 10.2. Enable using Async API
• 11. Disable AI service provider
  • 11.1. Disable using Sync API
  • 11.2. Disable using Async API

Credential

• 1. Create credential
  • 1.1. Sync API
  • 1.2. Async API

Profile Attributes

• 1. ProfileAttributes
  • ProfileAttributes

Profile

• 1. Profile Object Model
• 2. Base Profile API
  • BaseProfile
• 3. Profile API
  • Profile
    • Profile.add_negative_feedback()
    • Profile.add_positive_feedback()
    • Profile.chat()
    • Profile.chat_session()
    • Profile.create()
    • Profile.delete()
    • Profile.delete_feedback()
    • Profile.delete_profile()
    • Profile.explain_sql()
    • Profile.fetch()
    • Profile.generate()
    • Profile.generate_synthetic_data()
    • Profile.get_attributes()
    • Profile.list()
    • Profile.narrate()
    • Profile.run_sql()
    • Profile.set_attribute()
    • Profile.set_attributes()
    • Profile.show_prompt()
    • Profile.show_sql()
    • Profile.summarize()
    • Profile.translate()
• 4. Create Profile
• 5. Narrate
• 6. Show SQL
• 7. Run SQL
• 8. Chat
• 9. Summarize
• 10. Translate
• 11. List profiles
• 12. Async Profile
  • 1. AsyncProfile API
    • AsyncProfile
  • 2. Async Profile creation
  • 3. Async explain SQL
  • 4. Async run SQL
  • 5. Async show SQL
  • 6. Async concurrent SQL
  • 7. Async chat
  • 8. Summarize
  • 9. Translate
  • 10. Async pipeline
  • 11. 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 conversion
  • 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. VectorIndex Object Model
• 2. VectorIndexAttributes
  • VectorIndexAttributes
  • 2.1. OracleVectorIndexAttributes
    • OracleVectorIndexAttributes
• 3. 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()
  • 3.1. Create vector index
  • 3.2. List vector index
  • 3.3. Fetch vector index
  • 3.4. Update vector index attributes
  • 3.5. RAG using vector index
  • 3.6. Delete vector index
• 4. 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()
  • 4.1. Async create vector index
  • 4.2. Async list vector index
  • 4.3. Async fetch vector index
  • 4.4. Async update vector index attributes
  • 4.5. Async RAG using vector index

Synthetic Data

• 1. SyntheticDataAttributes
  • SyntheticDataAttributes
• 2. SyntheticDataParams
  • SyntheticDataParams
• 3. Single table synthetic data
  • 3.1. Single Table Sync API
  • 3.2. Singe Table Async API
• 4. Multi table synthetic data
  • 4.1. Multi table Sync API
  • 4.2. Multi table Async API

Summary

• 1. SummaryParams
  • SummaryParams
• 2. ChunkProcessingMethod
  • ChunkProcessingMethod
• 3. ExtractivenessLevel
  • ExtractivenessLevel
• 4. SummaryStyle
  • Style

AI Agent

• 1. Tool
  • 1.1. Supported Tools
    • ToolAttributes
    • ToolParams
    • Tool
  • 1.2. Create Tool
  • 1.3. 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.fetch()
    • Team.list()
    • Team.run()
    • Team.set_attribute()
    • Team.set_attributes()
  • 4.1. Run Team
• 5. AI agent examples
  • 5.1. Web Search Agent using OpenAI’s GPT model
• 6. Async AI Agent
  • 1. AsyncTool
    • AsyncTool
    • 1.1. Create Tool
    • 1.2. List Tools
  • 2. AsyncTask
    • AsyncTask
    • 2.1. Create Task
    • 2.2. List Tasks
  • 3. AsyncAgent
    • AsyncAgent
    • 3.1. Create Agent
    • 3.2. List Agents
  • 4. AsyncTeam
    • AsyncTeam
    • 4.1. Run Team
    • 4.2. List Teams
  • 5. Async AI agent examples
    • 5.1. Web Search Agent using OpenAI’s GPT model