{"pageModel":{"attributes":{"id":"","name":"105466.dita","viewName":"DitaDetail"},"elements":{"ditaContent":{"name":"DITAContent","value":"
\r\n

Manage AI Applications

\r\n
\r\n
\r\n

\r\nAdd Application\r\n

\r\n

To get started with protecting or validating an AI application with AI Defense, you'll need to use the Add Application command to save a connection to the AI application or model endpoint. You can select:

\r\n
    \r\n
  • \r\n

    \r\nGateway: An AI Defense Gateway acts as an intermediary to manage, monitor, and protect AI interactions. The gateway acts as a filter and security checkpoint for all AI traffic, ensuring safe and compliant operations.

    \r\n
    • \r\n
  • \r\n

    \r\nAPI: An API connection allows your AI application to call the AI Defense Inspection API to enforce AI Defense runtime policies and rules.

    \r\n
    • \r\n
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n\r\n
 		\r\n
\r\n

When creating an application, you will need to select a Connection type, which refers to the enforcement mechanism for your guardrail policies. For more information, see the Connection Guide below.

\r\n
\r\n
\r\n

To add an application to AI Defense:

\r\n
    \r\n
  1. \r\n

    Click Applications on the left navigation pane. Click Add application button on the right top corner of the page.

    \r\n
    2. \r\n
  2. \r\n

    On the Add Application dialog box, enter the Name for the application, Connection type (API or Gateway) and Description you would like to map.

    \r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
    \r\n\r\n
         		\r\n
    \r\n

    The Description is optional, you can add details if required.

    \r\n
    \r\n
    \r\n
    3. \r\n
  3. \r\n

    Click Continue and proceed to the appropriate section below: Add API Connection or Add Gateway Connection.

    \r\n
    4. \r\n
\r\n
\r\n
\r\n

Add API Connection

\r\n
\r\n

The steps below must be done in an API-style application. If you don't have an application, create one as explained in Add Application, above.

\r\n
    \r\n
  1. \r\n

    The application is created and now you can add a connection. Click Add Connection on the right top corner of the Applications page.

    \r\n
    2. \r\n
  2. \r\n

    In the Add connection pane, enter connection name, click Add connection.

    \r\n
    3. \r\n
  3. \r\n

    Generate an AI Defense Inspection API key by clicking Add API Key.\r\n

    \r\n
    4. \r\n
  4. \r\n

    In the Add API Key pane, enter the API key name , select expiration date and click Generate API key.

    \r\n
    5. \r\n
  5. \r\n

    Once the key is generated, make a note of the API key, and click Add API Key.

    \r\n
    6. \r\n
\r\n

The application is added with a connection and API key. Use the API key to connect to the AI Defense Inspection API as explained in the Inspection API documentation.

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n\r\n
 		\r\n
\r\n

\r\nWarning! Your Inspection API key is valid only for the AI Defense Inspection API and cannot be used with the AI Defense Management API. To generate a Management API key, see \"Generate an API Key for the Management API\" in the API Keys and URLs section.

\r\n
\r\n
\r\n
\r\n
\r\n
\r\n

Add Gateway Connection

\r\n
\r\n

The steps below must be done in a gateway-style application. If you don't have an application, create one now as explained above in Add Application.

\r\n
    \r\n
  1. \r\n

    Add a connection to your application: Click Add Connection on the right top corner of the Applications page.

    \r\n
    2. \r\n
  2. \r\n

    Enter a Connection name.

    \r\n
    3. \r\n
  3. \r\n

    Specify the model endpoint this connection will represent. In the Endpoint dropdown, choose an endpoint name. If no appropriate endpoint is available in the list, see Add Endpoint, below.

    \r\n
    4. \r\n
  4. \r\n

    Click Add connection.

    \r\n
    5. \r\n
\r\n

The application is added with a connection and its API endpoint.

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n\r\n
 		\r\n
\r\n

To use the gateway, you must allowlist the public egress IP address for the AI Defense gateway service, as shown in the \"IP addresses to allowlist\" section in the Set up Runtime for Gateway Interception section.

\r\n
\r\n
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n\r\n
 		\r\n
\r\n

The connection guide provides a cURL command to update the proxy URL, ensuring that all AI interactions are effectively monitored.

\r\n
\r\n
\r\n
\r\n
\r\n
\r\n

\r\nAdd Endpoint\r\n

\r\n

An endpoint represents the model endpoint of the LLM you're protecting with an AI Defense gateway. Defining it here allows AI Defense runtime protection to monitor traffic to and from the model.

\r\n

To add a new endpoint:

\r\n
    \r\n
  1. \r\n

    In the Applications section of AI Defense, add or edit the gateway-style application that represents your AI model.

    \r\n
    2. \r\n
  2. \r\n

    In the application inspection window for your application, in the Gateway connections list, click Add connection.

    \r\n
    3. \r\n
  3. \r\n

    Give your connection a Connection name.

    \r\n
    4. \r\n
  4. \r\n

    Click Add or manage endpoint.

    \r\n
    5. \r\n
  5. \r\n

    In the Add or manage endpoints dialog box, click Add endpoint.

    \r\n
    6. \r\n
  6. \r\n

    In the Add endpoint dialog box:

    \r\n
      \r\n
    1. \r\n

      Select Model provider from the dropdown list.

      \r\n
      2. \r\n
    2. \r\n

      Type the Endpoint domain name, such as https://api.openapi.com.

      \r\n
      3. \r\n
    \r\n
    7. \r\n
  7. \r\n

    Click Save and click Done.

    \r\n
    8. \r\n
\r\n

The endpoint is added, and you can choose it from the Endpoint dropdown in the Add Connection pane. Choose it and click Add connection.

\r\n
\r\n
\r\n

\r\nConnection Guide\r\n

\r\n

You can access the Connection Guide by clicking on the three dots in the same row as the Name of the application.

\r\n

AI Defense provides two primary methods for integrating applications: API Method and Gateway Method. These methods enable developers to seamlessly secure and monitor AI interactions based on organizational requirements.

\r\n

The connection guide provides step-by-step instructions to implement both methods:

\r\n
    \r\n
  • \r\n

    \r\nAPI Method: The connection guide provides only the name of the application and connection. The API key is not visible because it is shown only once, when the key is created. Connect to the AI Defense Inspection API as explained in the Inspection API documentation.

    \r\n
    • \r\n
  • \r\n

    \r\nGateway Method: The guide outlines network or proxy configurations required to route traffic through the AI Gateway, ensuring seamless and secure application integration. The connection guide provides you with all the details of the connection and endpoint. You can edit the cURL code to add to your proxy server.

    \r\n
    • \r\n
\r\n
\r\n
\r\n
\r\n","ditaVal":"","format":"html"},"bookTitle":{"value":""},"shortDescription":{"value":""}}},"parameters":{"appId":"SccAiDefense","topicAlias":"AddApplication"}}