Skip to main content
All CollectionsCustom Plugins
Naming Conventions for Custom Plugins in TeamAI
Naming Conventions for Custom Plugins in TeamAI

Learn best practices for naming custom plugins in TeamAI to ensure optimal AI model compatibility.

Moiz avatar
Written by Moiz
Updated over 5 months ago

Custom plugins in TeamAI allow users to extend the functionality of their AI models by integrating with external APIs and services. When creating a custom plugin, it's essential to follow naming conventions to ensure that your AI model can effectively understand and utilize the plugin.

Keep Names Short

When naming your custom plugin, it's important to keep the name short. This is because the plugin name is used by the AI model to identify and interact with the plugin. Shorter names are easier for the AI model to process and remember, leading to more efficient plugin usage.

Choose Meaningful Names

While keeping the name short, it's also crucial to choose a name that is meaningful and descriptive. A meaningful name helps the AI model understand the purpose and functionality of the plugin, making it easier for the model to decide when to use the plugin.

For example, if you are building a custom plugin for extracting data from Crunchbase, consider naming it "Crunchbase Extractor." This name clearly conveys the plugin's purpose and makes it easier for the AI model to determine when to use it.

Avoid Special Symbols

When naming your custom plugin, it's important to avoid using any special symbols. Special symbols in plugin names can result in errors and may prevent the AI model from properly interacting with the plugin.

To ensure compatibility, use only the following characters in your plugin names:

  • Alphabets (a-z, A-Z)

  • Numbers (0-9)

  • Spaces

  • Hyphens (-)

Plugin Name Transformation

It's worth noting that when a custom plugin is sent to the AI model, the plugin name undergoes a transformation. The name is converted to lowercase, and any spaces in the name are replaced with hyphens.

For example, if your plugin name is "Crunchbase Extractor," it will be sent to the AI model as "crunchbase-extractor."

Keep this transformation in mind when naming your plugins, as it may affect how the AI model interprets and uses the plugin.

Conclusion

Following naming conventions for custom plugins in TeamAI is essential for ensuring that your AI models can effectively understand and utilize the plugins. Remember to keep names short, choose meaningful names, avoid special symbols, and use only the allowed characters.

By adhering to these naming conventions, you'll make it easier for your AI models to interact with your custom plugins, leading to more efficient and effective plugin usage. Start creating custom plugins with appropriate names today and take your AI's capabilities to the next level!

Did this answer your question?