Command-line interface reference

Edit online

Complete reference for Knowledge Transformer command-line interface, including syntax, arguments, options, and examples.

Before you begin

Knowledge Transformer can be accessed via zassist in the command-line interface (CLI). Before using the Knowledge Transformer, ensure you have:

Transform documents

Description
The transform (or t) command creates a context blob (ZIP file) with your input documents and existing taxonomy, processes this, and extracts the updated taxonomy.
Syntax
zassist transform [input-file-or-dir] [knowledge-dir]
zassist t [input-file-or-dir] [knowledge-dir]
Arguments
  • [input-file-or-dir]: Single file or name of directory containing files to be processed
  • [knowledge-dir]: Directory containing existing taxonomy
Options
  • --output [output-dir] (or -o [output-dir]) where [output-dir] is the output directory. If no output directory is specified, a directory named output is created in the current working directory.
Examples

Transform a single document into a new taxonomy:

zassist transform document.vtt

Transform a single document using an existing taxonomy:

zassist transform document.vtt ./knowledge

Transform a directory using an existing taxonomy with a custom output location:

zassist transform ./docs ./knowledge --output ./results

Transform a single document using an existing taxonomy with a custom output location:

zassist transform file.pdf ./taxonomy -o ./output

Configure the Knowledge Transformer

Description
The config command enables you to set your API URL and API key for persistence across sessions.
Syntax
zassist config transform
Arguments
  • [api-url]: The API URL, for example http://localhost:8000/
  • [api-key]: The API key.
  • [ca-cert-file]: The file containing one or more CA Certificates.
Configuration commands
  • set-url [api-url] to set the API URL.
  • set-api-key [api-key] to configure the API key for authentication.
  • delete-api-key to delete the API key.
  • set-ca-cert to set the certificate.
  • show to display the current API URL and API key status.
Examples

Set API URL:

zassist config transform set-url http://localhost:8080

Set API key:

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

Show current configuration:

zassist config show

View the CLI version

Description
Shows the version of the CLI.
Syntax
zassist version

Getting help

Description
Displays help information for CLI commands.
Syntax
zassist --help
Examples

Show help information for transform:

zassist transform --help

Show help information for config:

zassist config --help

For further help with troubleshooting, see Troubleshooting Knowledge Transformer.