Private AI Mode Integration Script

With Private AI mode enabled, you can bring your own AI model as an issue generation engine, used by the application. You will need to configure a simple Groovy integration script, that defines the communication protocol with the AI engine. Without configuring the script, the app will not function properly and will not be able to generate issues. By default, a sample script is available that serves as example – it can be modified or adapted. 

The script will be invoked every time when the Generate Issues form is submitted. 

Script invocation lifecycle is as follows:

1. Generate Issues form is submitted
2. Groovy script execution is triggered
3. Groovy script integrates with a Private AI model over HTTP or other means
4. Groovy script returns a single String result, which contains the generated issues

For proper execution the following best practises must be followed:

• The script must always return the text response from the AI engine as a String result.
• A Groovy parameter query is passed. It contains the AI query – it must be forwarded without change to the AI engine.
• In case an error occur, an Exception should be thrown. Example: throw new Exception(“An error has occured…”)
• Always ensure you put a timeout to all blocking operations, especially HTTP calls.

The following variables are available for use within the script:

• query – query to send to the AI model
• language – selected language
• logger – may be used for logging. Use as: logger.info(“message”) | logger.debug(“message”) | logger.error(“message”). The resulting logs will be available in the standard atlassian-jira.log files – please ensure you enable the required level of logging for the com.deview_studios.atlassian.jira.dc.ai_issue_generator package from the Logging and profiling menu.

It’s recommended to enable DEBUG logging while developing the script to see if you’re receiving errors. Please see section Logging. 

If you need help developing the script, don’t hesitate to reach to a Deview Studios representative through our standard channels. No additional charges apply.

/* MODIFY THIS SCRIPT TO INTEGRATE YOUR AI MODEL. THIS IS JUST AN EXAMPLE. */
import com.atlassian.jira.util.json.*

def payload = new JSONObject() // Prepare body as per API specification
    .put("model", "gpt-4o")
    .put("messages", new JSONArray()
        .put(new JSONObject()
            .put("role", "user")
            .put("content", query)))
    .put("temperature", 1.0)
    .toString();

def post = new URL("https://api.openai.com/v1/chat/completions").openConnection() // Create a new request to specified URL
logger.debug("Preparing POST body: " + payload)

post.setConnectTimeout(60000) // Set a timeout to 60 seconds - make sure to always set timeouts
post.setReadTimeout(60000); // Set a timeout to 60 seconds - make sure to always set timeouts
post.setRequestMethod("POST") // Specify HTTP method
post.setDoOutput(true) // Specify our HTTP request has a body
post.setRequestProperty("Content-Type", "application/json") // Set HTTP header
post.setRequestProperty("Authorization", "Bearer REPLACE_ME") // Set HTTP header
post.getOutputStream().write(payload.getBytes("UTF-8")) // Set HTTP body

def postRC = post.getResponseCode() // Send POST request
def response = post.getInputStream().getText() // Read response body
logger.debug("Response code is: " + postRC + "; Response body is: " + response)

if (postRC.equals(200)) { // Verify request is successful
    def json = new JSONObject(response) // Read as JSON
    def result = json.getJSONArray("choices").getJSONObject(0).getJSONObject("message").get("content") // Traverse JSON tree
    return result // This script must always return the produced issues
}

throw new Exception("Unsuccessful request! HTTP response code is " + postRC + "; Response body is: " + response) // Throw error due to unsuccessful request

Usage

Limitations

AI Issue Breakdown Assistant for Jira has the following limitations:

• In Cloud AI mode, issue generation will be performed with a maximum of 4096 OpenAI tokens. Not applicable in Private AI mode.