Setting up a connection to your model

Set up a connection between OpenPages® and your model hosting instance. Get the credentials and other model details from IBM Cloud®, and then use them to configure your model in OpenPages.

Before you begin

Create the model in IBM Watson® Machine Learning on IBM Cloud. For more information, see the IBM Watson Machine Learning documentation.

Procedure

  1. Log in to IBM Watson Machine Learning.
  2. To get an IBM Cloud API Key, go to the menu, click IAM > API keys, and generate an API key.
    Figure 1. Generating an API key
    Generating an API key
  3. Click your model and collect the following information:
    • Base Deployment URL

      Click your model. Click the API Reference tab. The Base Deployment URL is at the beginning of the Endpoint URL.

      Endpoint with Base Deployment URL highlighted.
    • Deployment ID

      The Deployment ID is in the Endpoint URL following /deployments and preceding /predictions.

      Endpoint with the Deployment ID highlighted.
    • Space ID

      The Space ID is the part of the model URL in your browser’s address bar that follows &space_id=.

      Browser address bar with the Space ID highlighted.
  4. Click Administration menu > Integrations > Custom Machine Learning Models.
  5. Click New Model.
    Model name and description properties
  6. Enter the following information:
    1. Name

      Enter the name of the model that OpenPages users see in views.

    2. Description

      Enter the description of the model.

      This description is not displayed in views. It is only visible in the model configuration page.

    3. Watson Service Type

      Select the service type that you want to use.

  7. If you select Watson Machine Learning on Cloud, the properties for Watson Machine Learning on Cloud are displayed:
    Watson Machine Learning service type, Authentication URL and API Key properties
    Watson Machine Learning access parameters

    Enter the following information:

    1. Authentication URL

      Change this URL only if your organization is using a proxy.

      If you're using a proxy, enter the proxy URL for IAM on IBM Cloud.

    2. API Key

      Enter your IBM Cloud API key.

    3. Base Deployment URL

      Enter the baseline deployment ID of your model.

    4. Deployment ID

      Enter the deployment ID of your model.

    5. Space ID

      Enter the space ID of your model.

    6. API Version

      Enter the Watson™ Machine Learning API version.

  8. If you selected Natural Language Understanding on Cloud, the properties for Natural Language Understanding on Cloud are displayed:
    Natural Language Understanding service type, Authentication URL and API Key properties
    Natural Language Understanding access parameters

    Enter the following information:

    1. Authentication URL

      Change this URL only if your organization is using a proxy.

      If you're using a proxy, enter the proxy URL for IAM on IBM Cloud.

    2. API Key

      Enter the API key of the Natural Language Understanding instance.

    3. Base Deployment URL

      Enter your service URL. It is the URL to the Natural Language Understanding service on IBM Cloud.

    4. Model id

      Enter the identifier of the Natural Language Understanding classifier model. Contact the person who trained the classifier model to get the Model id.

    5. API Version

      Enter the Natural Language Understanding API version.

  9. Click Test Connection to verify that OpenPages can connect to your model on IBM Cloud.
  10. Click Next and continue with Configuring model inputs.