🌟 Contextual API Examples

Welcome to our collection of example notebooks showcasing the power of Contextual's AI platform! 🚀

🎯 Overview

This repository contains practical examples and demonstrations of how to interact with Contextual's API, helping you get started quickly and efficiently. You can run these examples in any jupyter notebook but an easy way to get started is Colab notebooks:

📚 Table of Contents

• 🚀 End to End Example - End to End example of the Contextual Platform
• 🔬 Hands on Lab - Lab broken into three chapters, Creating Agent & Datastores, Evaluation, and Tuning
• 🔧 Standalone API - Examples of using individual API endpoints like /generate and /rerank.
• 📊 Sheets Script - A Google Sheets script that automates form filling using Contextual AI's API integration.
• 📝 Policy Changes - An example use case for tracking changes in long policy documents.
• 📈 Improving Agent - An example use case for improving or specializing your RAG agent.

🚀 Getting Started

1. 📥 Clone this repository

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

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

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

3. 📦 Install required dependencies

   pip install -r requirements.txt

4. 🎮 Run the example notebook

🔧 Prerequisites

• Python 3.7+
• Jupyter Notebook/Lab
• Contextual API credentials
• Required Python packages (listed in requirements.txt)

💡 Examples Include

• 🔄 Basic API calls to create an Application
• 📊 Tune your Application
• 📈 Evaluation and Hillclimbing

🤝 Contributing

We welcome contributions! Feel free to:

• 🐛 Report bugs
• ✨ Request features
• 🔀 Submit pull requests

📫 Support

Need help?

• 📧 Contact our support team [email protected]
• 💬 Join our community discussions
• 📖 Check out our documentation

⚖️ License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with ❤️ by the Contextual team