openai-chatcompletion
Service icon

OpenAI_ChatCompletion

Stable version 1.0.0 (Compatible with OutSystems 11)
Uploaded
 on 7 Apr (12 days ago)
 by 
0.0
 (0 ratings)
openai-chatcompletion

OpenAI_ChatCompletion

Documentation
1.0.0

This component allows you to integrate a Retrieval-Augmented Generation (RAG) Proof of Concept with OpenAI’s Chat Completion API in your OutSystems applications.

🔧 Installation & Setup

  1. Download and install the component from the Forge into your OutSystems environment.

  2. Create an OpenAI account and generate an API key at https://platform.openai.com/account/api-keys.

  3. Set the OpenAI API Key by navigating to Service Center > Factory > Site Properties and updating the OpenAI_APIKey property with your key.

  4. Publish the module and make sure all dependencies are resolved.

  5. Optional: Configure additional site properties like OpenAIModel or MaxTokens as needed.

🧩 Available Public Methods & Web Blocks

  • Server Action: ChatCompletionConnector
    Input: Prompt (Text)
    Output: Response from OpenAI (Text)
    This action sends a user prompt to OpenAI and returns the completion based on the RAG-enhanced context.

  • Server Action: SetAPIKey
    Input: API Key (Text)
    Dynamically sets the key at runtime if needed.

  • Web Block: ChatInterface (optional)
    Prebuilt UI component to integrate chat functionality into your application quickly.

📌 Notes

  • No external dependencies beyond OpenAI.

  • Ideal for POCs or MVPs leveraging contextual Q&A over document-based content.