Core Architecture

Componentbase.py

• swarmauri.core.ComponentBase module
  • ComponentBase
    • ComponentBase.construct()
    • ComponentBase.copy()
    • ComponentBase.dict()
    • ComponentBase.from_orm()
    • ComponentBase.host
    • ComponentBase.id
    • ComponentBase.json()
    • ComponentBase.members
    • ComponentBase.model_computed_fields
    • ComponentBase.model_config
    • ComponentBase.model_construct()
    • ComponentBase.model_copy()
    • ComponentBase.model_dump()
    • ComponentBase.model_dump_json()
    • ComponentBase.model_extra
    • ComponentBase.model_fields
    • ComponentBase.model_fields_set
    • ComponentBase.model_json_schema()
    • ComponentBase.model_parametrized_name()
    • ComponentBase.model_post_init()
    • ComponentBase.model_rebuild()
    • ComponentBase.model_validate()
    • ComponentBase.model_validate_json()
    • ComponentBase.model_validate_strings()
    • ComponentBase.name
    • ComponentBase.owner
    • ComponentBase.parse_file()
    • ComponentBase.parse_obj()
    • ComponentBase.parse_raw()
    • ComponentBase.resource
    • ComponentBase.schema()
    • ComponentBase.schema_json()
    • ComponentBase.set_type()
    • ComponentBase.swm_is_remote
    • ComponentBase.swm_ismethod_registered()
    • ComponentBase.swm_method_signature()
    • ComponentBase.swm_path
    • ComponentBase.swm_public_interfaces()
    • ComponentBase.type
    • ComponentBase.update_forward_refs()
    • ComponentBase.validate()
    • ComponentBase.version
  • ResourceTypes
    • ResourceTypes.AGENT
    • ResourceTypes.AGENT_FACTORY
    • ResourceTypes.CHAIN
    • ResourceTypes.CHAINSTEP
    • ResourceTypes.CHAIN_METHOD
    • ResourceTypes.CHUNKER
    • ResourceTypes.CONVERSATION
    • ResourceTypes.DISTANCE
    • ResourceTypes.DOCUMENT
    • ResourceTypes.DOCUMENT_STORE
    • ResourceTypes.EMBEDDING
    • ResourceTypes.EXCEPTION
    • ResourceTypes.LLM
    • ResourceTypes.MESSAGE
    • ResourceTypes.METRIC
    • ResourceTypes.PARAMETER
    • ResourceTypes.PARSER
    • ResourceTypes.PROMPT
    • ResourceTypes.SCHEMA_CONVERTER
    • ResourceTypes.STATE
    • ResourceTypes.SWARM
    • ResourceTypes.TOOL
    • ResourceTypes.TOOLKIT
    • ResourceTypes.TRACE
    • ResourceTypes.UNIVERSAL_BASE
    • ResourceTypes.UTIL
    • ResourceTypes.VECTOR
    • ResourceTypes.VECTOR_STORE
  • generate_id()

Agent_apis

• swarmauri.core.agent_apis.IAgentCommands module
  • IAgentCommands
    • IAgentCommands.abatch()
    • IAgentCommands.ainvoke()
    • IAgentCommands.batch()
    • IAgentCommands.get_schema_config()
    • IAgentCommands.invoke()
    • IAgentCommands.stream()
• swarmauri.core.agent_apis.IAgentRouterCRUD module
  • IAgentRouterCRUD
    • IAgentRouterCRUD.create_route()
    • IAgentRouterCRUD.delete_route()
    • IAgentRouterCRUD.read_route()
    • IAgentRouterCRUD.update_route()

Agent_factories

• swarmauri.core.agent_factories.IAgentFactory module
  • IAgentFactory
    • IAgentFactory.create_agent()
    • IAgentFactory.date_created
    • IAgentFactory.id
    • IAgentFactory.last_modified
    • IAgentFactory.name
    • IAgentFactory.register_agent()
    • IAgentFactory.type
• swarmauri.core.agent_factories.IExportConf module
  • IExportConf
    • IExportConf.to_dict()
    • IExportConf.to_file()
    • IExportConf.to_json()

Agents

• swarmauri.core.agents.IAgent module
  • IAgent
    • IAgent.exec()
• swarmauri.core.agents.IAgentConversation module
  • IAgentConversation
• swarmauri.core.agents.IAgentParser module
  • IAgentParser
    • IAgentParser.parser
• swarmauri.core.agents.IAgentRetrieve module
  • IAgentRetrieve
• swarmauri.core.agents.IAgentSystemContext module
  • IAgentSystemContext
• swarmauri.core.agents.IAgentToolkit module
  • IAgentToolkit
• swarmauri.core.agents.IAgentVectorStore module
  • IAgentVectorStore

Chains

• swarmauri.core.chains.ICallableChain module
  • ICallableChain
    • ICallableChain.add_callable()
• swarmauri.core.chains.IChain module
  • IChain
    • IChain.add_step()
    • IChain.remove_step()
    • IChain.execute()
    • IChain.add_step()
    • IChain.execute()
    • IChain.remove_step()
• swarmauri.core.chains.IChainContext module
  • IChainContext
    • IChainContext.get_value()
    • IChainContext.update()
• swarmauri.core.chains.IChainContextLoader module
  • IChainContextLoader
    • IChainContextLoader.load_context()
• swarmauri.core.chains.IChainDependencyResolver module
• swarmauri.core.chains.IChainFactory module
  • IChainFactory
    • IChainFactory.add_chain_step()
    • IChainFactory.create_chain()
    • IChainFactory.get_chain()
    • IChainFactory.get_chain_steps()
    • IChainFactory.get_config()
    • IChainFactory.get_configs()
    • IChainFactory.remove_chain_step()
    • IChainFactory.reset_chain()
    • IChainFactory.set_chain()
    • IChainFactory.set_chain_steps()
    • IChainFactory.set_config()
    • IChainFactory.set_configs()
• swarmauri.core.chains.IChainStep module
  • IChainStep

Chunkers

• swarmauri.core.chunkers.IChunker module
  • IChunker
    • IChunker.chunk_text()

Conversations

• swarmauri.core.conversations.IConversation module
  • IConversation
    • IConversation.add_message()
    • IConversation.clear_history()
    • IConversation.get_last()
    • IConversation.history
• swarmauri.core.conversations.IMaxSize module
  • IMaxSize
• swarmauri.core.conversations.ISystemContext module
  • ISystemContext

Distances

• swarmauri.core.distances.IDistanceSimilarity module
  • IDistanceSimilarity
    • IDistanceSimilarity.distance()
    • IDistanceSimilarity.distances()
    • IDistanceSimilarity.similarities()
    • IDistanceSimilarity.similarity()

Document_stores

• swarmauri.core.document_stores.IDocumentRetrieve module
  • IDocumentRetrieve
    • IDocumentRetrieve.retrieve()
• swarmauri.core.document_stores.IDocumentStore module
  • IDocumentStore
    • IDocumentStore.add_document()
    • IDocumentStore.add_documents()
    • IDocumentStore.delete_document()
    • IDocumentStore.document_count()
    • IDocumentStore.get_all_documents()
    • IDocumentStore.get_document()
    • IDocumentStore.update_document()

Documents

• swarmauri.core.documents.IDocument module
  • IDocument
• swarmauri.core.documents.IExperimentDocument module
  • IExperimentDocument
    • IExperimentDocument.artifacts
    • IExperimentDocument.datetime_completed
    • IExperimentDocument.datetime_created
    • IExperimentDocument.feature_set
    • IExperimentDocument.instruction
    • IExperimentDocument.parameters
    • IExperimentDocument.results
    • IExperimentDocument.version

Embeddings

• swarmauri.core.embeddings.IFeature module
  • IFeature
    • IFeature.extract_features()
• swarmauri.core.embeddings.ISaveModel module
  • ISaveModel
    • ISaveModel.load_model()
    • ISaveModel.save_model()
• swarmauri.core.embeddings.IVectorize module
  • IVectorize
    • IVectorize.fit()
    • IVectorize.fit_transform()
    • IVectorize.infer_vector()
    • IVectorize.transform()

Experiment_stores

• swarmauri.core.experiment_stores.IExperimentStore module
  • IExperimentStore
    • IExperimentStore.add_experiment()
    • IExperimentStore.add_experiments()
    • IExperimentStore.delete_experiment()
    • IExperimentStore.get_all_experiments()
    • IExperimentStore.get_experiment()
    • IExperimentStore.update_experiment()

Llms

• swarmauri.core.llms.IFit module
  • IFit
    • IFit.fit()
• swarmauri.core.llms.IPredict module
  • IPredict
    • IPredict.predict()

Messages

• swarmauri.core.messages.IMessage module
  • IMessage

Metrics

• swarmauri.core.metrics.IMetric module
  • IMetric
• swarmauri.core.metrics.IMetricAggregate module
  • IMetricAggregate
    • IMetricAggregate.add_measurement()
    • IMetricAggregate.reset()
• swarmauri.core.metrics.IMetricCalculate module
  • IMetricCalculate
    • IMetricCalculate.calculate()
    • IMetricCalculate.update()
• swarmauri.core.metrics.IThreshold module
  • IThreshold

Parsers

• swarmauri.core.parsers.IParser module
  • IParser
    • IParser.parse()

Prompts

• swarmauri.core.prompts.IPrompt module
  • IPrompt
    • IPrompt.__call__()
• swarmauri.core.prompts.IPromptMatrix module
  • IPromptMatrix
    • IPromptMatrix.add_prompt_sequence()
    • IPromptMatrix.get_prompt_sequence()
    • IPromptMatrix.remove_prompt_sequence()
    • IPromptMatrix.shape
    • IPromptMatrix.show()
• swarmauri.core.prompts.ITemplate module
  • ITemplate
    • ITemplate.generate_prompt()
    • ITemplate.set_template()
    • ITemplate.set_variables()

Schema_converters

• swarmauri.core.schema_converters.ISchemaConvert module
  • ISchemaConvert
    • ISchemaConvert.convert()

Swarm_apis

• swarmauri.core.swarm_apis.IAgentRegistrationAPI module
  • IAgentRegistrationAPI
    • IAgentRegistrationAPI.get_agent()
    • IAgentRegistrationAPI.list_agents()
    • IAgentRegistrationAPI.register_agent()
    • IAgentRegistrationAPI.remove_agent()
    • IAgentRegistrationAPI.update_agent()
• swarmauri.core.swarm_apis.ISwarmAPI module
  • ISwarmAPI
    • ISwarmAPI.broadcast_request()
    • ISwarmAPI.dispatch_request()

Swarms

• swarmauri.core.swarms.ISwarm module
  • ISwarm
    • ISwarm.date_created
    • ISwarm.id
    • ISwarm.last_modified
    • ISwarm.name
    • ISwarm.type
• swarmauri.core.swarms.ISwarmAgentRegistration module
• swarmauri.core.swarms.ISwarmChainCRUD module
  • ISwarmChainCRUD
    • ISwarmChainCRUD.create_chain()
    • ISwarmChainCRUD.delete_chain()
    • ISwarmChainCRUD.list_chains()
    • ISwarmChainCRUD.read_chain()
    • ISwarmChainCRUD.update_chain()
• swarmauri.core.swarms.ISwarmComponent module
  • ISwarmComponent
• swarmauri.core.swarms.ISwarmConfigurationExporter module
  • ISwarmConfigurationExporter
    • ISwarmConfigurationExporter.to_dict()
    • ISwarmConfigurationExporter.to_json()
    • ISwarmConfigurationExporter.to_pickle()
• swarmauri.core.swarms.ISwarmFactory module
  • AgentDefinition
    • AgentDefinition.capabilities
    • AgentDefinition.configuration
    • AgentDefinition.count()
    • AgentDefinition.dependencies
    • AgentDefinition.execution_context
    • AgentDefinition.index()
    • AgentDefinition.type
  • CallableChainItem
    • CallableChainItem.count()
    • CallableChainItem.execution_context
    • CallableChainItem.index()
    • CallableChainItem.key
    • CallableChainItem.steps
  • FunctionDefinition
    • FunctionDefinition.callable_source
    • FunctionDefinition.count()
    • FunctionDefinition.execution_context
    • FunctionDefinition.identifier
    • FunctionDefinition.index()
    • FunctionDefinition.parameters
    • FunctionDefinition.return_type
  • FunctionParameter
    • FunctionParameter.count()
    • FunctionParameter.default
    • FunctionParameter.index()
    • FunctionParameter.name
    • FunctionParameter.required
    • FunctionParameter.type
  • ISwarmFactory
    • ISwarmFactory.create_agent()
    • ISwarmFactory.create_callable_chain()
    • ISwarmFactory.create_swarm()
    • ISwarmFactory.export_callable_chains()
    • ISwarmFactory.export_configuration()
    • ISwarmFactory.load_callable_chains()
    • ISwarmFactory.register_function()
  • Step
    • Step.args
    • Step.callable
    • Step.count()
    • Step.description
    • Step.index()
    • Step.kwargs

Toolkits

• swarmauri.core.toolkits.IToolkit module
  • IToolkit
    • IToolkit.add_tool()
    • IToolkit.add_tools()
    • IToolkit.get_tool_by_name()
    • IToolkit.remove_tool()

Tools

• swarmauri.core.tools.IParameter module
  • IParameter
• swarmauri.core.tools.ITool module
  • ITool
    • ITool.call()

Tracing

• swarmauri.core.tracing.IChainTracer module
  • IChainTracer
    • IChainTracer.process_chain()
• swarmauri.core.tracing.ITraceContext module
  • ITraceContext
    • ITraceContext.add_attribute()
    • ITraceContext.get_trace_id()
• swarmauri.core.tracing.ITracer module
  • ITracer
    • ITracer.annotate_trace()
    • ITracer.end_trace()
    • ITracer.start_trace()

Typing.py

• swarmauri.core.typing module
  • SubclassUnion

Utils

• swarmauri.core.utils.ITransactional module
  • ITransactional
    • ITransactional.abort_transaction()
    • ITransactional.begin_transaction()
    • ITransactional.commit_transaction()

Vector_stores

• swarmauri.core.vector_stores.IAngleBetweenVectors module
  • IAngleBetweenVectors
    • IAngleBetweenVectors.angle_between()
• swarmauri.core.vector_stores.IDecompose module
  • IDecompose
    • IDecompose.decompose()
• swarmauri.core.vector_stores.IDivergence module
  • IDivergence
    • IDivergence.calculate_divergence()
• swarmauri.core.vector_stores.IGradient module
  • IGradient
    • IGradient.calculate_gradient()
• swarmauri.core.vector_stores.IOrthogonalProject module
  • IOrthogonalProject
    • IOrthogonalProject.orthogonal_project()
• swarmauri.core.vector_stores.IProject module
  • IProject
    • IProject.project()
• swarmauri.core.vector_stores.IReflect module
  • IReflect
    • IReflect.reflect_vector()
• swarmauri.core.vector_stores.ISimilarity module
  • ISimilarity
    • ISimilarity.similarity()
• swarmauri.core.vector_stores.ISimiliarityQuery module
  • ISimilarityQuery
    • ISimilarityQuery.search_by_similarity_threshold()
• swarmauri.core.vector_stores.IVectorArithmetic module
  • IVectorArithmetic
    • IVectorArithmetic.add()
    • IVectorArithmetic.divide()
    • IVectorArithmetic.multiply()
    • IVectorArithmetic.subtract()
• swarmauri.core.vector_stores.IVectorBasisCheck module
  • IVectorBasisCheck
    • IVectorBasisCheck.is_basis()
• swarmauri.core.vector_stores.IVectorLinearCombination module
  • ILinearCombination
    • ILinearCombination.linear_combination()
• swarmauri.core.vector_stores.IVectorNorm module
  • IVectorNorm
    • IVectorNorm.l1_norm()
    • IVectorNorm.l2_norm()
    • IVectorNorm.max_norm()
• swarmauri.core.vector_stores.IVectorRotate module
  • IRotate
    • IRotate.rotate()
• swarmauri.core.vector_stores.IVectorSpan module
  • IVectorSpan
    • IVectorSpan.in_span()
• swarmauri.core.vector_stores.IVectorStore module
  • IVectorStore
    • IVectorStore.add_document()
    • IVectorStore.add_documents()
    • IVectorStore.clear_documents()
    • IVectorStore.delete_document()
    • IVectorStore.document_count()
    • IVectorStore.get_all_documents()
    • IVectorStore.get_document()
    • IVectorStore.update_document()
• swarmauri.core.vector_stores.IVectorStoreRetrieve module
  • IVectorStoreRetrieve
    • IVectorStoreRetrieve.retrieve()
• swarmauri.core.vector_stores.IVectorStoreSaveLoad module
  • IVectorStoreSaveLoad
    • IVectorStoreSaveLoad.load_parts()
    • IVectorStoreSaveLoad.load_store()
    • IVectorStoreSaveLoad.save_parts()
    • IVectorStoreSaveLoad.save_store()

Vectors

• swarmauri.core.vectors.IVector module
  • IVector
• swarmauri.core.vectors.IVectorMeta module
  • IVectorMeta
    • IVectorMeta.id
    • IVectorMeta.metadata
• swarmauri.core.vectors.IVectorProduct module
  • IVectorProduct
    • IVectorProduct.cross_product()
    • IVectorProduct.dot_product()
    • IVectorProduct.scalar_triple_product()
    • IVectorProduct.vector_triple_product()
• swarmauri.core.vectors.IVectorTransform module
  • IVectorTransform
    • IVectorTransform.project()
    • IVectorTransform.reflect()
    • IVectorTransform.rotate()
    • IVectorTransform.scale()
    • IVectorTransform.shear()
    • IVectorTransform.translate()