Configuring Knowledge Transformer

Edit online

Configure Knowledge Transformer by using zassist to set the API URL and authentication credentials, and selecting your preferred LLM.

You must also configure the API connection and select the LLM that Knowledge Transformer uses to process your documents.

Ensure that you have Knowledge Transformer enabled (see Enabling Knowledge Transformer), and that you have zassist installed (see Installing zassist). You can use the zassist config transform command to set an API URL, API keys, and set the CA certificates, for persistence across sessions. Setting the API URL is optional because a default is provided. However, configuring API key authentication is required for secured deployments.

Select the LLM that Knowledge Transformer uses to process your documents. You can choose from watsonx models or any LLM with an OpenAI-compatible API endpoint. Results generated by Knowledge Transformer might vary between different LLM models.

Get the API URL

If Knowledge Transformer is deployed in your cluster, get the API URL:

TRANSFORM_URL=https://$(oc get route wxa4z-transform -n wxa4z-zad -o jsonpath='{.spec.host}')
echo $TRANSFORM_URL

Use this URL when configuring the zassist CLI in the following sections.

Note: If you are using a local development instance of Knowledge Transformer, the default URL is http://localhost:8000/.

Set the API URL

An API URL can be set for persistence across sessions. You can set the API URL by using the zassist config transform command, for example:

zassist config transform set-url [api-url]

This command will save the API URL to the config file located in ~/.zassist/config.json, and will take effect immediately. The default API URL is http://localhost:8000/.

You can also override the configured URL by using an environment variable, for example:

export TRANSFORM_API_URL="http://localhost:8000"

Set an API key

For secured deployments, an API key must be provided to authenticate all requests for Knowledge Transformer. For more information on how to create the API key, see Knowledge Transformer Secret.

You can configure an API key by using the zassist config transform command, for example:

zassist config transform set-api-key [api-key]

The Knowledge Transformer CLI also supports API key authentication via the TRANSFORM_API_KEY environment variable. You can also manually set this by using an environment variable override, for example:

export TRANSFORM_API_KEY="api-key"

To delete the API key, use the delete-api-key command:

zassist config transform delete-api-key

Set Trusted CA Certificates

If the API certificate chains to an internal or private ICA and your operating system does not trust it by default, configure a PEM bundle with one or more CA certificates:

zassist config transform set-ca-cert /path/to/org-ca-bundle.pem

The CLI will continue to use your OS trust store and will add the certificates from this PEM bundle.

Note: If you want to skip the server certificate verification, use the command export WXA4Z_TLS_VERIFY=false.

View current configuration

The API URL and CA certificate bundles are saved to a config file, located in ~/.zassist/config.json.

To view the current configuration of your Knowledge Transformer setup, use:

zassist config transform show

The API key is stored in the OS credential store or can be read from the environment variable TRANSFORM_API_KEY.