HomeGuidesAnnouncementsCommunity
Guides

Skill Properties

This document provides guidance on managing the top-level properties of Max's skills. These properties determine how skills function, are presented, and are optimized for use by Max’s Chat Assistants. This guide is intended for developers and administrators responsible for configuring and maintaining Max's skill ecosystem.

Properties

1. Activate/Deactivate Skill for Max

  • Objective: Control whether a specific skill is available for the Max’s Chat Assistant.
  • Action:
    • Toggle the "Active for Chat" property:
      • On: The skill is available for the Chat Assistant to execute during chats.
      • Off: The skill is hidden from the Assistant, and Max will not invoke it during user interactions.
  • Important Note: Activating or deactivating a skill directly affects Max’s behavior and the available responses to user queries.

2. Assign Friendly Names and Descriptions

  • Objective: Provide a clear and concise name and description for each skill, enabling developers to easily understand its purpose.
  • Action:
    • Assign a friendly name to reflect the core function of the skill within Max’s framework.
    • Write a concise description summarizing the skill’s functionality and its use case within Max.
  • Best Practices:
    • Ensure the name is descriptive and relevant, as this will assist in quick identification of the skill’s purpose.
    • Descriptions should provide enough detail for developers and administrators to understand how the skill integrates with Max’s broader capabilities.

3. Associate Data Set with Skill

  • Objective: Link or inherit data sets that the skill will utilize during operation.
  • Action:
    • The data set can be:
      • Inherited from Max’s co-pilot framework (default behavior).
      • Overridden at the skill level for unique data requirements.
      • Left unassigned if no specific data set is required.
  • Best Practices:
    • Regularly evaluate whether the skill needs a distinct data set or can inherit default data from Max’s system. Overriding the data set should only be done if absolutely necessary to avoid unnecessary complexity.

4. Define Language Model (LLM) Properties for Max

  • Objective: Configure the skill’s language model properties to guide Max’s response selection process.
  • Action:
    • Assign an LLM Name to the Language Model (LLM) that Max will use to determine the most relevant skill for answering user queries.
    • Provide an LLM Description (limited to 1,028 characters) to help the LLM differentiate between skills and make more informed decisions.
  • Tip: The description should clearly define the skill’s role and limitations, helping Max’s LLM decide when to invoke the skill based on the user’s input.

5. Format Downloaded Artifacts in Max

  • Objective: Control the format in which skill-related data is exported from Max’s system.
  • Action:
    • Toggle the "Format Downloaded Artifacts" property:
      • On: Export skill tables to Excel in a clean, user-friendly format that is easy to read.
      • Off: Export raw, unformatted data, typically useful for detailed analysis or further processing.
  • Best Practices:
    • Use formatted exports when sharing data with non-technical teams.

6. Provide Details about the Skill for the Language Model

The following information is presented to the language model to help it know when to choose the skill, when not to, and how to choose parameters.

  • Capabilities: Define the capabilities of the skill that you want the language model to be aware
  • Limitations: Clearly articulate any limitations of the skill that may not be clear based on its description and capabiltieis.
  • Example Questions: List out some common question formats that would execute the skill. A good technique is to not specify directly the Dimensions, Metrics or Dimension Values in the questions but rather use placeholders. For example: How is [metric] for [filter] evolving.
  • Parameter Guidance: This is used to provide further instruction on how to select the parameters for the skill.

Cautionary Notes

  • Consistency is Key: Ensure that all properties are consistently set across skills to maintain uniformity in Max’s responses and behavior.
  • Clear Communication: Double-check names and descriptions to ensure they are clear and precise, avoiding any confusion among developers or administrators working with Max’s skills.
  • Impact of Changes: Always consider the impact of deactivating or modifying a skill on Max’s performance, especially in high-traffic or mission-critical environments.

Conclusion

Managing Max’s skill properties is crucial for maintaining a high level of responsiveness and accuracy in chat interactions. By following these steps and best practices, you’ll ensure that Max’s skills are configured correctly, leading to optimal performance and efficient management.