Manage Model connections (Automation Admin)

Connect to a curated list of foundational models from hyperscaler vendors such as Amazon Bedrock, Google Vertex AI, Azure OpenAI, OpenAI and others to integrate the power of generative AI into your automations.

The Automation Admin creates and tests Model connections by connecting to foundational models and makes these connections available to the Pro Developers, who would connect to these when creating Prompt Templates. The Model connections are used in Prompt Templates to send prompts and receive responses from the models.

Additionally, the Automation Admin creates custom roles and assigns these Model connections to the custom roles. These custom roles are then assigned to users who would be able to access the Model connections.

Follow these steps to create a Model connection.

Prerequisites

The Automation Admin requires these roles and permissions to create and manage Model connections for their business organization.
  • Role: AAE_Basic, Automation Admin custom role
  • Permission: Attended Bot Runner

See Roles and permissions for AI Tools for the Automation Admin custom role permissions.

Other requirements:
  • If you want to store authentication details in a credential vault, have that information handy. See Secure credential store through Credential Vault.
  • To test a Model connection, you must be connected to a Bot Agent (v22.60.10 and above). As part of the test, you would have to run the bot on your desktop. Hence ensure the Bot Agent is configured to your user. For this task, if you have to switch connection to a different Control Room, see: Switch device registration between Control Room instances.
  • You would need access to the Recorder package and the Generative AI Prompt Template package to test the connection successfully. A test Prompt would be executed to test the Model connection.

Procedure

  1. In your Control Room environment, navigate to Manage > Model Connections and click Create model connection.
  2. In the Create model connection screen you would configure these Connection settings:
    Create Model connections
    • Connection settings:
      • Model connection name: Provide a connection name.
      • Description (optional): Add a meaningful short description defining the connection.
      • Choose a vendor: Choose a foundational model vendor from the supported list of vendors. Currently we support Amazon Bedrock, Google Vertex AI, Azure OpenAI, OpenAI and other models.
      • After you select a model from the drop-down list, the Choose a model field displays. Select from the list of available models.
      • After you complete entering values for all parameters for the Connection settings section, click Next to move to the Authentication details section.
    • Authentication details:
      The authentication detail parameters vary based on the model you choose when defining the connection.
      Note: For authentication details for each model see: Authenticate Model connections.

      After setting up the authentication details, Confirm and click Next to proceed to the Test connection section to test the Model connection.

    • Test connection:
      • Click Test connection to make sure all connection details have been defined correctly and check if the connection is working.
      • If the connection works as expected, the system will process the request and you will get a system generated success message.
      • If the connection does not work as expected, you will get a system-generated message stating the reason for the connection failure. For example, if you have not downloaded the supported foundational model package to your workspace, you would get an error message. You would have to download the package and then retest the Model connection.
      • If the testing of a Model connection is unsuccessful or if you leave the task incomplete, the Model connection will not get saved and you will have to restart the process of creating the Model connection.
      • Click Next to begin adding the custom roles to users.
    • Invite roles:
      • In this phase, the Automation Admin would begin assigning custom roles to users.

        Assign custom role to users

        Note: The Automation Admin would create custom roles and assign the Model connections to the role, which can then be assigned to users. Only users assigned to this custom role can use this Model connection.
      • After assigning the roles, click Create model connection to complete creating the Model connection.
    Model connection is a success
  3. You will get a system-generated success message stating that your Model connection was created. You will get directed to the Model connections screen displaying a list of Model connections.
  4. You can View connection, Edit connection, Change status or Delete each connection by clicking on the ellipses next to them.
    Model connection actions
    Actions Function
    View connection

    Connection details gives you a summary-view of the model.

    General details displays when the connection was last modified and by whom.

    The Automation Admin can edit the Model connection from this view.
    Change status
    A Model connection gets created with the Available status. The Automation Admin can change the status of a Model connection to any of the following:
    • Available: Model connection can be used to create new Prompt Templates and run existing ones.
    • Limited Access: Model connection is available for running existing Prompt Templates, but you cannot add this to new ones.
    • Disabled: New Prompt Templates cannot be created using these Model connections. All existing automation executions using these Model connections will fail.
    Edit connection Lets you edit the Model connection details.
    The Edit button is enabled for the Automation Admin only.
    Note: Users, such as the Pro Developer, and Citizen Developer, with the Model connections > View Model connections permission, would be able to see details of the Model connection but not edit it.
    Delete

    Clicking on Delete displays a message asking for your confirmation and then deletes the Model connection. You will get a message confirming the deletion.

    If you delete a Model connection, all Prompt Templates referencing the deleted Model connection will fail to connect to the foundational model, which would cause all automations, using the Prompt Templates to fail execution.

    The Delete button is enabled for the Automation Admin only.
    Note: Users, such as the Pro Developer, and Citizen Developer, with the Model connections > View Model connections permission, would be able to see details of the Model connection but not delete it.

Next steps

After creating and testing the Model connection, you would assign it to the Pro Developers, who would use this connection to create Prompt Templates. See Create Prompt Templates (Pro Developer)
Note:

When you create, test, edit or delete a Model connection, the success or failure details of the actions are captured as logs and can be viewed in Administration > Audit log, and Administration > AI governance.

See AI governance.