Anthropic Claude integration for P4 Code Review

Use Anthropic Claude with P4 Code Review to generate AI-based explanations for code diffs and assist with code reviews.

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

To integrate Anthropic Claude with P4 Code Review, complete the following:

  • Generate API key

  • Configure AI in P4 Code Review

Generate API key

  1. Create an Anthropic Claude account or sign in.

  2. Generate an API key:

    1. Go to API Keys.

    2. Click Create API key.

    3. Copy the generated key.

Configure AI in P4 Code Review

There are two ways to configure AI in P4 Code Review:

  • Use AI configuration in System Information (Recommended)

  • Use ai_review block config.php (Not recommended)

Use AI configuration in System Information (Recommended)

This is the easiest way to set up AI in P4 Code Review.

  1. In the top right corner of P4 Code Review, click System Information from the User ID dropdown menu.

  2. Click Configuration.

  3. Click on AI Configuration to expand the section.

  4. Turn on Enable AI.

  5. At the bottom of the page, in the AI Vendor section, click the Edit vendor configuration icon.

  6. Configure the following settings:

    • AI Vendor: Select Anthropic AI from the dropdown.

    • AI Package Value: (optional) A display value for the AI package.

    • AI Model: Enter the name of the AI model.

    • AI Package Type: Enter a value to identify the prompt type used in the AI response.

    • API key: Enter your Anthropic Claude API key.

    • Character Limits: Enter the minimum and maximum characters required for AI processing.

    • API Endpoint: Enter the API endpoint URL.

    • Prompts: (Optional) Change the prompts sent to Anthropic Claude. These prompts are for the AI Assistant for comments. You can update the following:

      • Improve Comment

      • Summarize Text

      • Fix Spelling and Grammar

      • Custom Prompt

  7. Click Update AI Vendor.

Use config.php (Not recommended)

To configure Anthropic Claude using the config.php file, you must be a super user.

  1. 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'        => 'anthropicAI', // 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'   => 'claudewithexplaincode', // This is intended for future  
                                                                     // use when we will support
                                                                     // multiple models and have an 
                                                                     // AI configuration page in the UI.
                'ai_package_value' => 'Anthropic Claude', // This is used to display 
                                                                           // the model type in the
                                                                           // summary of the
                                                                           // AI vendor's response
                'ai_model'         => 'claude-3-sonnet-20240229',
                'api_key'          => $SECRET_KEY,                   // Add in the API-key for you AI vendor
                'api_end_point'    => 'https://api.anthropic.com/v1/messages',   // Add an optional API endpoint				
                                                                     // check if end point protocol (http/https) is required
                                                                     // 'api.anthropic.com/v1' is a valid end point  				
                '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.

  2. Ensure that your Anthropic account has sufficient usage credits to access the API. If necessary, recharge your account.

This configuration enables the Anthropic Claude model to explain the code diffs in your P4 Code Review.