ragit 0.8__py3-none-any.whl → 0.8.2__py3-none-any.whl

ragit-0.8.dist-info/METADATA

@@ -1,176 +0,0 @@
-Metadata-Version: 2.2
-Name: ragit
-Version: 0.8
-Home-page: https://github.com/stsfaroz/ragit
-Author: Salman Faroz
-License: MIT
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: sentence-transformers>=3.4.1
-Requires-Dist: pandas>=2.2.3
-Requires-Dist: chromadb>=0.6.3
-Requires-Dist: setuptools>=75.8.0
-Requires-Dist: wheel>=0.45.1
-Requires-Dist: twine>=6.1.0
-Dynamic: author
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
-Dynamic: requires-dist
-
-
-# Ragit
-🚀 Smart, Fast, Scalable Search 🚀
-
-## Installation
-```
-pip install ragit
-```
-
-**ragit** is a lightweight Python library that simplifies the management of vector databases. With **ragit**, you can easily create, update, query, and manage your vector database, all from CSV files containing text data.
-
-## Features
-
-- **Create a Vector Database:** Build your database from a CSV file with two required columns: `id` and `text`.
-- **Add New Entries:** Insert additional entries from CSV files or add them individually.
-- **Similarity Search:** Find nearby texts using various distance metrics (e.g., cosine, L2) with similarity scores.
-- **Data Retrieval:** Fetch entries by IDs or exact text matches.
-- **Deletion:** Remove single entries or entire collections when needed.
-
-## CSV File Format
-ragit expects your CSV file to have exactly two columns: `id` and `text`.  **Note:** Each `id` must be unique.
-
-## Example CSV (`data.csv`):
-
-```csv
-id,text
-1,The quick brown fox jumps over the lazy dog.
-2,Another sample entry for testing.
-```
-
-## Usage
-Below are some examples that demonstrate how to use `ragit`. The examples cover creating a database, adding entries, performing similarity searches, and more.
-
-### 1. Importing and Initializing
-First, import the `VectorDBManager` class from `ragit` and initialize it:
-
-```python
-from ragit import VectorDBManager
-
-# Initialize the vector database manager with a custom persistence directory and model
-db_manager = VectorDBManager(
-    persist_directory="./my_vector_db", # Optional # default : "./vector_db"
-    provider="sentence_transformer", # Optional # default : "sentence_transformer"
-    model_name="all-mpnet-base-v2" # Optional # default : "all-mpnet-base-v2"
-)
-```
-
-### 2. Creating a Database
-Create a new collection (named `my_collection`) using your CSV file. In this example, the `distance_metric` is set to "cosine"(available options: l2, cosine, ip, l1) :
-
-```python
-db_manager.create_database(
-    csv_path="data.csv", 
-    collection_name="my_collection",
-    distance_metric="cosine" # Optional # default : l2
-)
-```
-### Reloading Your Database
-
-To reuse your existing vector database, initialize VectorDBManager with the same parameters that were used when creating the database.
-
-```python
-from ragit import VectorDBManager
-
-db_manager = VectorDBManager(
-    persist_directory="./my_vector_db",
-    provider="sentence_transformer",
-    model_name="all-mpnet-base-v2"
-)
-```
-
-### 3. Adding a Single Entry
-Add an individual entry to the collection:
-
-```python
-db_manager.add_single_row(
-    id_="101",
-    text="This is a new test entry for the database.",
-    collection_name="my_collection"
-)
-```
-
-### 4. Adding Multiple Entries from CSV
-You can also add multiple entries from a CSV file. This function skips any entries that already exist in the collection:
-
-```python
-stats = db_manager.add_values_from_csv(
-    csv_path="data.csv",
-    collection_name="my_collection"
-)
-print(f"Added {stats['new_entries_added']} new entries")
-```
-
-### 5. Retrieving Collection Information
-Fetch and display information about your collection:
-
-```python
-info = db_manager.get_collection_info("my_collection")
-print(f"Collection size: {info['count']} entries")
-```
-
-### 6. Performing a Similarity Search
-Find texts that are similar to your query. In this example, the query text is "ai", and the search is filtered using the string "Artificial intelligence". The top 2 results are returned:
-
-```python
-results = db_manager.find_nearby_texts(
-    text="ai",
-    collection_name="my_collection",
-    k=2,
-    search_string="Artificial intelligence" # Optional
-)
-
-print("Results:")
-for item in results:
-    print(f"\nID: {item['id']}")
-    print(f"Text: {item['text']}")
-    print(f"Similarity: {item['similarity']}%")
-    print(f"Distance ({item['metric']}): {item['raw_distance']}")
-```
-
-### 7. Fetching Texts by IDs
-Retrieve text entries for a list of IDs:
-
-```python
-ids_to_fetch = ["1", "2", "3"]
-texts = db_manager.get_by_ids(ids_to_fetch, "my_collection")
-print("Texts:", texts)
-```
-
-### 8. Deleting a Row / Collection
-
-Remove an entry from the collection by its ID:
-
-```python
-db_manager.delete_entry_by_id(
-    id_="1",
-    collection_name="my_collection"
-)
-```
-
-
-Delete an entire collection. **Note:** You must pass `confirmation="yes"` to proceed with deletion.
-
-```python
-db_manager.delete_collection(
-    collection_name="my_collection",
-    confirmation="yes"
-)
-```
-
-## Contributing
-Contributions are welcome! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on GitHub.
-
-## License
-This project is licensed under the MIT License. See the `LICENSE` file for details.

ragit-0.8.dist-info/RECORD

@@ -1,7 +0,0 @@
-ragit/__init__.py,sha256=GECJxYFL_0PMy6tbcVFpW9Fhe1JiI2uXH4iJWhUHpKs,48
-ragit/main.py,sha256=f2kDfZPxP26DBvzmP7aF6VhnNAE1hC-ZONU5ZH6RVBM,11774
-ragit-0.8.dist-info/LICENSE,sha256=L8f7hg7lQm80qoZhSCoW1ACAKph-FpJaNaa9MyNDBqo,1069
-ragit-0.8.dist-info/METADATA,sha256=H73xJZU_viExL4wcb-knClT7-BmMvhtlAaeQ07gliXM,5230
-ragit-0.8.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ragit-0.8.dist-info/top_level.txt,sha256=pkPbG7yrw61wt9_y_xcLE2vq2a55fzockASD0yq0g4s,6
-ragit-0.8.dist-info/RECORD,,