StudioAssist Preferences

Prerequisites

• Katalon Studio Enterprise (KSE) 10.2.0.

You can configure to use StudioAssist to further improve your exeperience.

In Katalon Studio, go to Katalon Studio Enterprise > Settings > Katalon and select StudioAssist. Depending on your Account configuration, you will see a slight difference in the dialog.

AI service configuration

Katalon AI

When AI services and Katalon AI are enabled for your Account, you can freely choose between using Katalon AI Service or using your own OpenAI or Azure OpenAI API keys.

Preset AI Service

If your Admin has enabled the use of the organization’s AI key, the AI provider is shown at the top of the dialog as: "AI provider name – managed by your organization". For example:

With this setting, you can configure the token limit and model for the AI service. You cannot switch between services (Katalon AI, OpenAI, or Azure).

Personal AI keys

In the case of AI features are disabled, you can opt for your personal OpenAI key or Azure OpenAI API key.

• Use personal OpenAI key: Provide the following information before using.

• Secret key: Your OpenAI secret key. To get your key, refer to this OpenAI's instruction: Where do I find my secret key?
• Max completion token: The limit on the number of tokens returned in a model response. The default value is 16000. To learn more about the token limits, refer to the OpenAI rate limits documentation: OpenAI Token Limits.
• Organization ID (optional): The organization ID on OpenAI is the unique identifier for your organization which can be used in API requests.
• Model: The OpenAI model you want to use. If not changed, the gpt-4o-mini model is used by default.
• Use personal Azure OpenAI API key: Provide the following information before using.

• Base URL: The base URL for your Azure OpenAI resource in the following format: https://{your-resource-name}.openai.azure.com.
• Deployment name: Azure OpenAI uses the deployment name to call the model. Enter the deployment name of your choosing, make sure that the model supports chat completion.
• API key: Your Azure OpenAI key.
• Max completion token: The limit on the number of tokens returned in a model response. The default value is 16000.

Append tags for test cases used AI generated capabilities

By default, for test artifacts that are generated by AI - via the code generating feature and API test case generating feature - StudioAssist will automatically add the AI tag to the test case properties. You can customize the AI tag name to align with your organization’s terminology, or turn it off in StudioAssist settings.

Auto-include project context information

To improve the generated scripts from StudioAssist, you can enable the Object Repository information. This feature automatically uses the list of all test object IDs in that project as context.

This helps StudioAssist provide more tailored responses, while reduces the effort of having to provide the exact object paths or test objects you want to include in your test.

Customize engineering prompts with Prompt Library

Starting from version 10.2.3, you can customize your engineering prompts using Prompt Library to provide more context and improve the accuracy of StudioAssist responses.

1. Click Katalon Studio Enterprise on the main navigation and select Settings to open the Preferences dialog.
2. Select Katalon > StudioAssist > Prompt Library.
3. Configure your Prompt Library. Click on the prompt type you want to customize. Edit this text directly to include more context or specific instructions about how you want the AI to respond.

• Chat instruction: Used in the StudioAssist chat window. This controls how StudioAssist responds to your general questions or guidance requests. Add more context about your application under test (AUT) or focus area, so you don’t have to repeat this every time you chat.
• Generate code: Used in the script editor, add style guide details or coding preferences to make the generated code better fit your project.
• Explain code: Used in the script editor, specify if you want detailed technical explanations or a high-level summary, depending on your needs.

Notes

• Use ${userSelection} for Generate code and Explain code. This variable represents the specific piece of text or code you have highlighted (selected) in the script editor.
• Customize prompt is not applied for Katalon AI service.

4. Click Apply or Apply and Close to save.

You can now use StudioAssist with your customized prompts.

If the generated output is not to your expectation, simply open the Prompt Library and select Revert Original to revert each prompt or click Restore to Defaults to restore all prompts.