Skip to main content

Getting Started

Before you begin

This guide helps you set up your StackSpot AI account. You will be able to:

  • Create a Studio and a Workspace.
  • Create a Stack AI.
  • Create Knowledge Sources.
  • After that you can start using Code Buddy to get a better development experience.

Requirements

For more information, go to the Code Buddy page

  • The Github account you use to connect to Stackspot AI must have the email as public. Follow the instructions below to configure:
  1. In your GitHub account, go to:
    1. 'Settings';
    2. Click on 'E-mails' on the left side menu;
    3. In the section, uncheck 'Keep my email adresses private'. If it is already unchecked, do nothing.

Screenshot of GitHub's documentation. It shows how you should remove the option 'Keep my email addresses private' check box.

  1. After that, go to 'Public Profile'. The field 'Name' must have your first and last name. It cannot be your GitHub user.. Then in the 'Public e-mail' field, select your e-mail address.

Screenshot of GitHub's documentation. It shows how you should select your Public email and click on the Update Profile button.

Then, click on 'Update Profile'.

Done! You configured your GitHub account to connect to StackSpot AI.

Getting Started

Access the StackSpot AI Portal and follow the steps to add your own context to the platform

Step 1. Sign up to StackSpot

You have two options:

Option 1. Enterprise Login

If your enterprise has an account on StackSpot EDP, you can sign in using your email address. Follow the instructions:

  • Continue with your email address;
  • Log in with SSO;
  • Authorize StackSpot AI access;
  • Open your IDE.

Option 2. Sign up for a Personal account with your own GitHub;

Create a Personal account. Follow the instructions below:

  1. Access the StackSpot AI Portal;
  2. Log in via GitHub to create an account and start using your Personal account;
caution

If an error occur, check the Requirements section again. Follow the steps on your GitHub account.

Do you have any questions? Join the StackSpot AI Discord Chat.

Step 2. Create a Studio

If you already have a Studio, skip to the next step.

Studios are where you can find all your Stacks AIs.

On the upper menu, click on the ‘Create’ button. Select ‘Studio’ and fill out the fields:

  • Name: Add a name for your Studio.
  • Identification: Add a slug that will be part of your Studio’s URL;
  • Description: Describe your Studio and it’s main purpose. You have the option of adding a Studio logo.

Click ‘Create’ and done! See the gif below:

Gif showing the steps mentioned above to create a Studio on the AI Platform

Step 3. Create a Stack AI

Stack AI is a group of declarative technologies to give more context to the Large Language Model (LLM).

To create a Stack AI, visit the StackSpot AI Platform and follow these steps:

  1. In the upper right menu, click on 'Create'.
  2. From the dropdown menu, choose 'Stack AI'.
  3. Select the Studio that you previously created.
  4. You will need to fill out three information tabs. Please refer to the example below for guidance:
  • Stack Information: Add your Stack name and what it is about.
  • Name: Add a name for your Stack.
  • Use Case: Describe the use case of your Stack.
  • Definition: Add more declarative details about your Stack. Add technologies, framework, dependencies, etc.

See an example how to fill out the fields:

  • Programming Language: Java 17
  • Framework: SpringBoot
  • Test Framework: JUnit
  • Patterns: SOLID, Serverless
  • Observability: Dynatrace
  • Dependencies: Flywaydb 9.8.1; PostgreSQL 15.3

Click ‘Next’ and Review what you added. Then click on the ‘Finish’ button.

See an example below:

Gif showing the steps mentioned above on how to create Stack AI page

Step 4. Create a Workspace

If you already have a Workspace, skip to the next step.

Creating a Workspace is a better option to get contextualized answers from Code Buddy. You can link Stacks, Knowledge Sources, and Quick Commands to give more context to Code Buddy and get the best responses possible.

Follow these instructions to create a Workspace:

  1. After logging in, click on the ‘Create Workspace’ button. You will access the StackSpot AI Platform;
  2. On the left side menu, click on ‘Workspace’;
  3. On the upper menu, click on the ‘Create’ button;

Step 5. Add your Stack AI to the Workspace

Follow the instructions:

  1. Go to your Workspace Dashboard;
  2. On the right side menu click ‘Add Stack’ and choose your Stacks;

Step 6. Create a Knowledge Source

You can create three types of Knowledge Sources. There are a variety of knowledge source objects like OpenAPI or Swaggers you add, in the API type, for example. These objects help Code Buddy answer your question with better codes.

To create, access the ‘Agent Setup’ section on the StackSpot AI Platform and click on ‘Knowledge Source’.

Follow the instuctions:

1. Choose a Knowledge Source type. In this example, it will be an API.

Learn more about each type in the StackSpot AI key concepts section.

2. Click on the ‘+’ button, and fill out the fields:

  • Knowledge Source Information
  • Name: APIDemo
  • Description: Add a description about your Knowledge Source.

3. On ‘Adding Knowledge Objects’:

  • Drag and drop or browse files: You can add your APIs on this page. Then click on ‘Next’;

Files size limit to 500kb.

4. Review: Review the information you added. Then click on ‘Finish’.

See an example on how to create:

Gif showing the steps mentioned above to create Knowledge Source type API

Step 7. Add the Knowledge Source to a Workspace

To add your Knowledge Source to the Workspace, access the StackSpot AI platform and follow the instructions:

  • On the left side menu, click on ‘Workspace’;
  • Then choose the Stack AI you want;

See below:

Gif showing the steps mentioned above on how to add a Stack AI to a Workspace

Step 8. Access Code Buddy to test it

  • Access your IDE.
  • On the upper right corner, click on the ‘...’ icon.
  • Then click on 'New Chat' to test Code Buddy.

Learn more

Was this page helpful?