Setting access parameters for Natural Language Understanding

To connect to a model, you must set the access parameters. You set the access parameters as part of configuring a model on the Access Parameters section of the Model access page.

For more information about configuring models, see Setting up a connection to your model.

Procedure

Enter the following information in the Access Parameters section:
  1. Authentication URL

    Change this URL only if your organization is using a proxy. Only pass-through proxies are supported.

  2. API Key

    Copy the API key that you obtained from the model information in IBM® Cloud and paste it into API Key.

  3. Base Deployment URL

    Copy the URL that you obtained from the model information in IBM Cloud and paste it into Base Deployment URL.

  4. API Version

    Enter the API version of the Watson service type. To get the version, go to https://cloud.ibm.com/apidocs/natural-language-understanding#versioning.

  5. If you selected Natural Language Understanding on Cloud as the Watson service type, enter a Configuration string that specifies the Natural Language Understanding on Cloud text analytics feature to be used.

    For example,

    • If you want to use the Summarization feature to return a summary consisting of 2 sentences, specify the following configuration string:
      {
          "summarization": {
            "limit": 2
          }
        }

      For more information, see Summarization.

    • If you want to use the Entities feature to return a maximum of 10 entities from a custom model with the ID 1a553122-bc7a-439b-9561-33625e4cef34, specify the following configuration string:
      {
        "entities": {
          "limit": 10,
          "model": "1a553122-bc7a-439b-9561-33625e4cef34"
        }
      }

      For more information, see Entities.