01-getting-started

Contextual AI Platform Intro Examples

This repository contains example notebooks demonstrating how to use the Contextual AI Platform for creating and deploying generative AI agents. The examples focus on implementing Retrieval-Augmented Generation (RAG) for financial use cases.

Repository Structure

This repository includes sample data and a quick-start guide: Quick-start.ipynb to help you get started quickly!

The example can be completed in under 15 minutes. The notebook is self-contained and includes detailed explanations for each step.

For comprehensive platform documentation, visit docs.contextual.ai

Prerequisites

• Contextual AI Platform access
• Python 3.8+
• Python client pip install --pre contextual-client

API Key

To use the notebooks, you will need an API key to securely access the API. To generate an API key, your admin can follow the process below:

1. Log into your tenant at app.contextual.ai
2. Click on "API Keys"
3. Click on "Create API Key"
4. Please keep your key in a secure place, and do not share it with anyone

Use Case

These examples focus on creating a financial RAG agent that:

• Answers questions based on provided documents
• Avoids making forward-looking statements
• Handles financial data responsibly
• Provides accurate, document-based responses

Some sample data files are used in these notebooks, an ingested document, and some additional documents included in zipped folders if you want to test ingesting multiple documents.

• Ingestion: Apple.pdf (with additional pdf's included in the zip files)

🚀 Getting Started

To quickly get started running the notebook we reccomend using Google Colab. If you'd prefer to run it locally, you can run in VS Code following these steps:

1. 📥 Clone this repository

   git clone https://github.com/ContextualAI/examples
   cd examples/

2. 🌎 Create a virtual environment:

   python -m venv . && source bin/activate

3. 📦 Install required dependencies

   pip install -r requirements.txt

4. 🎮 Open the notebook in VS Code, click on "Select Kernel" (top right) -> "Python Environments" and select the newly created venv environment:

   

5. 🔑 Set up your API credentials in the respective notebook

   API_TOKEN = '...'  # Replace with your actual API token