solace-agent-mesh 0.0.1__py3-none-any.whl → 0.1.1__py3-none-any.whl

solace_agent_mesh/templates/rest-api-default-config.yaml

@@ -0,0 +1,24 @@
+
+- rest_config: &rest_config
+    listen_port: ${REST_API_SERVER_INPUT_PORT}
+    endpoint: ${REST_API_SERVER_INPUT_ENDPOINT}
+    rate_limit: ${REST_API_SERVER_INPUT_RATE_LIMIT}
+    host: ${REST_API_SERVER_HOST}
+
+- web_ui_config: &web_ui_config
+    enabled: ${WEBUI_ENABLED}
+    listen_port: ${WEBUI_PORT}
+    host: ${WEBUI_HOST}
+    response_api_url: ${WEBUI_RESPONSE_API_URL}
+    solace_broker_rest_messaging_url: ${SOLACE_BROKER_REST_MESSAGING_URL}
+    solace_agent_mesh_namespace: ${SOLACE_AGENT_MESH_NAMESPACE}
+    solace_broker_basic_auth: ${SOLACE_BROKER_BASIC_AUTH}
+    frontend_redirect_url: ${WEBUI_FRONTEND_REDIRECT_URL}
+    frontend_server_url: ${WEBUI_FRONTEND_SERVER_URL}
+    frontend_use_authorization: ${WEBUI_FRONTEND_USE_AUTHORIZATION}
+    frontend_auth_login_url: ${WEBUI_FRONTEND_AUTH_LOGIN_URL}
+    frontend_welcome_message: ${WEBUI_FRONTEND_WELCOME_MESSAGE}
+    frontend_bot_name: ${WEBUI_FRONTEND_BOT_NAME}
+    frontend_collect_feedback: ${WEBUI_FRONTEND_COLLECT_FEEDBACK}
+    frontend_url: ${WEBUI_FRONTEND_URL}
+    local_dev : ${WEBUI_LOCAL_DEV}

solace_agent_mesh/templates/rest-api-flows.yaml

@@ -0,0 +1,80 @@
+
+  # Web UI
+  - name: web_ui
+    trace_level: ERROR
+    components:
+      - component_name: web_ui
+        component_module: solace_ai_connector_web.backend.server
+        component_config:
+          <<: *web_ui_config 
+  # API to Gateway to Solace
+  - name: rest_gateway_input_flow
+    trace_level: ERROR
+    components:
+      - component_name: rest_input
+        component_module: solace_ai_connector_rest.components.rest_input
+        component_config:
+          <<: *rest_config 
+      - component_name: gateway_input
+        component_base_path: .
+        component_module: src.gateway.components.gateway_input
+        component_config:
+          identity_key_field: user_email
+          <<: *gateway_config
+        component_input:
+          source_expression: previous
+      - component_name: broker_output
+        component_module: broker_output
+        component_config:
+          <<: *broker_connection
+          payload_encoding: utf-8
+          payload_format: json
+          copy_user_properties: true
+        input_transforms:
+          - type: copy
+            source_expression: previous
+            dest_expression: user_data.output:payload
+          - type: copy
+            source_expression: template:${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/stimulus/gateway/gateway_input/{{GATEWAY_ID}}
+            dest_expression: user_data.output:topic
+        component_input:
+          source_expression: user_data.output
+  # Solace to Gateway to Web
+  - name: rest_gateway_output_flow
+    trace_level: ERROR
+    components:
+      - component_name: broker_input
+        component_module: broker_input
+        component_config:
+          <<: *broker_connection
+          broker_queue_name: ${SOLACE_AGENT_MESH_NAMESPACE}_{{GATEWAY_ID}}
+          broker_subscriptions:
+            - topic: ${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/response/orchestrator/{{GATEWAY_ID}}
+              qos: 1
+            - topic: ${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/streamingResponse/orchestrator/{{GATEWAY_ID}}
+              qos: 1
+            - topic: ${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/responseComplete/orchestrator/{{GATEWAY_ID}}
+              qos: 1
+          payload_encoding: utf-8
+          payload_format: json
+      - component_name: gateway_output
+        component_base_path: .
+        component_module: src.gateway.components.gateway_output
+        component_config:
+          <<: *gateway_config
+          copy_user_properties: true
+        component_input:
+          source_expression: input.payload
+      - component_name: rest_output
+        component_module: solace_ai_connector_rest.components.rest_output
+        component_config:
+          <<: *rest_config
+        input_transforms:
+          - type: copy
+            source_expression: previous:payload
+            dest_expression: user_data.component_input:message_info
+          - type: copy
+            source_expression: input.payload
+            dest_expression: user_data.component_input:content
+        component_input:
+          source_expression: user_data.component_input

solace_agent_mesh/templates/slack-default-config.yaml

@@ -0,0 +1,9 @@
+- slack_config: &slack_config
+    slack_bot_token: ${SLACK_BOT_TOKEN}
+    slack_app_token: ${SLACK_APP_TOKEN}
+    share_slack_connection: true
+    send_history_on_join: true
+    listen_to_channels: true
+    acknowledgement_message: "Chatbot is thinking... :hourglass_flowing_sand:"
+    max_total_file_size: 2000 # 2GB
+    max_file_size: 500 # 500MB

solace_agent_mesh/templates/slack-flows.yaml

@@ -0,0 +1,90 @@
+
+  # Slack to Gateway to Solace
+  - name: slack_gateway_input_flow
+    components:
+      - component_name: slack_input
+        component_module: solace_ai_connector_slack.components.slack_input
+        component_package: solace_ai_connector_slack
+        component_config:
+          <<: *slack_config
+      - component_name: gateway_input
+        component_base_path: .
+        component_module: src.gateway.components.gateway_input
+        component_config:
+          identity_key_field: user_email
+          <<: *gateway_config
+        component_input:
+          source_expression: previous
+        input_transforms:
+          - type: copy
+            source_expression: input.payload:thread_id
+            dest_expression: input.user_properties:session_id
+          - type: copy
+            source_value: >
+              - Format the response as a Slack message, using appropriate 
+              formatting such as *bold*, _italic_, and `code` where necessary.
+
+              - Use bullet points or numbered lists for multiple items.
+
+              - If including links, use the format <url|text>.
+            dest_expression: input.user_properties:response_format_prompt
+      - component_name: broker_output
+        component_module: broker_output
+        component_config:
+          <<: *broker_connection
+          payload_encoding: utf-8
+          payload_format: json
+          copy_user_properties: true
+        input_transforms:
+          - type: copy
+            source_expression: previous
+            dest_expression: user_data.output:payload
+          - type: copy
+            source_expression: template:${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/stimulus/gateway/gateway_input/{{GATEWAY_ID}}
+            dest_expression: user_data.output:topic
+        component_input:
+          source_expression: user_data.output
+
+  # Solace to Gateway to Slack
+  - name: slack_gateway_output_flow
+    trace_level: DEBUG
+    components:
+      - component_name: broker_input
+        component_module: broker_input
+        component_config:
+          <<: *broker_connection
+          broker_queue_name: ${SOLACE_AGENT_MESH_NAMESPACE}_{{GATEWAY_ID}}
+          broker_subscriptions:
+            - topic: ${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/response/orchestrator/{{GATEWAY_ID}}
+              qos: 1
+            - topic: ${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/streamingResponse/orchestrator/{{GATEWAY_ID}}
+              qos: 1
+            - topic: ${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/responseComplete/orchestrator/{{GATEWAY_ID}}
+              qos: 1
+          payload_encoding: utf-8
+          payload_format: json
+
+      - component_name: gateway_output
+        component_base_path: .
+        component_module: src.gateway.components.gateway_output
+        component_config:
+          <<: *gateway_config
+          copy_user_properties: true
+        component_input:
+          source_expression: input.payload
+
+      - component_name: slack_output
+        component_package: solace_ai_connector_slack
+        component_module: solace_ai_connector_slack.components.slack_output
+        component_config:
+          <<: *slack_config
+        input_transforms:
+          - type: copy
+            source_expression: input.user_properties
+            dest_expression: user_data.component_input:message_info
+          - type: copy
+            source_expression: input.payload
+            dest_expression: user_data.component_input:content
+        component_input:
+          source_expression: user_data.component_input
+

solace_agent_mesh/templates/solace-agent-mesh-default.yaml

@@ -0,0 +1,77 @@
+# mesh configuration
+solace_agent_mesh:
+  # Built-in components (agents, gateways, etc)
+  built_in:
+    # Configuring the built-in agents
+    agents:
+      # Web request agent can make queries to web to get real-time data
+      - name: web_request
+        enabled: true
+        # Global agent
+      - name: global
+        enabled: true
+        # Generate images from text, or convert images to text
+      - name: image_processing
+        enabled: true
+        # Slack agent, send messages to Slack channels
+      - name: slack
+        enabled: true
+
+  # Directory to component yaml config files, this directory would have a sub directory for each component type
+  config_directory: configs
+  # Directory to python module files
+  modules_directory: src
+  # Directory to store yaml configs that will overwrite the default configs. Used for custom configurations
+  overwrite_directory: overwrite
+  # Env File path. If extract env is on, this file will be used to store the extracted env variables (Changes are appended, not overwritten)
+  env_file: .env
+
+  # Build configuration
+  build:
+    # Build directory for the generated files
+    build_directory: build
+    # Extract all environment variable names from all config files
+    extract_env_vars: true
+    # Logging configuration
+    log_level_override: INFO
+    # The number of instances of the orchestrator component to run in parallel
+    orchestrator_instance_count: 5
+
+  # Runtime configuration
+  runtime:
+    # Runtime Services
+    services:
+      # File service configuration
+      file_service:
+        # File service type: volume, bucket, memory, or your custom module name
+        type: volume
+        # Maximum time a file will be stored before being deleted in seconds
+        max_time_to_live: 86400 # 1 day
+        # Interval to check for expired files in seconds
+        expiration_check_interval: 600 # 10 minutes
+        # Type specific configuration
+        config:
+          # Volume configuration - Only needed if type is volume
+          volume:
+            directory: /tmp/solace-agent-mesh
+          # Bucket configuration - Only needed if type is bucket
+          bucket:
+            # Bucket name
+            bucket_name:
+            # AWS Endpoint URL - Optional
+            endpoint_url:
+            # AWS S3 configuration - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
+            # The following object is passed as kwargs to boto3.session.Session
+            boto3_config:
+              # AWS region name
+              region_name:
+              # AWS credentials
+              aws_access_key_id: # You can also use profiles instead, check boto3 documentation
+              aws_secret_access_key:
+          # If using a custom module, add a key here with your Module name (type)
+          # It must also have a module_path key with the path to the module
+          # For example, for type=MyCustomModule, you would add:
+          # MyCustomModule:
+          #   module_path: path/to/module
+          #   custom_key: value
+

solace_agent_mesh/templates/solace-agent-mesh-plugin-default.yaml

@@ -0,0 +1,8 @@
+# Solace Agent Mesh Plugin configuration
+solace_agent_mesh_plugin:
+  # Plugin name
+  name: solace-agent-mesh-plugin
+
+  # Set to true if providing gateway interface under './interfaces' directory, 
+  # each interface must have a 'interface-flows.yaml' and a 'interface-default-config.yaml' file
+  includes_gateway_interface: false 

solace_agent_mesh/templates/web-default-config.yaml

@@ -0,0 +1,5 @@
+- web_config: &web_config
+    acknowledgement_message: "Chatbot is thinking... ⏳"
+    max_total_file_size: 0.5
+    max_file_size: 2000 # 2GB
+

solace_agent_mesh/templates/web-flows.yaml

@@ -0,0 +1,86 @@
+  # Start the Web application
+  - name: start_web_app
+    trace_level: ERROR
+    components:
+      - component_name: start_web_app
+        component_package: solace_ai_connector_web
+        component_module: solace_ai_connector_web.components.start_web_app
+  # Web to Gateway to Solace
+  - name: web_gateway_input_flow
+    trace_level: ERROR
+    components:
+      - component_name: web_input
+        component_module: solace_ai_connector_web.components.web_input
+        component_package: solace_ai_connector_web
+        component_config:
+          <<: *web_config
+      - component_name: gateway_input
+        component_base_path: .
+        component_module: src.gateway.components.gateway_input
+        component_config:
+          identity_key_field: user_email
+          <<: *gateway_config
+        component_input:
+          source_expression: previous
+        input_transforms:
+          - type: copy
+            source_value: >
+              - Format the response as markdown.
+            dest_expression: input.user_properties:response_format_prompt
+      - component_name: broker_output
+        component_module: broker_output
+        component_config:
+          <<: *broker_connection
+          payload_encoding: utf-8
+          payload_format: json
+          copy_user_properties: true
+        input_transforms:
+          - type: copy
+            source_expression: previous
+            dest_expression: user_data.output:payload
+          - type: copy
+            source_expression: template:${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/stimulus/gateway/gateway_input/{{GATEWAY_ID}}
+            dest_expression: user_data.output:topic
+        component_input:
+          source_expression: user_data.output
+  # Solace to Gateway to Web
+  - name: web_gateway_output_flow
+    trace_level: ERROR
+    components:
+      - component_name: broker_input
+        component_module: broker_input
+        component_config:
+          <<: *broker_connection
+          broker_queue_name: ${SOLACE_AGENT_MESH_NAMESPACE}_{{GATEWAY_ID}}
+          broker_subscriptions:
+            - topic: ${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/response/orchestrator/{{GATEWAY_ID}}
+              qos: 1
+            - topic: ${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/streamingResponse/orchestrator/{{GATEWAY_ID}}
+              qos: 1
+            - topic: ${SOLACE_AGENT_MESH_NAMESPACE}solace-agent-mesh/v1/responseComplete/orchestrator/{{GATEWAY_ID}}
+              qos: 1
+          payload_encoding: utf-8
+          payload_format: json
+      - component_name: gateway_output
+        component_base_path: .
+        component_module: src.gateway.components.gateway_output
+        component_config:
+          <<: *gateway_config
+          copy_user_properties: true
+        component_input:
+          source_expression: input.payload
+      - component_name: web_output
+        component_package: solace_ai_connector_web
+        component_module: solace_ai_connector_web.components.web_output
+        component_config:
+          <<: *web_config
+        input_transforms:
+          - type: copy
+            source_expression: input.user_properties
+            dest_expression: user_data.component_input:message_info
+          - type: copy
+            source_expression: input.payload
+            dest_expression: user_data.component_input:content
+        component_input:
+          source_expression: user_data.component_input
+

solace_agent_mesh/tools/components/conversation_formatter.py

@@ -0,0 +1,111 @@
+"""Reponsible for doing some formatting of the conversation"""
+
+from solace_ai_connector.components.component_base import ComponentBase
+
+info = {
+    "class_name": "ConversationFormatter",
+    "description": "Reponsible for doing some formatting of the conversation",
+    "config_parameters": [],
+    "input_schema": {
+        "type": "object",
+        "properties": {
+            "payload": {
+                "type": "object",
+            },
+            "topic": {
+                "type": "string",
+            },
+            "user_properties": {
+                "type": "object",
+            },
+        },
+        "required": ["payload", "topic", "user_properties"],
+    },
+    "output_schema": {
+        "type": "object",
+        "properties": {
+            "message": {
+                "type": "string",
+            },
+        },
+    },
+}
+
+
+class ConversationFormatter(ComponentBase):
+
+    def __init__(self, **kwargs):
+        super().__init__(info, **kwargs)
+
+    def invoke(self, message, data):
+        payload = data.get("payload")
+        topic = data.get("topic")
+        user_properties = data.get("user_properties")
+        output_message = None
+        if "/stimulus/gateway/" in topic:
+            # If the message is a stimulus, format the message to include the user's name
+            identity = user_properties.get("identity")
+            stimulus = payload.get("text")
+
+            if "/reinvoke" in topic:
+                output_message = f"   Reinvoke the orchestrator with: \n{self.prefix_each_line(stimulus, '    ')}\n"
+            else:
+                output_message = f"\nNew request from {identity}:\n{self.prefix_each_line(stimulus, '    ')}\n"
+
+        if "/response/gateway/" in topic or "/streamingResponse/gateway/" in topic:
+            # If the payload contains last_chunk and it is not True, then skip this message
+            if not isinstance(payload, dict):
+                print("Payload is not a dictionary")
+                return {"message": None}
+            if payload.get("last_chunk") is not True:
+                output_message = None
+            else:
+                # If the message is a response, format the message to include the response
+                response = payload.get("text")
+                output_message = (
+                    f"  Response:\n{self.prefix_each_line(response, '      ')}\n"
+                )
+
+        if "/responseComplete/gateway/" in topic:
+            # If the message is a response complete, format the message to include the completion message
+            output_message = "  Response complete\n"
+
+        if "/actionRequest/" in topic:
+            # If the message is an action request, format the message to include the action name
+            action_name = payload.get("action_name")
+            action_params = payload.get("action_params", {})
+
+            output_message = f"  Action request: {action_name}\n"
+            # action params have the param name as the key and the value as the value
+            for param_name, param_value in action_params.items():
+                output_message += f"    {param_name}: {self.prefix_each_line(param_value, '      ')}\n"
+
+        if "/actionResponse/" in topic:
+            # Get the two topic levels after .../agent/ to determine the agent name
+            after = topic.split("/agent/")[1]
+            topic_levels = after.split("/")
+            agent_name = topic_levels[0]
+            action_name = topic_levels[1]
+
+            output_message = f"  Action response: {agent_name}.{action_name}\n"
+
+            for param, value in payload.items():
+                output_message += (
+                    f"    {param}: {self.prefix_each_line(value, '     ')}\n"
+                )
+
+        if output_message is None:
+            return {"message": None}
+
+        # Truncate the message if it is too long
+        if len(output_message) > 2000:
+            output_message = output_message[:2000] + "..."
+
+        # output_message += "\n"
+
+        return {"message": output_message}
+
+    def prefix_each_line(self, text, prefix):
+        if not isinstance(text, str):
+            return text
+        return "\n".join([f"{prefix}{line}" for line in text.split("\n")])

solace_agent_mesh/tools/components/file_resolver_component.py

@@ -0,0 +1,58 @@
+from typing import Dict, Any
+
+from solace_ai_connector.components.component_base import ComponentBase
+from solace_ai_connector.common.message import Message
+
+
+from ...services.file_service import FileService, FS_PROTOCOL
+from ...services.file_service.file_utils import recursive_file_resolver
+
+info = {
+    "class_name": "FileResolverComponent",
+    "description": (
+        f"This component resolves all the {FS_PROTOCOL} URLs in the input data. "
+        "And returns the object with resolved URLs if `resolve_files` is set to True in user properties."
+    ),
+    "config_parameters": [
+        {
+            "name": "force_resolve",
+            "required": False,
+            "description": "Resolve all the urls regardless of the 'resolve' query parameter",
+            "default": True,
+            "type": "boolean",
+        },
+    ],
+    "input_schema": {
+        "type": "object",  # Any Object or string
+        "required": [],
+    },
+    "output_schema": {
+        "type": "object",  # Returns the object with resolved URLS
+        "required": [],
+    },
+}
+
+
+class FileResolverComponent(ComponentBase):
+    def __init__(self, **kwargs):
+        super().__init__(info, **kwargs)
+        self.file_service = FileService()
+        self.force_resolve = self.get_config("force_resolve", True)
+
+    def invoke(self, message: Message, data: Dict[str, Any]) -> Dict[str, Any]:
+        should_resolve_files = (message.get_user_properties() or {}).get("resolve_files", False)
+        if not should_resolve_files:
+            return data
+        copied_data = data.copy()
+        session_id = (message.get_user_properties() or {}).get("session_id")
+        if not session_id:
+            return copied_data
+
+        copied_data = recursive_file_resolver(
+            copied_data,
+            resolver=self.file_service.resolve_all_resolvable_urls,
+            session_id=session_id,
+            force_resolve=self.force_resolve,
+        )
+
+        return copied_data

solace_agent_mesh/tools/config/runtime_config.py

@@ -0,0 +1,26 @@
+import os
+import yaml
+
+
+def load_runtime_config(default_config_path=None):
+    config_path = (
+        default_config_path if default_config_path else os.getenv("RUNTIME_CONFIG_PATH")
+    )
+    if not config_path:
+        raise ValueError("Environment variable RUNTIME_CONFIG_PATH not set.")
+    config = {}
+    try:
+        with open(config_path, "r", encoding="utf-8") as yaml_str:
+            yaml_str = os.path.expandvars(yaml_str.read())
+            config = yaml.safe_load(yaml_str)
+    except FileNotFoundError as er:
+        raise FileNotFoundError(
+            f"Runtime config file not found at {config_path}"
+        ) from er
+    return config
+
+
+def get_service_config(service_name, default_config_path=None):
+    config = load_runtime_config(default_config_path)
+    services = config.get("services", {})
+    return services.get(service_name, {})