Overwrites
Solace Agent Mesh is powered by the Solace AI Event Connector, which is configured through YAML config files.
Before you create overwrites, you should have a good understanding of the Solace AI Event Connector. For more information, see Solace AI Event Connector.
There are two cases where you might need to use the overwrites feature:
- Overwriting system configurations
- Adding custom workflows
Overwriting System Configurations
All Solace Agent Mesh internal components are configured through YAML files. When building a project, you will see these files in the build directory. In some cases, you may want to customize certain files, but the build directory should never be manually edited. All content in the build directory is generated and overwritten at build time.
By placing a file with the same name in the overwrites directory, you can overwrite the content of the original system file.
The most common use case for this feature is customizing the configurations for the LLM Service or Embedding Service.
Check their respective pages for more information on configurations.
Adding Custom Workflows
There may be cases where you need a specific workflow that does not fall under one of the Solace Agent Mesh components (agents, gateways, etc.). In such cases, you can create your own custom Solace AI Event Connector workflow and place it in the overwrites directory.
Make sure to use a unique name for your workflow to avoid conflicts with system components.
Your files will be included in the build directory and will run alongside other components, provided you are using the sam run command. For custom deployments, check the Deployments page.
Avoid placing any YAML files in the overwrites directory that are not Solace AI Event Connector workflows, as this will cause a runtime error.