How to install and configure Freddy Copilot for Developers?

Wiki How To's
,
1

Introduction

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

How to configure Freddy Copilot for Developers?

  1. Ensure you have a Developer Account and Signed up for a Freshworks product.
  2. Ensure you have the Freshworks CLI, aka FDK installed
  3. Follow the Configuration guide to set values for “FDK path”, “API Key”, “User Name” and “Context Settings”.

Configuration guide

  1. Install the extension from VS Code Marketplace for Freddy Copilot for Developers
  2. Navigate to extension settings
  3. Add the FDK installation path under “FDK path”.
    1. For Mac users:
      1. The path for node installation will be similar to
        /Users/{username}/.nvm/versions/node/v18.xx.x/bin/fdk
      2. When unsure of the path, use the below command from your terminal to find out the path of the current Node JS version in use.
        which node
      3. When using multiple Node JS versions ensure you switch to Node 18.
        # When using a single Node 18 version
nvm use 18
# When using multiple Node 18 version
nvm use v18.xx.x
    2. For Ubuntu-based or Linux-system users: The path for node installation will be similar to
      1. The path for node installation will be similar to
        /Users/{username}/.nvm/versions/node/v18.xx.x/bin/fdk
      2. When unsure of the path, use the below command from your terminal to find out the path of the current Node JS version in use.
        which node
      3. When using multiple Node JS versions ensure you switch to Node 18.
        # When using a single Node 18 version
nvm use 18
# When using multiple Node 18 version
nvm use v18.xx.x
    3. For Windows users
      1. If Node is installed via NVM with Chocolatey - the path will be as shown below
        C:\ProgramData\nvm\v18.xx.x\fdk
      2. If Node is installed via installer then - the path will be as shown below
        C:\Program Files\nodejs\fdk
      3. If installed at any other location than the relevant location
        <DRIVE_NAME>:\<INSTALLATION_LOCATION>\nodejs\fdk
  4. Navigate to AMP → Click on Profile Settings → View API Key → Copy API key. Once copied add the API key under “Freddy Api Key”

Note: If you don’t see View API Key option means you haven’t signed up for Freddy Copilot for Developers Beta Program. Click here to sign up now!

  1. Enter the user name you would like to display in the conversational chat interface under “User Name.”
  2. Set a value for context setting. It denotes the 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.

  • Enabling context setting feature will consume more tokens, roughly correlating 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.

What’s next?

  1. Navigate to the tutorials section to explore more about building applications using Freddy Copilot for Developers with detailed instructions.
  2. When faced with challenges during the process kindly refer to the troubleshooting document to resolve the same.
  3. Refer to the Freddy Copilot for Developers FAQs section to resolve commonly asked questions
  4. Check out our Freshworks Neo blog to see what’s new.
  5. Check out the various developer resources available to simplify your app development journey with Freshworks.