How to set up OpenAI integration for P4 Code Review

To review the terms for using your own API keys, download the API Key Usage Agreement for Perforce P4 Code Review.

To integrate OpenAI with P4 Code Review, follow these steps:

1. Create an OpenAI account or log in to your OpenAI account here.

2. Create a project on the OpenAI platform.

3. Generate and copy a secret API key by taking the following actions:

   1. Navigate to the project settings.

   2. Generate a secret key.

   3. Copy the generated key.

4. To configure AI review integration for P4 Code Review, add the ai_review block configuration in SWARM_ROOT/data/config.php file, as in the following example:

   <?php
       'ai_review' => array(
            // Please read Perforce's Generative AI policy before enabling this feature. 
            // See https://www.perforce.com/generative-ai-policy 
            'enabled' => false, // set to true to enable the AI review feature
            'data_retention_lifetime' => '30 days',  // Delete AI summary records that are older than the
   					  	  // value provided. By default, this value is 30 days.
   						  // Enter a value in 'days' or 'months'.
   						  // For example, '30 days' or '2 months'.
   						  // A cron job is required to remove the
   						  // AI summaries on a schedule.
   						  // See Set up a cron job to delete AI summaries.	
           'timeout' => 30, // Setting timeout for the request sent from p4 code review to AI vendor 
                            //  Timeout set in seconds
           'ai_vendors' => array(
               'ai_model1' => array(
                   'ai_vendor'        => 'openAI', // Name of the AI provider being used
                   'ai_package_id'    => '1', // Ensure this remains as '1'. Do not modify the ai_package_id.
                   'ai_package_key'   => 'openaiwithexplaincodeongpt4', // This is intended for future  
                                                                        // use when we will support
                                                                        // multiple models and have an 
                                                                        // AI configuration page in the UI.
                   'ai_package_value' => 'Open AI With Explain Code On GPT4', // This is used to display 
                                                                              // the model type in the
                                                                              // summary of the
                                                                              // AI vendor's response
                   'ai_model'         => 'gpt-4',
                   'api_key'          => $SECRET_KEY,                   // Add in the API-key for you AI vendor
                   'api_end_point'    => 'https://api.openai.com/v1',   // Add an optional API endpoint				
                   'ai_package_type'  => "Explain the following code:", // This is the prompt for the AI.
                                                                        // You can modify the prompt  for
                                                                        // purposes other than explaining
                                                                        // the code, or to request the
                                                                        // output in a specific language.  
                   'ai_min_char_limit'=> 4, // Minimum number of characters required in the content
                                            // submitted to the AI vendor for analysis.
                                            // Defaults to 4 characters.
                   'ai_max_char_limit'=> 31000, // The maximum number of characters
                                                // that can be submitted to the AI vendor for analysis
                                                // Defaults to 31000 characters.
               ),
           ),
       ),

   Replace $SECRET_KEY with the API key that you copied earlier.

5. Ensure that your OpenAI account has enough tokens to use the API. If necessary, recharge your account.

This configuration enables the OpenAI's GPT-4 model to explain the code diffs in your P4 Code Review.