ragaai-catalyst 2.2.3b3__tar.gz → 2.2.3b5__tar.gz

{ragaai_catalyst-2.2.3b3 → ragaai_catalyst-2.2.3b5}/.gitignore

@@ -166,47 +166,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
-
-
-agent_load_test_exceptions.csv
-agent_load_test_failures.csv
-agent_load_test_stats.csv
-agent_load_test_stats_history.csv
-ai_document_061023_2.pdf
-catalyst_v2.ipynb
-chroma_db/
-custom_cost_bug.ipynb
-custom_cost_bug.py
-data/
-data_structure.py
-deephealth_sample_50_data.csv
-dh_full_test.ipynb
-diagnosis_agent.py
-langchain_sample_trace.json
-legal_rag.py
-load_test_streaming.py
-load_test_v1.py
-load_test_v2.py
-locustfile.py
-masking_example.py
-model_prices_and_context_window_backup.json
-multi_llm_test.py
-rag_agent_traces.json
-rag_agent_traces_with_streaming.json
-rag_agent_traces_wo_streaming.json
-rag_extraction_logic_final.py
-research_assistant.py
-sci_fi_story.md
-scifi_writer.py
-stress_test_langchain.py
-test.ipynb
-test_token_refresh.py
-uplaod_numerical_col_csv.py
-dh_full_test.py
-model_gemini_15_flash_002_w_stream.json
-model_gemini_15_flash_002_wo_stream.json
-model_gpt_4o_mini_w_stream.json
-model_gpt_4o_mini_wo_stream.json
-model_gpt_41_w_stream.json
-model_gpt_41_wo_stream.json
+#.idea/

{ragaai_catalyst-2.2.3b3/ragaai_catalyst.egg-info → ragaai_catalyst-2.2.3b5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ragaai_catalyst
-Version: 2.2.3b3
+Version: 2.2.3b5
 Summary: RAGA AI CATALYST
 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>, Tushar Kumar <tushar.kumar@raga.ai>, Rishabh Pandey <rishabh.pandey@raga.ai>, Jyotsana C G <jyotsana@raga.ai>
 Requires-Python: <=3.13.2,>=3.10

ragaai_catalyst-2.2.3b5/Quickstart.md

@@ -0,0 +1,200 @@
+# Quickstart | RagaAI Catalyst
+
+## **1. Install RagaAI Catalyst**
+
+To install the RagaAI Catalyst package, run the following command in your terminal:
+
+```bash
+pip install ragaai-catalyst
+```
+
+
+
+## **2. Set Up Authentication Keys**
+
+### **How to Get Your API Keys :**
+1. Log in to your account at [RagaAI Catalyst](https://catalyst.raga.ai/).
+2. Navigate to **Profile Settings** → **Authentication**.
+3. Click **Generate New Key** to obtain your **Access Key** and **Secret Key**.
+
+### **Initialize the SDK**
+
+To begin using Catalyst, initialize it as follows:
+
+```python
+from ragaai_catalyst import RagaAICatalyst
+
+catalyst = RagaAICatalyst(
+    access_key="YOUR_ACCESS_KEY",  # Replace with your access key
+    secret_key="YOUR_SECRET_KEY",  # Replace with your secret key
+    base_url="BASE_URL"  
+)
+```
+
+
+## **3. Create Your First Project**
+
+Create a new project and choose a use case from the available options:
+
+```python
+# Create a new project
+project = catalyst.create_project(
+    project_name="Project_Name",
+    usecase="Q/A"  # Options : Chatbot, Q/A, Others, Agentic Application
+)
+
+# List available use cases
+print(catalyst.project_use_cases())
+```
+
+### **Add a Dataset**
+Initialize the dataset manager and create a dataset from a CSV file, DataFrame, or JSONl file.
+
+Define a **schema mapping** for the dataset.
+
+```python
+from ragaai_catalyst import Dataset
+
+# Initialize dataset manager
+dataset_manager = Dataset(project_name="Project_Name")
+
+# Create dataset from a CSV file
+dataset_manager.create_from_csv(
+    csv_path="path/to/your.csv",
+    dataset_name="MyDataset",
+    schema_mapping={
+        'column1': 'schema_element1',
+        'column2': 'schema_element2'
+    }
+)
+
+# View dataset schema
+print(dataset_manager.get_schema_mapping())
+```
+
+
+## **4. Trace Your Application**
+
+
+
+### **Auto-Instrumentation**
+
+Auto-Instrumentation automatically traces your application after initializing the correct tracer.
+
+#### **Implementation**
+
+```python
+from ragaai_catalyst import init_tracing, Tracer
+
+# Initialize the tracer 
+tracer = Tracer(
+    project_name="Project_Name",
+    dataset_name="Dataset_Name",
+    tracer_type="agentic/langgraph"  
+)
+
+# Enable auto-instrumentation
+init_tracing(catalyst=catalyst, tracer=tracer)
+```
+
+#### **Supported Tracer Types**
+
+Choose from the given supported tracer types based on your framework:
+
+- `agentic/langgraph`
+- `agentic/langchain`
+- `agentic/smolagents`
+- `agentic/openai_agents`
+- `agentic/llamaindex`
+- `agentic/haystack`
+
+---
+
+
+
+### Custom Tracing
+
+You can enable custom tracing in two ways:
+
+1. Using the `with tracer()` function.
+2. Manually starting and stopping the tracer with `tracer.start()` and `tracer.stop()`.
+
+```python
+from ragaai_catalyst import Tracer
+
+# Initialize production tracer
+tracer = Tracer(
+    project_name="Project_Name",
+    dataset_name="tracer_dataset_name",
+    tracer_type="tracer_type"
+)
+
+# Start a trace recording (Option 1)
+with tracer():
+    # Your code here
+
+# Start a trace recording (Option 2)
+tracer.start()
+
+# Your code here
+
+# Stop the trace recording
+tracer.stop()
+
+# Verify data capture
+print(tracer.get_upload_status())
+```
+
+
+
+## **5. Evaluation Framework**
+
+
+1. Import `Evaluation` from `ragaai_catalyst`.
+2. Configure evaluation metrics.
+3. Add metrics from the available options.
+4. Check the status and retrieve results after running the evaluation.
+
+```python
+from ragaai_catalyst import Evaluation
+
+# Initialize evaluation engine
+evaluation = Evaluation(
+    project_name="Project_Name",
+    dataset_name="MyDataset"
+)
+
+# Define Schema-mapping
+
+schema_mapping = {
+    'Query': 'prompt',
+    'response': 'response',
+    'Context': 'context',
+    'expectedResponse': 'expected_response'
+}
+
+evaluation.add_metrics(
+    metrics=[
+        {
+            "name": "Faithfulness",
+            "config": {"model": "gpt-4o-mini", "provider": "openai", "threshold": {"gte": 0.232323}},
+            "column_name": "Faithfulness_v1",
+            "schema_mapping": schema_mapping
+        }
+    ]
+)
+
+# Get status and results
+
+print(f"Status: {evaluation.get_status()}")
+print(f"Results: {evaluation.get_results()}")
+```
+
+
+
+## **Next Steps**
+- **Explore the Dashboard:** Visualize metrics and insights in the RagaAI Web UI.
+
+
+
+**Version:** 1.0.0 | **Last Updated:** Mar 2025

{ragaai_catalyst-2.2.3b3 → ragaai_catalyst-2.2.3b5}/pyproject.toml

@@ -8,7 +8,7 @@ description = "RAGA AI CATALYST"
 readme = "README.md"
 requires-python = ">=3.10,<=3.13.2"
 # license = {file = "LICENSE"}
-version = "2.2.3.beta.3"
+version = "2.2.3.beta.5"
 authors = [
     {name = "Kiran Scaria", email = "kiran.scaria@raga.ai"},
     {name = "Kedar Gaikwad", email = "kedar.gaikwad@raga.ai"},

{ragaai_catalyst-2.2.3b3 → ragaai_catalyst-2.2.3b5}/ragaai_catalyst/ragaai_catalyst.py

@@ -48,9 +48,6 @@ class RagaAICatalyst:
             logger.error(
                 "RAGAAI_CATALYST_ACCESS_KEY and RAGAAI_CATALYST_SECRET_KEY environment variables must be set"
             )
-            raise ValueError(
-                "RAGAAI_CATALYST_ACCESS_KEY and RAGAAI_CATALYST_SECRET_KEY environment variables must be set"
-            )
 
         RagaAICatalyst.access_key, RagaAICatalyst.secret_key = (
             self._set_access_key_secret_key(access_key, secret_key)
@@ -79,9 +76,7 @@ class RagaAICatalyst:
                 os.environ["RAGAAI_CATALYST_BASE_URL"] = RagaAICatalyst.BASE_URL
                 RagaAICatalyst.get_token(force_refresh=True)
             except requests.exceptions.RequestException:
-                raise ConnectionError(
-                    "The provided base_url is not accessible. Please re-check the base_url."
-                )
+                logger.error("The provided base_url is not accessible. Please re-check the base_url.")
         else:
             # Get the token from the server
             RagaAICatalyst.get_token(force_refresh=True)
@@ -264,7 +259,7 @@ class RagaAICatalyst:
             if response.status_code == 400:
                 token_response = response.json()
                 if token_response.get("message") == "Please enter valid credentials":
-                    raise Exception(
+                    logger.error(
                         "Authentication failed. Invalid credentials provided. Please check your Access key and Secret key. \nTo view or create new keys, navigate to Settings -> Authenticate in the RagaAI Catalyst dashboard."
                     )
 
@@ -379,13 +374,13 @@ class RagaAICatalyst:
         # Check if the project already exists
         existing_projects = self.list_projects()
         if project_name in existing_projects:
-            raise ValueError(
+            logger.error(
                 f"Project name '{project_name}' already exists. Please choose a different name."
             )
 
         usecase_list = self.project_use_cases()
         if usecase not in usecase_list:
-            raise ValueError(f"Select a valid usecase from {usecase_list}")
+            logger.error(f"Select a valid usecase from {usecase_list}")
 
         json_data = {"name": project_name, "type": type, "usecase": usecase}
         headers = {

{ragaai_catalyst-2.2.3b3 → ragaai_catalyst-2.2.3b5}/ragaai_catalyst/tracers/tracer.py

@@ -365,6 +365,8 @@ class Tracer(AgenticTracing):
                 "output_cost_per_million_token": 2.40
             })
         """
+        logger.info("DEPRECATED: The set_model_cost method is deprecated and will be removed in a future version. Custom model costs can now be configured directly through the RagaAI Catalyst Platform")
+        print("DEPRECATED: The set_model_cost method is deprecated and will be removed in a future version. Custom model costs can now be configured directly through the RagaAI Catalyst Platform")
         # if not isinstance(cost_config, dict):
         #     logger.error("cost_config must be a dictionary")
 
@@ -418,7 +420,8 @@ class Tracer(AgenticTracing):
                         'telemetry.sdk.language','service.name', 'llm.model_name',
                         'llm.invocation_parameters', 'metadata', 'openinference.span.kind',
                         'llm.token_count.prompt', 'llm.token_count.completion', 'llm.token_count.total',
-                        "input_cost", "output_cost", "total_cost", "status_code"
+                        "input_cost", "output_cost", "total_cost", "status_code", "output.mime_type",
+                        "span_id", "trace_id"
                     }
                     # Apply masking only if the key is NOT in the excluded list
                     if parent_key and parent_key.lower() not in excluded_keys:

{ragaai_catalyst-2.2.3b3 → ragaai_catalyst-2.2.3b5/ragaai_catalyst.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ragaai_catalyst
-Version: 2.2.3b3
+Version: 2.2.3b5
 Summary: RAGA AI CATALYST
 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>, Tushar Kumar <tushar.kumar@raga.ai>, Rishabh Pandey <rishabh.pandey@raga.ai>, Jyotsana C G <jyotsana@raga.ai>
 Requires-Python: <=3.13.2,>=3.10

{ragaai_catalyst-2.2.3b3 → ragaai_catalyst-2.2.3b5}/ragaai_catalyst.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 .gitignore
 .gitmodules
 LICENSE
+Quickstart.md
 README.md
 pyproject.toml
 quickstart.md