Developer Integration Guide

Introduction

The goal of these guides are to provide background and step-by-step instructions for integrating the Champion AI platform into 3rd Party applications.

Table of Contents

• Platform Capabilities
• Champion Integrations
• Support
• Glossary

Platform Capabilities

The platform has several capabilities in order to bring your AI use case to life. Below are some of the key features of Champion:

• Generative Chatbot - Floating Action Button and Conversational Interface leveraging 3rd Party LLMs
• Retrieval Augmented Generation - Inclusion of custom knowledge into our Chatbot
• Predictions and Recommendations - Generative interface to QAD created ML Models
• Simulations - Ability to simulate/predict how changes
• Agents - Ability for Champion to call 3rd Party APIs and Databases
• Guardrails - Hallucination protection
• Anomaly Detection - AutoML Endpoint for Outlier Detection

Champion Integrations

Below are the types of integrations that are possible with Champion:

• Champion Chatbot Integration - Embedding the Chatbot to your client application
• Champion Knowledge Assist Integration - Augmenting your Chatbot with documentation
• Champion Agents Integration - Enabling Champion to act on behalf of users
• Champion Service API Integration - Use Case Specific API Integration Points
• Champion Recommended Actions Integration - Enabling Chatbot Callbacks

Glossary

Below are some definitions of terms in which we use in Champion:

Champion Specific

• Client Application - This is a 3rd party application in which a user would like to integrate Champion
• Client Application User - This is the user's identity w/in the 3rd Party application (eg Redzone User Ron, or MO User Ron or PI User Ron)
• Champion User - This is a user identity that exists within Champion

General Knowledge

• Client Credentials Token Exchange - This is the OAuth2 Client Credentials Flow. This flow is used for api-to-api integrations
• JSON Web Token - A JSON Web Token (JWT) is a compact, URL-safe token used for securely transmitting information between parties. It is commonly used in authentication and authorization systems, especially in OAuth 2.0 and OpenID Connect
• Authorization Code Flow - Designed for web apps, mobile apps, and APIs. It ensures that access tokens are never exposed in URLs, making it the recommended flow for handling user authentication securely. Secure, Supports Refresh Tokens for Long-term authentication and great for mobile and web applications