ragutils


Nameragutils JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryA package that abstracts most of the utilities used in RAG applications
upload_time2024-04-26 07:26:32
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseApache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
keywords document loaders embedding providers text splitters vector databases
VCS
bugtrack_url
requirements pinecone-client tiktoken pypdf unstructured langchain-community langchain langchain-openai langchain-google-genai langchain-pinecone google.generativeai python-dotenv docx2txt python-docx markdown beautifulsoup4 langchain-experimental nltk cohere langchain-cohere fastembed qdrant-client pymilvus docarray chromadb faiss-cpu
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # **ragutils**
* A Python package that abstracts RAG (Retrieval-Augmented Generation) utilities, providing unified document loaders, embedding models, text splitters, and vector databases in one package.
* Retriever and Rerankers coming soon
* Langchain based

## **BENEFITS**
* Unified Interface: Simplifies complex processes by providing a unified interface for various RAG utilities.
* Flexibility: Supports multiple document sources, splitting methods, embedding providers, and vector databases, enhancing adaptability to diverse use cases.
* Scalability: Designed to accommodate future functionalities, ensuring long-term viability and relevance.

## **INSTALL AND RUN**
    pip install ragutils

### **Document Loaders**
The DocumentLoader class is used to load documents from different sources and return them as a list of strings. The supported sources include CSV, JSON, PDF, HTML, Markdown, powerpoint and Word documents.

The purpose of the DocumentLoader class is to provide a single interface for loading documents from various sources and to ensure that the process of loading documents is consistent across different sources. This allows the code that uses the DocumentLoader class to be more flexible and easier to maintain.

By using the DocumentLoader class, the code can be written in a way that is independent of the specific source of the document. This makes it easier to modify or extend the code in the future, as new sources of documents can be added without affecting the rest of the code.

#### Example usage:
    from ragutils.document_loader import DocumentLoader
    loader = DocumentLoader()
    file_path = os.path.join("path/to/file.csv")
    data = loader.load_and_split(file_path)
    url = "https://example.com/document.html"
    data = loader.load(url)

### **Text Splitters**
The TextSplitter class is used to split text into a list of document objects. It can be used to preprocess the text data before indexing it to a vector database.

The TextSplitter class provides a number of different splitters, including splitters that split based on HTML headers, Markdown headers, character boundaries, recursive character boundaries, and semantic chunks. The splitters can be configured with arguments to control the splitting process, such as the maximum length of the chunks or the set of headers to split on.

The TextSplitter class is designed to be flexible and can be used with a wide range of text data, including HTML documents, Markdown documents, and plain text. It is also designed to be scalable in future.

#### Example usage:
    from ragutils.document_loaders import DocumentLoader
    from ragutils.text_splitter import TextSplitter
    document_loader = DocumentLoader()
    splitter = TextSplitter(splitter="recursive")

    file_path = os.path.join("path/to/file.csv")
    data = loader.load_and_split(file_path)
    documents = splitter.split_to_documents(data= data, chunk_size = 1000, chunk_overlap=20 )

### **Embedding Providers**
The EmbeddingProvider class is responsible for providing different embedding functions based on the embedding_provider specified in the settings file. It initializes the class with the specified embedding_provider and provides the get_embedding_function method to retrieve the embedding function based on the model_name.

#### Example usage:
    from ragutils.document_loader import DocumentLoader
    from ragutils.text_splitter import TextSplitter
    from ragutils.embedding_provider import EmbeddingProvider

    loader = DocumentLoader()
    file_path = os.path.join("path/to/file.csv")
    data = loader.load_and_split(file_path)
    url = "https://example.com/document.html"
    data = loader.load(url)

    # Split the text
    splitter = TextSplitter(splitter="recursive")
    documents = splitter.split_to_documents(data=data, chunk_size=1000, chunk_overlap=20)

    # Get the embedding function
    embedding_provider = EmbeddingProvider(embedding_provider="openai")
    embedding_function = embedding_provider.get_embedding_function()

#### **Vector Databases**
The purpose of the VectorDatabase class is to manage different vector databases, such as Chroma, Pinecone, Milvus, Qdrant, DocArrayInMemorySearch, and Faiss. It provides a consistent interface for creating and managing indexes for different vector databases.

#### Example usage
    from ragutils.document_loader import DocumentLoader
    from ragutils.text_splitter import TextSplitter
    from ragutils.embedding_provider import EmbeddingProvider
    from ragutils.vector_databases import VectorDatabase

    loader = DocumentLoader()
    file_path = os.path.join("path/to/file.csv")
    data = loader.load_and_split(file_path)
    url = "https://example.com/document.html"
    data = loader.load(url)

    # Split the text
    splitter = TextSplitter(splitter="recursive")
    documents = splitter.split_to_documents(data=data, chunk_size=1000, chunk_overlap=20)

    # Get the embedding function
    embedding_provider = EmbeddingProvider(embedding_provider="openai")
    embedding_function = embedding_provider.get_embedding_function()

    #embed the documents
    index_dir = 'tests/index/'
    vector_database = VectorDatabase(vector_store='chroma', index_name='test_index')
    vector_database.create_index(embedding_function, documents, index_dir)

### **Retrievers (Coming Soon)**
Stay tuned for retriever functionalities.

### **Rerankers (Coming Soon)**
Stay tuned for reranker functionalities.

## **CONTRIBUTE**
Feel free to contribute to ragutils by submitting bug reports, feature requests, or pull requests on GitHub.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ragutils",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "document loaders, embedding providers, text splitters, vector databases",
    "author": null,
    "author_email": "Koleshjr <koleshjr@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/be/27/938d7d8b81780ec83821a0afc2114a7bceb5043d166010a5f44642cc6d06/ragutils-0.1.0.tar.gz",
    "platform": null,
    "description": "# **ragutils**\n* A Python package that abstracts RAG (Retrieval-Augmented Generation) utilities, providing unified document loaders, embedding models, text splitters, and vector databases in one package.\n* Retriever and Rerankers coming soon\n* Langchain based\n\n## **BENEFITS**\n* Unified Interface: Simplifies complex processes by providing a unified interface for various RAG utilities.\n* Flexibility: Supports multiple document sources, splitting methods, embedding providers, and vector databases, enhancing adaptability to diverse use cases.\n* Scalability: Designed to accommodate future functionalities, ensuring long-term viability and relevance.\n\n## **INSTALL AND RUN**\n    pip install ragutils\n\n### **Document Loaders**\nThe DocumentLoader class is used to load documents from different sources and return them as a list of strings. The supported sources include CSV, JSON, PDF, HTML, Markdown, powerpoint and Word documents.\n\nThe purpose of the DocumentLoader class is to provide a single interface for loading documents from various sources and to ensure that the process of loading documents is consistent across different sources. This allows the code that uses the DocumentLoader class to be more flexible and easier to maintain.\n\nBy using the DocumentLoader class, the code can be written in a way that is independent of the specific source of the document. This makes it easier to modify or extend the code in the future, as new sources of documents can be added without affecting the rest of the code.\n\n#### Example usage:\n    from ragutils.document_loader import DocumentLoader\n    loader = DocumentLoader()\n    file_path = os.path.join(\"path/to/file.csv\")\n    data = loader.load_and_split(file_path)\n    url = \"https://example.com/document.html\"\n    data = loader.load(url)\n\n### **Text Splitters**\nThe TextSplitter class is used to split text into a list of document objects. It can be used to preprocess the text data before indexing it to a vector database.\n\nThe TextSplitter class provides a number of different splitters, including splitters that split based on HTML headers, Markdown headers, character boundaries, recursive character boundaries, and semantic chunks. The splitters can be configured with arguments to control the splitting process, such as the maximum length of the chunks or the set of headers to split on.\n\nThe TextSplitter class is designed to be flexible and can be used with a wide range of text data, including HTML documents, Markdown documents, and plain text. It is also designed to be scalable in future.\n\n#### Example usage:\n    from ragutils.document_loaders import DocumentLoader\n    from ragutils.text_splitter import TextSplitter\n    document_loader = DocumentLoader()\n    splitter = TextSplitter(splitter=\"recursive\")\n\n    file_path = os.path.join(\"path/to/file.csv\")\n    data = loader.load_and_split(file_path)\n    documents = splitter.split_to_documents(data= data, chunk_size = 1000, chunk_overlap=20 )\n\n### **Embedding Providers**\nThe EmbeddingProvider class is responsible for providing different embedding functions based on the embedding_provider specified in the settings file. It initializes the class with the specified embedding_provider and provides the get_embedding_function method to retrieve the embedding function based on the model_name.\n\n#### Example usage:\n    from ragutils.document_loader import DocumentLoader\n    from ragutils.text_splitter import TextSplitter\n    from ragutils.embedding_provider import EmbeddingProvider\n\n    loader = DocumentLoader()\n    file_path = os.path.join(\"path/to/file.csv\")\n    data = loader.load_and_split(file_path)\n    url = \"https://example.com/document.html\"\n    data = loader.load(url)\n\n    # Split the text\n    splitter = TextSplitter(splitter=\"recursive\")\n    documents = splitter.split_to_documents(data=data, chunk_size=1000, chunk_overlap=20)\n\n    # Get the embedding function\n    embedding_provider = EmbeddingProvider(embedding_provider=\"openai\")\n    embedding_function = embedding_provider.get_embedding_function()\n\n#### **Vector Databases**\nThe purpose of the VectorDatabase class is to manage different vector databases, such as Chroma, Pinecone, Milvus, Qdrant, DocArrayInMemorySearch, and Faiss. It provides a consistent interface for creating and managing indexes for different vector databases.\n\n#### Example usage\n    from ragutils.document_loader import DocumentLoader\n    from ragutils.text_splitter import TextSplitter\n    from ragutils.embedding_provider import EmbeddingProvider\n    from ragutils.vector_databases import VectorDatabase\n\n    loader = DocumentLoader()\n    file_path = os.path.join(\"path/to/file.csv\")\n    data = loader.load_and_split(file_path)\n    url = \"https://example.com/document.html\"\n    data = loader.load(url)\n\n    # Split the text\n    splitter = TextSplitter(splitter=\"recursive\")\n    documents = splitter.split_to_documents(data=data, chunk_size=1000, chunk_overlap=20)\n\n    # Get the embedding function\n    embedding_provider = EmbeddingProvider(embedding_provider=\"openai\")\n    embedding_function = embedding_provider.get_embedding_function()\n\n    #embed the documents\n    index_dir = 'tests/index/'\n    vector_database = VectorDatabase(vector_store='chroma', index_name='test_index')\n    vector_database.create_index(embedding_function, documents, index_dir)\n\n### **Retrievers (Coming Soon)**\nStay tuned for retriever functionalities.\n\n### **Rerankers (Coming Soon)**\nStay tuned for reranker functionalities.\n\n## **CONTRIBUTE**\nFeel free to contribute to ragutils by submitting bug reports, feature requests, or pull requests on GitHub.\n\n",
    "bugtrack_url": null,
    "license": "Apache License Version 2.0, January 2004 http://www.apache.org/licenses/  TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION  1. Definitions.  \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.  \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.  \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.  \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License.  \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.  \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.  \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).  \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.  \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\"  \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.  2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.  3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.  4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:  (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and  (b) You must cause any modified files to carry prominent notices stating that You changed the files; and  (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and  (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.  You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.  5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.  6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.  7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.  8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.  9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.  END OF TERMS AND CONDITIONS  APPENDIX: How to apply the Apache License to your work.  To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives.  Copyright [yyyy] [name of copyright owner]  Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ",
    "summary": "A package that abstracts most of the utilities used in RAG applications",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/koleshjr/ragutils"
    },
    "split_keywords": [
        "document loaders",
        " embedding providers",
        " text splitters",
        " vector databases"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "93ed4882a02d9f84b7901ce24c8607a57c000a32d44541936975a08a71d7f28d",
                "md5": "11fa3fcf3a0ad14efd8f44ecefa0d42e",
                "sha256": "b8ca745ef9287ddcd46e240e4a867df1290073528e316b900b5bb88f87ac363a"
            },
            "downloads": -1,
            "filename": "ragutils-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "11fa3fcf3a0ad14efd8f44ecefa0d42e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 16213,
            "upload_time": "2024-04-26T07:26:31",
            "upload_time_iso_8601": "2024-04-26T07:26:31.250018Z",
            "url": "https://files.pythonhosted.org/packages/93/ed/4882a02d9f84b7901ce24c8607a57c000a32d44541936975a08a71d7f28d/ragutils-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "be27938d7d8b81780ec83821a0afc2114a7bceb5043d166010a5f44642cc6d06",
                "md5": "71ac9e82056d86934756909648804e2b",
                "sha256": "69f01f15f335f17c1271720076dfb39ea98b329382985b9e4082641212e25793"
            },
            "downloads": -1,
            "filename": "ragutils-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "71ac9e82056d86934756909648804e2b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 19841,
            "upload_time": "2024-04-26T07:26:32",
            "upload_time_iso_8601": "2024-04-26T07:26:32.628322Z",
            "url": "https://files.pythonhosted.org/packages/be/27/938d7d8b81780ec83821a0afc2114a7bceb5043d166010a5f44642cc6d06/ragutils-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-26 07:26:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "koleshjr",
    "github_project": "ragutils",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "pinecone-client",
            "specs": [
                [
                    ">=",
                    "3.2.2"
                ]
            ]
        },
        {
            "name": "tiktoken",
            "specs": [
                [
                    ">=",
                    "0.6.0"
                ]
            ]
        },
        {
            "name": "pypdf",
            "specs": [
                [
                    ">=",
                    "4.1.0"
                ]
            ]
        },
        {
            "name": "unstructured",
            "specs": [
                [
                    ">=",
                    "0.13.2"
                ]
            ]
        },
        {
            "name": "langchain-community",
            "specs": [
                [
                    ">=",
                    "0.0.31"
                ]
            ]
        },
        {
            "name": "langchain",
            "specs": [
                [
                    ">=",
                    "0.1.14"
                ]
            ]
        },
        {
            "name": "langchain-openai",
            "specs": [
                [
                    ">=",
                    "0.1.1"
                ]
            ]
        },
        {
            "name": "langchain-google-genai",
            "specs": [
                [
                    ">=",
                    "1.0.1"
                ]
            ]
        },
        {
            "name": "langchain-pinecone",
            "specs": [
                [
                    ">=",
                    "0.1.0"
                ]
            ]
        },
        {
            "name": "google.generativeai",
            "specs": [
                [
                    ">=",
                    "0.4.1"
                ]
            ]
        },
        {
            "name": "python-dotenv",
            "specs": [
                [
                    ">=",
                    "1.0.1"
                ]
            ]
        },
        {
            "name": "docx2txt",
            "specs": [
                [
                    ">=",
                    "0.8"
                ]
            ]
        },
        {
            "name": "python-docx",
            "specs": [
                [
                    ">=",
                    "1.1.0"
                ]
            ]
        },
        {
            "name": "markdown",
            "specs": [
                [
                    ">=",
                    "3.6"
                ]
            ]
        },
        {
            "name": "beautifulsoup4",
            "specs": [
                [
                    ">=",
                    "4.12.3"
                ]
            ]
        },
        {
            "name": "langchain-experimental",
            "specs": [
                [
                    ">=",
                    "0.0.57"
                ]
            ]
        },
        {
            "name": "nltk",
            "specs": [
                [
                    ">=",
                    "3.8.1"
                ]
            ]
        },
        {
            "name": "cohere",
            "specs": [
                [
                    ">=",
                    "5.1.4"
                ]
            ]
        },
        {
            "name": "langchain-cohere",
            "specs": [
                [
                    ">=",
                    "0.1.3"
                ]
            ]
        },
        {
            "name": "fastembed",
            "specs": [
                [
                    ">=",
                    "0.2.6"
                ]
            ]
        },
        {
            "name": "qdrant-client",
            "specs": [
                [
                    ">=",
                    "1.9.0"
                ]
            ]
        },
        {
            "name": "pymilvus",
            "specs": [
                [
                    ">=",
                    "2.4.0"
                ]
            ]
        },
        {
            "name": "docarray",
            "specs": [
                [
                    ">=",
                    "0.40.0"
                ]
            ]
        },
        {
            "name": "chromadb",
            "specs": [
                [
                    "==",
                    "0.4.24"
                ]
            ]
        },
        {
            "name": "faiss-cpu",
            "specs": [
                [
                    ">=",
                    "1.8.0"
                ]
            ]
        }
    ],
    "lcname": "ragutils"
}
        
Elapsed time: 0.26654s