Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion 01-getting-started/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Contextual AI Platform Intro Examples

<img src="https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra" alt="Alt Text" width="300">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Light.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true">
<img src="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true" alt="Contextual AI" width="300">
</picture>

<p></p>
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
Expand Down
3 changes: 1 addition & 2 deletions 01-getting-started/end-to-end-example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@
"id": "8iPJnDH0HhXB"
},
"source": [
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Image description\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Image description\" width=\"160\" />\n",
"\n",
"<br/>\n",
"\n",
"# Introduction to Contextual AI Platform using the Python Client\n",
"\n",
Expand Down
3 changes: 1 addition & 2 deletions 01-getting-started/quick-start.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@
"id": "8iPJnDH0HhXB"
},
"source": [
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Image description\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Image description\" width=\"160\" />\n",
"\n",
"<br/>\n",
"\n",
"# Quick Start for Contextual AI Platform using the Python Client\n",
"\n",
Expand Down
8 changes: 6 additions & 2 deletions 02-hands-on-lab/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<img src="https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra" alt="Image description" width="200" />
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Light.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true">
<img src="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true" alt="Contextual AI" width="300">
</picture>

<br/>

Expand Down Expand Up @@ -63,4 +67,4 @@ To quickly get started running the notebook we reccomend using [Google Colab](ht
5. 🔑 Set up your API credentials in the respective [notebook](02-hands-on-lab/lab1_create_agent.ipynb)
```bash
API_TOKEN = '...' # Replace with your actual API token
```
```
3 changes: 1 addition & 2 deletions 02-hands-on-lab/lab1_create_agent.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Image description\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Image description\" width=\"160\" />\n",
"\n",
"<br/>\n",
"\n",
"# Lab 1: Create an Agent and Datastore\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion 03-standalone-api/01-lmunit/lmunit.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"id": "8iPJnDH0HhXB"
},
"source": [
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Image description\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Image description\" width=\"160\" />\n",
"\n",
"<br/>\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion 03-standalone-api/02-generate/generate.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"id": "8iPJnDH0HhXB"
},
"source": [
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Image description\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Image description\" width=\"160\" />\n",
"\n",
"<br/>\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion 03-standalone-api/03-rerank/rerank.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"id": "8iPJnDH0HhXB"
},
"source": [
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Image description\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Image description\" width=\"160\" />\n",
"\n",
"<br/>\n",
"\n",
Expand Down
6 changes: 6 additions & 0 deletions 03-standalone-api/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Light.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true">
<img src="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true" alt="Contextual AI" width="300">
</picture>

# Component API Examples

This repository contains examples of using the component API's.
Expand Down
10 changes: 8 additions & 2 deletions 05-policy-changes/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Tracking Changes in Long Policy Documents Using Contextual AI

<img src="https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra" alt="Alt Text" width="300">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Light.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true">
<img src="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true" alt="Contextual AI" width="300">
</picture>

<p></p>

<br>

Expand Down Expand Up @@ -74,4 +80,4 @@ You should now see a response incorporating the 2025 update.

## Notebook

The notebook walks you through setting up your agent, ingesting your data, and making the first query. To explore more of the python capabilities check out the end-to-end notebook or the full documentation.
The notebook walks you through setting up your agent, ingesting your data, and making the first query. To explore more of the python capabilities check out the end-to-end notebook or the full documentation.
2 changes: 1 addition & 1 deletion 05-policy-changes/policy-example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"id": "8iPJnDH0HhXB"
},
"source": [
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Image description\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Image description\" width=\"160\" />\n",
"\n",
"<br/>\n",
"\n",
Expand Down
10 changes: 8 additions & 2 deletions 06-improve-agent-performance/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Agent Improvement Walkthrough 📊

<img src="https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra" alt="Alt Text" width="300">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Light.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true">
<img src="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true" alt="Contextual AI" width="300">
</picture>

<p></p>

This repository contains an example notebook providing a deep dive on specializing or improving your Contextual AI agents.

Expand Down Expand Up @@ -60,4 +66,4 @@ For comprehensive platform documentation, visit [docs.contextual.ai](https://doc

## Support 🐛

For additional support or questions, please refer to the [official documentation](https://docs.contextual.ai/) or contact the Contextual AI support team.
For additional support or questions, please refer to the [official documentation](https://docs.contextual.ai/) or contact the Contextual AI support team.
2 changes: 1 addition & 1 deletion 06-improve-agent-performance/improvement-overview.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"id": "8iPJnDH0HhXB"
},
"source": [
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Image description\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Image description\" width=\"160\" />\n",
"\n",
"<br/>\n",
"\n",
Expand Down
9 changes: 7 additions & 2 deletions 07-evaluation-ragas/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# RAG Evaluation with RAGAS 📊

<img src="https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra" alt="Contextual AI logo" width="300">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Light.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true">
<img src="https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true" alt="Contextual AI" width="300">
</picture>

<p></p>
This repository contains an example notebook demonstrating how to evaluate Contextual AI's RAG agents using the RAGAS framework. THis approach can also be used with other external evaluation approaches.

## Repository Structure
Expand Down Expand Up @@ -42,4 +47,4 @@ For comprehensive platform documentation, visit [docs.contextual.ai](https://doc

## Support 🐛

For additional support or questions, please refer to the [official documentation](https://docs.contextual.ai/) or contact the Contextual AI support team.
For additional support or questions, please refer to the [official documentation](https://docs.contextual.ai/) or contact the Contextual AI support team.
2 changes: 1 addition & 1 deletion 07-evaluation-ragas/Using_RAGAS.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"id": "1079e444-91e1-4b81-a28a-2ce4763f4bc4"
},
"source": [
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Contextual AI logo\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Contextual AI logo\" width=\"160\" />\n",
"\n",
"# Evaluation of RAG Agents with RAGAS\n",
"\n",
Expand Down
953 changes: 499 additions & 454 deletions 08-ai-workshop/Contextual_workshop.ipynb

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"id": "8iPJnDH0HhXB"
},
"source": [
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Image description\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Image description\" width=\"160\" />\n",
"\n",
"<br/>\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion 14-monitoring/monitoring_intro.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
},
"source": [
"<div align=\"center\">\n",
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Contextual AI Logo\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Contextual AI Logo\" width=\"160\" />\n",
"</div>\n",
"\n",
"<br/>\n",
Expand Down
2 changes: 1 addition & 1 deletion 15-metadata-intro/metadata_intro.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"id": "8iPJnDH0HhXB"
},
"source": [
"<img src=\"https://imagedelivery.net/Dr98IMl5gQ9tPkFM5JRcng/3e5f6fbd-9bc6-4aa1-368e-e8bb1d6ca100/Ultra\" alt=\"Image description\" width=\"160\" />\n",
"<img src=\"https://github.com/ContextualAI/examples/blob/main/images/Contextual_AI_Lockup_Dark.png?raw=true\" alt=\"Image description\" width=\"160\" />\n",
"\n",
"<br/>\n",
"\n",
Expand Down
Loading