AI Features
Important
You must ensure that sending snippets of source code to OpenAI / Azure OpenAI is allowed by your organization. By entering an OpenAI / Azure OpenAI API key, CAST Imaging users will be able to send snippets of source code to OpenAI / Azure OpenAI, via the CAST Imaging interface. CAST Imaging does not provide any specific governance of such use.Overview
CAST Imaging integrates with OpenAI technology (CAST supports both OpenAI ) and Azure OpenAI to provide an automated AI driven explanation of objects materialized during an application analysis. This feature is available only when an API key from a supported provider is configured and when the relevant feature is enabled using the AI Features panel:
Entering an API key
Ensure you have generated your API key with your chosen provider see below , choose the provider in the drop down and enter the key:
The following is required:
Provider | Required |
---|---|
OpenAI | API key |
Azure OpenAI | API Key Endpoint URL: usually this will take the form https://<app_name>.openai.azure.com Deployment Name: usually this will take the form <app_name> |
Enabling AI features
Out of the box, all AI features are disabled. Use the toggle switches to enable the features you require:
Option | Description |
---|---|
Explain code with AI | Enables a right click contextual menu option when consulting results and working at Object level - with options providing explanations directly in the source code: |
Assistant chatbot | Enables the chatbot feature located in the lower right corner when consulting results: |
Transaction summary with AI | - |
Obtaining an API key
OpenAI
- Browse to https://platform.openai.com/login?launch and click SIGN UP (if you do not have a OpenAI account) or LOG IN (If you have already signed up)
- Choose the type of key you require:
- Browse to your profile using the user menu in the top right:
- Click the User API keys tab and then select View project API keys:
- Finally click Create new secret key:
Azure OpenAI
The following is required to obtain an Azure OpenAI API key:
- An Azure subscription - Create one for free .
- Access granted to Azure OpenAI in the desired Azure subscription. - Currently, access to this service is granted only by application. You can apply for access to Azure OpenAI by completing the form at https://aka.ms/oai/access .
- An Azure OpenAI Service resource with either the
gpt-35-turbo
or thegpt-4
models deployed. For more information about model deployment, see the resource deployment guide.
See https://azure.microsoft.com/en-gb/products/ai-services/openai-service/ for more information.