Getting started with Freddy AI Copilot for Developers

Wiki Handbooks
,
1

Introduction

Freddy AI Copilot for Developers is a Generative AI-powered development experience tool that allows quicker and more intuitive app development. Stretching across the Freshworks app development journey, it integrates seamlessly with Visual Studio code and can suggest code snippets through conversational messages.

Plugin Features Overview

It is a powerful VS Code extension designed to help developers streamline their Freshworks application development process. With Freddy AI Copilot, developers can perform operations such as

  1. Learn app development via Chat-based tutorials
  2. Rapid code generation
  3. Perform 1-Click actions such as
    1. 1-Click Review
    2. 1-Click Documentation
    3. 1-Click Publish

Requirements for Freddy

  1. VScode 1.5+
  2. FDK 9.0.2 or higher
  3. Node v18.13.0 or higher

How to get started?

User guide

  1. Open the copilot interface by clicking on the extension.
  2. You can also use Freddy using the Command Pallete with Cmd + Shift + P and searching for Ask Freddy
  3. Use rapid code generation workflow for input queries
  4. Use Stop App and Run app options to handle app lifecycle

text-to-code-flow-min

  1. Use Pack and Publish to upload the app to the application management portal (AMP)

Setup guide

  1. To kick things off, ensure you go through the necessary Prerequisites and get a thorough understanding.
  2. Create a Developer Account. Within the Dev Account, Sign up for a free trial account with a Freshworks product of your choice.
  3. Install the Freshworks CLI, aka FDK
  4. Configure Freddy AI Copilot, and start building Freshworks Applications.

Configuration guide

  1. Install the extension from VS Code Marketplace
  2. Navigate to extension settings
  3. Configure the setting values for “FDK path”, “API Key”, “User Name” and “Context Settings”.

The extension supports the following configuration keys

  1. Freddy: Fdk Path - You need to set up the FDK path of your installation directory
  2. Freddy: Freddy Api Key - API key to access Freddy AI Copilot for Developers
  3. Freddy: User Name - User name to be displayed against input prompts in the conversational interface
  4. Freddy: Context Settings - Number of previous conversation responses to be remembered and referred to while framing a new answer with stored context for the respective conversation. This ensures more accuracy in the answer given.

Note: Context setting

  • Enabling this feature will consume more tokens, roughly corresponding to the number of messages in a conversation (about 2800 tokens).

  • By default, the value is set at 5, with the option to raise it to a maximum of 10.

  • Increasing this value enhances accuracy, but keep in mind that it will significantly raise token consumption per query.

Refer to the detailed instructions available here.

What’s next?

  1. Navigate to the tutorials section to explore more about Freshworks app building experience.
  2. Refer to the Freddy AI Copilot FAQs section to resolve commonly asked questions
2 Likes