Context Setup On Workik

Tutorial series

Workik allows developers to leverage AI for development. Users can use AI for any task required, be it code generation, debugging, refactoring, documentation, and much more.

What sets Workik AI apart is its ability to generate highly personalized code that aligns with the user's context. Users can add a wide array of context types, such as text input, options lists, codebases, database schemas, images, REST API schemas, and more.

Note: Adding context is entirely optional. Users have the flexibility to include any context relevant to them.

1. Importance of Context

The importance of the context-adding feature in Workik can be detailed as follows:

Enhances AI's project comprehension, ensuring relevant and accurate coding assistance.
Help AI to accurately identify and fix bugs.
Helps AI to follow your preferred coding standards and practices
Helps the team work together smoothly by using the same project details.
Streamlines new developer onboarding by quickly aligning them with project specifics and coding practices.

2. How to Add Context

Start adding context to your Workik project, by clicking on the "Add" button located in the right panel.
Simply click on the type of context you need for your project. (Please find the detailed tutorial about each context type in the section below.)
Provide a title for the context in the "Title" field. A clear title allows the AI to quickly identify the context's relevance and use it wherever necessary.
In the "Description" box, clarify the purpose of the context you're adding and define how it should be used. A clear description helps AI to understand the context's intended use.
After entering the "Title" and "Description", you'll proceed to add the context value.
Note: The input method of context value will vary depending on the context type you select.

3. Types of Context

There are six different types of context supported by Workik:

Text Input
Options List
Code
Database
Image
Rest API

A. Text Input

Purpose:
Text Input is designed for incorporating text into the context. It can be useful for specifying details such as the framework being used, the programming language, or instructions for generating code. You can also use this feature to provide constraints to the AI, such as specifying certain project requirements or mentioning guidelines.
How to Set Up:
1. In the "Configure context value" section, type your context value into the provided text box.
2. Click the "Add Context" button to save this context to your project. The AI will now take this text input into account when performing related tasks or generating outputs.

B. Options List

Purpose:
When users need to work with predefined parameters or list of options, an Options List context can be used. For instance, let’s say you're using libraries like Pandas, Numpy, Scalar, Stump, or Saber, you can specify these as part of your option list context. AI can then offer suggestions based on these options while generating the output.
How to Set Up:
1. In the "Configure context value," enter the list of items you want to include.
2. In the "Separator value" field, define the character you used to separate the items in your list (e.g., a comma).
3. Click the "Import" button. This will process the text you entered or pasted and convert it into a list format based on the separator you specified.
4. Once you've configured the list and you’re satisfied with the entries, click the "Add Context" button.

This will save the options list to your project context and make it available for use within the platform.

C. Code

Adding code context helps AI to analyze existing code for patterns, errors, or optimization opportunities. This is important for tasks like code generation, refactoring, debugging, and more.

Three ways to add Code as context in Workik are:

Code Integration
Code Snippets
Upload Files/Folders

1. Code Integration

Purpose:
This method can be used to integrate external code repositories directly into your project. You can connect and sync codebases directly from GitHub, GitLab, or Bitbucket, ensuring that the latest versions of code are always available within the Workik project's context.
How to Set Up:
1. Within the 'Configure context value' section, ensure that the 'Code Integration' tab is selected.
2. Choose the platform where your code is hosted by selecting either 'GitHub', 'GitLab', or 'Bitbucket'.
3. Click on the 'Connect' button corresponding to your chosen platform. For this tutorial, we'll try to 'Connect GitHub'.
4. You will be prompted to log in to your chosen service and authorize Workik to access your repositories.
5. Once your GitHub is connected to Workik, select the repository you wish to give access to for your project.
6. After setting up the connection to a branch in your repository, click the 'Add Context' button.

This will finalize the integration and the selected code will be added as context to your Workik project.

2. Code Snippets

Purpose:
This option lets users manually input individual code snippets or functions that you frequently use. It is particularly useful for small blocks of code that need to be readily accessible within the Workik project.
How to Set Up:
1. Click on the 'Code Snippets' tab within the 'Configure context value' section.
2. Click on the 'Add Code' button. This should bring up a pop-up where you can enter the code snippet.
3. In the 'File name' field, enter a name for the code snippet file, which can be useful for referencing within your project.
4. In the 'Code' text area, type or paste the actual code snippet you wish to add. This could be a function, a class, or any other useful piece of code.
5. Once you have entered the code snippet, click the 'Save' button.
6. Click the 'Add Context' button, this action will add the code snippet to your project's context within Workik.

3. Upload files & folders

Purpose:
This method is used for uploading files or entire folders of code from your local system into the project. It is ideal for bulk additions and ensures that all necessary code files are contained within the workik project environment.
How to Set Up:
1. Click on the 'Upload files’ or ‘Upload folders' button in the 'Configure context value' section. A popup will open up:
2. Once you have selected your files or folders, click the 'Upload' button to add them to your project context.
3. Click the 'Add Context' button to finalize the addition of your code files or folders to the project context.

D. Database

By providing database schema or queries, users enable the AI to understand the data model and relationships. This helps AI to generate accurate database-related code, optimizing database interactions, or crafting accurate SQL queries.

Note: Workik doesn’t require users to add data. You can add database structure without sharing data.

Two ways to add Database as context in Workik are:

Custom Database Structure
Create Workik Database with AI

How to set up:

Click on the 'Create Database' button which will take you to the "Add Database" pop-up.

How to start creating Database for context

In the new dialog that opens, choose 'Custom Database Structure' or 'Create Workik Database with AI'. Select the option that best suits your needs.

Two ways to Add/Create Database in Workik

1. Custom Database Structure

Purpose:
Users can upload their database schema using CSV or JSON files. This allows users to add database structures without the need to connect to an actual live database.
How to Set Up:
1. Select the 'Database Type' from the dropdown menu.
2. Enter a relevant 'Database Name' to identify the database within your project.
3. You can either choose a JSON or CSV format for your database structure.
4. Finally clicking on 'Add Context' will add the custom database structure to your project's context.

2. Create Workik Database with AI

Purpose:
You can also use AI to help you create a database. AI instantly builds databases as per your preference and constraints.
How to Set Up:
1. Choose the 'Database type' from the dropdown menu, which includes – MySQL, MS SQL, PostgreSQL, MariaDB and MongoDB.
2. Use the AI assistance to generate your database by typing in the feature requirements in the provided text box.
3. Click the 'Send' button to submit your requirements to the AI.
4. After the AI processes your requirements, you will be prompted to review the generated database structure. Then click on 'Apply Changes'.
5. Before finalizing, you can also visually review the database structure. Once satisfied, simply click on the 'Create Database' button to confirm and add the AI-generated database to your project context.
6. Click on 'Add Context', and this will add the AI-generated database schema to your Workik project's context, enabling Workik to utilize this context to generate code accordingly.

E. Image

Purpose:
Image context can be used when the task involves visual data. AI can assist in not only image processing, analysis, and interpretation of visual data but also the generation of code based on the images provided.

Note: You can upload images as context only with OpenAi vision AI.
How to Set Up:
1. Click on the 'Upload Folder'/ 'Upload File' button. Locate and choose the relevant images to add them to your project's context.
2. On clicking upon 'Upload File'/'Upload Folder', you'll be prompted to choose file(s)/folder from your device. Locate and select the image file(s)/folder you wish to add. Then click on 'Upload'. The system will incorporate them into your project's context.

Once uploaded, these images can be used by the AI for tasks like pattern recognition, data analysis, or other vision-based processes.

F. Rest API

Adding REST API Schema helps the AI to comprehend the structure and endpoints of the APIs in use. This allows AI to generate API-related code, testing scripts, and integration tasks.

Note: Workik doesn’t require users to add data. You can add database structure without sharing data.

Two ways to add REST API a scontext in Workik are:

Import From Postman
Add Requests

1. Import From Postman

Purpose:
This option is tailored for users who prefer to import their API configurations from Postman, where they might have already defined and tested their API calls. It simplifies the process of transferring API settings into the workik project.
How to Set Up:
1. Click the 'Import From Postman' button within the 'Configure context value' section.
2. A dialog will appear prompting you to upload a Postman Collection file. To create a 'json' file for import, follow the provided steps:
3. Once you have your Postman collection file, upload it using the provided interface and then click 'Import' to finalize the addition of the Postman configuration to your project.
4. Click on the ‘Add Context’ button, to finalize adding your API collection as context to your project.

2. Add Requests

Purpose:
Adding requests manually gives you the ability to specify different API methods.
How to Set Up:
1. Click on the 'Add Requests' button in the 'Configure context value' section.
2. A new pop-up should appear where you can input the details of your API request.
3. Click on the ‘Add Context’ button, to finalize adding your API Request as context to your project.

Finally adding an API Request manually as context in Workik

4. Context Selection for AI

Context Selection can be done in two ways:

Enabling Vector Search
Manually Selecting the Required Context

A. Enabling Vector Search

Workik can automatically detect relevant context from Code and Database contexts using vector databases. Other context types are parsed through AI, based on manual selection by users. This ensures only necessary information is parsed for each AI prompt.

Note: This feature is currently available only for premium subscribers.

To enable this Feature:

Just click on ‘Enable’ adjacent to Vector search under ‘Environment Context’ panel.
Please enter your query, and the AI will analyze the relevant context to provide a response based on the prompt you have provided.
To review the context interpreted by the AI, please click on the 'View Context' button.
Here you can view the context that has been processed for the prompt sent and the corresponding response received.

B. Manually Selecting the Required Context

Navigate to the Right side panel of your interface where your contexts, such as 'Images','Database', 'Options List', or 'REST APIs' are listed.
You can select specific contexts by checking the boxes next to each entity. For example, if you want the AI to consider 'Products' and 'Orders' in its processing, ensure these are checked.
If you want to select all available contexts of any particular type of context, simply click the 'Select all' checkbox at the top of the list.
Once you have made your selections, the AI will use the chosen contexts to assist in generating code, queries, or performing other related tasks.