> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getlimina.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Upgrade & Migration Guide

> This guide will help you migrate from version 3 to version 4 of the Limina product

This document covers the breaking changes that must be addressed when migrating between Limina versions. For the complete list of all new features, please see the full release notes in the [Customer Portal](https://portal.getlimina.ai/).

## Upgrading from version 3.X, 4.0.X to version 4.1+

For customers with outbound firewall rules. Version 4.1.0+ utilizes new license verification endpoints `verify1.private-ai.com` and `verify2.private-ai.com` any existing firewall rules will need to be updated accordingly.

## Upgrading from version 3.X to version 4.0

### API URI change

Starting with version 4.0, you will no longer need to specify the container version in your API requests directly to the container. This change will allow customers to run multiple versions of the container simultaneously so that any API consumers can migrate without downtime. We recommend an API Gateway be utilized to insert versioning into the URI path, since it has been removed from the container.

For Community and Professional consumers, simply update `v3` to `v4` in your URI.

**Localhost Example**

<CodeGroup>
  ```shell 3.X wrap theme={"theme":"poimandres"}
  curl --request POST --url http://localhost:8080/v3/process/text \
  --json '{"text": ["Hello John"]}'
  ```

  ```shell 4.0 wrap theme={"theme":"poimandres"}
  curl --request POST --url http://localhost:8080/process/text \
  --json '{"text": ["Hello John"]}'
  ```
</CodeGroup>

**Community Example**

<CodeGroup>
  ```shell 3.X wrap theme={"theme":"poimandres"}
  curl --request POST https://api.private-ai.com/community/v3/process/text \
  --header 'x-api-key: <INSERT API KEY>' --json '{"text": ["Hello John"]}'
  ```

  ```shell 4.0 wrap theme={"theme":"poimandres"}
  curl --request POST https://api.private-ai.com/community/v4/process/text \
  --header 'x-api-key: <INSERT API KEY>' --json '{"text": ["Hello John"]}'
  ```
</CodeGroup>

**Professional Example**

<CodeGroup>
  ```shell 3.X wrap theme={"theme":"poimandres"}
  curl --request POST https://api.private-ai.com/professional/v3/process/text \
  --header 'x-api-key: <INSERT API KEY>' --json '{"text": ["Hello John"]}'
  ```

  ```shell 4.0 wrap theme={"theme":"poimandres"}
  curl --request POST https://api.private-ai.com/professional/v4/process/text \
  --header 'x-api-key: <INSERT API KEY>' --json '{"text": ["Hello John"]}'
  ```
</CodeGroup>

### GENDER\_SEXUALITY Entity Change

Terms denoting gender identity and sexual orientation, previously redacted under a single class `GENDER_SEXUALITY` will now be redacted under two separate classes: `GENDER` and `SEXUALITY` respectively. Please see our [Supported Entity Types](/entities/supported-entity-types) page for descriptions and examples of these entity types.

<CodeGroup>
  ```json Request Body wrap lines theme={"theme":"poimandres"}
  {
    "text": ["My male friend is gay"]
  }
  ```

  ```json 3.X Response wrap lines theme={"theme":"poimandres"}
  [
    {
      "processed_text": "My [GENDER_SEXUALITY_1] friend is [GENDER_SEXUALITY_2]"
    }
  ]
  ```

  ```json 4.0 Response wrap lines theme={"theme":"poimandres"}
  [
    {
      "processed_text": "My [GENDER_1] friend is [SEXUALITY_1]"
    }
  ]
  ```
</CodeGroup>

### HIPAA and PHI Entity Groupings Change

The entity type groupings `HIPAA` and `PHI` have been renamed and the entity types included in each set has also changed. `HIPAA` has been renamed to `HIPAA_SAFE_HARBOR` and, accordingly, only includes entity types covered by the [HIPAA Safe Harbor provision](https://www.hhs.gov/hipaa/for-professionals/special-topics/de-identification/index.html). The `PHI` grouping has been renamed to `HEALTH_INFORMATION`. For further information on using these selective entity groupings, please see our documentation on [Customizing Detection](/configuration-and-operations/entity-detection-and-redaction/customizing-detection), as well as our [Supported Entity Types](/entities/supported-entity-types) for details on which entity types are included in each set.