Verifying Knowledge Transformer deployment

After deploying ZAssistantDeploy with Knowledge Transformer enabled, verify that the service is running correctly and configure the zassist CLI to use it.

Before you begin

Procedure

  1. Verify the transform pod is running
    oc get pods -n wxa4z-zad | grep transform
    The expected output is:
    wxa4z-transform-xxxxxxxxxx-xxxxx   1/1     Running   0          2m
    If the pod is not running, check the pod status:
    oc describe pod -n wxa4z-zad -l app=wxa4z-transform
  2. Verify the route was created
    oc get route wxa4z-transform -n wxa4z-zad
    The expected output is:
    NAME              HOST/PORT                                          PATH   SERVICES          PORT   TERMINATION   WILDCARD
    wxa4z-transform   wxa4z-transform-wxa4z-zad.apps.<cluster-domain>          wxa4z-transform   8080   edge          None
  3. Get the Knowledge Transformer API URL
    TRANSFORM_URL=https://$(oc get route wxa4z-transform -n wxa4z-zad -o jsonpath='{.spec.host}')
    echo "Knowledge Transformer URL: $TRANSFORM_URL"
    Save this URL as you will need it to configure the zassist CLI, see Configuring Knowledge Transformer.
  4. Optional: Test the API connection
    curl -k -H "X-API-Key: $TRANSFORM_API_KEY" $TRANSFORM_URL/health
    The expected response is:
    {"status":"healthy"}
    If you receive an authentication error, verify your API key:
    oc get secret transform-secret -n wxa4z-zad -o jsonpath='{.data.TRANSFORM_API_KEY}' | base64 -d
  5. Configure the zassist CLI to use the deployed service
    To set the API URL:
    
    zassist config transform set-url $TRANSFORM_URL
    To set the API key:
    zassist config transform set-api-key $TRANSFORM_API_KEY
    To verify the configuration:
    zassist config transform show
    The expected output is:
    Transform Configuration:
         API URL: https://wxa4z-transform-wxa4z-zad.apps.<cluster-domain>
         API Key: ********** (configured)
         CA Cert: (none)
If the pod is not starting:
  1. Check the pod logs:
    oc logs -n wxa4z-zad -l app=wxa4z-transform --tail=100
  2. Verify secrets exist and contain required keys. Get the transform secret:
    oc get secret transform-secret -n wxa4z-zad -o jsonpath='{.data}' | jq 'keys'
    Check watsonx credentials:
    oc get secret wxa4z-ifm-credentials -n wxa4z-zad -o jsonpath='{.data}' | jq 'keys'
  3. Verify the watsonx credentials secret contains all the required keys:
    • MODEL_RUNTIME
    • LLM_BASE_URL
    • LLM_API_KEY
    • WATSONX_MODEL_ID
    • WATSONX_PROJECT_ID
If API requests fail with authentication errors:
  1. Verify the API key matches the secret:
    echo $TRANSFORM_API_KEY
       oc get secret transform-secret -n wxa4z-zad -o jsonpath='{.data.TRANSFORM_API_KEY}' | base64 -d
  2. Reconfigure the zassist CLI with the correct API key:
    zassist config transform set-api-key <correct-api-key>

What to do next

You can now use Knowledge Transformer to transform documents. See Technical preview: Knowledge Transformer to learn more about Knowledge Transformer, or see Using Knowledge Transformer to start using it.