/examples

Sample files, code snippets and downloads for ContextualAI

Primary LanguageJupyter NotebookMIT LicenseMIT

🌟 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:

Open In Colab

📚 Contents

  • 📓 Jupyter notebooks with step-by-step examples:
    • 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

🚀 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?

⚖️ License

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


Made with ❤️ by the Contextual team