ragaai-catalyst 2.0.5__py3-none-any.whl → 2.0.6b0__py3-none-any.whl

{ragaai_catalyst-2.0.5.dist-info → ragaai_catalyst-2.0.6b0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ragaai_catalyst
-Version: 2.0.5
+Version: 2.0.6b0
 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>
 Requires-Python: >=3.9
@@ -24,7 +24,10 @@ Requires-Dist: groq>=0.11.0
 Requires-Dist: PyPDF2>=3.0.1
 Requires-Dist: google-generativeai>=0.8.2
 Requires-Dist: Markdown>=3.7
+Requires-Dist: litellm==1.51.1
 Requires-Dist: tenacity==8.3.0
+Requires-Dist: tqdm>=4.66.5
+Requires-Dist: llama-index==0.10.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -45,10 +48,11 @@ RagaAI Catalyst is a powerful tool for managing and optimizing LLM projects. It
   - [Configuration](#configuration)
   - [Usage](#usage)
     - [Project Management](#project-management)
-    - [Trace Management](#trace-management)
-    - [Experiment Management](#experiment-management)
     - [Dataset Management](#dataset-management)
+    - [Evaluation Management](#evaluation)
+    - [Trace Management](#trace-management)
     - [Prompt Management](#prompt-management)
+    - [Synthetic Data Generation](#synthetic-data-generation)
 
 ## Installation
 
@@ -84,145 +88,208 @@ Create and manage projects using RagaAI Catalyst:
 # Create a project
 project = catalyst.create_project(
     project_name="Test-RAG-App-1",
-    description="Description of the project"
+    usecase="Chatbot"
 )
 
+# Get project usecases
+catalyst.project_use_cases()
+
 # List projects
 projects = catalyst.list_projects()
 print(projects)
 ```
 
-### Trace Management
+### Dataset Management
+Manage datasets efficiently for your projects:
 
-Record and analyze traces of your RAG application:
+```py
+from ragaai_catalyst import Dataset
 
-```python
-from ragaai_catalyst import Tracer
+# Initialize Dataset management for a specific project
+dataset_manager = Dataset(project_name="project_name")
 
-# Start a trace recording
-tracer = Tracer(
-    project_name="Test-RAG-App-1",
-    metadata={"key1": "value1", "key2": "value2"},
-    tracer_type="langchain",
-    pipeline={
-        "llm_model": "gpt-3.5-turbo",
-        "vector_store": "faiss",
-        "embed_model": "text-embedding-ada-002",
-    }
-).start()
+# List existing datasets
+datasets = dataset_manager.list_datasets()
+print("Existing Datasets:", datasets)
 
-# Your code here
+# 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'}
+)
 
-# Stop the trace recording
-tracer.stop()
+# Get project schema mapping
+dataset_manager.get_schema_mapping()
 
-# Alternatively, use a context manager
-with tracer.trace():
-    # Your code here
 ```
 
-### Experiment Management
+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).
+
+
+### Evaluation
 
-Create and manage experiments to evaluate your RAG application:
+Create and manage metric evaluation of your RAG application:
 
 ```python
-from ragaai_catalyst import Experiment
+from ragaai_catalyst import Evaluation
 
 # Create an experiment
-experiment_manager = Experiment(
+evaluation = Evaluation(
     project_name="Test-RAG-App-1",
-    experiment_name="Exp-01",
-    experiment_description="Experiment Description",
-    dataset_name="Dataset Created from UI",
+    dataset_name="MyDataset",
 )
 
+# Get list of available metrics
+evaluation.list_metrics()
+
 # Add metrics to the experiment
-experiment_manager.add_metrics(
+schema_mapping={
+    'Query': 'prompt',
+    'response': 'response',
+    'Context': 'context',
+    'expectedResponse': 'expected_response'
+}
+
+# Add single metric
+evaluation.add_metrics(
     metrics=[
-      {"name": "hallucination", "config": {"model": "gpt-4o", "provider":"OpenAI"}}
+      {"name": "Faithfulness", "config": {"model": "gpt-4o-mini", "provider": "openai", "threshold": {"gte": 0.232323}}, "column_name": "Faithfulness_v1", "schema_mapping": schema_mapping},
+    
     ]
 )
 
 # Add multiple metrics
-experiment_manager.add_metrics(
+evaluation.add_metrics(
     metrics=[
-        {"name": "hallucination", "config": {"model": "gpt-4o", "provider":"OpenAI"}},
-        {"name": "hallucination", "config": {"model": "gpt-4", "provider":"OpenAI"}},
-        {"name": "hallucination", "config": {"model": "gpt-3.5-turbo", "provider":"OpenAI"}}
+        {"name": "Faithfulness", "config": {"model": "gpt-4o-mini", "provider": "openai", "threshold": {"gte": 0.323}}, "column_name": "Faithfulness_gte", "schema_mapping": schema_mapping},
+        {"name": "Hallucination", "config": {"model": "gpt-4o-mini", "provider": "openai", "threshold": {"lte": 0.323}}, "column_name": "Hallucination_lte", "schema_mapping": schema_mapping},
+        {"name": "Hallucination", "config": {"model": "gpt-4o-mini", "provider": "openai", "threshold": {"eq": 0.323}}, "column_name": "Hallucination_eq", "schema_mapping": schema_mapping},
     ]
 )
 
 # Get the status of the experiment
-status = experiment_manager.get_status()
+status = evaluation.get_status()
 print("Experiment Status:", status)
 
 # Get the results of the experiment
-results = experiment_manager.get_results()
+results = evaluation.get_results()
 print("Experiment Results:", results)
 ```
 
 
 
-## Dataset Management
-Manage datasets efficiently for your projects:
+### Trace Management
 
-```py
-from ragaai_catalyst import Dataset
+Record and analyze traces of your RAG application:
 
-# Initialize Dataset management for a specific project
-dataset_manager = Dataset(project_name="project_name")
+```python
+from ragaai_catalyst import Tracer
 
-# List existing datasets
-datasets = dataset_manager.list_datasets()
-print("Existing Datasets:", datasets)
+# Start a trace recording
+tracer = Tracer(
+    project_name="Test-RAG-App-1",
+    dataset_name="tracer_dataset_name"
+    metadata={"key1": "value1", "key2": "value2"},
+    tracer_type="langchain",
+    pipeline={
+        "llm_model": "gpt-3.5-turbo",
+        "vector_store": "faiss",
+        "embed_model": "text-embedding-ada-002",
+    }
+).start()
 
-# 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}
-    ]
-)
+# Your code here
 
-# 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'}
-)
+# Stop the trace recording
+tracer.stop()
 ```
 
-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
+### Prompt Management
 
 Manage and use prompts efficiently in your projects:
 
 ```py
-from ragaai_catalyst.prompt_manager import PromptManager
+from ragaai_catalyst import PromptManager
 
 # Initialize PromptManager
-prompt_manager = PromptManager("your-project-name")
+prompt_manager = PromptManager(project_name="Test-RAG-App-1")
 
 # List available prompts
 prompts = prompt_manager.list_prompts()
 print("Available prompts:", prompts)
 
-# Get a specific prompt
+# Get default prompt by prompt_name
 prompt_name = "your_prompt_name"
 prompt = prompt_manager.get_prompt(prompt_name)
 
+# Get specific version of prompt by prompt_name and version
+prompt_name = "your_prompt_name"
+version = "v1"
+prompt = prompt_manager.get_prompt(prompt_name,version)
+
+# Get variables in a prompt
+variable = prompt.get_variables()
+print("variable:",variable)
+
+# Get prompt content
+prompt_content = prompt.get_prompt_content()
+print("prompt_content:", prompt_content)
+
 # 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)
-```
+# implement compiled_prompt with openai
+import openai
+def get_openai_response(prompt):
+    client = openai.OpenAI()
+    response = client.chat.completions.create(
+        model="gpt-4o-mini",
+        messages=prompt
+    )
+    return response.choices[0].message.content
+openai_response = get_openai_response(compiled_prompt)
+print("openai_response:", openai_response)
+
+# implement compiled_prompt with litellm
+import litellm
+def get_litellm_response(prompt):
+    response = litellm.completion(
+        model="gpt-4o-mini",
+        messages=prompt
+    )
+    return response.choices[0].message.content
+litellm_response = get_litellm_response(compiled_prompt)
+print("litellm_response:", litellm_response)
 
+```
 For more detailed information on Prompt Management, please refer to the [Prompt Management documentation](docs/prompt_management.md).
 
 
+### Synthetic Data Generation
+
+```py
+from ragaai_catalyst import SyntheticDataGeneration
+
+# Initialize Synthetic Data Generation
+sdg = SyntheticDataGeneration()
+
+# Process your file
+text = sdg.process_document(input_data="file_path")
+
+# Generate results
+result = sdg.generate_qna(text, question_type ='simple',model_config={"provider":"openai","model":"gpt-4o-mini"},n=20)
+
+# Get supported Q&A types
+sdg.get_supported_qna()
+
+# Get supported providers
+sdg.get_supported_providers()
+```
+
+
+
+
 

{ragaai_catalyst-2.0.5.dist-info → ragaai_catalyst-2.0.6b0.dist-info}/RECORD

@@ -1,15 +1,18 @@
-ragaai_catalyst/__init__.py,sha256=T0-X4yfIAe26-tWx6kLwNkKIjaFoQL2aNLIRp5wBG5w,424
+ragaai_catalyst/__init__.py,sha256=Gwhhw9Q-ze2BTwvo2FsXCS6ad9Dy4RktMRL3R_SbCR0,495
 ragaai_catalyst/_version.py,sha256=JKt9KaVNOMVeGs8ojO6LvIZr7ZkMzNN-gCcvryy4x8E,460
-ragaai_catalyst/dataset.py,sha256=XjI06Exs6-64pQPQlky4mtcUllNMCgKP-bnM_t9EWkY,10920
-ragaai_catalyst/evaluation.py,sha256=PR7rMkvZ4km26B24sSc60GPNS0JkrUMIYo5CPEqX2Qw,19315
+ragaai_catalyst/dataset.py,sha256=bDNZkcji22sg-zJqMHEwueTO8A2f_GJu70WcEHESwQk,10729
+ragaai_catalyst/evaluation.py,sha256=ZS5G5RjmATjljQhAKYCrDXW2mUNXscpRRoL8cseDjAA,20283
 ragaai_catalyst/experiment.py,sha256=8KvqgJg5JVnt9ghhGDJvdb4mN7ETBX_E5gNxBT0Nsn8,19010
+ragaai_catalyst/guardrails_manager.py,sha256=4G8RkZH4QXXZXPGFDlJ7_93dSBCtVwZOrLvg2jawtHc,10533
+ragaai_catalyst/internal_api_completion.py,sha256=51YwXcas5NviC1wjr8EX5Y6BOyTbJ4FlKHM8gE46Wtk,2916
 ragaai_catalyst/prompt_manager.py,sha256=ZMIHrmsnPMq20YfeNxWXLtrxnJyMcxpeJ8Uya7S5dUA,16411
-ragaai_catalyst/proxy_call.py,sha256=nlMdJCSW73sfN0fMbCbtIk6W992Nac5FJvcfNd6UDJk,5497
+ragaai_catalyst/proxy_call.py,sha256=CHxldeceZUaLU-to_hs_Kf1z_b2vHMssLS_cOBedu78,5499
 ragaai_catalyst/ragaai_catalyst.py,sha256=5Q1VCE7P33DtjaOtVGRUgBL8dpDL9kjisWGIkOyX4nE,17426
-ragaai_catalyst/synthetic_data_generation.py,sha256=STpZF-a1mYT3GR4CGdDvhBdctf2ciSLyvDANqJxnQp8,12989
+ragaai_catalyst/synthetic_data_generation.py,sha256=49DtTzYVGaGvye-g6cgpYNf7YMf2wZFLQ7ACxtqu9_E,18945
 ragaai_catalyst/utils.py,sha256=TlhEFwLyRU690HvANbyoRycR3nQ67lxVUQoUOfTPYQ0,3772
 ragaai_catalyst/tracers/__init__.py,sha256=NppmJhD3sQ5R1q6teaZLS7rULj08Gb6JT8XiPRIe_B0,49
-ragaai_catalyst/tracers/tracer.py,sha256=eaGJdLEIjadHpbWBXBl5AhMa2vL97SVjik4U1L8gros,9591
+ragaai_catalyst/tracers/llamaindex_callback.py,sha256=vPE7MieKjfwLrLUnnPs20Df0xNYqoCCj-Mt2NbiuiKU,14023
+ragaai_catalyst/tracers/tracer.py,sha256=Y7eGoUDU1tAF3adccfn1ukE38zMs38azUKfO7hB4Zto,11300
 ragaai_catalyst/tracers/exporters/__init__.py,sha256=kVA8zp05h3phu4e-iHSlnznp_PzMRczB7LphSsZgUjg,138
 ragaai_catalyst/tracers/exporters/file_span_exporter.py,sha256=RgGteu-NVGprXKkynvyIO5yOjpbtA41R3W_NzCjnkwE,6445
 ragaai_catalyst/tracers/exporters/raga_exporter.py,sha256=rQ5Wj71f2Ke3qLlV8KiWCskbGBR-ia_hlzDx86rPrEo,18188
@@ -19,7 +22,7 @@ ragaai_catalyst/tracers/instrumentators/llamaindex.py,sha256=SMrRlR4xM7k9HK43hak
 ragaai_catalyst/tracers/instrumentators/openai.py,sha256=14R4KW9wQCR1xysLfsP_nxS7cqXrTPoD8En4MBAaZUU,379
 ragaai_catalyst/tracers/utils/__init__.py,sha256=KeMaZtYaTojilpLv65qH08QmpYclfpacDA0U3wg6Ybw,64
 ragaai_catalyst/tracers/utils/utils.py,sha256=ViygfJ7vZ7U0CTSA1lbxVloHp4NSlmfDzBRNCJuMhis,2374
-ragaai_catalyst-2.0.5.dist-info/METADATA,sha256=tWppjo0sERHjjugIOAWdwD1p05HO6T6N_E1KYd9G9hY,6625
-ragaai_catalyst-2.0.5.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-ragaai_catalyst-2.0.5.dist-info/top_level.txt,sha256=HpgsdRgEJMk8nqrU6qdCYk3di7MJkDL0B19lkc7dLfM,16
-ragaai_catalyst-2.0.5.dist-info/RECORD,,
+ragaai_catalyst-2.0.6b0.dist-info/METADATA,sha256=jx1IOXpDN1OeHqmHrwMucgmzHcIer7saIPSU2923JHI,8525
+ragaai_catalyst-2.0.6b0.dist-info/WHEEL,sha256=a7TGlA-5DaHMRrarXjVbQagU3Man_dCnGIWMJr5kRWo,91
+ragaai_catalyst-2.0.6b0.dist-info/top_level.txt,sha256=HpgsdRgEJMk8nqrU6qdCYk3di7MJkDL0B19lkc7dLfM,16
+ragaai_catalyst-2.0.6b0.dist-info/RECORD,,

{ragaai_catalyst-2.0.5.dist-info → ragaai_catalyst-2.0.6b0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.4.0)
 Root-Is-Purelib: true
 Tag: py3-none-any