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: Define or modify an agent with specific…
apikeys: Create or delete API keys.
auth: Manage platform stack authentication.
cache: Upload a file to the stack's cache and…
config: Manage the instances (stacks) of hila…
conversations: Create, update, list, and delete QNA…
customquestions: Create and manage custom qeustions.
dataloading: Upload data as well as manage and monitor…
deepanalysis: Interact with the deep analysis feature in…
deployments: List and scale hila k8s deployments in the…
externalconnections: Create, update, inspect, test, and query…
featuresets: Create, list, export, and delete feature…
io: Manage QNA IO items, such as user input,…
jargon: Create jargon words and manage the lexicon…
jobs: Create, get, list, and delete jobs in the…
jobtypes: Create, search, update, and delete job…
load: Run performance tests on the platform.
metadata: Create, generate, query, and maintain…
modelstore: Manage models in the Vianai platform's…
objpermissions: List, create, delete, and other actions on…
pipelines: Manage data transformation pipelines on…
projects: Manage projects in the platform.
render: Render and preview QnA templates on the…
roles: List roles, create, update, and delete…
threads: Create, update, list, and delete QNA…
tools: Manage tools in the platform.
transformers: Manage feature transformers in the platform
unstructured: Upload unstructured documents and ask…
usagetracking: Check usage tracking and metrics in the…
users: List users, create new users, and delete…
userpreferences: Set and get user preferences in the platform.
vianai_config: Set and get vianai configuration values in…
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`

Define or modify an agent with specific business goals.

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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl apikeys`

Create or delete API keys.

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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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`

Upload a file to the stack's cache and then download into the stack's db.

Usage:

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

Options:

--help: Show this message and exit.

Commands:

upload: Upload a document to the stack's cache.
download: Download a file from cache to the stack's…
raw: Upload a raw file to the stack's cache.

`vianctl cache upload`

Upload a document to the stack's cache.

Usage:

$ vianctl cache upload [OPTIONS] FILEPATH

Arguments:

FILEPATH: [required]

Options:

--help: Show this message and exit.

`vianctl cache download`

Download a file from cache to the stack's db with the upload key returned from the upload command.

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 a raw file to the stack's cache.

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:

--details: stack details.
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 conversations`

Create, update, list, and delete QNA Conversations.

QNA conversations represent collections of related QNA threads, serving as containers for organizing and managing discussions.

-----------------------
USAGE EXAMPLES:
-----------------------

vianctl qnaconversation list --page 1 --page-size 10 --order-field "name" --order-direction "ASC"
vianctl qnaconversation create --name "New Conversation" --description "This is a sample QNA Conversation"
vianctl qnaconversation update --filters '{"name": ["New Conversation"]}' --name "Updated Conversation" --description "Updated description" --status "ACTIVE" --is-pinned
vianctl qnaconversation delete --filters '{"status": ["ACTIVE"]}' --delete-type "archive"

-----------------------
TIPS:
-----------------------

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

Usage:

$ vianctl conversations [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 conversations list`

List QNA Conversations with advanced filtering options.

Usage:

$ vianctl conversations 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl conversations create`

Create a new QNA Conversation.

Usage:

$ vianctl conversations 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl conversations update`

Update an existing QNA Conversation.

Usage:

$ vianctl conversations 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl conversations delete`

Delete QNA Conversations with advanced filtering options.

Usage:

$ vianctl conversations 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl customquestions`

Create and manage custom qeustions.

Usage:

$ vianctl customquestions [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 customquestions create`

Create Custom Question.

Usage:

$ vianctl customquestions 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl customquestions clone`

Clone Custom Question.

Usage:

$ vianctl customquestions clone [OPTIONS]

Options:

-u, --uuid TEXT: UUID of the custom question to clone [required]
-qm, --qna-metadata-uuid TEXT: UUID of QNA Metadata
-sn, --stack-name TEXT: Name of the stack to clone the question into
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl customquestions list`

List Custom Questions

Usage:

$ vianctl customquestions 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl customquestions update`

Update Custom Question.

Usage:

$ vianctl customquestions 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl customquestions delete`

Delete Custom Questions.

Usage:

$ vianctl customquestions 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl dataloading`

Upload data as well as manage and monitor data loading jobs.

This command supports various file types and provides options for enforcing table structures, maintaining archives, and customizing data loading configurations.

Note: Run --help after any subcommand for more details.

Usage:

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

Options:

--help: Show this message and exit.

Commands:

upload: Upload files from a directory and submit…
cancel: Cancel the dataloading job.
status: Get the status of a dataloading job.

`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": [""]}]

Use --table-structure-name with --enforce-table-structure to validate data against a predefined schema.
Use --output to control the output style (json, yaml, table).

Usage example:

vianctl dataloading upload vianctl/data db_name_Apr25_0214 --filetype csv --overwrite append

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:

--tablename TEXT: Optional table name for the data loading job. If not provided, the file name will be used.
--setname TEXT: Feature set name. If not provided, the file name will be used.
--description TEXT: Description for the data loading job. [default: Data description.]
--dryrun / --no-dryrun: Dry run: if true, data is not saved in a table. [default: no-dryrun]
--dtypes TEXT: A list of pandas data types as a string instance.
--filetype TEXT: File type of the data. Options: 'csv', 'parquet'. [default: parquet]
--overwrite TEXT: Overwrite mode for the data. Options: 'append', 'replace'. [default: replace]
--separator TEXT: Data separator. [default: ,]
--srcurl TEXT: Source url from where data is to be loaded.
--upload-key TEXT: Cache upload key.
--job-description TEXT: Job description as string or JSON.
--job-type TEXT: Job type. Supports one value: dataloading. [default: dataloading]
--maintain-archives / --no-maintain-archives: Whether to maintain archives of the uploaded files. [default: no-maintain-archives]
--tabs TEXT: Tabs containing sheet information of workbook as JSON string.
--engine TEXT: Engine clause appended to CREATE TABLE for some databases.
--table-structure-name TEXT: The name of the table structure/schema.
--enforce-table-structure / --no-enforce-table-structure: Whether to enforce the table structure during data loading. [default: no-enforce-table-structure]
--identifier-columns TEXT: A list of column names that uniquely identify rows in the dataset as JSON string.
--primary-keys TEXT: A list of column names for upsert operations as JSON string.
--wait / --no-wait: Wait for the job to complete before returning. [default: no-wait]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl dataloading cancel`

Cancel the dataloading job.

Usage example: vianctl dataloading cancel <job_id>

Usage:

$ vianctl dataloading cancel [OPTIONS] JOB_ID

Arguments:

JOB_ID: [required]

Options:

-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl dataloading status`

Get the status of a dataloading job.

Usage example: vianctl dataloading status <job_id>

Usage:

$ vianctl dataloading status [OPTIONS] JOB_ID

Arguments:

JOB_ID: [required]

Options:

-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl deepanalysis`

Interact with the deep analysis feature in the platform.

The deep analysis feature enables users to generate detailed reports to gain actionable insights. This module provides commands to interact with the deep analysis API, allowing users to explore business metrics, identify trends, and make data-driven decisions.

Key Features:

Generate Reports: Create in-depth reports based on user-defined prompts.
Reasoning Transparency: Break down questions into sub-questions and answers, showing the logical steps taken to derive conclusions.
Interactive Refinement: Modify sub-questions and rerun analyses to explore alternative scenarios and outcomes.
Iterative Updates: Save analyses and rerun them later to observe how results evolve with new data.
Actionable Insights: Transform raw data into meaningful insights to support informed decision-making.

Usage:

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

Options:

--help: Show this message and exit.

Commands:

ask: Generate a report using the deep analysis…
rerun: Regenerate a topic using the deep analysis…
update: Update a question using the deep analysis…

`vianctl deepanalysis ask`

Generate a report using the deep analysis API.

Usage:

$ vianctl deepanalysis ask [OPTIONS]

Options:

-p, --prompt TEXT: Prompt for the analysis (required) [required]
-m, --metadata TEXT: Metadata name for the analysis (required) [required]
-a, --agent TEXT: Agent to use for the analysis
-mq, --max-questions INTEGER: Maximum number of questions to generate
-q, --qna-conversation-uuid TEXT: Optional UUID for the QNA conversation
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl deepanalysis rerun`

Regenerate a topic using the deep analysis API.

Usage:

$ vianctl deepanalysis rerun [OPTIONS]

Options:

-t, --topic-id TEXT: ID of the topic to regenerate (required) [required]
-n, --name TEXT: Optional new name for the topic
-d, --description TEXT: Optional new description for the topic
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl deepanalysis update`

Update a question using the deep analysis API.

Usage:

$ vianctl deepanalysis update [OPTIONS]

Options:

-q, --question-id TEXT: ID of the question to update (required) [required]
-t, --question-text TEXT: New text for the question (required) [required]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl deployments`

List and scale hila k8s deployments in the platform.

Usage:

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

Options:

--help: Show this message and exit.

Commands:

list: List all k8s deployments.
scale

`vianctl deployments list`

List all k8s deployments.

Usage:

$ vianctl deployments list [OPTIONS]

Options:

-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl deployments scale`

Usage:

$ vianctl deployments scale [OPTIONS] DEPLOYMENT REPLICAS

Arguments:

DEPLOYMENT: Name of the deployment to scale [required]
REPLICAS: Number of replicas to scale the deployment to [required]

Options:

-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl externalconnections`

Create, update, inspect, test, and query external data connections.

External connections define how the platform connects to third-party databases (e.g., MySQL, PostgreSQL, ClickHouse).

-----------------------
USAGE EXAMPLES:
-----------------------

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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl externalconnections get`

Get details of an external connection by name. vianctl externalconnection get -n my_connection

Usage:

$ vianctl externalconnections get [OPTIONS]

Options:

-n, --name TEXT: Name of the external connection [required]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl featuresets`

Create, list, export, and delete feature sets, as well as manage raw feature set creation.

Feature sets represent structured data collections used for data driven tasks.

-----------------------
USAGE EXAMPLES:
-----------------------

vianctl featureset list --output json
vianctl featureset export <YOUR_FEATURE_SET_NAME> --limit 100
vianctl featureset delete <YOUR_FEATURE_SET_NAME> "age > 30"
vianctl featureset raw myconnection mytable myfeatureset ".parquet" --columns ""

-----------------------
TIPS:
-----------------------

• Use --where to filter data during deletion or creation.
• Use --output to control the output style (json, yaml, table).
• Run --help after any subcommand for more details.

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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl io`

Manage QNA IO items, such as user input, raw prompts, and final LLM prompts, in the platform.

Usage:

$ vianctl io [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 io list`

List QNA IO with parameters filtering options.

Usage:

$ vianctl io 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl io create`

Create a new QNA IO with optional parameters.

Usage:

$ vianctl io 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl io update`

Update an existing QNA IO.

Usage:

$ vianctl io 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 io delete`

Delete QNA IO with advanced filtering options.

Usage:

$ vianctl io 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl jargon`

Create jargon words and manage the lexicon in the platform.

Usage:

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

Options:

--help: Show this message and exit.

Commands:

create: Create a jargon word in the lexicon.
list: Search for a jargon word in the lexicon.
update: Update a parameter of a jargon word in the…
delete: Delete a jargon word from the lexicon.

`vianctl jargon create`

Create a jargon word in the lexicon.

Usage:

$ vianctl jargon create [OPTIONS]

Options:

-j, --jargon TEXT: Jargon term [required]
-m, --meaning TEXT: Meaning of the jargon [required]
-u, --user-group TEXT: User group for the jargon [default: *]
-qm, --qna-metadata-uuid TEXT: QNA metadata UUID [required]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl jargon list`

Search for a jargon word in the lexicon.

Usage:

$ vianctl jargon 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 jargon lexicon
-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 jargons (JSON string). [default: {}]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl jargon update`

Update a parameter of a jargon word in the lexicon.

Usage:

$ vianctl jargon update [OPTIONS]

Options:

-f, --filters TEXT: Specifies different condition(s) for filtering the jargons to update (JSON string) [required]
-j, --jargon TEXT: The updated jargon value
-m, --meaning TEXT: The updated meaning of the jargon
-s, --status TEXT: The updated status of the jargon
-u, --user-group TEXT: The updated user group associated with the jargon
-qm, --qna-metadata-uuid TEXT: The updated UUID associated with QnA metadata, if applicable
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl jargon delete`

Delete a jargon word from the lexicon.

Usage:

$ vianctl jargon delete [OPTIONS]

Options:

-f, --filters TEXT: Specifies different condition(s) for filtering jargons 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl jobs`

Create, get, list, and delete 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.
list-pods: List all jobs.

`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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl jobs list`

List all jobs.

Usage:

$ vianctl jobs list [OPTIONS]

Options:

-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 or python file 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--secondary-job-type TEXT: Secondary job type for some kubernetes jobs (e.g. for testing secondary job type would be 'pytest' or 'python').
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl jobs list-pods`

List all jobs.

Usage:

$ vianctl jobs list-pods [OPTIONS]

Options:

-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl jobtypes`

Create, search, update, and delete job types with flexible options.

Job types define the configuration and metadata for jobs that can be run on the platform.

-----------------------
USAGE EXAMPLES:
-----------------------

vianctl jobtype search --filters '{"names": ["testing-rr-5"]}'
vianctl jobtype create '{"name": "testing-vianctl-2","description": "nlp","status": "enabled","image_url":"my_rr:latest","volume_mounts": {"main": ["/models","/source","/env","/data"],"config": ["/config"]},"port": 8080,"environment_variables": {"JOB_IMAGE_PULL_POLICY": "Never"},"runtime_object": "knative"}' vianctl jobtype create "path/to/job_type-info.json" vianctl jobtype update '{"filters":{"names":["testing-vianctl-2"]}, "image_url":"new_url"}' vianctl jobtype update "path/to/job_type-update.json" vianctl jobtype delete '{"names": ["testing-vianctl-2"]}'

-----------------------
TIPS:
-----------------------

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

Usage:

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

Options:

--help: Show this message and exit.

Commands:

create: Add new job types to the system.
search: Search for job types.
update: Update existing job types.
delete: Delete job types.

`vianctl jobtypes create`

Add new job types to the system.

Usage:

$ vianctl jobtypes create [OPTIONS] JOB_TYPES_JSON

Arguments:

JOB_TYPES_JSON: JSON string or file path to create new job types [required]

Options:

-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl jobtypes search`

Search for job types.

Usage:

$ vianctl jobtypes search [OPTIONS]

Options:

-f, --filters TEXT: JSON string with search filters [default: {}]
-p, --page INTEGER: Page number for pagination [default: 1]
-ps, --page-size INTEGER: Number of items per page [default: 100]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl jobtypes update`

Update existing job types.

Usage:

$ vianctl jobtypes update [OPTIONS] UPDATES_JSON

Arguments:

UPDATES_JSON: JSON string or file path to update existing job types [required]

Options:

-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl jobtypes delete`

Delete job types.

Usage:

$ vianctl jobtypes delete [OPTIONS] FILTERS

Arguments:

FILTERS: JSON string to filter job types to delete [required]

Options:

-d, --delete-type TEXT: Type of deletion: archive, delete, force_delete [default: archive]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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: eacb2eb3-011f-436c-8025-40b390003845]
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl metadata`

Create, generate, query, and maintain metadata objects.

QnA metadata defines the structure and behavior of conversational analytics over structured data.

-----------------------
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" --delete-type 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 metadata [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…
create-metadata-tag: create qna metadata tags.
get-metadata-tags: " get qna metadata tags values filtered by…
update-metadata-tags: update qna metadata tags values filtered…
delete-metadata-tags: delete qna metadata tags filtered by…

`vianctl metadata list`

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

Usage:

$ vianctl metadata list [OPTIONS]

Options:

--project-name TEXT: Project name
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--tags: bool value to include metadata tags in response or not
--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 metadata create-db`

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

Usage:

$ vianctl metadata 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
--hcf-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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl metadata migrate-db`

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

Usage:

$ vianctl metadata 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl metadata clone`

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

Usage:

$ vianctl metadata 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--version TEXT: Version type of the metadata -- hca or hcf
--metadata-tags TEXT: JSON string array of metadata tags in following format:

[{

"name": "key6",

"value": {

  &quot;api&quot;:&quot;url&quot;,

  &quot;token&quot;: &quot;token&quot;

"status": "active"

}]

--hca-config-path TEXT: Path to the hca configuration file
--help: Show this message and exit.

`vianctl metadata update`

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

Usage:

$ vianctl metadata 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl metadata delete`

Delete or archive QnA metadata by UUIDs or names.

Usage:

$ vianctl metadata 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'
--delete-type TEXT: select delete type from (archive / delete / force_delete) [default: archive]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl metadata generate`

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

Usage:

$ vianctl metadata 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl metadata create`

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

Usage:

$ vianctl metadata 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
--metadata-tags TEXT: JSON string array of metadata tags in following format:

[{

"name": "key6",

"value": {

  &quot;api&quot;:&quot;url&quot;,

  &quot;token&quot;: &quot;token&quot;

"status": "active"

}]

-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--version TEXT: Version of the metadata
--help: Show this message and exit.

`vianctl metadata 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 metadata ask [OPTIONS]

Options:

-n, --conversation_uuid TEXT: conversation_uuid for the current session. If omitted, a random one will be generated.
-t, --thread-uuid TEXT: thread_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: List of QNA Metadata names [required]
-fp, --followup TEXT: Your follow up question or prompt. Useful for non-interactive or automated use.
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl metadata create-metadata-tag`

create qna metadata tags.

Parameters:

--metadata-uuid Comma-separated list of metadata UUIDs to filter tags

--names metadata tag names.

--uuids metadata tag uuids.

--status metadata tag status.

--output Output format (json, table, csv, yaml, or file:<filename>)

Examples:

create qna metadata tags :

vianctl qnametadata create-metadata-tags --metadata-uuid "4243b513-ad9e-4c59-a78b-9834d4b1cb14" --names "tag_name" --value "new value" --status "active"

Usage:

$ vianctl metadata create-metadata-tag [OPTIONS]

Options:

--metadata-uuid TEXT: Metadata uuid
--metadata-tags TEXT: JSON string array of metadata tags in following format:

[{

"name": "key6",

"value": {

  &quot;api&quot;:&quot;url&quot;,

  &quot;token&quot;: &quot;token&quot;

"status": "active"

}]

--name TEXT: metadata tag name.
--value TEXT: Metadata tag value.
--status TEXT: Metadata tag status.
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl metadata get-metadata-tags`

" get qna metadata tags values filtered by metadata UUID(s), names, tag uuids or status.

Parameters:

--metadata-uuids Comma-separated list of metadata UUIDs to filter tags

--names metadata tag names.

--uuids metadata tag uuids.

--status metadata tag status.

--output Output format (json, table, csv, yaml, or file:<filename>)

Examples:

get qna metadata tags values filter by metadata uuid and name:

vianctl qnametadata get-metadata-tags --names "tag_name" --metadata-uuids "4243b513-ad9e-4c59-a78b-9834d4b1cb14, 80df4227-ac8f-4169-ade2-9d0c352946ec"

Usage:

$ vianctl metadata get-metadata-tags [OPTIONS]

Options:

--metadata-uuids TEXT: Metadata uuid
--names TEXT: metadata tag name.
--uuids TEXT: metadata tag uuids.
--status TEXT: Metadata tag status.
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl metadata update-metadata-tags`

update qna metadata tags values filtered by metadata UUID(s), names, tag uuids or status.

Parameters:

--metadata-uuids Comma-separated list of metadata UUIDs to filter tags

--names metadata tag names.

--uuids metadata tag uuids.

--status metadata tag status.

--output Output format (json, table, csv, yaml, or file:<filename>)

Examples:

update qna metadata tags values by metadata uuids and name:

vianctl qnametadata update-metadata-tags --names "tag_name" --metadata-uuids "4243b513-ad9e-4c59-a78b-9834d4b1cb14, 80df4227-ac8f-4169-ade2-9d0c352946ec" --value "new value"

Usage:

$ vianctl metadata update-metadata-tags [OPTIONS]

Options:

--metadata-uuids TEXT: Metadata uuid
--names TEXT: metadata tag name.
--uuids TEXT: metadata tag uuids.
--status TEXT: Metadata tag status.
--value TEXT: Metadata tag new value.
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl metadata delete-metadata-tags`

delete qna metadata tags filtered by metadata UUID(s), names, tag uuids or status.

Parameters:

--metadata-uuids Comma-separated list of metadata UUIDs to filter tags

--names metadata tag names.

--uuids metadata tag uuids.

--status metadata tag status.

--output Output format (json, table, csv, yaml, or file:<filename>)

Examples:

delete qna metadata tags by metadata uuids:

vianctl qnametadata delete-metadata-tags --metadata-uuids e1e0d306-f5e6-4564-9766-53fd26fc59d6

delete qna metadata tags by metadata uuid and name:

vianctl qnametadata delete-metadata-tags --metadata-uuids e1e0d306-f5e6-4564-9766-53fd26fc59d6 --names 'predict_metadata'

Usage:

$ vianctl metadata delete-metadata-tags [OPTIONS]

Options:

--metadata-uuids TEXT: Metadata uuid
--names TEXT: metadata tag name.
--uuids TEXT: metadata tag uuids.
--status TEXT: Metadata tag status.
--delete-type TEXT: select delete type from (archive / delete / force_delete) [default: archive]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl modelstore`

Manage models in the Vianai platform's modelstore.

=======================
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 from the Model…
update: Update model metadata in the Model Store.
export: Export model metadata from the model store.
create: Create a new model in the model store.
ask
delete: Delete or archive a model.
create-tags: Create one or more metadata tags for…
update-tags: Update the value of one or more model tags…
get-tags: List all tags in the Model Store,…
delete-tags: Delete or archive a model tag from the…

`vianctl modelstore list`

List all available models from the Model Store.

You can filter models by project UUIDs or project names. If no filter is provided, it will return models from all accessible projects.

Options: --project-uuids: Provide one or more project UUIDs (comma-separated) to filter models. --project-names: Provide one or more project names (comma-separated) to filter models. --page: Page number for paginated results (default: 1). --page_size: Number of items per page (default: 100). --output-format: Output format (e.g., json, table).

Example: vianctl modelstore list --project-uuids '92de3bd4-5879-41f4-95b0-2db744f27983,28a9701c-f433-42fc-916e-225522177ee7'

Usage:

$ vianctl modelstore list [OPTIONS]

Options:

-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--project-names TEXT: Project name(s), comma-separated
--project-uuids TEXT: Project UUID(s), comma-separated
--page TEXT: Page number (default: 1) [default: 1]
--page_size TEXT: Number of items per page (default: 100) [default: 100]
--help: Show this message and exit.

`vianctl modelstore update`

Update model metadata in the Model Store.

You can update the version, stage, or status of one or more models by providing filter conditions using the --filters option.

Required: --filters: JSON string defining the filter criteria (e.g., UUIDs of models to update)

Optional:
--version: New version to set on matching models
--stage: New stage to set (e.g., 'production', 'staging')
--model-status: New model status (e.g., 'active', 'archived')
--output: Output format (json, table, csv, yaml, or file:<filename>)

Examples: vianctl modelstore update --model-status active --filters '{"uuids":["fe00d5e1-2a52-4c2b-aa5c-60d60876ab96"]}'

Usage:

$ vianctl modelstore update [OPTIONS]

Options:

--version TEXT: Model Version
--stage TEXT: Model Stage
--model-status TEXT: Model Status
--filters TEXT: JSON string specifying filter condition for update [required]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl modelstore export`

Export model metadata from the model store.

You can filter by model names, model UUIDs, project names, or project UUIDs.

Optionally, include tags in the export using the --tags flag.

Examples:

-----------

Export all models from a project by name:

vianctl modelstore export --project-names 'LLM Project'

Export models from a project and include tags:

vianctl modelstore export --project-names 'LLM Project' --tags

Export a specific model by name from a project and include tags:

vianctl modelstore export --project-names 'LLM Project' --model-names 'testModel' --tags

Export using model UUIDs:

vianctl modelstore export --model-uuids 'uuid1,uuid2'

Export with custom output format (e.g., table, json, yaml):

vianctl modelstore export --project-names 'LLM Project' --output-format table

Usage:

$ vianctl modelstore export [OPTIONS]

Options:

--model-names TEXT: Model Name(s)
--model-uuids TEXT: Model UUID(s)
--page TEXT: Page number (default: 1) [default: 1]
--page_size TEXT: Number of items per page (default: 100) [default: 100]
--project-names TEXT: Project name(s), comma-separated
--project-uuids TEXT: Project UUID(s), comma-separated
--tags: Boolean to include model tags in output
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl modelstore create`

Create a new model in the model store.

You can specify the project name, model name, version, stage, and status.

Optionally, you can attach tags to the model using a JSON string.

Tags should be passed in the following format:

'[{"name": "tag1", "value": "val1", "status": "active"}, {"name": "tag2", "value": "val2"}]'

Examples:

-----------

Create a model with basic metadata:

vianctl modelstore create --project-name 'LLM Project' --model-name testModel2 --version 1 --stage 1 --model_status active

Create a model with tags:

vianctl modelstore create --project-name 'LLM Project' --model-name testModel2 --version 1 --stage 1 --model_status active --tags '[{"name": "tag1","value": "123", "status": "active"},{"name": "tag2","value": "123","status":"active"}]'

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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--tags TEXT: JSON string representing list of tags '[{"name": "metadata","value": "value"}]' or file containing the JSON string
--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 uuid
--question TEXT: Your question or prompt.
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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/force_delete the model [default: archive]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl modelstore create-tags`

Create one or more metadata tags for models in the Model Store.

Each tag must include:

model_uuid: UUID of the model
name: Name of the tag
value: Value of the tag

You must provide a JSON array of tag objects via --tags.

Example:

vianctl modelstore create-tags --tags '[{"model_uuid": "e1e0d306-f5e6-4564-9766-53fd26fc59d6", "name": "tag3", "value": "updated"}]'

vianctl modelstore create-tag --model-uuid 'ffa95792-e0a3-4dd3-ae2d-93ccc27fe494' --tag-name "tagname" --tag-value "tag_value"

You can also control the output format using --output:

--output json table csv yaml file:<filename>

Usage:

$ vianctl modelstore create-tags [OPTIONS]

Options:

--tags TEXT: JSON string specifying list of tag name and values [{'model_uuid':'uuid','name':'', 'values': ''}], or file containing the JSON string
--model-uuid TEXT: Model uuid
--model-name TEXT: Model Name if you are passing this make sure to pass project name of the model
--project-name TEXT: Project name where model name is belongs to Name)
--project-uuids TEXT: Project uuid where model name is belongs to Name)
--tag-name TEXT: Model tag Name)
--tag-value TEXT: Model tag value)
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl modelstore update-tags`

Update the value of one or more model tags in the Model Store.

Required:

--filters JSON string specifying filter conditions for selecting tags to update

Optional:

--value New value to assign to the selected tag(s)

--output Output format (json, table, csv, yaml, or file:<filename>)

Examples:

Update a tag value by UUID:

vianctl modelstore update-tags --filters '{"uuids":["0cbe56d0-521c-4bcb-bf7b-bfd90fa89018"]}' --value 'value23456'

Update multiple tags by UUID list (JSON filter) and save response:

vianctl modelstore update-tags --filters '{"uuids":["uuid1","uuid2"]}' --value 'new_value' --output file:response.json Update multiple tags by comma-separated UUIDs and save response:

vianctl modelstore update-tags --uuids "uuid1, uuid2" --value 'new_value' --output file:response.json Update a tag by name and save response::

vianctl modelstore update-tags --names tag_name --value 'new_value' --output file:response.json Update a nested field inside a tag for a specific model UUID:

vianctl modelstore update-tags

--model-uuids "612c5dce-cf77-4b06-97a4-dedcc73d9bb0"

--names "prompt_metadata"

--nested-field "text2sql_prompt"

--value '{"system_intel": "new system instruction","user_prompt":"new user instruction"}'

Usage:

$ vianctl modelstore update-tags [OPTIONS]

Options:

--filters TEXT: JSON string specifying filter condition for update
--model-uuids TEXT: Model uuid
--names TEXT: Model tag name.
--uuids TEXT: Model tag uuids.
--status TEXT: Model tag status.
--nested-field TEXT: Nested field inside a tag value in case of json value.
--value TEXT: Model tag new value.
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl modelstore get-tags`

List all tags in the Model Store, optionally filtered by model UUID(s).

Optional:

--model-uuid Comma-separated list of model UUIDs to filter tags

--project-name Project name to filter models

--project-uuid Project UUID for filtering

--tag Comma-separated list of specific tag names to filter

--output Output format (json, table, csv, yaml, or file:<filename>)

Examples:

List all tags:

vianctl modelstore get-tags

List tags for a specific model:

vianctl modelstore get-tags --model-uuid e1e0d306-f5e6-4564-9766-53fd26fc59d6

List tags for multiple models:

vianctl modelstore get-tags --model-uuid e1e0d306-f5e6-4564-9766-53fd26fc59d6,a2b7f123-1234-4567-8888-abcdabcdabcd

Save results to a JSON file:

vianctl modelstore get-tags --model-uuid e1e0d306-f5e6-4564-9766-53fd26fc59d6 --output file:tags.json

Usage:

$ vianctl modelstore get-tags [OPTIONS]

Options:

--model-uuid TEXT: Model uuid
--project-name TEXT: Project Name
--project-uuid TEXT: Project uuid.
--tag TEXT: tag name
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl modelstore delete-tags`

Delete or archive a model tag from the Model Store.

Required:

--tag-uuid UUID of the tag to delete or archive

Optional:

--delete-type 'archive' (default), 'delete' or 'force_delete'

--output Output format (json, table, csv, yaml, or file:<filename>)

This command either archives or permanently deletes the specified tag based on the delete_type.

Examples:

Archive the tag (default behavior):

  vianctl modelstore delete-tags --uuids 0fc2c922-8ec3-4ce1-b9db-44b165d6ff24

Permanently delete the tag:

vianctl modelstore delete-tags uuids 0fc2c922-8ec3-4ce1-b9db-44b165d6ff24 --delete-type delete

Usage:

$ vianctl modelstore delete-tags [OPTIONS]

Options:

--delete-type TEXT: select delete type from (archive / delete / force_delete) [default: archive]
--model-uuid TEXT: Model uuid
--names TEXT: Model tag name.
--uuids TEXT: Model tag uuid.
--status TEXT: Model tag status.
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl objpermissions`

List, create, delete, and other actions on object permissions in the Vianai platform,

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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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.

-------------------------------
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 "machine learning" --page 1 --size 5

Usage:

$ vianctl pipelines list [OPTIONS]

Options:

-p, --pipeline: Include pipeline details in the output
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
-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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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
--tgt-set INTEGER: Target dataset ID
--target-column TEXT: Target column
-f, --pipeline-file TEXT: JSON file containing pipeline steps [required]
--ref-pipeline INTEGER: Reference pipeline ID
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl projects`

Manage projects in the platform.

--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl render`

Render and preview QnA templates on the Vianai platform.

This CLI allows you to render Jinja templates for QnA questions, threads, or conversations by providing either a UUID (for lookup) or a JSON payload directly. The rendered output can be previewed in JSON or raw format.

----------------------- AVAILABLE COMMANDS: -----------------------

question Render a template for a single QnA question. conversation Render a template for a QnA conversation. thread Render a template for a QnA thread.

----------------------- KEY PARAMETERS: -----------------------

--uuid UUID for lookup (question, thread, or conversation). --json-file Path to a JSON file for the template payload. --template Template path (e.g., template_path/template_name.html). --output / -o Output format: json | raw.

----------------------- USAGE EXAMPLES: -----------------------

vianctl render question --uuid <uuid> vianctl render conversation --uuid <uuid> vianctl render thread --json-file ./payload.json

----------------------- TIPS: -----------------------

• Use --json-file to provide complex JSON payloads for rendering. • Either --uuid or --json-file must be provided, not both. • The subcommand determines the default template path if --template is not specified. • Use --output raw to print the raw rendered template.

Usage:

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

Options:

--help: Show this message and exit.

Commands:

question: Render a template for a question.
conversation: Render a template for a conversation.
thread: Render a template for a thread.

`vianctl render question`

Render a template for a question.

Usage:

$ vianctl render question [OPTIONS]

Options:

--uuid TEXT: UUID for lookup (question)
--json-file TEXT: Path to JSON file for payload
--template TEXT: Template path, e.g., template_path/template_name.html
--output TEXT: Output format: json or raw [default: json]
--help: Show this message and exit.

`vianctl render conversation`

Render a template for a conversation.

Usage:

$ vianctl render conversation [OPTIONS]

Options:

--uuid TEXT: UUID for lookup (conversation)
--json-file TEXT: Path to JSON file for payload
--template TEXT: Template path, e.g., template_path/template_name.html
--output TEXT: Output format: json or raw [default: json]
--help: Show this message and exit.

`vianctl render thread`

Render a template for a thread.

Usage:

$ vianctl render thread [OPTIONS]

Options:

--uuid TEXT: UUID for lookup (thread)
--json-file TEXT: Path to JSON file for payload
--template TEXT: Template path, e.g., template_path/template_name.html
--output TEXT: Output format: json or raw [default: json]
--help: Show this message and exit.

`vianctl roles`

List roles, create, update, and delete roles in the Vianai platform.

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.

The create/update commands require permissions to be in this format: [ {"api.x":["create","read","update","delete"]}, …] where api.x is the API endpoint and create/read/update/delete are the actions allowed on that api endpoint. Remove an item from the list to remove that permission for that role for that endpoint.

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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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).
-p, --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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl threads`

Create, update, list, and delete QNA threads efficiently.

QNA threads represent individual questions within a QNA Conversation, serving as distinct entities for organizing and managing discussions.

-----------------------
USAGE EXAMPLES:
-----------------------

vianctl qnathread list --page 1 --page-size 10
vianctl qnathread create --qna-conversation-uuid "<uuid>" --name "New Thread" --description "This is a sample QNA Thread" --title "Sample Title"
vianctl qnathread update --filters '{"uuid": ["<uuid>"]}' --name "Updated Thread" --description "Updated description" --status "ACTIVE" --is-pinned
vianctl qnathread delete --filters '{"uuid": ["<uuid>"]}' --delete-type "delete"

-----------------------
TIPS:
-----------------------

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

Usage:

$ vianctl threads [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 threads list`

List QNA Threads with advanced filtering options.

Usage:

$ vianctl threads 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl threads create`

Create a new QNA Thread with optional parameters.

Usage:

$ vianctl threads 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl threads update`

Update an existing QNA Thread.

Usage:

$ vianctl threads 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl threads delete`

Delete QNA Threads with advanced filtering options.

Usage:

$ vianctl threads 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl tools`

Manage 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 > template.json

JSON File Format:

Single transformer: {"classname": "…", "method": "…", …} Multiple transformers: [{"classname": "…", …}, {"classname": "…", …}]

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`

Upload unstructured documents and ask quesitons about them.

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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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]
-t, --timeout INTEGER: Timeout in seconds for the upload process (default: 300 seconds) [default: 300]
-i, --interactive: Interactive mode
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 "What is this document about?"

Specify conversation explicitly (useful for chaining queries):

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

🔹 Interactive mode:

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

vianctl unstructured ask --file 'file:/pritam.kishor/apple_news.pdf, file:/pritam.kishor/apple_news2.pdf' --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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl usagetracking`

Check usage tracking and metrics in the platform.

Provides commands to fetch usage logs and stack trace metrics for monitoring and analysis.

-----------------------
USAGE EXAMPLES:
-----------------------

vianctl usage get-logs --size 10000 --sort-field "@timestamp" --sort-order desc
vianctl usage get-logs --key "job-id" --fields "key,message,status"
vianctl usage stack-metrics --key "function.stage1" --milliseconds 500 --sort-order asc

-----------------------
TIPS:
-----------------------

• Use --fields to select specific fields for log output.
• Use --milliseconds to filter stack metrics by execution time.
• Use --output-format to control the output style (json, yaml, table).
• Run --help after any subcommand for more details.

Usage:

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

Options:

--help: Show this message and exit.

Commands:

get-logs: Fetch logs from the system with optional…
stack-metrics: Fetch stack trace metrics.

`vianctl usagetracking get-logs`

Fetch logs from the system with optional filtering and sorting.

The results can be sorted and limited

based on size and sort options. Output format can be customized.

Examples:

-----------

Get the latest 100 logs sorted by timestamp:

vianctl usage get-logs

Get logs filtered by a specific key:

vianctl usage get-logs --key "job-id"

Get logs sorted in ascending order:

vianctl usage get-logs --sort-order asc

Use the follow option to continuously fetch new logs:

vianctl usage get-logs --follow

Usage:

$ vianctl usagetracking get-logs [OPTIONS]

Options:

-k, --key TEXT: Filter logs by this key
-s, --size TEXT: Number of log records to fetch (default: 100) [default: 100]
--sort-field TEXT: Field name to sort results by (default: '@timestamp') [default: @timestamp]
--sort-order TEXT: Sort order for logs, either "asc" or "desc". Default is "desc". [default: desc]
-p, --pod-name-contains TEXT: Pod name to filter logs by.
-i, --interactive: Interactive mode
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
-f, --follow: Follow log output (like tail -f)
--help: Show this message and exit.

`vianctl usagetracking stack-metrics`

Fetch stack trace metrics.

You can filter by key and duration (milliseconds), and sort the results accordingly.

Examples:

-----------

Get recent stack metrics:

vianctl usage stack-metrics

Get metrics filtered by key:

vianctl usage stack-metrics --key "function.stage1"

Get metrics for durations above a certain threshold:

vianctl usage stack-metrics --milliseconds 500

Get metrics sorted in ascending order:

vianctl usage stack-metrics --sort-order asc

Usage:

$ vianctl usagetracking stack-metrics [OPTIONS]

Options:

--key TEXT: Filter metrics by this key
--milliseconds TEXT: Minimum execution time in milliseconds to filter metrics
--size INTEGER: Number of metric records to fetch (default: 10000) [default: 10000]
--sort-field TEXT: Field to sort results by (default: '@timestamp') [default: @timestamp]
--sort-order TEXT: Sort order: 'asc' or 'desc' (default: 'desc') [default: desc]
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl users`

List users, create new users, and delete existing users in the platform.

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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl userpreferences`

Set and get 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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)
-u, --user_id TEXT: user id for whom the preference is to be set (optional)
-i, --interactive: Interactive mode
-O, --output TEXT: Output format for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--help: Show this message and exit.

`vianctl vianai_config`

Set and get 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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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 for displaying results.

Supported formats:

table → Display as a table (console only)
json → Display as JSON
csv → Display as CSV
yaml → Display as YAML

To save the output to a file instead of console, use:

file:models.json → Save as JSON file
file:models.csv → Save as CSV file
file:models.yaml → Save as YAML file
--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

Websocket client connection allows users to look at the different messages which are passed from one service to other for communication. This can be a helpful tool in debugging issues related to service communication in the Vianai platform.

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