LumenVox containers data dictionary
This page provides information on the various tables found within the LumenVox Postgres Database.
Database table detail
Analysis Set
Table name: analysis_set
Description: This is a list of all the analysis sets available on the analysis portal. For each analysis set there is one row in this table. Each analysis set will have a corresponding table stored with the analysis_set_id set as its name containing all the relevant interaction sets (See Individual analysis sets below). Analysis sets can only be created if archiving is enabled.
Maintenance suggestions: This would depend on the clients data retention rules, but should they clear a table from here there should remove the table with the corresponding analysis_set_id. This function can also be performed via the analysis portal.
Field | Details |
analysis_set_id | Uuid default gen_random_uuid() - not null
|
deployment_id | uuid - not null
|
description
| text |
created_date | timestamp with time zone default now() - not null
|
filter_json | Text - not null
|
num_sessions | integer - not null
|
num_interactions | integer - not null
|
job_status_json | text
|
filter_summary | text
|
analysis_set_status | integer default 0 - not null
|
settings_json
| text |
analysis_json | text |
properties | bytea |
Individual analysis sets
Table name: analysis_interaction_[analysis_set_id]
Description: These are the individual analysis sets created via the analysis portal. Each analysis set is denoted with the analysis_set_id in its name (see example below).
Maintenance suggestions: This would depend on the clients data retention rules, but should they clear the analysis_sets table they should remove the corresponding analysis set table as well. This function can also be performed via the analysis portal.
Field | Details |
id | uuid |
session_id | uuid |
interaction_id | uuid |
interaction_type | integer |
interaction_main_type | integer |
interaction_sub_type | integer |
status | integer |
status_text | varchar |
channel_id | integer |
audio_format | varchar |
error | varchar |
start_date | timestamp with timezone |
end_date | timestamp with timezone |
transcript_text | varchar |
transcript_si | varchar |
notes | varchar |
original_result | varchar |
org_config | varchar |
org_text | varchar |
org_si | varchar |
org_score | integer |
org_final_result_status | integer |
org_final_result_text | varchar |
org_grammar_hash | text |
org_phrases_hash | text |
org_archive_metadata | smallint |
tuned_result | varchar |
tuned_config | varchar |
tuned_text | varchar |
tuned_si | varchar |
tuned_score | integer |
tuned_status | integer |
tuned_final_result_status | integer |
tuned_final_result_text | varchar |
tuned_grammar_hash | text |
tuned_phrases_hash | text |
tuned_archive_metadata | smallint |
Audit Auth Log (Voice biometrics)
Table name: AuditAuthLog
Description: This table is for voice biometrics only. This table is used by the audit service to log all API attempts e.g. init enrollment, finalize enrollment, createidentity
Maintenance suggestions: This is dependent on the client security audit requirements and data retention periods, but you may want to align with the BiometricSession retention rules.
Field | Details |
CorrelationId | uuid - not null
|
OperatorId | uuid - not null
|
EventDate | timestamp with time zone - not null
|
Action | varchar(50) - not null
|
Outcome | text - not null
|
TargetUri | varchar(500)
|
TargetName | varchar(50)
|
TargetId | varchar(50)
|
InitiatorId | varchar(50)
|
InitiatorType | varchar(50)
|
CredentialType | varchar(50)
|
DeploymentId | Uuid - not null
|
Audit Data Log (Voice biometrics)
Table name: AuditDataLog
Description: This table is for voice biometrics only. This table is linked to AuditAuthLog and shows what was changed (before/after) i.e. what was added, amended or deleted.
Maintenance suggestions: This is dependent on the client security audit requirements and data retention periods, but you may want to align with the BiometricSession retention rules.
Field | Details |
CorrelationId
| uuid - not null |
OperatorId | uuid - not null |
Action | text - not null |
ChangeDate
| timestamp with time zone - not null |
Service | varchar(500) - not null
|
Table
| varchar(50) - not null |
EntryId | Text - not null
|
Changes | Varchar |
DeploymentId | Uuid - not null
|
Biometric Error (Voice biometrics)
Table name: BiometricError
Description: This table is for voice biometrics only. It lists the errors belonging to a particular step in the enrolment or verification session.
Maintenance suggestions: The same maintenance rules applied to the BiometricSession table should be applied here.
Field | Details |
ErrorId | uuid default uuid_generate_v4() - not null
|
Error | varchar - not null |
ErrorCode | integer - not null
|
HttpStatusCode | integer - not null |
Message | varchar - not null |
MessageData | varchar |
BiometricStepId | uuid - not null |
Biometric Operation (Voice biometrics)
Table name: BiometricOperation
Description: This table is for voice biometrics only. All API operations like enroll, verify, create speaker, delete speaker etc are stored here.
Maintenance suggestions: This is dependent on the client security audit requirements and data retention periods.
Field | Details |
CorrelationId | uuid - not null |
OperationName | varchar(256) - not null |
HostNameIp | varchar(256) - not null |
ClientNameIp | varchar(256)- not null |
OperationStart | timestamp with time zone not null |
OperationEnd | timestamp with time zone not null |
OperationStatus | text - not null |
OperationErrorCode | smallint - not null |
OperationInfo | varchar |
OperatorId | uuid - not null |
DeploymentId | uuid - not null |
OperationHttpStatusCode | smallint. default 0, not null |
Biometric Result Type (Voice biometrics)
Table name: BiometricResultType
Description: This table is for voice biometrics only. The possible results for each enrolment and verification session result are saved here e.g. audio too loud, audio too short, successful match, mismatch.
Maintenance suggestions: None, this is a fixed table
Field | Details |
Id | integer generated by default as identity
|
Name | text - not null,
|
Description | text - not null,
|
Abbreviation
| char - not null |
Order | integer - not null
|
Biometric Session (Voice biometrics)
Table name: BiometricSession
Description: This table is for voice biometrics only. It stores the transactional data for each session.
Maintenance suggestions: This will depend on the grow of the number of sessions and the retention policy of the client.
Field | Details |
SessionSymbol | uuid - not null
|
SessionType | text - not null |
SessionStatus | text - not null |
SessionStart | timestamp with time zone - not null
|
SessionEnd | timestamp with time zone - not null
|
IdentitySymbol
| uuid - not null |
ConfigurationSymbol
| uuid - not null |
EnrollmentTag | varchar(256)
|
LanguageId
| smallint - not null |
DeploymentId | uuid - not null
|
Biometric Step (Voice biometrics)
Table name: BiometricStep
Description: This table is for voice biometrics only. Each step of the session for enrollment and verification is stored here e.g. on enrollment there would be a minimum of three steps to obtain the three required audio files.
Maintenance suggestions: The same maintenance rules applied to the BiometricSession table should be applied here.
Field | Details |
CorrelationId | uuid - not null
|
SessionSymbol
| uuid - not null |
Phrase | varchar - not null |
Step | smallint default 0 - not null |
StatusHint | text default - text not null |
StatusText | varchar
|
Biometric Step Result (Voice biometrics)
Table name: BiometricStepResult
Description: This table is for voice biometrics only. The table stores the results of each enrolment or verification step.
Maintenance suggestions: The same maintenance rules applied to the BiometricSession table should be applied here.
Field | Details |
CorrelationId | uuid - not null
|
ResultTypeId | integer - not null
|
ResultValue | text - not null
|
ResultLevel | text - not null |
Bun Migrations
Table name: bun_migrations
Description: This utilized for database migrations for Golang modules. Every update of the database for each release is logged here for migration. It keeps a record of database versions.
Maintenance suggestions: No maintenance needed. It stores one row per release.
Field | Details |
id | bigserial |
name | varchar |
group_id
| bigint |
migrated_at
| timestamp with time zone default CURRENT_TIMESTAMP - not null |
Bun Migration Locks
Table name: bun_migration_locks
Description: This is an internal table used for the data migration process. It saves a record of tables that are migrated per version upgrade. This assists with the startup of services upon migration.
Maintenance suggestions: None
Field | Details |
id
| bigserial |
table_name
| varchar |
id
| uuid - not null |
deployment_id | uuid - not null |
start_date
| timestamp with time zone not null |
end_date | timestamp with time zone not null,
|
waiting_interactions,
| text |
Settings | text |
num_interactions | integer - not null
|
archive_metadata
| bytea |
Configuration Attribute
Table name: CONFIGURATION_ATTRIBUTE
Description: This is the value associated with a configuration element for speech and voice biometric configurations.
Maintenance suggestions: None
Field | Details |
ID | uuid default uuid_generate_v4() not null |
CONFIGURATION_SYMBOL | uuid - not null |
NAME | text |
VALUE | text |
VALIDATION_CLASS | text |
Creator | text |
CreateDate | timestamp with time zone - not null |
Modifier | text |
ModifyDate | timestamp with time zone |
Configuration Element
Table name: CONFIGURATION_ELEMENT
Description: This table is used for mapping of speech and voice biometric configurations
Maintenance suggestions: None however it is advised that this is backed up
Field | Details |
CONFIGURATION_SYMBOL | uuid - default not null
uuid_generate_v4() |
TYPE | text - not null |
DESCRIPTION | text |
STATUS | varchar(1) |
LANGUAGE_ID | integer |
PARENT_CONFIGURATION_SYMBOL | uuid |
Creator | text |
CreateDate | timestamp with timezone, not null |
Modifier | text |
ModifyDate | timestamp with time zone |
NAME
| varchar(64) default uuid_generate_v4() not null |
DEPLOYMENT_ID | Uuid - default '00000000-0000-0000-0000-000000000000'::uuid not null |
Customer Keys
Table name: CustomerKeys
Description: For every deployment, a different customer encryption key is stored in this table.
Maintenance suggestions: None
Field | Details |
Id | uuid - not null |
DeploymentId | uuid - not null |
CreatedDate | timestamp with time zone not null |
MasterKeyId | uuid - not null |
EncryptedKey" | bytea |
Default Deployment Data
Table name: DefaultDeploymentData
Description: Used for automatically generating deployment data if not supplied. This is no longer in use.
Maintenance suggestions: No maintenance required
Field | Details |
Key | text - not null |
Value | text |
Creator | uuid - not null |
CreateDate | timestamp with time zone not null |
Modifier | uuid |
ModifyDate | timestamp with time zone |
Deployment Data
Table name: DeploymentData
Description: This is where all information surrounding deployment data e.g. connection strings & certificates is stored. This data is encrypted.
Maintenance suggestions: No maintenance is required. Deployments can be added and deleted from the admin portal. Deployments deleted are marked as deleted in this table but not physical removed for audit purposes.
Field | Details |
DeploymentId | uuid - not null |
Data | bytea |
Creator | uuid - not null |
CreateDate | timestamp with time zone not null |
Modifier | uuid |
ModifyDate | timestamp with time zone |
Metadata | bytea |
DeletedDate | timestamp with time zone |
Emergency Public Keys
Table name: EmergencyPublicKeys
Description: This was used to recover the customer key in case it gets lost, but the table is no longer in use and will be removed in a future release.
Maintenance suggestions: None
Field | Details |
Id | uuid - not null |
PublicKey | bytea |
IsActive | boolean - not null |
Creator | uuid - not null |
CreateDate | timestamp with time zone not null |
Modifier | uuid |
ModifyDate | timestamp with time zone |
Interaction
Table name: interaction
Description: This table stores a list of all interactions archived (if archiving is enabled).
Maintenance suggestions: This will depend on the clients data retention rules and how long they would like to store sessions and interactions for.
Field | Details |
id
| uuid - not null |
type
| integer - not null, |
sub_type
| integer - not null |
status
| integer - not null |
settings
| text |
required_grammars | text
|
language
| text |
start_date
| timestamp with time zone - not null |
end_date
| timestamp with time zone - not null |
deployment_id | uuid - not null
|
session_id
| uuid - not null |
audio_metadata | text |
request_metadata | text |
result_metadata
| text |
grammar_hash | text |
ssml_hash
| text |
result_externa
| text |
channel_id
| integer |
main_type
| integer default 0 - not null, |
archive_metadata
| bytea |
phrases_hash
| text |
License Statuses
Table name: license_statuses
Description: This table is important to the licensing phone home service and stores the information submitted to and received from LumenVox’s licensing server
Maintenance suggestions: None
Field | Details |
license_status_id | uuid - not null |
cluster_guid | uuid - not null |
sync_time | timestamp with time zone default CURRENT_TIMESTAMP not null |
reported | text - not null |
response | text - not null |
response_signature | text - not null |
License Usage Counters
Table name: license_usage_counters
Description: This stores usage information per various license counters e.g. product & language usage. Records are stored per session.
Maintenance suggestions: This table could be cleared out following the same maintenance rules for the session table however it’s important to note that this information is important for the phone home licensing function.
Field | Details |
deployment_id | uuid - not null |
license_usage | bytea |
date_stored | timestamp |
Master Keys
Table name: MasterKeys
Description: Used for encrypting customer keys
Maintenance suggestions: None. Automatically maintained.
Field | Details |
Id | uuid- not null |
MasterKeyHash | bytea |
CreatedDate | timestamp with time zone not null |
EmergencyBackup | bytea |
EncryptedMasterKey | bytea |
Migration Helpers
Table name: migration_helpers
Description: Used to track migration of license table when upgrading schema versions
Maintenance suggestions: None
Field | Details |
migration_guid | uuid - default |
from_ver | integer |
to_ver | integer - not null |
start_time
| timestamp with time zone default CURRENT_TIMESTAMP not null |
active | boolean - default true, not null |
Session
Table name: Session
Description: This table stores a list of all the sessions archived (if archiving is enabled).
Maintenance suggestions: This will depend on the clients data retention rules and how long they would like to store sessions and interactions for. If sessions are removed then corresponding interactions, audio etc should also be removed. This also may impact analysis sets created using the sessions.
Field | Details |
id | uuid |
deployment_id | uuid |
start_date | timestamp with time zone |
end_date | timestamp with time zone |
waiting_interactions | text |
settings | text |
num_interactions | integer |
archive_metadata | bytea |
Storage Audio
Table name: storage_audio
Description: Stores all the links to the audio files saved in MongoDB for display in the portal (if archiving is enabled).
Maintenance suggestions: This table can be cleaned up as per the client’s session table maintenance plan along with interactions.
Field | Details |
deployment_id
| uuid - not null |
session_id | uuid - not null
|
channel_id | integer default 0 - not null
|
interaction_id
| uuid |
storage_ref
| uuid - not null |
created_date | timestamp with time zone default now() - not null
|
Storage Grammar
Table name: storage_grammar
Description: Contains references to the grammars stored in MongoDB (if archiving is enabled).
Maintenance suggestions: This table can be cleaned up as per the client’s session table maintenance plan.
Field | Details |
deployment_id | uuid - not null |
hash_string | text - not null
|
storage_ref | uuid - not null |
created_date | timestamp with time zone default now() - not null
|
Storage Phrases
Table name: storage_phrases
Description: Stores phrase list references to phrase lists stored in the Mongo DB (if archiving is enabled).
Maintenance suggestions: This table can be cleaned up as per the client’s session table maintenance plan.
Field | Details |
deployment_id | uuid - not null
|
hash_string | text - not null |
phrases_string
| Text - not null |
created_date | timestamp with time zone default now - not null
|
Storage SSML
Table name: storage_ssml
Description: Stores SSML references to the SSML store in the Mongo DB (if archiving is enabled).
Maintenance suggestions: This table can be cleaned up as per the client’s session table maintenance plan.
Field | Details |
deployment_id | uuid - not null |
hash_string
| text - not null |
storage_ref
| uuid - not null |
created_date
| timestamp with time zone default now()- not null |
System Language (Voice biometrics)
Table name: SYSTEM_LANGUAGE
Description: This table is for voice biometrics only. It contains a list of all available languages for a Voice Biometric deployment.
Maintenance suggestions: This does not require maintenance.
Field | Details |
ID | integer generated by default as identity |
SYMBOL | varchar(10) not null, |
NAME | varchar(30) not null, |
PARENT_LANGUAGE_ID | integer |