Vianai Command Line Interface (vianctl) Reference

Command Line Interface for the Vianai Machine Learning Platform

Usage:

$ vianctl [OPTIONS] COMMAND [ARGS]...

Options:

--renew-token / --no-renew-token: Renew authentication token by logging in instead of trying to use the authentication token from the configuration file. Saves new token to configuraiton file. Prompts for user and password if environment variables VIANAI_USER and VIANAI_PASSWORD don't exist. [default: no-renew-token]
--verbose / --no-verbose: [default: no-verbose]
--config-path TEXT: [default: /home/ubuntu/.config/vianai/config]
--auth / --no-auth: Include auth token if appropriate. Most commands send one by default. [default: auth]
--version
--install-completion: Install completion for the current shell.
--show-completion: Show completion for the current shell, to copy it or customize the installation.
--help: Show this message and exit.

Commands:

version: Print version and exit.
agents: Interact with agents in the platform.
apikeys: Interact with the API keys in the platform.
auth: Manage Platform Stack authentication.
cache: Interact with the file cache in the platform.
config: Manage the instances (stacks) of hila…
qnacustomquestions: Interact with the QNA custom questions…
dataloading: Interact with the dataloading in the…
externalconnections: Manage external data source connections on…
featuresets: Interact with feature sets in the platform.
jobs: Interact with jobs in the platform.
load: Run Performance Tests on the platform.
modelstore: Interact with modelstore in the platform.
objpermissions: Manages object permissions in the Vianai…
pipelines: Manage data transformation pipelines on…
projects: Interact with projects in the platform.
qnaconversations: Interact with QNA Conversations in the…
qnaio: Interact with QNA IO in the platform.
qnametadata: Manage and interact with QnA metadata…
qnathreads: Interact with QNA Threads in the platform.
roles: Manages roles in the Vianai platform,…
tools: Interact with tools in the platform.
transformers: Manage feature transformers in the platform
unstructured: Interact with the unstructured files in…
users: Manages users in the Vianai platform,…
userpreferences: Interact with the user preferences in the…
vianai_config: Interact with the vianai configuration…
websockets: Manages websocket connection in the Vianai…

`vianctl version`

Print version and exit.

Usage:

$ vianctl version [OPTIONS]

Options:

--help: Show this message and exit.

`vianctl agents`

Interact with agents in the platform.

Agents are designed to assist with business analytics by leveraging advanced reasoning and tool integration. They can analyze data, generate insights, and perform iterative refinements to support decision-making. This module provides commands to create, update, list, and delete agents, enabling seamless management of their configurations and capabilities.

Key Features:

Create Agents: Define agents with specific goals, instructions, and tools to address business needs.
Update Agents: Modify existing agents to refine their behavior or adapt to new requirements.
List Agents: Retrieve details of all agents or a specific agent by ID.
Delete Agents: Remove agents that are no longer needed.

Usage:

$ vianctl agents [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: Retrieve agents.
create: Create a new agent.
update: Update an existing agent.
delete: Delete an agent.

`vianctl agents list`

Retrieve agents.

Usage:

$ vianctl agents list [OPTIONS]

Options:

-a, --agent-id INTEGER: ID of the topic to regenerate (required)
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl agents create`

Create a new agent.

Usage:

$ vianctl agents create [OPTIONS]

Options:

-n, --name TEXT: Name of the agent (required) [required]
-inst, --instructions TEXT: Detailed instructions for the agent [required]
-g, --goal TEXT: Goal of the agent [required]
-m, --model TEXT: Model to use for the agent (default: gpt-4o)
--reasoning-model TEXT: Reasoning model for the agent
--reasoning-prompt TEXT: Reasoning prompt for the agent
--sys-prompt TEXT: System prompt for the agent
--use-gpt-tool-call: Whether to use GPT tool calls
--parallel-tool-calls: Enable parallel tool calls [default: True]
--summary-model TEXT: Summary model for the agent
-tc, --tool-choice TEXT: Tool choice for the agent
-t, --tools INTEGER: List of tool IDs to associate with the agent
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl agents update`

Update an existing agent.

Usage:

$ vianctl agents update [OPTIONS] AGENT_ID

Arguments:

AGENT_ID: ID of the agent to update [required]

Options:

-n, --name TEXT: Name of the agent
-m, --model TEXT: Model to use for the agent
-i, --instructions TEXT: Detailed instructions for the agent
-g, --goal TEXT: Goal of the agent
--reasoning-model TEXT: Reasoning model for the agent
--reasoning-prompt TEXT: Reasoning prompt for the agent
--sys-prompt TEXT: System prompt for the agent
--use-gpt-tool-call: Whether to use GPT tool calls
--parallel-tool-calls: Enable parallel tool calls
--summary-model TEXT: Summary model for the agent
-tc, --tool-choice TEXT: Tool choice for the agent
-t, --tools INTEGER: List of tool IDs to associate with the agent
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl agents delete`

Delete an agent.

Usage:

$ vianctl agents delete [OPTIONS] AGENT_ID

Arguments:

AGENT_ID: ID of the agent to delete [required]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl apikeys`

Interact with the API keys in the platform.

API keys are unique identifiers used to authenticate and authorize access to the platform's services. They inherit the permissions of the user who created them, ensuring that access is limited to the resources and actions allowed for that user.

Key Features:

Authentication: API keys verify the identity of the client making the request.
Authorization: API keys enforce the same permissions as the user who created them.
Security: API keys can be configured with expiration times to limit their validity and reduce security risks.

Commands:

: Generate a new API key with a specified expiration time.
: Remove an existing API key from the platform.

Best Practices:

Use descriptive names for API keys to easily identify their purpose.
Set appropriate expiration times to minimize security risks.
Regularly review and delete unused or expired API keys.

Usage:

$ vianctl apikeys [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

create: Create API key.
delete: Update an existing tool.

`vianctl apikeys create`

Create API key.

Usage:

$ vianctl apikeys create [OPTIONS]

Options:

-n, --name TEXT: Name of API key [required]
-a, --amount TEXT: Amount in relation to the time unit for API key expire time generation [required]
-u, --unit TEXT: The time unit for API Key expire time generation. Acceptable values are: 'seconds', 'minutes', 'hours', 'days', 'weeks' [required]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl apikeys delete`

Update an existing tool.

Usage:

$ vianctl apikeys delete [OPTIONS]

Options:

-k, --api-key TEXT: API key to delete
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl auth`

Manage Platform Stack authentication.

Usage:

$ vianctl auth [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

login: Obtain authentication token and save to…
logout: Delete authentication token from the…
invalidate: Set a bad value for the authentication token.
check: Check if authentication token works.
checkassert: Check if authentication works and return…
setapikey: Set the API key for authentication.
setaccesstoken: Set the access token for authentication.

`vianctl auth login`

Obtain authentication token and save to the configuration file.

Interactively asks for a username and password.

Usage:

$ vianctl auth login [OPTIONS]

Options:

--prompt-user / --no-prompt-user: Force prompt for username and password. Otherwise, will only prompt if one of the environment variables VIANAI_USER or VIANAI_PASSWORD is not set. [default: no-prompt-user]
--print-token / --no-print-token: Print the access token on success [default: no-print-token]
--help: Show this message and exit.

`vianctl auth logout`

Delete authentication token from the configuration file.

Usage:

$ vianctl auth logout [OPTIONS]

Options:

--help: Show this message and exit.

`vianctl auth invalidate`

Set a bad value for the authentication token. Useful for testing.

Usage:

$ vianctl auth invalidate [OPTIONS]

Options:

--help: Show this message and exit.

`vianctl auth check`

Check if authentication token works.

Usage:

$ vianctl auth check [OPTIONS]

Options:

--help: Show this message and exit.

`vianctl auth checkassert`

Check if authentication works and return an error if it doesn't.

Usage:

$ vianctl auth checkassert [OPTIONS]

Options:

--help: Show this message and exit.

`vianctl auth setapikey`

Set the API key for authentication.

Usage:

$ vianctl auth setapikey [OPTIONS] API_KEY

Arguments:

API_KEY: API key to set [required]

Options:

--help: Show this message and exit.

`vianctl auth setaccesstoken`

Set the access token for authentication.

Usage:

$ vianctl auth setaccesstoken [OPTIONS] ACCESS_TOKEN

Arguments:

ACCESS_TOKEN: Access token to set [required]

Options:

--help: Show this message and exit.

`vianctl cache`

Interact with the file cache in the platform.

Usage:

$ vianctl cache [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

upload: Documentation for upload.
download
raw: Upload are raw file to stack PVC.

`vianctl cache upload`

Documentation for upload.

Usage:

$ vianctl cache upload [OPTIONS] FILEPATH

Arguments:

FILEPATH: [required]

Options:

--help: Show this message and exit.

`vianctl cache download`

Usage:

$ vianctl cache download [OPTIONS] UPLOADKEY OUTPUT_PATH

Arguments:

UPLOADKEY: [required]
OUTPUT_PATH: [required]

Options:

--help: Show this message and exit.

`vianctl cache raw`

Upload are raw file to stack PVC.

Usage:

$ vianctl cache raw [OPTIONS] DESTINATION FILEPATH

Arguments:

DESTINATION: [required]
FILEPATH: [required]

Options:

--help: Show this message and exit.

`vianctl config`

Manage the instances (stacks) of hila Conversational Analytics to interact with through the CLI. You can add a stack, delete a stack, choose a stack, get the current stack, as well as other stack-related actions.

Usage:

$ vianctl config [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

get-stacks
use-stack
current-stack
get-path
delete-stack
add-stack

`vianctl config get-stacks`

Usage:

$ vianctl config get-stacks [OPTIONS]

Options:

--help: Show this message and exit.

`vianctl config use-stack`

Usage:

$ vianctl config use-stack [OPTIONS] STACK_NAME

Arguments:

STACK_NAME: [required]

Options:

--force: Force add even if health check fails.
--help: Show this message and exit.

`vianctl config current-stack`

Usage:

$ vianctl config current-stack [OPTIONS]

Options:

--help: Show this message and exit.

`vianctl config get-path`

Usage:

$ vianctl config get-path [OPTIONS]

Options:

--help: Show this message and exit.

`vianctl config delete-stack`

Usage:

$ vianctl config delete-stack [OPTIONS] NAME

Arguments:

NAME: [required]

Options:

--help: Show this message and exit.

`vianctl config add-stack`

Usage:

$ vianctl config add-stack [OPTIONS] NAME WEBSERVICES_URL

Arguments:

NAME: [required]
WEBSERVICES_URL: [required]

Options:

--force: Force add even if health check fails.
--help: Show this message and exit.

`vianctl qnacustomquestions`

Interact with the QNA custom questions feature in the platform.

Usage:

$ vianctl qnacustomquestions [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

create: Create Custom Question.
clone: Clone Custom Question.
list: List Custom Questions
update: Update Custom Question.
delete: Delete Custom Questions.

`vianctl qnacustomquestions create`

Create Custom Question.

Usage:

$ vianctl qnacustomquestions create [OPTIONS]

Options:

-q, --question TEXT: Question [required]
-s, --sql TEXT: SQL [required]
-c, --certainty TEXT: Certainty [default: unknown]
-qm, --qna-metadata-uuid TEXT: UUID of QNA Metadata [required]
-d, --definition TEXT: Definition
-sq, --suggested-questions TEXT: List of suggested questions (List of JSON strings)
-m, --metrics TEXT: Metrics for the custom question (JSON string)
-st, --status TEXT: Status [default: draft]
-src, --sources TEXT: List of data sources. e.g. qna_metadata:UUID, model:UUID, RAG:name
-qi, --qna-io-uuid TEXT: UUID of the QNA IO
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnacustomquestions clone`

Clone Custom Question.

Usage:

$ vianctl qnacustomquestions clone [OPTIONS]

Options:

-u, --uuid TEXT: UUID of the custom question to clone [required]
-qm, --qna-metadata-uuid TEXT: UUID of QNA Metadata
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnacustomquestions list`

List Custom Questions

Usage:

$ vianctl qnacustomquestions list [OPTIONS]

Options:

-p, --page INTEGER: Page number for pagination [default: 1]
-ps, --page-size INTEGER: Number of items per page [default: -1]
-s, --search TEXT: Search term to filter custom questions
-of, --order-field TEXT: Field to order the results by
-od, --order-direction TEXT: Direction to order the results (ASC/DESC)
-f, --filters TEXT: Filters to apply for listing custom questions (JSON string) [default: {}]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnacustomquestions update`

Update Custom Question.

Usage:

$ vianctl qnacustomquestions update [OPTIONS]

Options:

-f, --filters TEXT: Specifies different condition(s) for filtering the questions to update (JSON string) [required]
-d, --definition TEXT: Definition
-s, --sql TEXT: SQL
-sq, --suggested-questions TEXT: List of suggested questions (List of JSON strings)
-m, --metrics TEXT: Metrics for the custom question (JSON string)
-c, --certainty TEXT: Certainty
-st, --status TEXT: Status
-src, --sources TEXT: List of sources
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnacustomquestions delete`

Delete Custom Questions.

Usage:

$ vianctl qnacustomquestions delete [OPTIONS]

Options:

-f, --filters TEXT: Specifies different condition(s) for filtering custom questions to delete (JSON string) [required]
-d, --delete-type TEXT: Type of delete operation. Can only be 'archive', 'delete', or 'force_delete'. [default: archive]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl dataloading`

Interact with the dataloading in the platform.

Usage:

$ vianctl dataloading [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

upload: Upload files from a directory and submit…
cancel
status

`vianctl dataloading upload`

Upload files from a directory and submit data loading jobs.

This command reads files from the specified directory and submits data loading jobs using the upload-submit API. For each file, it looks for a corresponding .json file in the same directory to use as the dtypes_list otherwise best guesses will be used.

dtypes json content of the file like:

[{"name": "product_group_number", "value": "object", "samples": [""]}, {"name": "product_group_name", "value": "object", "samples": [""]}]

Usage:

$ vianctl dataloading upload [OPTIONS] SOURCE DB_NAME

Arguments:

SOURCE: file or the directory containing the files to upload. [required]
DB_NAME: Database connection name for the data source. [required]

Options:

--table-structure-name TEXT: Optional table structure name to enforce during data loading.
--overwrite TEXT: Overwrite mode for the data. Options: 'append', 'replace'. [default: replace]
--filetype TEXT: File type of the data. Options: 'parquet', 'csv'. [default: parquet]
--maintain-archives / --no-maintain-archives: Whether to maintain archives of the uploaded files. [default: no-maintain-archives]
--enforce-table-structure / --no-enforce-table-structure: Whether to enforce the table structure during data loading. [default: no-enforce-table-structure]
--tablename TEXT: Optional table name for the data loading job. If not provided, the file name will be used.
--wait / --no-wait: Wait for the job to complete before returning. [default: no-wait]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl dataloading cancel`

Usage:

$ vianctl dataloading cancel [OPTIONS] JOB_ID

Arguments:

JOB_ID: [required]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl dataloading status`

Usage:

$ vianctl dataloading status [OPTIONS] JOB_ID

Arguments:

JOB_ID: [required]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl externalconnections`

Manage external data source connections on the Vianai platform.

External connections define how the platform connects to third-party databases (e.g., MySQL, PostgreSQL, ClickHouse). This CLI provides commands to create, update, inspect, test, and query external data connections.

AVAILABLE COMMANDS: ———————–

list List all configured external connections.

get Retrieve full details of a specific external connection by name.

create Create a new external connection. Requires connection type, URL, and a name.

update Update an existing connection. Supports partial updates (e.g., URL, hidden tables).

delete Delete an external connection by name. Use –force to bypass confirmation.

test Validate credentials and connectivity for an external connection.

get_tables List all tables available through a given external connection.

get_columns List columns (name and type) in a table from an external connection.

query Execute a read-only SQL query on an external data source.

KEY PARAMETERS: ———————–

–name / -n Name of the external connection. (Required for most operations)

–type / -t Type of database (e.g., postgresql, snowflake, mysql).

–url / -u JDBC-style URL or endpoint of the data source.

–description / -d Optional description for the connection.

–hide-tables Comma-separated list of tables to exclude from visibility.

–hide-schemas Comma-separated list of schemas to exclude from visibility.

–hide-views Comma-separated list of views to exclude from visibility.

–output / -o Output format: json

yaml

table.

USAGE EXAMPLES: ———————–

vianctl externalconnection list vianctl externalconnection get -n my_connection vianctl externalconnection create -n my_pg -t postgresql -u jdbc://localhost:5432/mydb -d "Local PG DB" vianctl externalconnection update -n my_pg –description "Updated description" vianctl externalconnection delete -n my_pg –force vianctl externalconnection test -n my_pg vianctl externalconnection get_tables -n my_pg vianctl externalconnection get_columns -n my_pg -t my_table vianctl externalconnection query -n my_pg –query "SELECT * FROM users LIMIT 10"

TIPS: ———————–

• Use --interactive (-i) for guided input prompts (when supported). • Run --help after any subcommand for more details. • Always test new connections using test to verify credentials.

Usage:

$ vianctl externalconnections [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list
get: Get details of an external connection by…
create: Create a new external connection.
update: Update an existing external connection.
delete: Delete an external connection by name.
test: Test connection to an external connection…
get-tables: Get tables from an external connection.
get-columns: Get columns from a specific table in an…
query: Run sql query on an external connection by…

`vianctl externalconnections list`

Usage:

$ vianctl externalconnections list [OPTIONS]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl externalconnections get`

Get details of an external connection by name.

Usage:

$ vianctl externalconnections get [OPTIONS]

Options:

-n, --name TEXT: Name of the external connection [required]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl externalconnections create`

Create a new external connection.

Usage:

$ vianctl externalconnections create [OPTIONS]

Options:

-n, --name TEXT: Name of the external connection [required]
-d, --description TEXT: Description of the external connection [required]
-u, --url TEXT: URL of the external connection [required]
-t, --type TEXT: Type of connection (e.g., mysql, postgresql) [required]
--display: Whether to display the connection [default: True]
--is-rdbms: Whether the connection is a relational database [default: True]
--hide-tables TEXT: List of tables to hide
--hide-schemas TEXT: List of schemas to hide
--hide-views TEXT: List of views to hide
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl externalconnections update`

Update an existing external connection.

Usage:

$ vianctl externalconnections update [OPTIONS]

Options:

-n, --name TEXT: Name of the external connection to update [required]
-d, --description TEXT: Updated description
-u, --url TEXT: Updated URL of the external connection
-t, --type TEXT: Updated type of connection
--display: Whether to display the connection
--is-rdbms: Whether the connection is a relational database
--hide-tables TEXT: Updated list of tables to hide
--hide-schemas TEXT: Updated list of schemas to hide
--hide-views TEXT: Updated list of views to hide
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl externalconnections delete`

Delete an external connection by name.

Usage:

$ vianctl externalconnections delete [OPTIONS]

Options:

-n, --name TEXT: Name of the external connection to delete [required]
-f, --force: Force deletion without confirmation
--help: Show this message and exit.

`vianctl externalconnections test`

Test connection to an external connection by name.

Usage:

$ vianctl externalconnections test [OPTIONS]

Options:

-n, --name TEXT: Name of the external connection to test [required]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl externalconnections get-tables`

Get tables from an external connection.

Usage:

$ vianctl externalconnections get-tables [OPTIONS]

Options:

-n, --name TEXT: Name of the external connection [required]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl externalconnections get-columns`

Get columns from a specific table in an external connection.

Usage:

$ vianctl externalconnections get-columns [OPTIONS]

Options:

-n, --name TEXT: Name of the external connection [required]
-t, --table TEXT: Table name [required]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl externalconnections query`

Run sql query on an external connection by name.

Usage:

$ vianctl externalconnections query [OPTIONS]

Options:

-n, --name TEXT: Name of the external connection to test [required]
--query TEXT: sql query to execute on the external connection [required]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl featuresets`

Interact with feature sets in the platform.

Usage:

$ vianctl featuresets [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List feature sets with optional filtering…
export: Export a feature set in the specified format.
delete: Delete rows from a feature set based on…
raw: Export a feature set in the specified format.

`vianctl featuresets list`

List feature sets with optional filtering by name.

Usage:

$ vianctl featuresets list [OPTIONS]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl featuresets export`

Export a feature set in the specified format.

Usage:

$ vianctl featuresets export [OPTIONS] SETNAME

Arguments:

SETNAME: Name of the feature set to export [required]

Options:

--limit INTEGER: Maximum number of rows to retrieve
--start INTEGER: Starting index for retrieval
--end INTEGER: Ending index for retrieval
--datetime FLOAT: Timestamp to filter features by datetime
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl featuresets delete`

Delete rows from a feature set based on where clause.

Usage:

$ vianctl featuresets delete [OPTIONS] SETNAME WHERE

Arguments:

SETNAME: Name of the feature set to export [required]
WHERE: SQL where clause to filter rows for deletion [required]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl featuresets raw`

Export a feature set in the specified format.

Usage:

$ vianctl featuresets raw [OPTIONS] CONNECTIONNAME TABLENAME SETNAME FILESPATTERN

Arguments:

CONNECTIONNAME: Name of the connection to use create the feature set in [required]
TABLENAME: Name of the table to create [required]
SETNAME: Name of the feature set to create [required]
FILESPATTERN: Pattern for source files to create the feature set [required]

Options:

--columns TEXT: Colums to include in the feature set (default: all columns) [default: *]
--where TEXT: where clause to filter the results for this feature set
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl jobs`

Interact with jobs in the platform.

Usage:

$ vianctl jobs [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

get: Retrieve the status of a specific job.
list: List all jobs.
create: Create a new job.
delete: Delete a specific job.

`vianctl jobs get`

Retrieve the status of a specific job.

Usage:

$ vianctl jobs get [OPTIONS] JOB_ID

Arguments:

JOB_ID: The ID of the job to retrieve [required]

Options:

--wait / --no-wait: Wait for the job to complete before returning [default: no-wait]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl jobs list`

List all jobs.

Usage:

$ vianctl jobs list [OPTIONS]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl jobs create`

Create a new job.

Usage:

$ vianctl jobs create [OPTIONS] JOB_TYPE DATA

Arguments:

JOB_TYPE: The type of job to create [required]
DATA: JSON string containing job data [required]

Options:

--wait / --no-wait: Wait for the job to complete [default: no-wait]
--runtime-object TEXT: The job class to use for the job:kubernetes, knative [default: kubernetes]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl jobs delete`

Delete a specific job.

Usage:

$ vianctl jobs delete [OPTIONS] JOB_ID [RUNTIME_OBJECT]

Arguments:

JOB_ID: The ID of the job to delete [required]
[RUNTIME_OBJECT]: The job class to use for the job:kubernetes, knative [default: kubernetes]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl load`

Run Performance Tests on the platform.

Usage:

$ vianctl load [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

create: Create as set of test users.
delete: Delete as set of test users.
ask: Ask a set of questions for a number of users.

`vianctl load create`

Create as set of test users.

Usage:

$ vianctl load create [OPTIONS]

Options:

--number-users INTEGER: Numer of test users to create [default: 1]
--userfile TEXT: CSV file with user details (username, password, roles)
--user-roles TEXT: List of user roles [default: BusinessAnalyst]
--password TEXT: Password for the test users [default: Welcome@vianai123!]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl load delete`

Delete as set of test users.

Usage:

$ vianctl load delete [OPTIONS]

Options:

--number-users INTEGER: Numer of test users to delete [default: 1]
--userfile TEXT: CSV file with user details (username, password, roles)
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl load ask`

Ask a set of questions for a number of users.

Usage:

$ vianctl load ask [OPTIONS]

Options:

--project-name TEXT: Project Name [default: LLM Project]
--model-name TEXT: Model Name
--metadata TEXT: Metadata name to run the questions against
--questions-file TEXT: CSV file with questions to run
--number-questions INTEGER: Number of questions to run (-1 for all) [default: -1]
--random-questions / --no-random-questions: Run random questions from the list [default: no-random-questions]
--calc-metrics / --no-calc-metrics: Calculate metrics for the questions [default: no-calc-metrics]
--run-id TEXT: Run ID for the test run [default: b6cb18b7-9cf5-4f0e-8e0c-ec25b1bbadfb]
--output-file TEXT: Output file for the test run
--output-featureset TEXT: Output featureset for the test run
--number-users INTEGER: Numer of test users to run questions for [default: 1]
--userfile TEXT: CSV file with user details (username, password, roles)
--password TEXT: Password for the test users [default: Welcome@vianai123!]
--verbose-messaging / --no-verbose-messaging: output verbose information
--debug-messaging / --no-debug-messaging: output debug information
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl modelstore`

Interact with modelstore in the platform.

Provides commands to manage models in the Vianai platform's modelstore.

AVAILABLE COMMANDS:
———————–

list List all available models.
create Create a new model in a project.
update Update an existing model's metadata or status.
delete Delete or archive a model by name.
import Import a model from a file into a project.
export Export a model to a file from a project.
copy Copy a model from one project to another.
ask Query a model with a question or prompt (supports batch from file).

KEY PARAMETERS:
———————–

–project-name Name of the project (default: "LLM Project").
–model-name Name of the model.
–version Model version (default: "version").
–stage Model stage (default: "Model Stage").
–model_status Model status (default: "inactive").
–filters JSON string specifying filter conditions (for update).
–output-format / -o Output format: json | yaml | table.
–delete_type Type of delete: archive | delete (for delete).
–question Question or prompt to ask the model (ask).
–question-file Path to a file with questions for batch querying (ask).

USAGE EXAMPLES:
———————–

vianctl modelstore list
vianctl modelstore create –project-name "My Project" –model-name "mymodel" –version v1
vianctl modelstore update –project-name "My Project" –model-name "mymodel" –filters '{"names": ["mymodel"]}'
vianctl modelstore delete –project-name "My Project" –model-name "mymodel" –delete_type delete
vianctl modelstore import myproject mymodel ./model.pkl
vianctl modelstore export myproject mymodel ./exported_model.pkl
vianctl modelstore copy myproject mymodel srcproject srcmodel
vianctl modelstore ask –project-name "My Project" –model-name "mymodel" –question "What is the capital of France?"
vianctl modelstore ask –project-name "My Project" –model-name "mymodel" –question-file questions.json

TIPS:
———————–

• Use --filters as a JSON string to target specific models for update.
• Use --output-format to control the output style (json, yaml, table).
• Use --question-file to batch query a model with multiple questions (JSON or CSV).
• Run --help after any subcommand for more details.

Usage:

$ vianctl modelstore [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List all available models.
import: Import a model.
export: Export a model.
copy: Copy a model from another project.
update
create: Create a new model.
ask
delete: Delete or archive a model.

`vianctl modelstore list`

List all available models.

Usage:

$ vianctl modelstore list [OPTIONS]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl modelstore import`

Import a model.

Usage:

$ vianctl modelstore import [OPTIONS] PROJECT MODELNAME FILENAME

Arguments:

PROJECT: [required]
MODELNAME: [required]
FILENAME: [required]

Options:

--help: Show this message and exit.

`vianctl modelstore export`

Export a model.

Usage:

$ vianctl modelstore export [OPTIONS] PROJECT MODELNAME FILENAME

Arguments:

PROJECT: [required]
MODELNAME: [required]
FILENAME: [required]

Options:

--help: Show this message and exit.

`vianctl modelstore copy`

Copy a model from another project.

Usage:

$ vianctl modelstore copy [OPTIONS] PROJECT MODELNAME SRC_PROJECT SRC_MODELNAME

Arguments:

PROJECT: [required]
MODELNAME: [required]
SRC_PROJECT: [required]
SRC_MODELNAME: [required]

Options:

--help: Show this message and exit.

`vianctl modelstore update`

Usage:

$ vianctl modelstore update [OPTIONS]

Options:

--project-name TEXT: Project Name [default: LLM Project]
--model-name TEXT: Model Name [required]
--version TEXT: Model Version [default: version]
--stage TEXT: Model Stage [default: Model Stage]
--model_status TEXT: Model Status [default: inactive]
--filters TEXT: JSON string specifying filter condition for update [required]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl modelstore create`

Create a new model.

Usage:

$ vianctl modelstore create [OPTIONS]

Options:

--project-name TEXT: Project Name [default: LLM Project]
--model-name TEXT: Model Name [required]
--version TEXT: Model Version [default: version]
--stage TEXT: Model Stage [default: Model Stage]
--model_status TEXT: Model Status [default: inactive]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl modelstore ask`

Usage:

$ vianctl modelstore ask [OPTIONS]

Options:

--project-name TEXT: Project Name [default: LLM Project]
--project-uuid TEXT: Project uuid.
--model-name TEXT: Model Name
--model-uuid TEXT: Model Name
--question TEXT: Your question or prompt.
-O, --output TEXT: Output format (table, json, csv, yaml)
--question-file TEXT: Path to the question file containing a list of questions to test. Supported formats:
JSON: A list of question objects, e.g., [{"question": "Your question here"}]
CSV: A single column named 'question', e.g., question Your question here Another question here
--help: Show this message and exit.

`vianctl modelstore delete`

Delete or archive a model.

Usage:

$ vianctl modelstore delete [OPTIONS]

Options:

--project-name TEXT: Project Name [default: LLM Project]
--model-name TEXT: Model Name [required]
--delete_type TEXT: archive/delete the model [default: archive]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl objpermissions`

Manages object permissions in the Vianai platform, including listing, creating and deleting object permissions

The list command retrieves all object permissions for username or uncname. If no parameters are provided, it lists the current user's object permissions.

The create and delete commands require parameters like uncname, owner, user role, and permissions. If unsure about parameters, run with –interactive or -i flag.

Usage:

$ vianctl objpermissions [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list
create
delete

`vianctl objpermissions list`

Usage:

$ vianctl objpermissions list [OPTIONS]

Options:

-u, --username TEXT: Username for the user whose object permissions are listed. if not provided will list for current user.
-unc, --uncname TEXT: Uncname for the object permissions to be listed. if not provided will list for all object permissions.
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl objpermissions create`

Usage:

$ vianctl objpermissions create [OPTIONS]

Options:

-unc, --uncname TEXT: Uncname for the object permissions to be created. (required)
-owner, --owner TEXT: owner for for the object permissions to be created. (required)
-r, --role TEXT: user role for the object permissions to be created. (required)
--create: Grant create permission for the object. (optional, default: False)
--read: Grant read permission for the object. (optional, default: False)
--update: Grant update permission for the object. (optional, default: False)
--delete: Grant delete permission for the object. (optional, default: False)
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl objpermissions delete`

Usage:

$ vianctl objpermissions delete [OPTIONS]

Options:

-id, --id TEXT: id object permissions to be deleted. (required)
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl pipelines`

Manage data transformation pipelines on the Vianai platform.

A transformation pipeline defines a configurable series of data preparation steps, enabling tasks such as cleansing, feature engineering, and pre-processing for machine learning workflows.

This CLI supports full lifecycle management of pipelines, including creation, listing, updating, deletion, and inspection.

AVAILABLE COMMANDS: ———————–

list List all transformation pipelines. Supports filters, search mode, and pagination.

get Retrieve one or more pipelines by name, with optional pagination.

create Create a new pipeline by providing metadata and a JSON file defining transformation steps.

update Update an existing pipeline. Only specified fields (e.g., metadata or step file) are modified.

delete Archive or permanently delete a pipeline by name. Use –permanent for hard delete.

KEY PARAMETERS: ———————–

–name / -n Name of the pipeline.

–src-set ID of the source dataset.

–tgt-set ID of the target dataset.

–target-column Name of the target column in the dataset.

–pipeline-file / -f Path to the JSON file describing transformation steps.

–filters JSON string for advanced filtering of pipelines.

–output-format / -o Output format: json

yaml

table.

ADVANCED SEARCH (list command): ——————————-

–search Enable advanced search mode.

–filters JSON-based filters (e.g., {"srcset": 1, "pipelinename": "cleaning"}).

–pipelinename Filter by pipeline name.

–srcset Filter by source dataset ID.

–index Filter by pipeline index.

–page Page number for paginated results.

–size Page size for paginated results.

USAGE EXAMPLES: ———————–

# List all pipelines vianctl pipeline list

# List with full metadata and steps vianctl pipeline list –pipeline

# Search pipelines using filters vianctl pipeline list –search –pipelinename "data-cleaning" –srcset 1

# Create a new pipeline vianctl pipeline create –name "cleaning" –src-set 1 –tgt-set 10
–target-column label –pipeline-file pipeline.json

# Update a pipeline’s description and steps vianctl pipeline update –name "cleaning" –description "v2" –pipeline-file updated.json

# Archive a pipeline vianctl pipeline delete –name "cleaning"

# Permanently delete a pipeline vianctl pipeline delete –name "cleaning" –permanent

NOTES: ———————–

• Define or update transformation logic in a structured JSON file using –pipeline-file. • Use list with --search and filters to preview pipelines before updating or deleting. • All commands support --output-format json|yaml|table for response formatting.

Usage:

$ vianctl pipelines [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: Get data transformation pipelines with…
get: Get data transformation pipelines with…
create: Create a new data transformation pipeline.
update: Update an existing data transformation…
delete: Delete (archive or permanently remove) a…

`vianctl pipelines list`

Get data transformation pipelines with optional filtering and search capabilities.

BASIC USAGE: # List all pipelines vianctl pipeline list

# List all pipelines with detailed pipeline information
vianctl pipeline list --pipeline

SEARCH MODE: # Enable search with specific filters vianctl pipeline list –search –pipelinename pipeline1 –index idx1

# Search with multiple values for the same filter
vianctl pipeline list --search --pipelinename pipeline1 --pipelinename pipeline2

# Search with pagination
vianctl pipeline list --search --page 2 --size 20 --srcset 1

ADVANCED FILTERING: # Use JSON filters for complex queries vianctl pipeline list –search –filters '{"pipelinename": ["pipeline1"], "srcset": [1, 2]}'

OUTPUT FORMATS: # Different output formats vianctl pipeline list –output-format table vianctl pipeline list –output-format json vianctl pipeline list –output-format yaml

EXAMPLES: # Search for pipelines by name and include pipeline details vianctl pipeline list –search –pipeline –pipelinename "data-cleaning" –pipelinename "feature-engineering"

# Filter by source and target sets
vianctl pipeline list --search --srcset 1 --srcset 2 --tgtset 10

# Search with description filter
vianctl pipeline list --search --pipelinedescription &quot;machine learning&quot; --page 1 --size 5

Usage:

$ vianctl pipelines list [OPTIONS]

Options:

-p, --pipeline: Include pipeline details in the output
-O, --output TEXT: Output format (table, json, csv, yaml)
-s, --search: Enable search mode with filtering capabilities
--index TEXT: Filter by index names (can be used multiple times). Example: –index idx1 –index idx2
--pipelinename, --name TEXT: Filter by pipeline names (can be used multiple times). Example: –pipelinename pipeline1 –pipelinename pipeline2
--pipelinedescription, --description TEXT: Filter by pipeline descriptions (can be used multiple times). Example: –pipelinedescription 'data cleaning'
--srcset INTEGER: Filter by source set IDs (can be used multiple times). Example: –srcset 1 –srcset 2
--tgtset INTEGER: Filter by target set IDs (can be used multiple times). Example: –tgtset 10 –tgtset 20
--targetcolumn TEXT: Filter by target column names (can be used multiple times). Example: –targetcolumn col1 –targetcolumn col2
--reference-pipeline INTEGER: Filter by reference pipeline IDs (can be used multiple times). Example: –reference-pipeline 100
--filters TEXT: JSON string containing custom filters. Example: –filters '{"pipelinename": ["pipeline1"], "srcset": [1, 2]}'
--page INTEGER: Page number for paginated results (default: 1) [default: 1]
--size INTEGER: Number of results per page (default: 10) [default: 10]
--help: Show this message and exit.

`vianctl pipelines get`

Get data transformation pipelines with optional filtering by name.

Usage:

$ vianctl pipelines get [OPTIONS]

Options:

-n, --name TEXT: Pipeline name to filter by
-p, --page INTEGER: Page number [default: 1]
-s, --page-size INTEGER: Page size [default: 10]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl pipelines create`

Create a new data transformation pipeline.

Usage:

$ vianctl pipelines create [OPTIONS]

Options:

-n, --name TEXT: Pipeline name [required]
-d, --description TEXT: Pipeline description
--src-set INTEGER: Source dataset ID [required]
--tgt-set INTEGER: Target dataset ID [required]
--target-column TEXT: Target column [required]
-f, --pipeline-file TEXT: JSON file containing pipeline steps [required]
--ref-pipeline INTEGER: Reference pipeline ID
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl pipelines update`

Update an existing data transformation pipeline.

Usage:

$ vianctl pipelines update [OPTIONS]

Options:

-n, --name TEXT: Pipeline name to update [required]
-d, --description TEXT: New pipeline description
--src-set INTEGER: New source dataset ID
--tgt-set INTEGER: New target dataset ID
--target-column TEXT: New target column
-f, --pipeline-file TEXT: JSON file containing new pipeline steps
--ref-pipeline INTEGER: New reference pipeline ID
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl pipelines delete`

Delete (archive or permanently remove) a data transformation pipeline.

Usage:

$ vianctl pipelines delete [OPTIONS]

Options:

-n, --name TEXT: Pipeline name to delete [required]
--permanent: Permanently delete instead of archive
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl projects`

Interact with projects in the platform.

Provides commands to manage projects in the Vianai platform.

AVAILABLE COMMANDS: ———————–

create Create a new project with a name, description, status, and optional parent project. list List projects with pagination, search, ordering, and filtering options. update Update existing projects matching filter criteria. delete Delete (archive, delete, or force delete) projects matching filter criteria.

KEY PARAMETERS: ———————–

–name / -n Name of the project. –description / -d Description of the project. –status / -st Status of the project (e.g., active). –parent-project-uuid / -pp UUID of the parent project. –output-format / -o Output format: json | yaml | table.

–page / -p Page number for pagination (list). –page-size / -ps Number of items per page (list). –search / -s Search term to filter projects (list). –order-field / -of Field to order results by (list). –order-direction / -od Direction to order results: ASC | DESC (list). –filters / -f Filters as a JSON string (list, update, delete).

–delete-type / -d Type of delete: archive

delete

force_delete (delete).

USAGE EXAMPLES: ———————–

vianctl project create -n "My Project" -d "A sample project" -st active vianctl project list –page 1 –page-size 20 –search "finance" vianctl project update -f '{"name": "Old Project"}' –name "New Name" vianctl project delete -f '{"status": "inactive"}' –delete-type delete

TIPS: ———————–

• Use --filters with a JSON string to target specific projects for update or delete. • Use --output-format to control the output style (json, yaml, table). • Run --help after any subcommand for more details.

Usage:

$ vianctl projects [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

create: Create a new project.
list: List projects with filtering options.
update: Update an existing project.
delete: Delete projects with filtering options.

`vianctl projects create`

Create a new project.

Usage:

$ vianctl projects create [OPTIONS]

Options:

-n, --name TEXT: Name of the project [required]
-d, --description TEXT: Description of the project
-st, --status TEXT: Status of the project [default: active]
-pp, --parent-project-uuid TEXT: UUID of the parent project
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl projects list`

List projects with filtering options.

Usage:

$ vianctl projects list [OPTIONS]

Options:

-p, --page INTEGER: Page number for pagination [default: 1]
-ps, --page-size INTEGER: Number of items per page [default: -1]
-s, --search TEXT: Search term to filter custom questions
-of, --order-field TEXT: Field to order the results by
-od, --order-direction TEXT: Direction to order the results (ASC/DESC)
-f, --filters TEXT: Filters to apply for listing projects(JSON string) [default: {}]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl projects update`

Update an existing project.

Usage:

$ vianctl projects update [OPTIONS]

Options:

-f, --filters TEXT: Specifies different condition(s) for filtering the questions to update (JSON string) [required]
-n, --name TEXT: New project name
-d, --description TEXT: New project description
-st, --status TEXT: New project status
-pp, --parent-project-uuid TEXT: New parent project UUID
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl projects delete`

Delete projects with filtering options.

Usage:

$ vianctl projects delete [OPTIONS]

Options:

-f, --filters TEXT: Specifies different condition(s) for filtering custom questions to delete (JSON string) [required]
-d, --delete-type TEXT: Type of delete operation. Can only be 'archive', 'delete', or 'force_delete'. [default: archive]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnaconversations`

Interact with QNA Conversations in the platform.

Usage:

$ vianctl qnaconversations [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List QNA Conversations with advanced…
create: Create a new QNA Conversation.
update: Update an existing QNA Conversation.
delete: Delete QNA Conversations with advanced…

`vianctl qnaconversations list`

List QNA Conversations with advanced filtering options.

Usage:

$ vianctl qnaconversations list [OPTIONS]

Options:

-p, --page INTEGER: Page number for pagination [default: 1]
-ps, --page-size INTEGER: Number of items per page [default: -1]
-s, --search TEXT: Search term to filter QNA conversations
-of, --order-field TEXT: Field to order the results by
-od, --order-direction TEXT: Direction to order the results (ASC/DESC)
-f, --filters TEXT: Filters to apply for listing QNA conversations (JSON string) [default: {}]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnaconversations create`

Create a new QNA Conversation.

Usage:

$ vianctl qnaconversations create [OPTIONS]

Options:

-n, --name TEXT: Name of the QNA Conversation [required]
-d, --description TEXT: Description of the QNA Conversation
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnaconversations update`

Update an existing QNA Conversation.

Usage:

$ vianctl qnaconversations update [OPTIONS]

Options:

-f, --filters TEXT: Specifies different condition(s) for filtering the qna conversations to update (JSON string) [required]
-n, --name TEXT: New name for the QNA Conversation
-d, --description TEXT: New description for the QNA Conversation
-cw, --context-window INTEGER: New context window for the QNA Conversation
-fv, --feedback-value: New feedback value for the QNA Conversation
-fc, --feedback-comment TEXT: New feedback comment for the QNA Conversation
-st, --status TEXT: New status for the QNA Conversation
-un, --user-name TEXT: New user name associated with the QNA Conversation
-ip, --is-pinned: Flag to pin the QNA Conversation
-if, --is-favorite: Flag to mark the QNA Conversation as favorite
-ir, --is-report: Flag to mark the QNA Conversation as a report
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnaconversations delete`

Delete QNA Conversations with advanced filtering options.

Usage:

$ vianctl qnaconversations delete [OPTIONS]

Options:

-f, --filters TEXT: Specifies different condition(s) for filtering qna conversations to delete (JSON string) [required]
-dt, --delete-type TEXT: Deletion type: archive, delete, or force_delete [default: archive]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnaio`

Interact with QNA IO in the platform.

Usage:

$ vianctl qnaio [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List QNA IO with parameters filtering…
create: Create a new QNA IO with optional parameters.
update: Update an existing QNA IO.
delete: Delete QNA IO with advanced filtering…

`vianctl qnaio list`

List QNA IO with parameters filtering options.

Usage:

$ vianctl qnaio list [OPTIONS]

Options:

--uuid TEXT: Filter QNA IO by UUID
--qna-conversation-uuid TEXT: Filter QNA IO Entry by QNA Conversation UUIDs
--qna-thread-uuid TEXT: Filter QNA IO Entry by QNA thread UUIDs
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnaio create`

Create a new QNA IO with optional parameters.

Usage:

$ vianctl qnaio create [OPTIONS] METADATA_UUID

Arguments:

METADATA_UUID: UUID of metadata [required]

Options:

--uuid UUID: UUID of the QNA IO
--user-input TEXT: User input for the QNA IO [required]
--query-type TEXT: Query type (e.g., text2sql) [required]
--llm-prompt TEXT: LLM prompt for QNA IO [default: n/a]
--raw-output TEXT: Raw output JSON string from LLM [required]
--final-output TEXT: Final output as JSON string [default: {}]
--status TEXT: Status of the QNA IO [default: active]
--derived-features TEXT: Derived features as JSON string [default: {}]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnaio update`

Update an existing QNA IO.

Usage:

$ vianctl qnaio update [OPTIONS]

Options:

--uuid-filter TEXT: List of UUIDs for the QNA IO to filter
--created-by-filter TEXT: List of created_by for this operation.
--metadata-uuid-filter TEXT: List of metadata_uuid for this operation
--high-confidence-status-filter TEXT: List Source for qnaio
--query-type-filter TEXT: List of query_types
--qna-conversation-uuid-filter TEXT: List of conversation ids.
--qna-thread-uuid-filter TEXT: List of thread ids.
--transaction-uuid-filter TEXT: List of transaction ids.
--service-filter TEXT: List of services
--uuid TEXT: New UUID for the QNA IO
--qna-conversation-uuid TEXT: New QNA Conversation UUID for the QNA IO
--qna-thread-uuid TEXT: New QNA Thread UUID for the QNA IO
--query-type TEXT: New QNA Type UUID for the QNA IO
--feedback-value / --no-feedback-value: New feedback value for the QNA IO
--feedback-comment TEXT: New feedback comment for the QNA IO
--status TEXT: New status for the QNA IO
--is-pinned / --no-is-pinned: Flag to pin the QNA IO
--is-favorite / --no-is-favorite: Flag to mark the QNA IO as favorite
--flag-followup / --no-flag-followup: Flag to indicate if the query is a followup query
--service TEXT: List of new services for QNA IO
--help: Show this message and exit.

`vianctl qnaio delete`

Delete QNA IO with advanced filtering options.

Usage:

$ vianctl qnaio delete [OPTIONS]

Options:

--uuid TEXT: List of UUIDs for the QNA IO to delete
--qna-conversation-uuid TEXT: List of QNA Conversation UUIDs for the QNA IO to delete
--qna-thread-uuid TEXT: List of QNA Conversation UUIDs for the QNA IO to delete
--feedback-value / --no-feedback-value: Feedback value for the QNA IO to delete
--feedback-comment TEXT: List of feedback comments for the QNA IO to delete
--status TEXT: List of statuses for the QNA IO to delete
--is-pinned / --no-is-pinned: Flag to filter pinned QNA IO for deletion
--is-favorite / --no-is-favorite: Flag to filter favorite QNA IO for deletion
--query-type TEXT: List of Query Type types for the QNA IO to delete
--created-by TEXT: List of 'created by' users to filter QNA IO for deletion
--modified-by TEXT: List of 'modified by' users to filter QNA IO for deletion
--created-ts FLOAT: Start timestamp for filtering QNA IO created
--modified-ts FLOAT: Start timestamp for filtering QNA IO modified
--deletetype TEXT: Deletion type: archive, delete, or force_delete [default: archive]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnametadata`

Manage and interact with QnA metadata configurations on the Vianai platform.

QnA metadata defines the structure and behavior of conversational analytics over structured data. This CLI enables creation, generation, querying, and maintenance of metadata objects.

AVAILABLE COMMANDS: ———————–

list List all QnA metadata entries. Supports filtering and pagination.

create Create metadata using input fields or a JSON configuration file.

create-db Create a logical database configuration for storing QnA metadata.

generate Auto-generate metadata from schema and table definitions.

update Update fields in existing metadata using filters or a file.

clone Clone an existing metadata object with optional field overrides.

migrate-db Migrate metadata storage to a different database configuration.

delete Delete or archive QnA metadata by name or UUID.

ask Query the QnA system interactively or in batch mode using a metadata name.

KEY PARAMETERS: ———————–

–name Name of the QnA metadata object.

–file Path to a JSON file containing metadata configuration or update data.

–project-name Filter metadata entries by project name.

–update-fields JSON string with fields to override during cloning.

–filters JSON string defining filters for update/delete operations.

–deletetype Mode for delete operation: delete

archive.

–output / -o Output format: json

yaml

table.

USAGE EXAMPLES: ———————–

vianctl qnametadata list –project-name "Retail Project" –page 1 –page-size 50 vianctl qnametadata create –file ./configs/qna_metadata.json vianctl qnametadata generate –name my_metadata –external-connection-name my_conn –data '{"tables": […]}' vianctl qnametadata ask –metadata my_metadata –interactive vianctl qnametadata clone –base-metadata old_metadata –update-fields '{"name": "new_name", "db_name": "db_new"}' vianctl qnametadata update –filters '{"name": ["metadata_to_update"]}' –data '{"description": "Updated desc"}' vianctl qnametadata delete –names "old_metadata_name" –deletetype archive

NOTES: ———————–

• Use --file to provide complex JSON inputs. • All commands support output formatting via --output json|yaml|table. • The ask command supports CSV/JSON-based batch queries. • Use --schema with clone to scaffold a payload for edits.

Usage:

$ vianctl qnametadata [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List all QnA metadata records with…
create-db: Create a new database via CLI options or…
migrate-db: Migrate an existing QnA metadata database…
clone: Clone an existing QnA metadata…
update: Update fields in existing QnA metadata…
delete: Delete or archive QnA metadata by UUIDs or…
generate: Generate QnA metadata from data, tables,…
create: Create a new QnA metadata entry from data…
ask: Ask questions to the QnA system using a…

`vianctl qnametadata list`

List all QnA metadata records with optional filters like project name and pagination.

Usage:

$ vianctl qnametadata list [OPTIONS]

Options:

--project-name TEXT: Project name
-O, --output TEXT: Output format (table, json, csv, yaml)
--page TEXT: Integer value of page [default: 1]
--page_size TEXT: Integer value of page_size [default: 100]
--help: Show this message and exit.

`vianctl qnametadata create-db`

Create a new database via CLI options or JSON input file.

Usage:

$ vianctl qnametadata create-db [OPTIONS]

Options:

-f, --file TEXT: Path to JSON input file
--db-name TEXT: Database name
--table-schema-name TEXT: Name of the table schema
--conn-name TEXT: Connection name used to access the database
--parent-conn-name TEXT: Parent database connection name, if applicable
--views-data TEXT: JSON string representing logical views on the database
--hca-version TEXT: Version of the hila Conversational Analytics pipeline
--ro-username TEXT: Read-only database username
--ro-password TEXT: Read-only database password
--qna-version TEXT: Version of the QnA metadata schema
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnametadata migrate-db`

Migrate an existing QnA metadata database to a new destination database.

Usage:

$ vianctl qnametadata migrate-db [OPTIONS]

Options:

-f, --file TEXT: Path to JSON configuration file
--qna-metadata-name TEXT: Qna metadata name
--destination-db TEXT: Destination database [required]
--hca-version TEXT: HCA version [required]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnametadata clone`

Clone an existing QnA metadata configuration with updated fields and model setup.

Usage:

$ vianctl qnametadata clone [OPTIONS]

Options:

-f, --file TEXT: Path to JSON configuration file
--schema: Generate payload schema template file for editing
--base-metadata TEXT: Name of the source metadata to clone from
--update-fields TEXT: JSON string of fields to update/add (must contains the new name, db_name, project_name) [required]
--models-dict TEXT: JSON string dictionary of models and their parameters
--run-setup-models: Flag to run setup_models_cf endpoint and update prompts [default: True]
--qnametadata-version TEXT: QNA metadata version required for default metadata
-O, --output TEXT: Output format (table, json, csv, yaml)
--version TEXT: Version type of the metadata – hca or hcf
--hca-config-path TEXT: Path to the hca configuration file
--help: Show this message and exit.

`vianctl qnametadata update`

Update fields in existing QnA metadata using filters or input file.

Usage:

$ vianctl qnametadata update [OPTIONS]

Options:

-f, --file TEXT: Path to JSON configuration file
--filters TEXT: JSON string specifying condition(s) to match metadata for update [required]
--name TEXT: Metadata name
--data TEXT: JSON string of updated QnA metadata
--generate_alternate_queries TEXT: Whether to generate alternate queries [default: False]
--application-type TEXT: Application type
--qnametadata-index TEXT: QNA metadata index
--entity-type TEXT: Entity type of the metadata
--default-currency TEXT: Default currency of the metadata
--company-metadata TEXT: JSON string array of company metadata
-d, --description TEXT: Metadata description
--allowed-llms TEXT: JSON string array of LLMs allowed for use
--preferred-llm TEXT: JSON string dictionary of preferred LLM configuration
--allowed-embedding-models TEXT: JSON string array of Embedding Models allowed for use
--preferred-embedding-model TEXT: Preferred Embedding Model
--project-name TEXT: Project name
--status TEXT: Status of the metadata
--version TEXT: Version of the metadata
--config TEXT: JSON string dictionary of configuration values
--external-connection-name TEXT: External connection name
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnametadata delete`

Delete or archive QnA metadata by UUIDs or names.

Usage:

$ vianctl qnametadata delete [OPTIONS]

Options:

-f, --file TEXT: Path to JSON configuration file
--uuids TEXT: list of uuids like –uuids 'uuid1, uuid2'
--names TEXT: list of names like –names 'name1 , name2'
--deletetype TEXT: select delete type from (archive / delete / force_delete) [default: archive]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnametadata generate`

Generate QnA metadata from data, tables, and connection details.

Usage:

$ vianctl qnametadata generate [OPTIONS]

Options:

-f, --file TEXT: Path to JSON configuration file
--name TEXT: Name of the metadata [required]
--external-connection-name TEXT: External connection name [required]
--data TEXT: JSON string of QNA metadata data [required]
--schema TEXT: Table schema name
--conn-type TEXT: Database connection type [default: postgresql]
--description TEXT: Metadata description
--preferred-embedding-model TEXT: Preferred Embedding Models –preferred-embedding-model gpt-3.5-turbo-instruct
--max-sample-values TEXT: Number of sample values [default: 10]
--tables TEXT: JSON string array of table names
--columns TEXT: JSON string dictionary of table names and their corresponding column names
--allowed-llms TEXT: string array of LLMs allowed for use
--preferred-llm TEXT: JSON string dictionary of preferred LLM
--allowed-embedding-models TEXT: JSON string array of Embedding Models allowed for use
--project-name TEXT: project name
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnametadata create`

Create a new QnA metadata entry from data and connection details.

Usage:

$ vianctl qnametadata create [OPTIONS]

Options:

-f, --file TEXT: Path to json payload file
--name TEXT: Name of the metadata [required]
--external-connection-name TEXT: External connection name [required]
--data TEXT: JSON string of QNA metadata data [required]
--schema TEXT: Table schema name
--conn-type TEXT: Database connection type [default: postgresql]
--description TEXT: Metadata description
--preferred-embedding-model TEXT: Preferred Embedding Models –preferred-embedding-model gpt-3.5-turbo-instruct
--max-sample-values TEXT: Number of sample values [default: 10]
--tables TEXT: JSON string array of table names
--columns TEXT: JSON string dictionary of table names and their corresponding column names
--allowed-llms TEXT: string array of LLMs allowed for use
--preferred-llm TEXT: JSON string dictionary of preferred LLM
--allowed-embedding-models TEXT: JSON string array of Embedding Models allowed for use
--project-name TEXT: project name
-O, --output TEXT: Output format (table, json, csv, yaml)
--version TEXT: Version of the metadata
--help: Show this message and exit.

`vianctl qnametadata ask`

Ask questions to the QnA system using a metadata name.

Examples:

Ask one question: vianctl qnametadata ask –metadata <name> –question "What is revenue?"
Interactive chat: vianctl qnametadata ask –metadata <name> –interactive
Batch test: vianctl qnametadata ask –metadata <name> –question-file questions.json –output json
run random questions suggested questions: vianctl qnametadata ask –metadata <name> –num-questions 5

Usage:

$ vianctl qnametadata ask [OPTIONS]

Options:

-n, --conversation_uuid TEXT: conversation_uuid for the current session. If omitted, a random one will be generated.
-i, --interactive: Interactive mode
-q, --question TEXT: Your question or prompt. Useful for non-interactive or automated use.
--metadata TEXT: QNA Metadata name. [required]
--all: Use this flag to run against all predefined questions in the knowledge base.
--num-questions INTEGER: Specify how many random questions to run from the knowledge base.
--project-name TEXT: Project Name. [default: QNA Project]
--project-uuid TEXT: Project uuid. [default: QNA Project uuid]
--question-file TEXT: Path to the question file containing a list of questions to test. Supported formats:
JSON: A list of question objects, e.g., [{"question": "Your question here"}]
CSV: A single column named 'question', e.g., question Your question here Another question here
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnathreads`

Interact with QNA Threads in the platform.

Usage:

$ vianctl qnathreads [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List QNA Threads with advanced filtering…
create: Create a new QNA Thread with optional…
update: Update an existing QNA Thread.
delete: Delete QNA Threads with advanced filtering…

`vianctl qnathreads list`

List QNA Threads with advanced filtering options.

Usage:

$ vianctl qnathreads list [OPTIONS]

Options:

-p, --page INTEGER: Page number for pagination [default: 1]
-ps, --page-size INTEGER: Number of items per page [default: -1]
-s, --search TEXT: Search term to filter QNA threads
-of, --order-field TEXT: Field to order the results by
-od, --order-direction TEXT: Direction to order the results (ASC/DESC)
-f, --filters TEXT: Filters to apply for listing QNA threads (JSON string) [default: {}]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnathreads create`

Create a new QNA Thread with optional parameters.

Usage:

$ vianctl qnathreads create [OPTIONS]

Options:

-qc, --qna-conversation-uuid TEXT: UUID of the parent QNA Conversation [required]
-u, --uuid TEXT: UUID of the QNA Thread
-n, --name TEXT: Name of the QNA Thread [default: Thread]
-d, --description TEXT: Description of the QNA Thread
-src, --sources TEXT: List of data sources. e.g. qna_metadata:UUID, model:UUID, RAG:name
-st, --status TEXT: Status of the QNA Thread [default: CREATED]
-ip, --is-pinned: Flag to pin the QNA Thread
-if, --is-favorite: Flag to mark the QNA Thread as favorite
-qt, --qna-thread-type TEXT: QNA Thread type
-t, --title TEXT: QNA Thread title
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnathreads update`

Update an existing QNA Thread.

Usage:

$ vianctl qnathreads update [OPTIONS]

Options:

-f, --filters TEXT: Specifies different condition(s) for filtering the qna threads to update (JSON string) [required]
-n, --name TEXT: New name for the QNA Thread
-d, --description TEXT: New description for the QNA Thread
-src, --sources TEXT: New sources for the QNA Thread
-qc, --qna-conversation-uuid TEXT: New QNA Conversation UUID for the QNA Thread
-fv, --feedback-value: New feedback value for the QNA Thread
-fc, --feedback-comment TEXT: New feedback comment for the QNA Thread
-st, --status TEXT: New status for the QNA Thread
-ip, --is-pinned: Flag to pin the QNA Thread
-if, --is-favorite: Flag to mark the QNA Thread as favorite
-sm, --summary TEXT: New summary for the QNA Thread
-qt, --qna-thread-type TEXT: New type for the QNA Thread
-t, --title TEXT: New title for the QNA Thread
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl qnathreads delete`

Delete QNA Threads with advanced filtering options.

Usage:

$ vianctl qnathreads delete [OPTIONS]

Options:

-f, --filters TEXT: Specifies different condition(s) for filtering qna threads to delete (JSON string) [required]
-dt, --delete-type TEXT: Deletion type: archive, delete, or force_delete [default: archive]
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl roles`

Manages roles in the Vianai platform, including listing roles, creating, updating and deleting roles, and updating user roles.

The list command retrieves all roles in the platform and can be used without any parameters.

The create, update, delete and updateuser commands require params like role name and permissions, username etc. If unsure about params run with –interactive or -i flag.

Usage:

$ vianctl roles [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List all roles for current user.
updateuser: Update roles for a user.
create: Create a new role.
delete: Delete a role.
update: Update an existing role.

`vianctl roles list`

List all roles for current user.

Usage:

$ vianctl roles list [OPTIONS]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl roles updateuser`

Update roles for a user.

Usage:

$ vianctl roles updateuser [OPTIONS]

Options:

-u, --username TEXT: Username for the user whose roles are being updated (required).
-g, --groups TEXT: Roles for the user, should be separated by "," for multiple roles e.g. "Administrator, ITAdmin" (required).
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl roles create`

Create a new role.

Usage:

$ vianctl roles create [OPTIONS]

Options:

-r, --role-name TEXT: Role name for new role to be created (required).
--permissions, -- TEXT: permissions for the new roles, should be in this format [ {"api.x":["create","read"]}, …..]
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl roles delete`

Delete a role.

Usage:

$ vianctl roles delete [OPTIONS]

Options:

-r, --role-name TEXT: Role name for the role to be deleted (required).
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl roles update`

Update an existing role.

Usage:

$ vianctl roles update [OPTIONS]

Options:

-r, --role-name TEXT: Role name for new role to be created (required).
--permissions, -- TEXT: permissions for the new roles, should be in this format [ {"api.x":["create","read"]}, …..]
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl tools`

Interact with tools in the platform.

Tools are essential components that enable specific functionalities within the platform, particularly in supporting the deep analysis mode. They help retrieve data and perform computations to enhance the analytical capabilities of deep analysus mode. This module provides commands to create, update, list, and delete tools, allowing users to manage their configurations and capabilities effectively.

Key Features:

List Tools: Retrieve a list of all tools or details of a specific tool by its ID.
Create Tools: Define new tools with specific configurations, including their type, purpose, and example code.
Update Tools: Modify existing tools to refine their behavior or adapt to new requirements.
Delete Tools: Remove tools that are no longer needed.

Usage:

$ vianctl tools [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: Retrieve tools.
create: Create a new tool.
update: Update an existing tool.
delete: Delete a tool.

`vianctl tools list`

Retrieve tools.

Usage:

$ vianctl tools list [OPTIONS]

Options:

-t, --tool-id INTEGER: ID of the topic to regenerate (required)
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl tools create`

Create a new tool.

Usage:

$ vianctl tools create [OPTIONS]

Options:

-n, --name TEXT: Name of the tool [required]
-t, --tool-type TEXT: Type of the tool [required]
-m, --method-name TEXT: Method name of the tool [required]
-p, --purpose TEXT: Purpose of the tool [required]
-cd, --code-description TEXT: Code description of the tool [required]
-pd, --purpose-description TEXT: Purpose description of the tool [required]
-e, --example-code TEXT: Example code for the tool
-c, --config TEXT: Additional configuration for the tool (JSON string)
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl tools update`

Update an existing tool.

Usage:

$ vianctl tools update [OPTIONS] TOOL_ID

Arguments:

TOOL_ID: ID of the tool to update [required]

Options:

-n, --name TEXT: Name of the tool
-t, --tool-type TEXT: Type of the tool
-m, --method-name TEXT: Method name of the tool
-p, --purpose TEXT: Purpose of the tool
-cd, --code-description TEXT: Code description of the tool
-pd, --purpose-description TEXT: Purpose description of the tool
-e, --example-code TEXT: Example code for the tool
-c, --config TEXT: Additional configuration for the tool (JSON format)
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl tools delete`

Delete a tool.

Usage:

$ vianctl tools delete [OPTIONS] TOOL_ID

Arguments:

TOOL_ID: ID of the tool to delete [required]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl transformers`

Manage feature transformers in the platform

Usage:

$ vianctl transformers [OPTIONS] COMMAND [ARGS]...

Options:

-v, --verbose: Enable verbose output for debugging
-o, --output [table|json]: Output format for displaying results [default: table]
--help: Show this message and exit.

Commands:

list: List all feature transformers
create: Create new feature transformers

`vianctl transformers list`

List all feature transformers

Retrieves and displays all configured feature transformers from the system.

Options: • –raw: Show the raw API response instead of formatted table • –output: Use global –output option to control format (table/json)

Examples:

# List transformers in table format
vianctl list

# List transformers in JSON format
vianctl --output json list

# Show raw API response
vianctl list --raw

# Verbose output with debugging info
vianctl --verbose list

Usage:

$ vianctl transformers list [OPTIONS]

Options:

--raw: Return raw API response without formatting
--help: Show this message and exit.

`vianctl transformers create`

Create new feature transformers

Create feature transformers from a JSON file, interactively, or show a template.

Options: • –file/-f: Load transformer configurations from JSON file • –interactive/-i: Create transformers using interactive prompts • –template: Display a JSON template for creating transformers

Examples:

# Show template for creating transformers
vianctl create --template

# Create from JSON file
vianctl create --file transformers.json

# Create interactively
vianctl create --interactive

# Save template to file (using shell redirection)
vianctl create --template &gt; template.json

JSON File Format:

Single transformer: {&quot;classname&quot;: &quot;...&quot;, &quot;method&quot;: &quot;...&quot;, ...}
Multiple transformers: [{&quot;classname&quot;: &quot;...&quot;, ...}, {&quot;classname&quot;: &quot;...&quot;, ...}]

Usage:

$ vianctl transformers create [OPTIONS]

Options:

-f, --file FILE: JSON file containing transformer configurations
-i, --interactive: Create transformer interactively with prompts
--template: Generate and display a JSON template for creating transformers
--help: Show this message and exit.

`vianctl unstructured`

Interact with the unstructured files in the platform.

Usage:

$ vianctl unstructured [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: Lists all uploaded unstructured files…
upload: Uploads a file to the server.
delete: Delete a file from the server using its…
ask: Ask a question about an uploaded…

`vianctl unstructured list`

Lists all uploaded unstructured files along with their access permissions. Optionally filters files by folder path.

Usage:

$ vianctl unstructured list [OPTIONS]

Options:

--folder TEXT: Filter files by folder path
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl unstructured upload`

Uploads a file to the server.

This command uploads the given file to the server and optionally waits

for the upload process to complete. When using the –wait flag, it monitors

the job status and displays progress and final result.

Examples:

# Upload a file with progress tracking

vianctl unstructured upload -f apple_news.pdf --wait

# Upload and output the response in JSON format

vianctl unstructured upload -f apple_news.pdf --output json

# Upload a file to a specific folder on the server

vianctl unstructured upload -f apple_news.pdf --dest /my-folder

# Upload a file in interactive mode

vianctl unstructured upload -f apple_news.pdf --dest /my-folder --wait --interactive

Usage:

$ vianctl unstructured upload [OPTIONS]

Options:

-f, --file TEXT: Source file to upload [required]
--dest TEXT: Destination path
--wait / --no-wait: wait till upload [default: no-wait]
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl unstructured delete`

Delete a file from the server using its UNC (Universal Naming Convention) name.

This command finds the file by its UNC name, deletes the unstructured content,

and then removes associated metadata/permissions if applicable.

Example:

# Delete a specific uploaded file using UNC name

vianctl unstructured delete --uncname file:/pritam.kishor/my_report.pdf

# Delete and print the result in JSON format

vianctl unstructured delete --uncname file:/pritam.kishor/my_report.pdf --output json

Tip:

Use `vianctl unstructured list` to view all available UNC names.

Usage:

$ vianctl unstructured delete [OPTIONS]

Options:

--uncname TEXT: UNC name of the file to delete. You can get this from 'vianctl unstructured list'.
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl unstructured ask`

Ask a question about an uploaded unstructured file (like a PDF or document).

Supports both interactive chat sessions and non-interactive (single-shot) querying modes.

📌 Usage Examples:

🔹 JSON (non-interactive) mode:

Ask a specific question and receive raw JSON output:

vianctl unstructured ask --file file:/username/apple_news.pdf --question &quot;What is this document about?&quot;

Specify conversation explicitly (useful for chaining queries):

vianctl unstructured ask --file file:/username/apple_news.pdf --output json --question &quot;Summarize the content&quot; \

🔹 Interactive mode:

Start a chat session to ask follow-up questions interactively:

vianctl unstructured ask --file &#x27;file:/pritam.kishor/apple_news.pdf, file:/pritam.kishor/apple_news2.pdf&#x27; --interactive

🛠 Notes:

- `--file` is required in both modes.

- `--question` is required in non-interactive mode.

- You cannot use `--interactive` and `--output` at the same time.

Usage:

$ vianctl unstructured ask [OPTIONS]

Options:

-f, --file TEXT: Path to file (optional, will prompt if not provided)
-n, --conversation_uuid TEXT: Conversation uuid for the conversation (optional, will generate random name if not provided)
-i, --interactive: Interactive mode
-q, --question TEXT: Question to ask (optional, for non-interactive/shell script usage)
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl users`

Manages users in the Vianai platform, including listing users, creating new users, and deleting existing users.

The list command retrieves all users in the platform and can be used without any parameters to get a JSON output of all users.

The create and delete command requires a username, password, email, and groups for the new user. If unsure, about params run with –interactive or -i flag.

Usage:

$ vianctl users [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List all users.
create: Create a new user.
delete: Delete a user.

`vianctl users list`

List all users.

Usage:

$ vianctl users list [OPTIONS]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl users create`

Create a new user.

Usage:

$ vianctl users create [OPTIONS]

Options:

-u, --username TEXT: username for new user (required)
-p, --password TEXT: password for new user (required)
-e, --email TEXT: email for new user (required)
-g, --groups TEXT: groups for new user, should be a list of strings e.g. ["subscriber"] (required)
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl users delete`

Delete a user.

Usage:

$ vianctl users delete [OPTIONS]

Options:

-u, --username TEXT: username for new user (required)
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl userpreferences`

Interact with the user preferences in the platform.

Usage:

$ vianctl userpreferences [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List all user preference values.
get: Get a user preference value.
set: Set a user preference value.

`vianctl userpreferences list`

List all user preference values.

Usage:

$ vianctl userpreferences list [OPTIONS]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl userpreferences get`

Get a user preference value.

Usage:

$ vianctl userpreferences get [OPTIONS]

Options:

-s, --system TEXT: system value for userpreference (required)
-m, --module TEXT: module value for userpreference (required)
-n, --name TEXT: name value for userpreference (required)
-userid, --userid TEXT: name value for userpreference (optional)
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl userpreferences set`

Set a user preference value.

Usage:

$ vianctl userpreferences set [OPTIONS]

Options:

-s, --system TEXT: system value for userpreference (required)
-m, --module TEXT: module value for userpreference (required)
-n, --name TEXT: name value for userpreference (required)
-v, --value TEXT: value to be set (required)
-desc, --description TEXT: description value for userpreference (optional)
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl vianai_config`

Interact with the vianai configuration values in the platform.

Usage:

$ vianctl vianai_config [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List all vianai config values.
get: Get a vianai config value.
set: Set a vianai config value.

`vianctl vianai_config list`

List all vianai config values.

Usage:

$ vianctl vianai_config list [OPTIONS]

Options:

-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl vianai_config get`

Get a vianai config value.

Usage:

$ vianctl vianai_config get [OPTIONS]

Options:

-s, --system TEXT: system value for vianai config (required)
-m, --module TEXT: module value for vianai config (required)
-n, --name TEXT: name value for vianai config (required)
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl vianai_config set`

Set a vianai config value.

Usage:

$ vianctl vianai_config set [OPTIONS]

Options:

-s, --system TEXT: system value for vianai config (required)
-m, --module TEXT: module value for vianai config (required)
-n, --name TEXT: name value for vianai config (required)
-v, --value TEXT: value to set for vianai config (required)
-i, --interactive: Interactive mode
-O, --output TEXT: Output format (table, json, csv, yaml)
--help: Show this message and exit.

`vianctl websockets`

Manages websocket connection in the Vianai platform,

The connect command can be run without any parameters to connect to the WebSocket server.

The connect command connects to the WebSocket server using the webservices URL, username, and token which are already in config

Usage:

$ vianctl websockets [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

connect: Connect to the WebSocket server.

`vianctl websockets connect`

Connect to the WebSocket server.

Usage:

$ vianctl websockets connect [OPTIONS]

Options:

--help: Show this message and exit.

TABLE OF CONTENTS