Skill interface

This guide provides a comprehensive overview of the Skill interface, empowering developers to create advanced Skills for Flowstate. While the Create your first Skill documentation offers a valuable introduction, this guide delves deeper into the interfaces that are crucial for building sophisticated Skills.

Prerequisites

Before attempting this guide, you must:

1. Deploy a solution
2. Set up your development environment
3. Connect VS Code to your cloud organization
4. Know how to create skills

What is the skill interface?

The Skill interface offers a set of methods that define how Skills interact with the Flowstate environment. By understanding these methods, you can leverage the full potential of the Skill interface to create powerful and versatile Skills.

note

For implementation details see: skill_interface.py

Structure of this Guide

This guide will explore three essential methods of the skill interface:

1. execute: This method defines the core functionality of a Skill. It defines the actions the Skill performs when activated within the Flowstate environment. For an in-depth explanation, see execute.
2. get_footprint: This method specifies one or more reservations that must be held when executing a Skill. Each reservation has a sharing type which is used to determine when two Skills can be scheduled concurrently. To learn more about different types of reservations, see get_footprint.
3. preview: This method enables developers to simulate Skill execution without real-world consequences. It provides a "dry run" environment to test and refine Skill behavior before deployment. For an in-depth explanation, see preview.

By following this guide, you will gain a thorough understanding of the skill interface and be well-equipped to create advanced skills that enhance the capabilities of Flowstate.