Frequently Asked Questions#

How to use local folder as a plugin resource for Tokkio charts#

You may specify the local folder path as the config_dir option for ace agent components. For Tokkio, the following updates (addition of files field) are needed in the app.yaml file:

- name: chat-engine
type: ucf.svc.ace-agent.chat-engine
files:
    config_dir: <path_to_local_folder>
- name: chat-controller
type: ucf.svc.ace-agent.chat-controller
files:
    config_dir: <path_to_local_folder>
- name: plugin-server
type: ucf.svc.ace-agent.plugin-server
files:
    config_dir: <path_to_local_folder>

In the corresponding params.yaml file, remove the references to the NGC resource provided with the variable configNgcPath for these microservices.

How to provide a different name to the avatar character used in the reference workflow#

The name of the avatar character is dictated by the prompt given in the reference application’s plugin server. For example, in the following greeting flow for Colang, the avatar’s name has been embedded -

@meta(bot_intent=True)
flow bot express greeting
(bot express "Hi, I am Ben. How can I help you?"
    or bot express "Welcome! My name is Ben. Ask away!"

Similarly, for any prompt updates given to the LLM via the python modules, one can choose to add a system prompt to provide a name to the avatar.

What is the Difference between the Legacy NGC API Key and NGC Personal Key?#

Legacy API Key: This was the initial type of API key provided by NVIDIA NGC. It grants access to various NGC services but lacks advanced management features.

Personal API Key: Introduced to enhance security and management, Personal API Keys are tied to individual users within an NGC organization. They offer several advantages over the original API keys:

Role-Based Access Control (RBAC): Personal API Keys support RBAC, allowing administrators to define specific permissions for each user, thereby controlling access to different NGC services and resources.

Lifecycle Management: These keys are linked to the user’s lifecycle within the NGC organization. If a user leaves the organization or their role changes, their Personal API Key can be revoked or adjusted accordingly.

Key Management Features: Users can set expiration dates, revoke, delete, or rotate their Personal API Keys as needed, providing greater control and security.

How to migrate custom bots from Colang 2 alpha to Colang 2 beta#

Please refer to the Colang documentation for guidance regarding the migration.

How to add additional libraries to the plugin server resource#

The plugin server resource is a python module. Import the required library like you normally would for any python code. Example:

from openai import OpenAI, AsyncOpenAI

Add the additional modules/versions in the requirements.txt file

What is the difference between the Tokkio UI and the Tokkio Iframe?#

The Tokkio Iframe is a minimal UI which only contains an avatar stream and some basic controls, but nothing else. It doesn’t support many features, including ASR/TTS transcripts, the retail use-case, user-attention indicator, etc. The Iframe is designed to be embedded in a website, though it can also be deployed on its own.

The Tokkio UI harnesses the full power of all of the Tokkio features. It has support for all of the Tokkio features, and can be leveraged to create a fully customizable user experience which includes an avatar conversation as well as other types of user input such as a touch menu.

How can I embed the Tokkio Iframe in my website?#

Visit the Embedding the Iframe into a Website section in the Iframe documentation for details on how this can be done.

On this page