Protocol Documentation

Not yet initialized

Create operation is in progress

Created successfully

Tuning in progress

Deleted

Deletion in progress

Exporting of the analysis set in progress (busy)

Importing of the analysis set in progress (busy)

Order by creation date ascending

Order by creation date descending

Order by the number of sessions ascending

Order by the number of sessions descending

Order by the number of interactions ascending

Order by the number of interactions descending

Order by interaction status ascending

Order by interaction status descending

Order by interaction name ascending

Order by interaction name descending

Order by interaction type ascending

Order by interaction type descending

Undefined

Audio

Voice print

Voice print feature

Audio hash

Ssml

Grammar

No diagnostic type specified (do not use)

Postgres diagnostic test specified

MongoDB diagnostic test specified

Redis diagnostic test specified

RabbitMQ diagnostic test specified

Order by interaction start date ascending

Order by interaction start date descending

Order by interaction end date ascending

Order by interaction end date descending Can be extended depending on requirements

No transcription

Correct

Incorect

Out of Grammar

Out of Coverage

SI Match

Failure for load

Failure for decode

No input

No input - correct

No input - incorrect

Used to analyze AnalysisSetFilterOptions and to notify user about number of sessions and interactions which are going to be included into analysis. This request is optional, and AnalysisSet can be created without this one being called.

Creates an analysis set based on the requested filter. There are AnalysisSetFilterOptions as part of request for various filtering adjustments like: start/end time, type, status etc.

Retrieves analysis set by ID returned from AnalysisSetCreate method call. analysis set can be requested immediately after being created. Check its status field AnalysisSetStatus for creating progress.

Deletes an AnalysisSet

Returns a list of some of AnalysisSet fields for table view. Classic pagination is used where you need to provide page size and starting point to get only limited data set.

Retrieves data from the archive by its storage_id field.

Retrieves stream data from the archive by its storage_id field.

RetrieveStorageId retrieves the storage_id from archive by its hash value.

Returns a list of some of interactions within analysis set. Classic pagination is used where you need to provide page size and starting point to get only limited data set.

Retrieves one interaction by ID. Interaction can be requested immediately after analysis set is created.

Updates the interaction. Interaction can be updated in order to test different parameters setting for interaction processing.

Returns license file of used third party components

Returns license usage report for specified deployment

Returns license usage snapshots for specified deployment in specified period

Sends lumenvox cloud license server response to license service

Retrieves license status report from license service

Export analysis set data including audio and grammars.

Import an analysis set from exported data.

Run various diagnostic checks: postgres, mongodb, redis

Performs fuzzy matching on machine and human transcribed texts

Creates a new Post-Processing Profile within a deployment and returns its server-generated GUID. Request: - CreatePostProcessingProfileRequest: - Includes data needed to define the profile (for example: deployment_id, name, and operations). - Operations are applied in ascending order of their index; index values should be unique within the profile. Response: - CreatePostProcessingProfileResponse: - Contains the GUID (UUID) of the newly created profile (profile_id). Behavior: - The profile name should be unique within the specified deployment. - Implementation will validate the operations list (e.g., non-empty pattern strings). Errors: - INVALID_ARGUMENT: Malformed request (e.g., missing required fields, invalid operations). - NOT_FOUND: Specified deployment does not exist. - ALREADY_EXISTS: A profile with the same name already exists within the deployment.

Retrieves Post-Processing Profile, specified by id. Request: - GetPostProcessingProfileRequest: - Contains requesting profile ID (profile_id). Response: - GetPostProcessingProfilesResponse: - Contains Post-Processing Profile message. Errors: - INVALID_ARGUMENT: Malformed request (e.g., invalid profile_id UUID string). - NOT_FOUND: Specified profile_id does not exist.

Retrieves Post-Processing Profiles, filtered by criteria in the request. Request: - GetPostProcessingProfilesRequest: Response: - GetPostProcessingProfilesResponse: - Contains a list of matching Post-Processing Profile(s). Errors: - INVALID_ARGUMENT: Malformed request (e.g., invalid UUID string).

Updates specified Post-Processing Profile. Request: - UpdatePostProcessingProfileRequest: - Contains profile_id of updating profile and new list of RegexOperations Response: - UpdatePostProcessingProfileResponse: - Contains the updated profile Behavior: - Server-managed fields (profile_id, created_at) are immutable; - A successful update should increment the profile version. Errors: - INVALID_ARGUMENT: Malformed request (e.g., missing profile identifier, invalid operations). - NOT_FOUND: Specified profile do not exist.

Deletes a Post-Processing Profile identified in the request. Request: - DeletePostProcessingProfileRequest: - Identifies the target profile to delete by profile_id. Response: - DeletePostProcessingProfileResponse: - Confirms the deletion and may include later additional metadata about the deleted profile. Behavior: - The operation removes the specified profile from use. Errors: - INVALID_ARGUMENT: Malformed request (e.g., missing required identifier). - NOT_FOUND: The specified profile does not exist or is already deleted.

Exports a Post-Processing Profile into a portable representation. Request: - ExportPostProcessingProfileRequest: - Identifies which profile to export. Response: - ExportPostProcessingProfileResponse: - Contains the serialized/portable profile definition suitable for backup, migration, or import. Behavior: - The exported payload should include all data necessary to faithfully recreate the profile, including name, operations (with ordering), and versioning history. Errors: - INVALID_ARGUMENT: Malformed request (e.g., missing identifiers). - NOT_FOUND: The specified profile (or version) does not exist.

Imports a Post-Processing Profile from a portable representation. Request: - ImportPostProcessingProfileRequest: - Provides the serialized/portable profile definition to import. Response: - ImportPostProcessingProfileResponse: - Returns identifiers for the imported profile (profile_id). Errors: - INVALID_ARGUMENT: Malformed payload or validation errors. - ALREADY_EXISTS: Conflict with an existing profile when overwrite is not allowed. - NOT_FOUND: Referenced deployment does not exist.

Retrieves the full version history of a Post-Processing Profile. Request: - GetPostProcessingProfileHistoryRequest: - Identifies the target profile by profile_id Response: - GetPostProcessingProfileHistoryResponse: - Contains an ordered collection of profile versions (ascending by version number) Behavior: - Returned versions should reflect the exact historical state, including timestamps. Errors: - INVALID_ARGUMENT: Malformed request. - NOT_FOUND: The specified profile does not exist.