ProxyAI

https://docs.tryproxy.io
Admin
ProxyAI is an intelligent coding assistant that integrates with JetBrains IDEs, offering...
Tokens:13,482
Snippets:19
Trust Score:7.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run Ollama Model Locally

Source: https://docs.tryproxy.io/providers/local/ollama

This command downloads and starts a specified Ollama model. It's a prerequisite for using the model with the ProxyAI plugin. Ensure Ollama is installed before executing.

```shell
ollama run codellama
```

--------------------------------

### OpenAI API Key Configuration

Source: https://docs.tryproxy.io/providers/cloud/openai

Guides users through obtaining and applying their OpenAI API key within the ProxyAI tool for seamless integration. This involves creating an OpenAI account, generating an API key, and configuring it in the ProxyAI settings.

```APIDOC
OpenAI Provider Setup:

Purpose: Configure ProxyAI to utilize the OpenAI API for AI model interactions.

Steps:
1.  **Create OpenAI Account**:
    *   Action: Sign up for an account on the OpenAI platform.
    *   Link: https://platform.openai.com/signup

2.  **Generate OpenAI API Key**:
    *   Action: Navigate to the API Keys section on the OpenAI platform.
    *   Action: Create a new secret key.
    *   Note: This key is essential for authenticating requests.
    *   Link: https://platform.openai.com/api-keys

3.  **Apply API Key in ProxyAI**:
    *   Location: Access ProxyAI settings via `File > Settings/Preferences > Tools > ProxyAI > Providers > OpenAI`.
    *   Action: Paste the generated API key into the designated input field.
    *   Action: Save the configuration by clicking `Apply` or `OK`.

Dependencies:
*   An active OpenAI account.
*   A valid OpenAI API key.

Inputs:
*   `OpenAI API Key`: A string representing the secret key obtained from OpenAI.

Outputs:
*   Successful authentication and usage of OpenAI models through ProxyAI.
```

--------------------------------

### ProxyAI Provider Setup and API Key Configuration

Source: https://docs.tryproxy.io/providers/cloud/proxyai

This entry details the process of setting up the ProxyAI cloud provider. It covers account tiers (Anonymous, Free, Individual), how to obtain an API key from the account page, and the steps to apply this key within the plugin's settings. It also notes that requests default to the anonymous tier if no key is provided.

```APIDOC
ProxyAI Provider Configuration:

Purpose: To configure the ProxyAI cloud provider for use with the plugin.

Account Tiers:
  - Anonymous: Rate limited access to specific models (e.g., gpt-4o-mini, codestral, zeta).
  - Free: Token limited access to features and models (e.g., deepseek-v3, qwen-2.5-coder-32b, llama-3.1-405b).
  - Individual: Unlimited access to all models and features.

API Key Management:
  - Obtaining Key: Found on the user's account page under "Your API Keys". Click the Copy icon.
  - Importance: Essential for authenticating requests with the ProxyAI API.
  - Default Behavior: If no key is provided, requests default to the anonymous tier.

Configuration Steps:
  1. Navigate to plugin settings: File > Settings/Preferences > Tools > ProxyAI > Providers > ProxyAI.
  2. Paste the API key into the designated field.
  3. Click 'Apply' or 'OK' to save.

Available Models: Access to a range of powerful AI models, with details available on the Models page.
```

--------------------------------

### Full Configuration JSON Structure

Source: https://docs.tryproxy.io/enterprise/remote-settings

This snippet shows the complete JSON structure for configuring prompts and providers. It includes detailed prompt definitions for various core actions like editing code, fixing errors, generating commit messages, and reviewing changes. The structure is designed for use in AI-powered development tools.

```json
{
  "prompts": {
    "coreActions": {
      "editCode": "You are a code modification assistant. Your task is to modify the provided code based on the user's instructions.\n\nRules:\n1. Return only the modified code, with no additional text or explanations.\n2. The first character of your response must be the first character of the code.\n3. The last character of your response must be the last character of the code.\n4. NEVER use triple backticks (```) or any other markdown formatting in your response.\n5. Do not use any code block indicators, syntax highlighting markers, or any other formatting characters.\n6. Present the code exactly as it would appear in a plain text editor, preserving all whitespace, indentation, and line breaks.\n7. Maintain the original code structure and only make changes as specified by the user's instructions.\n8. Ensure that the modified code is syntactically and semantically correct for the given programming language.\n9. Use consistent indentation and follow language-specific style guidelines.\n10. If the user's request cannot be translated into code changes, respond only with the word NULL (without quotes or any formatting).\n11. Do not include any comments or explanations within the code unless specifically requested.\n12. Assume that any necessary dependencies or libraries are already imported or available.\n\nIMPORTANT: Your response must NEVER begin or end with triple backticks, single backticks, or any other formatting characters.",
      "fixCompileErrors": "I will provide you with a snippet of code that is causing a compilation error.\nYour task is to identify the potential causes of the compilation error(s) and propose code solutions to fix them.\nPlease approach this step by step, explaining your reasoning as you go.",
      "generateCommitMessages": "Branch: {BRANCH_NAME}\nDate: {DATE_ISO_8601}\n\nWrite a short and descriptive git commit message for the following git diff.\nUse imperative mood, present tense, active voice and verbs.\nYour entire response will be passed directly into git commit.",
      "generateNameLookups": "Provide five alternative names for a given function or method body. Your response should be a list of names, separated by commas, without any extra information.\n",
      "reviewChanges": "You are an experienced software developer tasked with reviewing code changes and providing concise, valuable feedback. Your goal is to analyze the provided git diff and open files, then suggest logical and meaningful improvements if needed, focusing on brevity and specific code examples.\n\nFollow these steps to complete your review:\n\n1. Analyze the git diff and open files:\n   Be concise and focus on the most important points. Include:\n   - For each modified file:\n     * Specific line numbers of changes\n     * Brief description of changes, quoting specific lines of modified code\n     * Change category (e.g., bug fix, feature addition, refactoring)\n     * Purpose and potential impact\n     * Any potential issues, risks, or bugs\n     * Impact on code readability and maintainability\n     * Potential impact on performance and scalability\n   - Identification of any code smells or anti-patterns in the changes\n   - Key relationships between changes in different files\n   - Overall coherence and consistency of the changes\n   - Any potential security concerns\n   - For each change, consider and note its impact on the overall codebase\n\n2. Determine if improvements are needed:\n   Based on your analysis, decide if any improvements are necessary. If so, provide your suggestions using the following format:\n\n   ```{lang}\n   // Your code suggestion here.\n   ```\n\n   Ensure your suggestions are:\n   - Specific and actionable\n   - Relevant to the changes in the git diff and the context of open files\n   - Aligned with best practices in software development\n   - Accompanied by brief explanations of their importance\n\n   If no improvements are needed, briefly explain why the current changes are sufficient.\n\n3. Provide a short summary:\n   - A brief overview of the changes reviewed\n   - Main findings from your analysis\n   - A concise list of key suggestions (if any), ordered by importance\n   - Your overall assessment of the code changes\n\nRemember to keep your analysis, suggestions, and summary concise and to the point. Focus on providing specific code examples in your suggestions rather than verbose explanations."
    },
    "chatActions": [
      {
        "name": "Explain"
      }
    ]
  },
  "providers": {
    "openai": {
      "model": "gpt-4",
      "temperature": 0.7
    }
  }
}
```

--------------------------------

### ProxyAI Prompts Configuration Structure

Source: https://docs.tryproxy.io/enterprise/remote-settings

Illustrates the JSON structure for defining custom prompts in ProxyAI. This includes sections for core actions, chat actions, and personas, allowing users to override default prompts or add new interactive features.

```json
{
  "prompts": {
    "coreActions": {
      "generateCommitMessages": "Branch: {BRANCH_NAME}..."
    },
    "chatActions": [
      {
        "name": "Explain Selection",
        "instructions": "Explain: {SELECTION}"
      }
    ],
    "personas": [
      {
        "name": "Code Reviewer",
        "instructions": "Review the code..."
      }
    ]
  }
}
```

--------------------------------

### Anthropic API Configuration and Key Management

Source: https://docs.tryproxy.io/providers/cloud/anthropic

Guides users through obtaining an Anthropic API key and configuring the ProxyAI plugin with Anthropic provider settings. It includes steps for account creation, API key generation, and selecting specific Anthropic models and versions for use.

```APIDOC
Anthropic Provider Configuration:

1.  **Account Creation**:
    *   Sign up for an Anthropic account at: https://console.anthropic.com/login

2.  **API Key Generation**:
    *   Navigate to the API Keys page within your Anthropic account: https://console.anthropic.com/settings/keys
    *   Create a new API key.
    *   Copy the generated API key.

3.  **Plugin Configuration**:
    *   Access ProxyAI settings: File > Settings/Preferences > Tools > ProxyAI > Providers > Anthropic.
    *   **API Key**: Paste the copied API key into the designated field.
    *   **Anthropic Version**: The plugin automatically manages the `anthropic-version`. For custom versioning, consult Anthropic's API versioning documentation: https://docs.anthropic.com/en/api/versioning.
    *   **Model Selection**:
        *   Choose a model from the provided list for messages and commands.
        *   **Available Models**:
            *   Claude 3 Opus: `claude-3-opus-20240229`
            *   Claude 3 Sonnet: `claude-3-sonnet-20240229`
            *   Claude 3 Haiku: `claude-3-haiku-20240307`
        *   Refer to the full list of Anthropic models: https://docs.anthropic.com/en/docs/models-overview#claude-3-a-new-generation-of-ai
    *   Save changes by clicking `Apply` or `OK`.
```

--------------------------------

### Custom OpenAI Provider Configurations

Source: https://docs.tryproxy.io/enterprise/remote-settings

Defines configurations for interacting with custom OpenAI-compatible AI services. It includes settings for both chat completion and code completion endpoints, specifying API URLs, required headers, and request body parameters such as model names, temperature, and streaming options.

```APIDOC
{
  "name": "Default Self-Hosted",
  "chatCompletionSettings": {
    "url": "https://your-internal-llm-service.example.com/v1/chat/completions",
    "headers": {
      "Authorization": "Bearer $CUSTOM_SERVICE_API_KEY",
      "X-LLM-Application-Tag": "proxyai",
      "Content-Type": "application/json"
    },
    "body": {
      "stream": true,
      "model": "llama-4-maverick-17b",
      "messages": "$OPENAI_MESSAGES",
      "temperature": 0.0,
      "max_tokens": 8192
    }
  },
  "codeCompletionSettings": {
    "codeCompletionsEnabled": true,
    "infillTemplate": "OPENAI",
    "url": "https://your-internal-llm-service.example.com/v1/completions",
    "headers": {
      "Authorization": "Bearer $CUSTOM_SERVICE_API_KEY",
      "X-LLM-Application-Tag": "proxyai",
      "Content-Type": "application/json"
    },
    "body": {
      "suffix": "$SUFFIX",
      "stream": true,
      "model": "gpt-3.5-turbo-instruct",
      "temperature": 0.2,
      "prompt": "$PREFIX",
      "max_tokens": 24
    }
  }
}
```

```APIDOC
{
  "name": "Azure OpenAI East US",
  "chatCompletionSettings": {
    "url": "https://your-azure-endpoint.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2023-05-15",
    "headers": {
      "api-key": "$CUSTOM_SERVICE_API_KEY",
      "X-LLM-Application-Tag": "proxyai",
      "Content-Type": "application/json"
    },
    "body": {
      "stream": true,
      "model": "gpt-4",
      "messages": "$OPENAI_MESSAGES",
      "temperature": 0.1,
      "max_tokens": 4096
    }
  },
  "codeCompletionSettings": {
    "codeCompletionsEnabled": false
  }
}
```

--------------------------------

### Generate Git Commit Message

Source: https://docs.tryproxy.io/editor/commit-message

ProxyAI analyzes staged changes and suggests a consistent commit message. Users can also provide additional instructions for specific requirements or style guides.

```IDE Integration
1. Open the Commit tool window (Cmd+K / Ctrl+K).
2. Stage the files you want to include in the commit.
3. Select the 'Generate message' option from the dropdown above the text input field.

To provide additional input:
- Use the input field to add specific instructions or details when generating the message.
```

--------------------------------

### ProxyAI Commit Message Prompt Customization

Source: https://docs.tryproxy.io/editor/commit-message

Users can customize the instructions ProxyAI uses to generate commit messages by modifying the 'Commit Message Prompt Template'. This allows for tailored commit message generation based on specific project needs or style guides.

```APIDOC
Settings/Preferences > Tools > ProxyAI > Prompts > Generate Commit Message

Configuration:
  Commit Message Prompt Template: A text field where users can define the prompt structure.

Available Placeholders:
  - BRANCH_NAME: Automatically inserts the name of the current branch (e.g., `feature/user-auth`).
  - DATE_ISO_8601: Inserts the current date in ISO 8601 format (e.g., `2023-05-15`).

Example Template:
"Write a concise Git commit message for the following staged changes. Use the branch name: {BRANCH_NAME} and today's date: {DATE_ISO_8601}. 

Changes:
{changes}"
```

--------------------------------

### Configure Groq for Chat Completions

Source: https://docs.tryproxy.io/providers/cloud/custom

Steps to configure the Groq AI provider for chat completions within ProxyAI. This involves selecting a preset template, obtaining an API key from Groq's console, and entering it into the ProxyAI settings.

```APIDOC
ProxyAI Provider Settings:
  Navigate: File > Settings/Preferences > Tools > ProxyAI > Providers > Custom OpenAI

  Configuration Steps:
  1. Preset Selection:
     - Choose 'Groq' from the Preset template dropdown.
  2. API Key Input:
     - Obtain your API key from [Groq's console](https://console.groq.com/keys).
     - Paste the key into the designated API key field.
  3. Verification:
     - Verify that the configuration is correct and the connection is successful.
  4. Save:
     - Click 'Apply' or 'OK' to save the changes.
```

--------------------------------

### Configure Fireworks API for Code Completions

Source: https://docs.tryproxy.io/providers/cloud/custom

Instructions for setting up the Fireworks API with StarCoder 16B for code completions in ProxyAI. This requires obtaining an API key from Fireworks and applying it in the ProxyAI settings, leveraging the pre-configured Fireworks preset.

```APIDOC
ProxyAI Provider Settings:
  Navigate: File > Settings/Preferences > Tools > ProxyAI > Providers > Custom OpenAI

  Configuration Steps:
  1. Preset Selection:
     - ProxyAI provides a preset template for Fireworks.
  2. API Key Input:
     - Obtain your API key from the Fireworks API.
     - Paste the key into the dedicated field in the ProxyAI settings.
  3. Model Support:
     - StarCoder 16B via Fireworks API supports fill-in-the-middle (FIM) completions.
```

--------------------------------

### Azure OpenAI Configuration in ProxyAI

Source: https://docs.tryproxy.io/providers/cloud/azure

Instructions for configuring the ProxyAI plugin to use Azure OpenAI services. This involves navigating to plugin settings and inputting specific Azure credentials and identifiers.

```APIDOC
ProxyAI Azure OpenAI Configuration:

1. Navigate to Plugin Settings:
   - Go to File > Settings/Preferences > Tools > ProxyAI > Providers > Azure.

2. Input Credentials and Details:
   - API Key or Microsoft Entra ID: Paste your obtained secret key or Entra ID token.
   - Resource Name: The first part of your Azure OpenAI service endpoint URL (e.g., 'my-resource-name' from 'https://my-resource-name.openai.azure.com/').
   - Deployment ID: The name of your deployment as found in Azure AI Studio under Management > Deployment.
   - API Version: The most recent non-preview API version.

3. Save Changes:
   - Click 'Apply' or 'OK' to save the configuration.
```

--------------------------------

### Azure OpenAI Limitations

Source: https://docs.tryproxy.io/providers/cloud/azure

Highlights current limitations for Azure OpenAI integration within ProxyAI, specifically regarding code completion features.

```APIDOC
Azure OpenAI Service:

Limitations:
  - Code completions are currently unsupported.
  - To enable code completion, manual configuration via the Custom OpenAI provider is required.
```

--------------------------------

### ProxyAI Context Window Management

Source: https://docs.tryproxy.io/models

Details how ProxyAI manages context windows for chat sessions, including service-specific limits and recommendations for optimal processing.

```APIDOC
ProxyAI Cloud Context Window:
  Service-specific limit: Up to 16,000 tokens per chat session.
  Management: ProxyAI automatically summarizes or removes older conversation parts to stay within the limit.
  Optimal Processing Input Limit: Keep total input context (files, selections, etc.) under 200,000 tokens.
```

--------------------------------

### ProxyAI Name Lookups Usage

Source: https://docs.tryproxy.io/editor/name-lookups

Instructions on how to activate and use the Name Lookups feature within the ProxyAI IDE integration. This feature leverages AI to suggest descriptive names for code elements.

```APIDOC
ProxyAI Name Lookups:

Purpose: Analyzes variables, functions, classes, and other code elements to propose clear and descriptive names during refactoring.

Usage Steps:
1. Position your cursor on the code element (variable, method, class) you intend to rename.
2. Initiate the refactoring process using the following keyboard shortcuts:
   - Windows/Linux: Shift+F6
   - macOS: Cmd+F6
3. ProxyAI will automatically analyze the context and add AI-generated name suggestions to the standard IDE lookup list.
4. Select any of the AI-suggested names from the dropdown menu to apply the rename operation.

Dependencies: Requires the ProxyAI IDE plugin to be installed and configured.

Inputs: Cursor position on a code element.

Outputs: A list of AI-suggested names presented in the IDE's refactoring dialog.

Limitations: The quality of suggestions depends on the context provided and the AI model's understanding.
```

--------------------------------

### ProxyAI Cloud Chat Models

Source: https://docs.tryproxy.io/models

Lists chat models available through ProxyAI Cloud, specifying the model name, provider, and availability for Free and Pro plans.

```APIDOC
ProxyAI Cloud Chat Models:
  Model Name | Provider | Free Tier | Pro Tier
  --------------------------------------------------
  o3-mini | OpenAI |  | ✅
  gpt-4o | OpenAI |  | ✅
  gpt-4o-mini | OpenAI | ✅ | ✅
  claude-3.7-sonnet | Anthropic |  | ✅
  gemini-pro-2.5 | Google |  | ✅
  gemini-flash-2.0 | Google | ✅ | ✅
  qwen-2.5-coder-32b | Fireworks | ✅ | ✅
  llama-3.1-405b | Fireworks | ✅ | ✅
  deepseek-r1 | Fireworks |  | ✅
  deepseek-v3 | Fireworks | ✅ | ✅

Notes:
- Model availability and usage limits depend on your ProxyAI Cloud plan (Free or Pro).
- Availability may change over time.
```

--------------------------------

### ProxyAI Cloud Code Models

Source: https://docs.tryproxy.io/models

Lists code generation models available through ProxyAI Cloud, specifying model name, provider, availability, and the type of code assistance provided.

```APIDOC
ProxyAI Cloud Code Models:
  Model Name | Provider | Free Tier | Pro Tier | Type
  ------------------------------------------------------------------
  gpt-3.5-turbo-instruct | OpenAI | ✅ | ✅ | [Autocomplete](/editor/tab#autocomplete)
  codestral | Mistral | ✅ | ✅ | [Autocomplete](/editor/tab#autocomplete)
  qwen-2.5-coder-32b | Fireworks | ✅ | ✅ | [Autocomplete](/editor/tab#autocomplete)
  zeta | ProxyAI | ✅ | ✅ | [Next Edits](/editor/tab#next-edits)

Notes:
- Model availability and usage limits depend on your ProxyAI Cloud plan (Free or Pro).
- Availability may change over time.
```

--------------------------------

### Review Past Commits

Source: https://docs.tryproxy.io/editor/commit-message

Analyze and understand previous commits to the codebase. This feature provides explanations for historical commits.

```IDE Integration
1. Open the Git tool window (View > Tool Windows > Git or Cmd+9/Alt+9).
2. Navigate to the Log tab.
3. Right-click the commit you want explained.
4. Select 'ProxyAI > Explain Commit with ProxyAI'.
```

--------------------------------

### Review Code Changes

Source: https://docs.tryproxy.io/editor/commit-message

Send staged changes to ProxyAI for quick analysis and feedback before committing. This helps in identifying potential issues or improvements.

```IDE Integration
1. Stage the files you want to review.
2. Utilize the 'Review Changes' functionality within the ProxyAI integration.
```
Tokens:
Raw