ragaai-catalyst 1.0.7b4__tar.gz → 1.0.8b1__tar.gz

{ragaai_catalyst-1.0.7b4/ragaai_catalyst.egg-info → ragaai_catalyst-1.0.8b1}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: ragaai_catalyst
-Version: 1.0.7b4
+Version: 1.0.8b1
 Summary: RAGA AI CATALYST
-Author-email: Kiran Scaria <kiran.scaria@raga.ai>, Kedar Gaikwad <kedar.gaikwad@raga.ai>, Dushyant Mahajan <dushyant.mahajan@raga.ai>
+Author-email: Kiran Scaria <kiran.scaria@raga.ai>, Kedar Gaikwad <kedar.gaikwad@raga.ai>, Dushyant Mahajan <dushyant.mahajan@raga.ai>, Siddhartha Kosti <siddhartha.kosti@raga.ai>, Ritika Goel <ritika.goel@raga.ai>, Vijay Chaurasia <vijay.chaurasia@raga.ai>
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: aiohttp>=3.10.2
@@ -44,6 +44,7 @@ RagaAI Catalyst is a powerful tool for managing and optimizing LLM projects. It
     - [Trace Management](#trace-management)
     - [Experiment Management](#experiment-management)
     - [Dataset Management](#dataset-management)
+    - [Prompt Management](#prompt-management)
 
 ## Installation
 
@@ -63,9 +64,11 @@ from ragaai_catalyst import RagaAICatalyst
 catalyst = RagaAICatalyst(
     access_key="YOUR_ACCESS_KEY",
     secret_key="YOUR_SECRET_KEY",
-    api_keys={"OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"}
+    base_url="BASE_URL"
 )
 ```
+**Note**: Authetication to RagaAICatalyst is necessary to perform any operations below 
+
 
 ## Usage
 
@@ -102,12 +105,12 @@ tracer = Tracer(
         "vector_store": "faiss",
         "embed_model": "text-embedding-ada-002",
     }
-).start_trace()
+).start()
 
 # Your code here
 
 # Stop the trace recording
-tracer.stop_trace()
+tracer.stop()
 
 # Alternatively, use a context manager
 with tracer.trace():
@@ -153,34 +156,69 @@ print("Experiment Status:", status)
 results = experiment_manager.get_results()
 print("Experiment Results:", results)
 ```
-### Dataset Management
 
-Create and manage trace datasets for your projects.
 
 
-```python
+## Dataset Management
+Manage datasets efficiently for your projects:
+
+```py
 from ragaai_catalyst import Dataset
 
 # Initialize Dataset management for a specific project
-dataset_manager = Dataset(project_name="Test-RAG-App-1")
+dataset_manager = Dataset(project_name="project_name")
 
 # List existing datasets
 datasets = dataset_manager.list_datasets()
-print("Exisiting Datasets:", datasets)
+print("Existing Datasets:", datasets)
 
-# Create a new dataset with filters
-dataset_manager.create_dataset(
+# Create a dataset from trace
+dataset_manager.create_from_trace(
     dataset_name='Test-dataset-1',
     filter_list=[
-        {
-            "name": "llm_model",
-            "values": ["gpt-3.5-turbo", "gpt-4"]
-        },
-        {
-            "name": "prompt_length",
-            "lte": 27,
-            "gte": 23
-        }
+        {"name": "llm_model", "values": ["gpt-3.5-turbo", "gpt-4"]},
+        {"name": "prompt_length", "lte": 27, "gte": 23}
     ]
 )
+
+# Create a dataset from CSV
+dataset_manager.create_from_csv(
+    csv_path='path/to/your.csv',
+    dataset_name='MyDataset',
+    schema_mapping={'column1': 'schema_element1', 'column2': 'schema_element2'}
+)
 ```
+
+For more detailed information on Dataset Management, including CSV schema handling and advanced usage, please refer to the [Dataset Management documentation](docs/dataset_management.md).
+
+## Prompt Management
+
+Manage and use prompts efficiently in your projects:
+
+```py
+from ragaai_catalyst.prompt_manager import PromptManager
+
+# Initialize PromptManager
+prompt_manager = PromptManager("your-project-name")
+
+# List available prompts
+prompts = prompt_manager.list_prompts()
+print("Available prompts:", prompts)
+
+# Get a specific prompt
+prompt_name = "your_prompt_name"
+prompt = prompt_manager.get_prompt(prompt_name)
+
+# Compile a prompt with variables
+compiled_prompt = prompt.compile(query="What's the weather?", context="sunny", llm_response="It's sunny today")
+print("Compiled prompt:", compiled_prompt)
+
+# Get prompt parameters
+parameters = prompt.get_parameters()
+print("Prompt parameters:", parameters)
+```
+
+For more detailed information on Prompt Management, please refer to the [Prompt Management documentation](docs/prompt_management.md).
+
+
+

{ragaai_catalyst-1.0.7b4 → ragaai_catalyst-1.0.8b1}/README.md

@@ -13,6 +13,7 @@ RagaAI Catalyst is a powerful tool for managing and optimizing LLM projects. It
     - [Trace Management](#trace-management)
     - [Experiment Management](#experiment-management)
     - [Dataset Management](#dataset-management)
+    - [Prompt Management](#prompt-management)
 
 ## Installation
 
@@ -32,9 +33,11 @@ from ragaai_catalyst import RagaAICatalyst
 catalyst = RagaAICatalyst(
     access_key="YOUR_ACCESS_KEY",
     secret_key="YOUR_SECRET_KEY",
-    api_keys={"OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"}
+    base_url="BASE_URL"
 )
 ```
+**Note**: Authetication to RagaAICatalyst is necessary to perform any operations below 
+
 
 ## Usage
 
@@ -71,12 +74,12 @@ tracer = Tracer(
         "vector_store": "faiss",
         "embed_model": "text-embedding-ada-002",
     }
-).start_trace()
+).start()
 
 # Your code here
 
 # Stop the trace recording
-tracer.stop_trace()
+tracer.stop()
 
 # Alternatively, use a context manager
 with tracer.trace():
@@ -122,34 +125,69 @@ print("Experiment Status:", status)
 results = experiment_manager.get_results()
 print("Experiment Results:", results)
 ```
-### Dataset Management
 
-Create and manage trace datasets for your projects.
 
 
-```python
+## Dataset Management
+Manage datasets efficiently for your projects:
+
+```py
 from ragaai_catalyst import Dataset
 
 # Initialize Dataset management for a specific project
-dataset_manager = Dataset(project_name="Test-RAG-App-1")
+dataset_manager = Dataset(project_name="project_name")
 
 # List existing datasets
 datasets = dataset_manager.list_datasets()
-print("Exisiting Datasets:", datasets)
+print("Existing Datasets:", datasets)
 
-# Create a new dataset with filters
-dataset_manager.create_dataset(
+# Create a dataset from trace
+dataset_manager.create_from_trace(
     dataset_name='Test-dataset-1',
     filter_list=[
-        {
-            "name": "llm_model",
-            "values": ["gpt-3.5-turbo", "gpt-4"]
-        },
-        {
-            "name": "prompt_length",
-            "lte": 27,
-            "gte": 23
-        }
+        {"name": "llm_model", "values": ["gpt-3.5-turbo", "gpt-4"]},
+        {"name": "prompt_length", "lte": 27, "gte": 23}
     ]
 )
+
+# Create a dataset from CSV
+dataset_manager.create_from_csv(
+    csv_path='path/to/your.csv',
+    dataset_name='MyDataset',
+    schema_mapping={'column1': 'schema_element1', 'column2': 'schema_element2'}
+)
 ```
+
+For more detailed information on Dataset Management, including CSV schema handling and advanced usage, please refer to the [Dataset Management documentation](docs/dataset_management.md).
+
+## Prompt Management
+
+Manage and use prompts efficiently in your projects:
+
+```py
+from ragaai_catalyst.prompt_manager import PromptManager
+
+# Initialize PromptManager
+prompt_manager = PromptManager("your-project-name")
+
+# List available prompts
+prompts = prompt_manager.list_prompts()
+print("Available prompts:", prompts)
+
+# Get a specific prompt
+prompt_name = "your_prompt_name"
+prompt = prompt_manager.get_prompt(prompt_name)
+
+# Compile a prompt with variables
+compiled_prompt = prompt.compile(query="What's the weather?", context="sunny", llm_response="It's sunny today")
+print("Compiled prompt:", compiled_prompt)
+
+# Get prompt parameters
+parameters = prompt.get_parameters()
+print("Prompt parameters:", parameters)
+```
+
+For more detailed information on Prompt Management, please refer to the [Prompt Management documentation](docs/prompt_management.md).
+
+
+

ragaai_catalyst-1.0.8b1/docs/dataset_management.md

@@ -0,0 +1,100 @@
+## Dataset Management
+
+Create and manage datasets easily for your projects using the `ragaai_catalyst` library. This guide provides steps to list, create, and manage datasets efficiently.
+
+#### - Initialize Dataset Management
+
+To start managing datasets for a specific project, initialize the `Dataset` class with your project name.
+
+```python
+from ragaai_catalyst import Dataset
+
+# Initialize Dataset management for a specific project
+dataset_manager = Dataset(project_name="project_name")
+
+# List existing datasets
+datasets = dataset_manager.list_datasets()
+print("Existing Datasets:", datasets)
+```
+
+#### 1. Create a New Dataset from Trace
+
+Create a dataset by applying filters to trace data. Below is an example of creating a dataset with specific criteria.
+
+```python
+dataset_manager.create_from_trace(
+    dataset_name='Test-dataset-1',
+    filter_list=[
+        {
+            "name": "llm_model",
+            "values": ["gpt-3.5-turbo", "gpt-4"]
+        },
+        {
+            "name": "prompt_length",
+            "lte": 27,
+            "gte": 23
+        }
+    ]
+)
+```
+
+#### 2. Create a New Dataset from CSV
+
+You can create a new dataset by uploading a CSV file and mapping its columns to the required schema elements.
+
+##### a. Retrieve CSV Schema Elements with `get_csv_schema()`
+
+This function retrieves the valid schema elements that the CSV column names must map to. It helps ensure that your CSV column names align correctly with the expected schema.
+
+###### Returns
+
+- A dictionary containing schema information:
+  - `success`: A Boolean indicating whether the schema elements were fetched successfully.
+  - `data['schemaElements']`: A list of valid schema column names.
+
+```python
+schemaElements = dataset_manager.get_csv_schema()['data']['schemaElements']
+print('Supported column names: ', schemaElements)
+```
+
+##### b. Create a Dataset from CSV with `create_from_csv()`
+
+Uploads the CSV file to the server, performs schema mapping, and creates a new dataset.
+
+###### Parameters
+
+- `csv_path` (str): Path to the CSV file.
+- `dataset_name` (str): The name you want to assign to the new dataset created from the CSV.
+- `schema_mapping` (dict): A dictionary that maps CSV columns to schema elements in the format `{csv_column: schema_element}`.
+
+Example usage:
+
+```python
+dataset_manager.create_from_csv(
+    csv_path='path/to/your.csv',
+    dataset_name='MyDataset',
+    schema_mapping={'column1': 'schema_element1', 'column2': 'schema_element2'}
+)
+```
+
+#### Understanding `schema_mapping`
+
+The `schema_mapping` parameter is crucial when creating datasets from a CSV file. It ensures that the data in your CSV file correctly maps to the expected schema format required by the system.
+
+##### Explanation of `schema_mapping`
+
+- **Keys**: The keys in the `schema_mapping` dictionary represent the column names in your CSV file.
+- **Values**: The values correspond to the expected schema elements that the columns should map to. These schema elements define how the data is stored and interpreted in the dataset.
+
+##### Example of `schema_mapping`
+
+Suppose your CSV file has columns `user_id` and `response_time`. If the valid schema elements for these are `user_identifier` and `response_duration`, your `schema_mapping` would look like this:
+
+```python
+schema_mapping = {
+    'user_id': 'user_identifier',
+    'response_time': 'response_duration'
+}
+```
+
+This mapping ensures that when the CSV is uploaded, the data in `user_id` is understood as `user_identifier`, and `response_time` is understood as `response_duration`, aligning the data with the system's expectations.

ragaai_catalyst-1.0.8b1/docs/prompt_management.md

@@ -0,0 +1,184 @@
+# Prompt Management
+
+The Prompt Management feature in RagaAI Catalyst allows you to efficiently manage, retrieve, and use prompts in your projects. 
+
+## Table of Contents
+1. [Ideal Flow](#ideal-flow)
+2. [Error Cases](#error-cases)
+3. [FAQs](#faqs)
+
+## Ideal Flow
+
+### 1. Initialize RagaAICatalyst and PromptManager
+
+First, set up your RagaAICatalyst instance and create a PromptManager for your project:
+
+```python
+from ragaai_catalyst import RagaAICatalyst
+from ragaai_catalyst.prompt_manager import PromptManager
+
+catalyst = RagaAICatalyst(
+access_key="your_access_key",
+secret_key="your_secret_key",
+base_url="https://your-api-base-url.com/api"
+)
+```
+
+Create a PromptManager for your project:
+
+```python
+project_name = "your-project-name"
+prompt_manager = PromptManager(project_name)
+```
+
+### 2. List Available Prompts
+
+```python
+prompts = prompt_manager.list_prompts()
+print("Available prompts:", prompts)
+```
+
+### 3. List Prompt Versions
+
+```python
+prompt_name = "your_prompt_name"
+versions = prompt_manager.list_prompt_versions(prompt_name)
+```
+
+### 4. Get a Prompt Object
+
+Retrieve a prompt object by name:
+
+```python
+prompt_name = "your_prompt_name"
+prompt = prompt_manager.get_prompt(prompt_name)
+
+```
+
+Retrieve a specific prompt object by name and version:
+
+```python
+prompt_name = "your_prompt_name"
+version = "your_version"
+prompt = prompt_manager.get_prompt(prompt_name, version)
+```
+
+### 5. Get Prompt Variables
+
+```python
+prompt_variables = prompt.get_variables()
+print("prompt_variables: ",prompt_variables)
+```
+
+
+### 6. Compile Prompt
+
+Once you have a prompt, you can compile it with variables:
+
+```python
+compiled_prompt = prompt.compile(query="What's the weather?", context="sunny", llm_response="It's sunny today")
+print("Compiled prompt:", compiled_prompt)
+```
+
+### 7. Get Parameters
+
+```python
+parameters = prompt.get_parameters()
+print("parameters: ",parameters)
+```
+
+
+## Error Cases
+
+### 1. Project Not Found
+
+If the project you are trying to access does not exist, the `PromptManager` will raise a `ValueError`:
+
+```python
+prompt_manager = PromptManager("non_existent_project")
+
+# Error: Project not found. Please enter a valid project name
+```
+
+### 2. Prompt Not Found
+
+If the prompt you are trying to access does not exist, the `get_prompt` method will raise a `ValueError`:
+
+```python
+prompt = prompt_manager.get_prompt("non_existent_prompt")
+
+# Error: Prompt not found. Please enter a valid Prompt name
+```
+
+### 3. Prompt Version Not Found
+
+If the prompt version you are trying to access does not exist, the `get_prompt` method will raise a `ValueError`:
+
+```python
+prompt = prompt_manager.get_prompt("your_prompt_name", "non_existent_version")
+
+# Error: Version not found. Please enter a valid version name
+```
+
+### 4. Missing Variables in Compile
+
+If the variables you are trying to compile the prompt with are not found, the `compile` method will raise a `ValueError`:
+
+```python
+prompt = prompt_manager.get_prompt("your_prompt_name", "your_version")
+prompt.get_variables()
+compiled_prompt = prompt.compile(query="What's the weather?")
+
+# Error: Missing variable(s): context, llm_response
+```
+
+### 5. Extra Variables in Compile
+
+If the variables you are trying to compile the prompt with are not found, the `compile` method will raise a `ValueError`:
+
+```python
+prompt = prompt_manager.get_prompt("your_prompt_name", "your_version")
+compiled_prompt = prompt.compile(query="What's the weather?", context="sunny", llm_response="It's sunny today", expected_response="The weather is sunny")
+
+# Error: Extra variable(s) provided: expected_response
+```
+
+### 6. Types of variable not str
+
+If the variables you are trying to compile the prompt with are not 'str', the `compile` method will raise a `ValueError`:
+
+```python
+prompt = prompt_manager.get_prompt("your_prompt_name", "your_version")
+compiled_prompt = prompt.compile(query=True, context="sunny", llm_response="It's sunny today")
+
+# Error: Value for variable 'query' must be a string, not bool
+```
+
+
+## FAQs
+
+### 1. How do I get the list of prompts in a project?
+
+You can get the list of prompts in a project by using the `list_prompts()` method in the `PromptManager`. This method allows you to retrieve the list of prompts in a project.
+
+### 2. How do I get the versions of a prompt?
+
+You can get the versions of a prompt by using the `list_prompt_versions(prompt_name)` method in the `PromptManager`. This method allows you to retrieve the versions of a prompt.
+
+### 3. How do I get the default version of a prompt?
+
+You can get the default version of a prompt by using the `get_prompt(prompt_name)` method in the `PromptManager`. This method allows you to retrieve the default version of a prompt. Then you can use `compile` method to get the prompt with default variables.
+
+### 4. How do I get the specific versions of a prompt?
+
+You can get the versions of a prompt by using the `get_prompt(prompt_name, version)` method in the `PromptManager`. This method allows you to retrieve the versions of a prompt. Then you can use `compile` method to get the prompt with default variables.
+
+
+### 5. How do I get the variables of a prompt?
+
+You can get the variables of a prompt by using the `get_variables()` method. This method allows you to retrieve the variables of a prompt.
+
+### 6. How do I get my parameters?
+
+You can get the parameters of a prompt by using the `get_parameters()` method. This method allows you to retrieve the parameters of a prompt.
+

ragaai_catalyst-1.0.8b1/examples/prompt_management_litellm.ipynb

@@ -0,0 +1,150 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Using RagaAI Catalyst Prompt Management with LiteLLM"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import litellm\n",
+    "\n",
+    "\n",
+    "from ragaai_catalyst.prompt_manager import PromptManager\n",
+    "from ragaai_catalyst import RagaAICatalyst"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "OPENAI_API_KEY = \"YOUR_OPENAI_API_KEY\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "catalyst = RagaAICatalyst(\n",
+    "    access_key=\"ACCESS_KEY\",\n",
+    "    secret_key=\"SECRET_KEY\",\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "prompt_manager = PromptManager(\"PROJECT_NAME\")\n",
+    "\n",
+    "# Get the prompt\n",
+    "prompt = prompt_manager.get_prompt(\"hallu\", version='v3')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Get prompt variables\n",
+    "prompt_variables = prompt.get_variables()\n",
+    "print(\"prompt_variables: \",prompt_variables)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Get parameters\n",
+    "parameters = prompt.get_parameters()\n",
+    "print(\"parameters: \",parameters)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Compile the prompt\n",
+    "compiled_prompt = prompt.compile(\n",
+    "    query='What is the capital of France?',\n",
+    "    llm_response=\"The capital of France is Paris.\",\n",
+    "    context=\"France is a country in Western Europe. Its capital and largest city is Paris.\"\n",
+    ")\n",
+    "print(compiled_prompt)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Function to call LiteLLM API\n",
+    "def get_litellm_response(prompt):\n",
+    "    response = litellm.completion(\n",
+    "        model=\"gpt-4o-mini\",\n",
+    "        messages=prompt\n",
+    "    )\n",
+    "    return response.choices[0].message.content"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Get response from LiteLLM\n",
+    "litellm_response = get_litellm_response(compiled_prompt)\n",
+    "\n",
+    "print(\"LiteLLM Response:\")\n",
+    "print(litellm_response)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "raga_ai_catalyst",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.14"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}