swarmauri_standard 0.9.2.dev9__tar.gz

swarmauri_standard-0.9.2.dev9/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [2025] [Jacob Stewart @ Swarmauri]
+
+   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.

swarmauri_standard-0.9.2.dev9/PKG-INFO

@@ -0,0 +1,313 @@
+Metadata-Version: 2.4
+Name: swarmauri_standard
+Version: 0.9.2.dev9
+Summary: This repository includes standard components within the Swarmauri framework.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: aiofiles
+Requires-Dist: h11 (>=0.16.0)
+Requires-Dist: httpx (>=0.27.0)
+Requires-Dist: joblib (>=1.4.0)
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pillow (>=11.1.0)
+Requires-Dist: pydantic (>=2.9.2)
+Requires-Dist: rich
+Requires-Dist: swarmauri_base
+Requires-Dist: swarmauri_core
+Requires-Dist: toml (>=0.10.2)
+Requires-Dist: typing_extensions
+Description-Content-Type: text/markdown
+
+![Swarmauri Logo](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
+
+<p align="center">
+    <a href="https://pypi.org/project/swarmauri-standard/">
+        <img src="https://img.shields.io/pypi/dm/swarmauri-standard" alt="PyPI - Downloads"/></a>
+    <a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/swarmauri_standard/">
+        <img alt="Hits" src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/swarmauri_standard.svg"/></a>
+    <a href="https://pypi.org/project/swarmauri-standard/">
+        <img src="https://img.shields.io/pypi/pyversions/swarmauri-standard" alt="PyPI - Python Version"/></a>
+    <a href="https://pypi.org/project/swarmauri-standard/">
+        <img src="https://img.shields.io/pypi/l/swarmauri-standard" alt="PyPI - License"/></a>
+    <a href="https://pypi.org/project/swarmauri-standard/">
+        <img src="https://img.shields.io/pypi/v/swarmauri-standard?label=swarmauri-standard&color=green" alt="PyPI - swarmauri-standard"/></a>
+
+
+</p>
+
+---
+
+# Swarmauri Standard
+
+The Swarmauri SDK offers a comprehensive suite of tools designed for building distributed, extensible systems using the Swarmauri framework. 
+
+
+## Standard
+
+- **Concrete Classes**: Ready-to-use, pre-implemented classes that fulfill standard system needs while adhering to Swarmauri principles. **These classes are the first in line for ongoing support and maintenance, ensuring they remain stable, performant, and up to date with future SDK developments.**
+
+
+
+## AI Kit
+
+The AI Kit provides a collection of tools and components for building intelligent systems with the Swarmauri SDK. Below is an overview of the directories and their contents:
+
+### Agents
+- [QAAgent.py](swarmauri_standard/agents/QAAgent.py): Implements a question-answering agent.
+- [RagAgent.py](swarmauri_standard/agents/RagAgent.py): Implements a retrieval-augmented generation agent.
+- [SimpleConversationAgent.py](swarmauri_standard/agents/SimpleConversationAgent.py): Implements a basic conversational agent.
+- [ToolAgent.py](swarmauri_standard/agents/ToolAgent.py): Implements an agent that uses various tools.
+
+### Chains
+- [CallableChain.py](swarmauri_standard/chains/CallableChain.py): Defines a chain of callable steps.
+- [ChainStep.py](swarmauri_standard/chains/ChainStep.py): Represents a single step in a chain.
+- [ContextChain.py](swarmauri_standard/chains/ContextChain.py): Manages context within a chain.
+- [PromptContextChain.py](swarmauri_standard/chains/PromptContextChain.py): Handles prompt-based context in a chain.
+
+### Chunkers
+- [DelimiterBasedChunker.py](swarmauri_standard/chunkers/DelimiterBasedChunker.py): Splits text based on delimiters.
+- [FixedLengthChunker.py](swarmauri_standard/chunkers/FixedLengthChunker.py): Splits text into fixed-length chunks.
+- [MdSnippetChunker.py](swarmauri_standard/chunkers/MdSnippetChunker.py): Splits markdown text into snippets.
+- [SentenceChunker.py](swarmauri_standard/chunkers/SentenceChunker.py): Splits text into sentences.
+- [SlidingWindowChunker.py](swarmauri_standard/chunkers/SlidingWindowChunker.py): Splits text using a sliding window approach.
+
+### Conversations
+- [Conversation.py](swarmauri_standard/conversations/Conversation.py): Manages conversation state and flow.
+- [MaxSizeConversation.py](swarmauri_standard/conversations/MaxSizeConversation.py): Implements a conversation with a maximum size limit.
+- [MaxSystemContextConversation.py](swarmauri_standard/conversations/MaxSystemContextConversation.py): Manages conversation with system context constraints.
+- [SessionCacheConversation.py](swarmauri_standard/conversations/SessionCacheConversation.py): Implements a session-cached conversation.
+
+### Data Connectors
+- [GoogleDriveDataConnector.py](swarmauri_standard/dataconnectors/GoogleDriveDataConnector.py): Connects to Google Drive for data access.
+
+### Decorators
+- [deprecate.py](swarmauri_standard/decorators/deprecate.py): Marks functions as deprecated.
+- [maybe_async.py](swarmauri_standard/decorators/maybe_async.py): Allows functions to be optionally asynchronous.
+- [retry_on_status_codes.py](swarmauri_standard/decorators/retry_on_status_codes.py): Retries functions based on status codes.
+- [tool_decorator.py](swarmauri_standard/decorators/tool_decorator.py): Decorates tool functions.
+
+### Distances
+- [CanberraDistance.py](swarmauri_standard/distances/CanberraDistance.py): Calculates Canberra distance.
+- [ChebyshevDistance.py](swarmauri_standard/distances/ChebyshevDistance.py): Calculates Chebyshev distance.
+- [ChiSquaredDistance.py](swarmauri_standard/distances/ChiSquaredDistance.py): Calculates Chi-squared distance.
+- [CosineDistance.py](swarmauri_standard/distances/CosineDistance.py): Calculates Cosine distance.
+- [EuclideanDistance.py](swarmauri_standard/distances/EuclideanDistance.py): Calculates Euclidean distance.
+- [HaversineDistance.py](swarmauri_standard/distances/HaversineDistance.py): Calculates Haversine distance.
+- [JaccardIndexDistance.py](swarmauri_standard/distances/JaccardIndexDistance.py): Calculates Jaccard index distance.
+- [LevenshteinDistance.py](swarmauri_standard/distances/LevenshteinDistance.py): Calculates Levenshtein distance.
+- [ManhattanDistance.py](swarmauri_standard/distances/ManhattanDistance.py): Calculates Manhattan distance.
+- [SorensenDiceDistance.py](swarmauri_standard/distances/SorensenDiceDistance.py): Calculates Sørensen-Dice distance.
+- [SquaredEuclideanDistance.py](swarmauri_standard/distances/SquaredEuclideanDistance.py): Calculates squared Euclidean distance.
+
+### Documents
+- [Document.py](swarmauri_standard/documents/Document.py): Manages document data and operations.
+
+### Embeddings
+- [CohereEmbedding.py](swarmauri_standard/embeddings/CohereEmbedding.py): Generates embeddings using Cohere.
+- [GeminiEmbedding.py](swarmauri_standard/embeddings/GeminiEmbedding.py): Generates embeddings using Gemini.
+- [MistralEmbedding.py](swarmauri_standard/embeddings/MistralEmbedding.py): Generates embeddings using Mistral.
+- [OpenAIEmbedding.py](swarmauri_standard/embeddings/OpenAIEmbedding.py): Generates embeddings using OpenAI.
+- [TfidfEmbedding.py](swarmauri_standard/embeddings/TfidfEmbedding.py): Generates TF-IDF embeddings.
+- [VoyageEmbedding.py](swarmauri_standard/embeddings/VoyageEmbedding.py): Generates embeddings using Voyage.
+
+### Exceptions
+- [IndexErrorWithContext.py](swarmauri_standard/exceptions/IndexErrorWithContext.py): Custom index error with context.
+
+### Factories
+- [AgentFactory.py](swarmauri_standard/factories/AgentFactory.py): Creates
+agents using predefined configurations.
+
+### Image Generators
+- [BlackForestImgGenModel.py](swarmauri_standard/image_gens/BlackForestImgGenModel.py): Generates images using the Black Forest model.
+- [DeepInfraImgGenModel.py](swarmauri_standard/image_gens/DeepInfraImgGenModel.py): Generates images using the Deep Infra model.
+- [FalAIImgGenModel.py](swarmauri_standard/image_gens/FalAIImgGenModel.py): Generates images using the Fal AI model.
+- [HyperbolicImgGenModel.py](swarmauri_standard/image_gens/HyperbolicImgGenModel.py): Generates images using the Hyperbolic model.
+- [OpenAIImgGenModel.py](swarmauri_standard/image_gens/OpenAIImgGenModel.py): Generates images using the OpenAI model.
+
+### LLMs
+- [AI21StudioModel.py](swarmauri_standard/llms/AI21StudioModel.py): Implements the AI21 Studio model.
+- [AnthropicModel.py](swarmauri_standard/llms/AnthropicModel.py): Implements the Anthropic model.
+- [AnthropicToolModel.py](swarmauri_standard/llms/AnthropicToolModel.py): Implements the Anthropic tool model.
+- [CohereModel.py](swarmauri_standard/llms/CohereModel.py): Implements the Cohere model.
+- [CohereToolModel.py](swarmauri_standard/llms/CohereToolModel.py): Implements the Cohere tool model.
+- [DeepInfraModel.py](swarmauri_standard/llms/DeepInfraModel.py): Implements the Deep Infra model.
+- [DeepSeekModel.py](swarmauri_standard/llms/DeepSeekModel.py): Implements the Deep Seek model.
+- [FalAIVisionModel.py](swarmauri_standard/llms/FalAIVisionModel.py): Implements the Fal AI Vision model.
+- [GeminiProModel.py](swarmauri_standard/llms/GeminiProModel.py): Implements the Gemini Pro model.
+- [GeminiToolModel.py](swarmauri_standard/llms/GeminiToolModel.py): Implements the Gemini tool model.
+- [GroqAIAudio.py](swarmauri_standard/llms/GroqAIAudio.py): Implements the Groq AI audio model.
+- [GroqModel.py](swarmauri_standard/llms/GroqModel.py): Implements the Groq model.
+- [GroqToolModel.py](swarmauri_standard/llms/GroqToolModel.py): Implements the Groq tool model.
+- [GroqVisionModel.py](swarmauri_standard/llms/GroqVisionModel.py): Implements the Groq vision model.
+- [HyperbolicAudioTTS.py](swarmauri_standard/llms/HyperbolicAudioTTS.py): Implements the Hyperbolic audio TTS model.
+- [HyperbolicModel.py](swarmauri_standard/llms/HyperbolicModel.py): Implements the Hyperbolic model.
+- [HyperbolicVisionModel.py](swarmauri_standard/llms/HyperbolicVisionModel.py): Implements the Hyperbolic vision model.
+- [LlamaCppModel.py](swarmauri_standard/llms/LlamaCppModel.py): Implements the Llama Cpp model.
+- [MistralModel.py](swarmauri_standard/llms/MistralModel.py): Implements the Mistral model.
+- [MistralToolModel.py](swarmauri_standard/llms/MistralToolModel.py): Implements the Mistral tool model.
+- [OpenAIAudio.py](swarmauri_standard/llms/OpenAIAudio.py): Implements the OpenAI audio model.
+- [OpenAIAudioTTS.py](swarmauri_standard/llms/OpenAIAudioTTS.py): Implements the OpenAI audio TTS model.
+- [OpenAIModel.py](swarmauri_standard/llms/OpenAIModel.py): Implements the OpenAI model.
+- [OpenAIReasonModel.py](swarmauri_standard/llms/OpenAIReasonModel.py): Implements the OpenAI reason model.
+- [OpenAIToolModel.py](swarmauri_standard/llms/OpenAIToolModel.py): Implements the OpenAI tool model.
+- [PerplexityModel.py](swarmauri_standard/llms/PerplexityModel.py): Implements the Perplexity model.
+- [PlayHTModel.py](swarmauri_standard/llms/PlayHTModel.py): Implements the PlayHT model.
+- [WhisperLargeModel.py](swarmauri_standard/llms/WhisperLargeModel.py): Implements the Whisper Large model.
+
+### Measurements
+- [CompletenessMeasurement.py](swarmauri_standard/measurements/CompletenessMeasurement.py): Measures the completeness of data.
+- [DistinctivenessMeasurement.py](swarmauri_standard/measurements/DistinctivenessMeasurement.py): Measures the distinctiveness of data.
+- [FirstImpressionMeasurement.py](swarmauri_standard/measurements/FirstImpressionMeasurement.py): Measures the first impression of data.
+- [MeanMeasurement.py](swarmauri_standard/measurements/MeanMeasurement.py): Measures the mean of data.
+- [MiscMeasurement.py](swarmauri_standard/measurements/MiscMeasurement.py): Miscellaneous measurements.
+- [MissingnessMeasurement.py](swarmauri_standard/measurements/MissingnessMeasurement.py): Measures the missingness of data.
+- [PatternMatchingMeasurement.py](swarmauri_standard/measurements/PatternMatchingMeasurement.py): Measures pattern matching in data.
+- [RatioOfSumsMeasurement.py](swarmauri_standard/measurements/RatioOfSumsMeasurement.py): Measures the ratio of sums in data.
+- [StaticMeasurement.py](swarmauri_standard/measurements/StaticMeasurement.py): Static measurements.
+- [UniquenessMeasurement.py](swarmauri_standard/measurements/UniquenessMeasurement.py): Measures the uniqueness of data.
+- [ZeroMeasurement.py](swarmauri_standard/measurements/ZeroMeasurement.py): Measures zero values in data.
+
+### Messages
+- [AgentMessage.py](swarmauri_standard/messages/AgentMessage.py): Defines messages sent by agents.
+- [FunctionMessage.py](swarmauri_standard/messages/FunctionMessage.py): Defines messages for functions.
+- [HumanMessage.py](swarmauri_standard/messages/HumanMessage.py): Defines messages sent by humans.
+- [SystemMessage.py](swarmauri_standard/messages/SystemMessage.py): Defines system messages.
+
+### Parsers
+- [CSVParser.py](swarmauri_standard/parsers/CSVParser.py): Parses CSV files.
+- [HTMLTagStripParser.py](swarmauri_standard/parsers/HTMLTagStripParser.py): Strips HTML tags from text.
+- [Md2HtmlParser.py](swarmauri_standard/parsers/Md2HtmlParser.py): Converts markdown to HTML.
+- [OpenAPISpecParser.py](swarmauri_standard/parsers/OpenAPISpecParser.py): Parses OpenAPI specifications.
+- [PhoneNumberExtractorParser.py](swarmauri_standard/parsers/PhoneNumberExtractorParser.py): Extracts phone numbers from text.
+- [PythonParser.py](swarmauri_standard/parsers/PythonParser.py): Parses Python code.
+- [RegExParser.py](swarmauri_standard/parsers/RegExParser.py): Parses text using regular expressions.
+- [URLExtractorParser.py](swarmauri_standard/parsers/URLExtractorParser.py): Extracts URLs from text.
+- [XMLParser.py](swarmauri_standard/parsers/XMLParser.py): Parses XML files.
+
+### Pipelines
+- [Pipeline.py](swarmauri_standard/pipelines/Pipeline.py): Defines data processing pipelines.
+
+### Prompts
+- [PromptGenerator.py](swarmauri_standard/prompts/PromptGenerator.py): Generates prompts.
+- [PromptMatrix.py](swarmauri_standard/prompts/PromptMatrix.py): Defines a matrix of prompts.
+- [Prompt.py](swarmauri_standard/prompts/Prompt.py): Defines a single prompt.
+
+### Prompt Templates
+- [PromptTemplate.py](swarmauri_standard/prompt_templates/PromptTemplate.py): Defines templates for generating prompts.
+
+### Schema Converters
+- [AnthropicSchemaConverter.py](swarmauri_standard/schema_converters/AnthropicSchemaConverter.py): Converts schemas for Anthropic models.
+- [CohereSchemaConverter.py](swarmauri_standard/schema_converters/CohereSchemaConverter.py): Converts schemas for Cohere models.
+- [GeminiSchemaConverter.py](swarmauri_standard/schema_converters/GeminiSchemaConverter.py): Converts schemas for Gemini models.
+- [GroqSchemaConverter.py](swarmauri_standard/schema_converters/GroqSchemaConverter.py): Converts schemas for Groq models.
+- [MistralSchemaConverter.py](swarmauri_standard/schema_converters/MistralSchemaConverter.py): Converts schemas for Mistral models.
+- [OpenAISchemaConverter.py](swarmauri_standard/schema_converters/OpenAISchemaConverter.py): Converts schemas for OpenAI models.
+- [ShuttleAISchemaConverter.py](swarmauri_standard/schema_converters/ShuttleAISchemaConverter.py): Converts schemas for Shuttle AI models.
+
+### Service Registries
+- [ServiceRegistry.py](swarmauri_standard/service_registries/ServiceRegistry.py): Manages service registrations.
+
+### State
+- [DictState.py](swarmauri_standard/state/DictState.py): Manages state using dictionaries.
+
+### STT (Speech-to-Text)
+- [GroqSTT.py](swarmauri_standard/stt/GroqSTT.py): Implements speech-to-text using Groq.
+- [OpenaiSTT.py](swarmauri_standard/stt/OpenaiSTT.py): Implements speech-to-text using OpenAI.
+- [WhisperLargeSTT.py](swarmauri_standard/stt/WhisperLargeSTT.py): Implements speech-to-text using Whisper Large.
+
+### Swarms
+- [Swarm.py](swarmauri_standard/swarms/Swarm.py): Manages swarm operations.
+
+### Task Management Strategies
+- [RoundRobinStrategy.py](swarmauri_standard/task_mgmt_strategies/RoundRobinStrategy.py): Implements a round-robin task management strategy.
+
+### Toolkits
+- [AccessibilityToolkit.py](swarmauri_standard/toolkits/AccessibilityToolkit.py): Provides tools for accessibility.
+- [Toolkit.py](swarmauri_standard/toolkits/Toolkit.py): Defines a general toolkit.
+
+### Tool LLMs
+- [AnthropicToolModel.py](swarmauri_standard/tool_llms/AnthropicToolModel.py): Implements the Anthropic tool model.
+- [CohereToolModel.py](swarmauri_standard/tool_llms/CohereToolModel.py): Implements the Cohere tool model.
+- [GeminiToolModel.py](swarmauri_standard/tool_llms/GeminiToolModel.py): Implements the Gemini tool model.
+- [GroqToolModel.py](swarmauri_standard/tool_llms/GroqToolModel.py): Implements the Groq tool model.
+- [MistralToolModel.py](swarmauri_standard/tool_llms/MistralToolModel.py): Implements the Mistral tool model.
+- [OpenAIToolModel.py](swarmauri_standard/tool_llms/OpenAIToolModel.py): Implements the OpenAI tool model.
+
+### Tools
+- [AdditionTool.py](swarmauri_standard/tools/AdditionTool.py): Implements a tool for performing addition operations.
+- [AutomatedReadabilityIndexTool.py](swarmauri_standard/tools/AutomatedReadabilityIndexTool.py): Calculates the Automated Readability Index.
+- [CalculatorTool.py](swarmauri_standard/tools/CalculatorTool.py): Provides basic calculator functionalities.
+- [CodeExtractorTool.py](swarmauri_standard/tools/CodeExtractorTool.py): Extracts code snippets from text.
+- [CodeInterpreterTool.py](swarmauri_standard/tools/CodeInterpreterTool.py): Interprets and executes code snippets.
+- [ColemanLiauIndexTool.py](swarmauri_standard/tools/ColemanLiauIndexTool.py): Calculates the Coleman-Liau Index.
+- [FleschKincaidTool.py](swarmauri_standard/tools/FleschKincaidTool.py): Calculates the Flesch-Kincaid Grade Level.
+- [FleschReadingEaseTool.py](swarmauri_standard/tools/FleschReadingEaseTool.py): Calculates the Flesch Reading Ease score.
+- [GunningFogTool.py](swarmauri_standard/tools/GunningFogTool.py): Calculates the Gunning Fog Index.
+- [ImportMemoryModuleTool.py](swarmauri_standard/tools/ImportMemoryModuleTool.py): Imports memory modules.
+- [JSONRequestsTool.py](swarmauri_standard/tools/JSONRequestsTool.py): Handles JSON-based HTTP requests.
+- [Parameter.py](swarmauri_standard/tools/Parameter.py): Manages tool parameters.
+- [RequestsTool.py](swarmauri_standard/tools/RequestsTool.py): Handles HTTP requests.
+- [TemperatureConverterTool.py](swarmauri_standard/tools/TemperatureConverterTool.py): Converts temperatures between different units.
+- [TestTool.py](swarmauri_standard/tools/TestTool.py): Implements a test tool.
+- [WeatherTool.py](swarmauri_standard/tools/WeatherTool.py): Provides weather-related functionalities.
+
+### Tracing
+- [CallableTracer.py](swarmauri_standard/tracing/CallableTracer.py): Traces callable objects.
+- [ChainTracer.py](swarmauri_standard/tracing/ChainTracer.py): Traces chains of operations.
+- [SimpleTraceContext.py](swarmauri_standard/tracing/SimpleTraceContext.py): Provides a simple trace context.
+- [SimpleTracer.py](swarmauri_standard/tracing/SimpleTracer.py): Implements a simple tracer.
+- [TracedVariable.py](swarmauri_standard/tracing/TracedVariable.py): Manages traced variables.
+- [VariableTracer.py](swarmauri_standard/tracing/VariableTracer.py): Traces variable changes.
+
+### Transports
+- [PubSubTransport.py](swarmauri_standard/transports/PubSubTransport.py): Implements a publish-subscribe transport mechanism.
+
+### TTS (Text-to-Speech)
+- [HyperbolicTTS.py](swarmauri_standard/tts/HyperbolicTTS.py): Implements text-to-speech using Hyperbolic.
+- [OpenaiTTS.py](swarmauri_standard/tts/OpenaiTTS.py): Implements text-to-speech using OpenAI.
+- [PlayhtTTS.py](swarmauri_standard/tts/PlayhtTTS.py): Implements text-to-speech using PlayHT.
+
+
+### Vectors
+- [Vector.py](swarmauri_standard/vectors/Vector.py): Defines vector operations and manipulations.
+
+### Vector Stores
+- [TfidfVectorStore.py](swarmauri_standard/vector_stores/TfidfVectorStore.py): Implements a vector store using TF-IDF.
+
+### VLMs (Vision-Language Models)
+- [FalVLM.py](swarmauri_standard/vlms/FalVLM.py): Implements the Fal Vision-Language Model.
+- [GroqVLM.py](swarmauri_standard/vlms/GroqVLM.py): Implements the Groq Vision-Language Model.
+- [HyperbolicVLM.py](swarmauri_standard/vlms/HyperbolicVLM.py): Implements the Hyperbolic Vision-Language Model.
+
+# Features
+
+- **Polymorphism**: Allows for dynamic behavior switching between components, enabling flexible, context-aware system behavior.
+- **Discriminated Unions**: Provides a robust method for handling multiple possible object types in a type-safe manner.
+- **Serialization**: Efficiently encode and decode data for transmission across different environments and system components, with support for both standard and custom serialization formats.
+- **Intensional and Extensional Programming**: Leverages both rule-based (intensional) and set-based (extensional) approaches to building and manipulating complex data structures, offering developers a wide range of tools for system design.
+
+## Use Cases
+
+- **Modular Systems**: Develop scalable, pluggable systems that can evolve over time by adding or modifying components without disrupting the entire ecosystem.
+- **Distributed Architectures**: Build systems with distributed nodes that seamlessly communicate using the SDK’s standardized interfaces.
+- **Third-Party Integrations**: Extend the system's capabilities by easily incorporating third-party tools, libraries, and services.
+- **Prototype and Experimentation**: Test cutting-edge ideas using the experimental components in the SDK, while retaining the reliability of core and standard features for production systems.
+
+# Future Development
+
+The Swarmauri SDK is an evolving platform, and the community is encouraged to contribute to its growth. Upcoming releases will focus on enhancing the framework's modularity, providing more advanced serialization methods, and expanding the community-driven component library.
+
+
+## Contributing
+
+Contributions are welcome! If you'd like to add a new feature, fix a bug, or improve documentation, kindly go through the [contributions guidelines](https://github.com/swarmauri/swarmauri-sdk/blob/master/contributing.md) first.
+
+