Configuration and maintenance of the AI Media Server

This section covers how to configure the AI Media Server (AIMS) to support custom features and functionality, and the commands used for maintenance purposes.

Do not make any changes to the AIMS VM via the terminal interface (other than as described when running the initial Pexip installation wizard) unless directed to do so by Pexip support. This includes (but is not limited to) changes to the time zone, changes to IP tables, configuration of Ethernet interfaces, or the installation of any third-party code/applications.

This section includes:

Installing / updating TLS certificates
Re-running the installation wizard
Configuring languages
Word boosting
Configuring Pexip Infinity instances

Installing / updating TLS certificates

After you have completed the initial installation of the AIMS VM and it has restarted, you must install valid TLS certificates. These certificates must be trusted by the Pexip Infinity instance that is connecting to AIMS, so you can either use a public TLS certificate, or upload your private CA to Pexip Infinity as a trusted CA certificate.

This same procedure is followed when you need to update or replace any expiring or expired certificates.

Log in to the AIMS server via SSH as the user admin@IP.
Copy your TLS certificates to the home directory of the admin user:
```
scp public.pem admin@IP:
scp private.pem admin@IP:
```

At the command prompt, run

aims-config tls-certs-set public.pem private.pem

Check that when you connect to https://<IP>, you get a holding page and the correct certificates are in use.

Re-running the installation wizard

To rerun the installation wizard:

Log in to the AIMS server as the user admin, either through SSH or the VMware console.
At the command prompt, run the command installwizard
At each step, the default values are the answers from the previous run (if they are still valid).

Press ENTER to accept the default value, or enter the value you want to use instead.

When all installation wizard steps have been completed, the appliance automatically reboots.

Configuring languages

AIMS supports a number of different languages. You enable the languages you wish to use in your deployment by loading an associated language model onto AIMS.

Getting the available language models

To get a list of all the language models that are currently supported by AIMS and therefore available for enabling on the server:

Log in to the AIMS server as the user admin, either through SSH or the VMware console.
At the command prompt, run:
```
aims-config services-list-available
```

This will output a list of available language models, for example:

de-DE-conformer
en-US-parakeet
es-US-conformer
fr-FR-conformer

Getting the loaded language models

To get a list of the language models that are already loaded onto AIMS:

Log in to the AIMS server as the user admin, either through SSH or the VMware console.
At the command prompt, run:
```
aims-config services-list-enabled
```

This will output the loaded language models, for example:

loaded_services: en-US-parakeet

Setting the loaded language models

To load selected language models onto AIMS:

At the command prompt, run:

aims-config services-set-enabled <language-model_1> <language-model_2>

For example:

aims-config services-set-enabled en-US-parakeet es-US-conformer

You will be prompted to reboot the appliance, and this will terminate all active sessions.

Changing the list of loaded services will reboot the box and terminate all running sessions (Y/N)

Setting the default language

To set the default language for a particular Pexip Infinity instance, which is used for all calls from VMRs that do not have a specific language configured):

At the command prompt, run:

aims-config infinity-instance-set-default-language <infinity-instance_name> <language>

where <infinity-instance_name> is the name of a Pexip Infinity instance registered with AIMS.

For example:

aims-config infinity-instance-set-default-language Pexip1 es-US

You will be prompted to reboot the appliance, and this will terminate all active sessions.

Word boosting

The "word boosting" capability allows administrators to enhance and extend the vocabulary of a language by uploading a word boosting file. This file is used to improve every Automatic Speech Recognition (ASR) interaction for live captions, ensuring the system recognizes proper names, products, and domain-specific terminologies more accurately.

When enabling or removing word boosting, any changes will take effect without needing to restart the AIMS server, but will only apply to newly-placed calls.

Enabling word boosting

To enable word boosting:

Create text file(s) containing the list of words to be boosted. You must create a separate file for each language you wish to support. For AIMS v1 the supported languages are en-US, es-US, de-DE and fr-FR.

Each file must meet the following requirements:
- one word per line, with no spaces
- alphabetic characters only (including capital letters)
- no numbers or symbols
- UTF-8 encoded.
For example, Pexip's en-US.txt file might include the following:
```
Pexip
Infinity
AIMS
VMR
WebRTC
```
Copy each file onto the AIMS server using SFTP/SCP.
Log in to the AIMS server as the user admin, either through SSH or the VMware console.

For each file, run the following command:

aims-config wordboost-add <language> <file>

For example:

aims-config wordboost-add en-US /wordboost/en-US.txt

The tool will tell you that it has imported the word boost information, for example:

I: Wordboost file for en-US updated with 3 words
I: Updated livecaption config file

Removing word boosting

To remove any existing word boost configuration for a given language, run:

aims-config wordboost-rm <language>

For example:

aims-config wordboost-rm en-US

Expected response:

I: Wordboost file for en-US updated with 0 words
I: Updated livecaption config file

Listing languages

To list the languages for which a word boost file has been configured on the system, run:

aims-config wordboost-list

This will return a list of languages, for example:

de-DE
en-US
es-US
fr-FR

Listing boosted words

To obtain the list of words configured in the word boost list for a given language, run:

aims-config wordboost-show <language>

For example:

aims-config wordboost-show en-US

might return:

Pexip
AIMS

Configuring Pexip Infinity instances

Getting the registered Pexip Infinity instances

To get a list of Pexip Infinity instances registered with this AIMS server:

Log in to the AIMS server as the user admin, either through SSH or the VMware console.
At the command prompt, run:
```
aims-config infinity-instance-list
```

Adding additional Pexip Infinity instances

To add additional Pexip Infinity instances:

Log in to the AIMS server as the user admin, either through SSH or the VMware console.
At the command prompt, run:
```
aims-config infinity-instance-add
```
At the prompt, enter a user-friendly name for this instance. This must be a single line with no spaces:
```
Infinity Instance Name (user-friendly):
```

At the prompt, paste the file containing the Live Captions App-Id and Live captions JWT public key that you copied when configuring Pexip Infinity with a media processing server:

Paste the output from your Infinity node:

The format should be similar to the following:

{"appId":"00abc000-111a-1234-1abc-a11122b3c444","pubKey":"-----BEGIN PUBLIC KEY-----\naaBBccDD2211NNddejj22pp0044mmMMeEEpppqqJJ2jj2kkkkeeddii99EE11nneedjj==\n-----END PUBLIC KEY-----","defaultLanguageCode": "en-US"}

Removing a configured Pexip Infinity instance

To remove a Pexip Infinity instance:

At the command prompt, run:

aims-config infinity-instance-rm <infinity-instance_name>

The name must match the name of an existing instance.

For example:

aims-config infinity-instance-rm Pexip1

would return:

I: Removed instance Pexip1
I: Updated livecaption config file