Describes an analysis set
| Field | Type | Label | Description |
| analysis_set_id | string | UUID for the current analysis set |
|
| description | string | Name or description for the analysis set |
|
| created_date | google.protobuf.Timestamp | Creation timestamp |
|
| filter_json | string | Interaction filter definition |
|
| num_sessions | uint32 | Number of sessions included in the analysis set |
|
| num_interactions | uint32 | Number of interactions included in the analysis set |
|
| job_status_json | string | Current status for the analysis set creation as json |
|
| filter_summary | string | Short description of the filter used |
|
| analysis_set_status | AnalysisSet.AnalysisSetStatus | Current status for the analysis set |
|
| settings_json | string | Current settings used |
|
| analysis_json | string | Analysis set description as a json string |
|
| properties | AnalysisSetProperties | Analysis set properties |
Creates an analysis set based on the requested filter
| Field | Type | Label | Description |
| filter_options | AnalysisSetFilterOptions | Creation filter |
|
| analysis_set_name | string | The name (description) of the new analysis set created |
Returns the new created analysis set identifier
| Field | Type | Label | Description |
| analysis_set_id | string | UUID of the new analysis set created |
Deletes an existing analysis set
| Field | Type | Label | Description |
| analysis_set_id | string | UUID of the target analysis set |
Empty response for deletion operation
Defines a filter for analysis set creation
| Field | Type | Label | Description |
| start_timestamp | google.protobuf.Timestamp | Start timestamp for the interval |
|
| end_timestamp | google.protobuf.Timestamp | End timestamp for the interval |
|
| interaction_type | InteractionType | Interaction type filter |
|
| sub_type | InteractionSubType | Interaction SubType |
|
| final_result_status | FinalResultStatus | Interaction status filter |
|
| language_string | string | Interaction language filter |
|
| grammar_hash | string | Specific grammars filter |
|
| properties | AnalysisSetProperties | Analysis set properties |
Request for analysisSet retrieval
| Field | Type | Label | Description |
| analysis_set_id | string | UUID of the target analysis set |
Returns the requested analysis set
| Field | Type | Label | Description |
| analysis_set | AnalysisSet | Requested analysis set |
Defines a filter for analysis set list
| Field | Type | Label | Description |
| created_date_from | google.protobuf.Timestamp | Start timestamp for the interval |
|
| created_date_to | google.protobuf.Timestamp | End timestamp for the interval |
|
| type | InteractionType | Interaction type filter |
|
| description | string | Description (name) filter |
Creates a request / filter for analysis set retrieval
| Field | Type | Label | Description |
| page_size | uint32 | Number of records per page (optional). Accepted values 1-100, default 10 |
|
| starting_at | uint32 | Records offset for applied filter (optional), default 0 |
|
| list_order | AnalysisSetListRequest.AnalysisSetListOrder | repeated | Analysis set list order (optional), default created_date |
| filter | AnalysisSetListFilterOptions | Additional filtering options (optional, e.g. by type or language...) |
Returns a list of analysis sets
| Field | Type | Label | Description |
| analysis_set_list | AnalysisSet | repeated | The list of requested analysis sets |
| total_number_of_matched | uint32 | The number of analysis sets in the response |
Requests the number of interactions and sessions generated by an AnalysisSetCreate filter
| Field | Type | Label | Description |
| filter_options | AnalysisSetFilterOptions | Analysis set filter |
Returns the number of sessions and interactions generated by an AnalysisSetCreate filter
| Field | Type | Label | Description |
| sessions_extract_needed | uint32 | Number of sessions |
|
| interactions_extract_needed | uint32 | Number of interactions |
Stores the analysis set properties
| Field | Type | Label | Description |
| combine_business_and_residence | bool | Flag to combine Human Business and Human Residence for CPA results |
Describes the binary data entry structure
| Field | Type | Label | Description |
| storage_id | string | Binary storage identifier |
|
| deployment_id | string | Deployment identifier |
|
| tag | string | Associated tag for the binary data |
|
| data | bytes | Binary data |
|
| data_type | DataType | Type of the binary data |
Describes component for license usage
| Field | Type | Label | Description |
| usage_count | uint32 | number of operations for this component |
|
| usage_ms | uint32 | milliseconds used for this component |
Describes an Analysis Set export request
| Field | Type | Label | Description |
| analysis_set_id | string | UUID of the analysis set selected for export |
Describes an Analysis Set export response
| Field | Type | Label | Description |
| status | google.rpc.Status | The export statsus. |
|
| analysis_set_id | string | UUID of the analysis set selected for export |
|
| analysis_set_description | string | Description of the exported analysis set |
|
| archived_data | bytes | archived analysis set data |
|
| status_message | string | Error description in case of failures |
Request for ThirdPartyLicenses
Currently no fields required
Response for ThirdPartyLicenses request
| Field | Type | Label | Description |
| third_party_licenses | string | Text for ThirdPartyLicense description |
| Field | Type | Label | Description |
| analysis_set_id | string | UUID of the analysis set selected for export |
|
| analysis_set_description | string | Description of the imported analysis set |
|
| archived_data | bytes | archived analysis set data |
| Field | Type | Label | Description |
| status | google.rpc.Status | The import statsus. |
|
| analysis_set_id | string | UUID of the imported analysis set |
|
| status_message | string | Error description in case of failures |
Defines the Interaction filter within an analysis set
| Field | Type | Label | Description |
| session_id | string | Lumenvox session identifier |
|
| start_timestamp | google.protobuf.Timestamp | Start date time |
|
| end_timestamp | google.protobuf.Timestamp | End date time |
|
| grammar_hash | string | Include selected grammars |
|
| ssml_hash | string | Include selected ssml |
|
| search_text | string | Search text |
Creates a request for interaction details retrieval
| Field | Type | Label | Description |
| interaction_id | string | UUID of the interaction |
|
| analysis_set_id | string | UUID for the analysis set |
Returns the InteractionDetails for requested interaction / analysis set
| Field | Type | Label | Description |
| interaction | InteractionDetails | Interaction details message |
Creates a request for analysis set retrieval based on predefined filters
| Field | Type | Label | Description |
| analysis_set_id | string | Identifier of analysis set (required) |
|
| page_size | uint32 | Page size, accepted values 1-100, default 10 (optional) |
|
| starting_at | uint32 | Records offset for applied filter, default 0 (optional) |
|
| list_order | InteractionAnalysisListRequest.InteractionAnalysisListOrder | repeated | Set analysis set order, default created_date (optional) |
| filter | InteractionAnalysisFilterOptions | Additional filtering options (e.g. by type or language...) (optional) |
Returns a filtered list of interactions within selected analysis set
| Field | Type | Label | Description |
| interaction_list | InteractionDetails | repeated | List of Interactions |
| total_number_of_matched | uint32 | Total number of entries in the list |
|
| total_number_of_transcribed | uint32 | Total number of transcribed entries in the list |
Update asr transcription message
| Field | Type | Label | Description |
| interaction_id | string | UUID for interaction |
|
| analysis_set_id | string | UUID of analysis set |
|
| transcript_text | string | New transcription value |
|
| transcript_si | string | New transcription semantic interpretation |
|
| notes | string | Notes |
Updates the transcription for an asr interaction
| Field | Type | Label | Description |
| interactionAnalysis | InteractionAnalysisUpdateTranscription | Update transcription message |
Updates asr transcription response
| Field | Type | Label | Description |
| status | google.rpc.Status | Operation status |
|
| interaction | InteractionDetails | Product interaction within a session |
Describes one interaction
| Field | Type | Label | Description |
| id | string | New interaction UUID |
|
| analysis_set_id | string | Analysis set uuid |
|
| session_id | string | Original session identifier |
|
| interaction_id | string | Original interaction identifier |
|
| main_type | InteractionType | Base or Original Interaction type: ASR, TTS |
|
| status | InteractionAnalysisStatus | Analysis status |
|
| channel_id | uint32 | Audio channel identifier |
|
| audio_format | AudioFormat | Audio format |
|
| error | string | Error |
|
| start_timestamp | google.protobuf.Timestamp | Processing start timestamp |
|
| end_timestamp | google.protobuf.Timestamp | Processing end timestamp |
|
| transcript_text | string | Transcribed text |
|
| transcript_semantic | string | Transcribed semantic |
|
| original_result | InteractionResultSet | Original interaction result |
|
| tuned_result | InteractionResultSet | Tuned interaction result |
|
| status_text | string | Analysis status text |
|
| html_error | string | Error text in html format |
|
| type | InteractionType | Converted Interaction type: CPA, TTS |
|
| sub_type | InteractionSubType | Interaction SubType |
|
| notes | string | Notes |
Describes an interaction result with current settings and grammars
| Field | Type | Label | Description |
| settings | InteractionSettings | Interaction settings |
|
| text | string | Returned text |
|
| semantic | string | Returned semantic |
|
| score | uint32 | Confidence |
|
| grammar_hash | string | repeated | Grammars used |
| ssml_hash | string | repeated | Ssmls used |
| interaction_result | Result | Interaction result |
|
| decode_time | uint32 | Decode time |
|
| confidence_threshold | float | Confidence Threshold |
|
| interaction_request | string | Interaction Request |
|
| final_result_status | FinalResultStatus | Final status of the interaction |
|
| log_events | LogEvent | repeated | Interaction Events |
| phrases | TranscriptionPhraseList | repeated | Optional phrase lists for transcription interaction |
| final_result_status_text | string | Final result status text |
|
| session_settings | SessionSettings | Session settings |
LicenseStatusReportPullRequest sent to request license report status info
no fields
LicenseStatusReportPullResponse contains information provided by license
service with corresponding id which will be matched later when receiving
response from lumenvox cloud licensing server
| Field | Type | Label | Description |
| license_status_id | string | unique license status id |
|
| license_status_report_json | string | license status report received from license service |
|
| status | google.rpc.Status | response status |
LicenseStatusReportResponsePushRequest contains information from lumenvox license
cloud services which are then sent to license service for validation
| Field | Type | Label | Description |
| license_status_id | string | unique license status id |
|
| license_status_report_response_json | string | license status response retrieved from lumenvox cloud license server |
LicenseStatusReportResponsePushResponse contains status determining if request was
successfully processed
| Field | Type | Label | Description |
| status | google.rpc.Status | response status |
Request for binary data retrieval
| Field | Type | Label | Description |
| storage_id | string | Storage identifier for the binary data |
Returns the binary data
| Field | Type | Label | Description |
| archive_entry | ArchiveEntry | Binary data |
Describes a request for storage identifier
| Field | Type | Label | Description |
| type | DataType | Data type to be retrieved |
|
| hash | string | Hash of the data |
|
| session_id | string | Session identifier |
|
| channel_id | int32 | Audio chanel |
Returns the binary storage UUID
| Field | Type | Label | Description |
| storage_id | string | Binary storage UUID |
Describes the snapshot data structure
| Field | Type | Label | Description |
| deployment_id | string | Deployment ID |
|
| snapshot_uuid | string | Snapshot UUID (primary key for snapshot database table) |
|
| created_date | int64 | Snapshot created (unix timestamp) |
|
| component_license_usage | ComponentLicenseUsage | repeated | Usage report snapshot generated at created_date Array of usage report information, one element per component |
Report request for current transaction usages
| Field | Type | Label | Description |
| component | string | Optional component filter (all components returned if not specified) |
Returns usage report
| Field | Type | Label | Description |
| session_ms | uint32 | milliseconds of time (duration) of session/deployment |
|
| session_audio_ms | uint32 | milliseconds of audio streamed into session/deployment. |
|
| license_usage | UsageReportResponse.LicenseUsageEntry | repeated | map of license usage metadata aggregated for single session. |
| Field | Type | Label | Description |
| key | string |
|
|
| value | ComponentLicenseUsage |
|
UsageSnapshotRequest
Report request for snapshot transaction usages
| Field | Type | Label | Description |
| component | string | Optional component filter (all components returned if not specified) |
|
| start_timestamp | google.protobuf.Timestamp | Starting timestamp for filter |
|
| end_timestamp | google.protobuf.Timestamp | Ending timestamp for filter |
Response for snapshot usage
| Field | Type | Label | Description |
| snapshot_data | SnapshotData | repeated | Array of usage snapshot report information, one element per snapshot Note that each snapshot may contain multiple ComponentData entries |
Describes the possible statuses for an analysis set
| Name | Number | Description |
| ANALYSIS_SET_STATUS_UNINITIALIZED | 0 | Not yet initialized |
| ANALYSIS_SET_STATUS_CREATING | 1 | Create operation is in progress |
| ANALYSIS_SET_STATUS_READY | 2 | Created sucessfuly |
| ANALYSIS_SET_STATUS_WORKING | 3 | Tuning in progress |
| ANALYSIS_SET_STATUS_DELETED | 4 | Deleted |
| ANALYSIS_SET_STATUS_ERASING | 5 | Deletion in progress |
Enum with available sorting fields
| Name | Number | Description |
| ANALYSIS_SET_LIST_ORDER_CREATED_DATE | 0 | Order by creation date ascending |
| ANALYSIS_SET_LIST_ORDER_CREATED_DATE_DESC | 1 | Oreder by creation date descending |
| ANALYSIS_SET_LIST_ORDER_NUM_SESSIONS | 2 | Order by the number of sessions ascending |
| ANALYSIS_SET_LIST_ORDER_NUM_SESSIONS_DESC | 3 | Order by the number of sessions descending |
| ANALYSIS_SET_LIST_ORDER_NUM_INTERACTIONS | 4 | Order by the number of interactions ascending |
| ANALYSIS_SET_LIST_ORDER_NUM_INTERACTIONS_DESC | 5 | Order by the number of interactions descending |
| ANALYSIS_SET_LIST_ORDER_STATUS | 6 | Order by interaction status ascending |
| ANALYSIS_SET_LIST_ORDER_STATUS_DESC | 7 | Order by interaction status descending |
| ANALYSIS_SET_LIST_ORDER_NAME | 8 | Order by interaction name ascending |
| ANALYSIS_SET_LIST_ORDER_NAME_DESC | 9 | Order by interaction name descending |
| ANALYSIS_SET_LIST_ORDER_TYPE | 10 | Order by interaction type ascending |
| ANALYSIS_SET_LIST_ORDER_TYPE_DESC | 11 | Order by interaction type descending |
Data types for binary storage
| Name | Number | Description |
| DATA_TYPE_UNDEFINED | 0 | Undefined |
| DATA_TYPE_AUDIO | 1 | Audio |
| DATA_TYPE_MODEL | 2 | Voice print |
| DATA_TYPE_FEATURE | 3 | Voice print feature |
| DATA_TYPE_HASH | 4 | Audio hash |
| DATA_TYPE_SSML | 5 | Ssml |
| DATA_TYPE_GRAMMAR | 6 | Grammar |
Enum with the sorting fields
| Name | Number | Description |
| INTERACTION_ANALYSIS_LIST_ORDER_START_TIME | 0 | Order by interaction start date ascending |
| INTERACTION_ANALYSIS_LIST_ORDER_START_TIME_DESC | 1 | Order by interaction start date descending |
| INTERACTION_ANALYSIS_LIST_ORDER_END_TIME | 2 | Order by interaction end date ascending |
| INTERACTION_ANALYSIS_LIST_ORDER_END_TIME_DESC | 3 | Order by interaction end date descending Can be extended depending on requirements |
Enum with interaction analysis statuses
| Name | Number | Description |
| INTERACTION_ANALYSIS_STATUS_NO_TRANSCRIPT | 0 | No transcription |
| INTERACTION_ANALYSIS_STATUS_CORRECT | 1 | Correct |
| INTERACTION_ANALYSIS_STATUS_INCORRECT | 2 | Incorect |
| INTERACTION_ANALYSIS_STATUS_OOG | 3 | Out of Grammar |
| INTERACTION_ANALYSIS_STATUS_OOC | 4 | Out of Coverage |
| INTERACTION_ANALYSIS_STATUS_SI_MATCH | 5 | SI Match |
| INTERACTION_ANALYSIS_STATUS_LOAD_FAILURE | 6 | Failure for load |
| INTERACTION_ANALYSIS_STATUS_DECODE_FAILURE | 7 | Failure for decode |
| INTERACTION_ANALYSIS_STATUS_NO_INPUT | 8 | No input |
| INTERACTION_ANALYSIS_STATUS_CORRECT_NO_INPUT | 9 | No input - correct |
| INTERACTION_ANALYSIS_STATUS_INCORRECT_NO_INPUT | 10 | No input - incorrect |
ReportingAPIService
The LumenVox Reporting API can be used to access various reporting resources
| Method Name | Request Type | Response Type | Description |
| AnalysisSetPreCreate | AnalysisSetPreCreateRequest | AnalysisSetPreCreateResponse | 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. |
| AnalysisSetCreate | AnalysisSetCreateRequest | AnalysisSetCreateResponse | 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. |
| AnalysisSetGet | AnalysisSetGetRequest | AnalysisSetGetResponse | 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. |
| AnalysisSetDelete | AnalysisSetDeleteRequest | AnalysisSetDeleteResponse | Deletes an AnalysisSet |
| AnalysisSetList | AnalysisSetListRequest | AnalysisSetListResponse | 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. |
| RetrieveArchiveData | RetrieveArchiveDataRequest | RetrieveArchiveDataResponse | Retrieves data from the archive by its storage_id field. |
| RetrieveArchiveDataStream | RetrieveArchiveDataRequest | RetrieveArchiveDataResponse stream | Retrieves stream data from the archive by its storage_id field. |
| RetrieveStorageId | RetrieveStorageIdRequest | RetrieveStorageIdResponse | RetrieveStorageId retrieves the storage_id from archive by its hash value. |
| InteractionList | InteractionAnalysisListRequest | InteractionAnalysisListResponse | 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. |
| InteractionGet | InteractionAnalysisGetRequest | InteractionAnalysisGetResponse | Retrieves one interaction by ID. Interaction can be requested immediately after analysis set is created. |
| InteractionUpdate | InteractionAnalysisUpdateTranscriptionRequest | InteractionAnalysisUpdateTranscriptionResponse | Updates the interaction. Interaction can be updated in order to test different parameters setting for interaction processing. |
| GetThirdPartyLicenseAttribution | GetThirdPartyLicenseAttributionRequest | GetThirdPartyLicenseAttributionResponse | Returns license file of used third party components |
| UsageReport | UsageReportRequest | UsageReportResponse | Returns license usage report for specified deployment |
| UsageSnapshot | UsageSnapshotRequest | UsageSnapshotResponse | Returns license usage snapshots for specified deployment in specified period |
| LicenseStatusReportResponsePush | LicenseStatusReportResponsePushRequest | LicenseStatusReportResponsePushResponse | Sends lumenvox cloud license server response to license service |
| LicenseStatusReportPull | LicenseStatusReportPullRequest | LicenseStatusReportPullResponse | Retrieves license status report from license service |
| ExportAnalysisSet | ExportAnalysisSetRequest | ExportAnalysisSetResponse stream | Export analysis set data including audio and grammars. |
| ImportAnalysisSet | ImportAnalysisSetRequest stream | ImportAnalysisSetResponse | Import an analysis set from exported data. |
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| double | double | double | float | float64 | double | float | Float | |
| float | float | float | float | float32 | float | float | Float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
Copyright (C) 2001-2024, Ai Software, LLC d/b/a LumenVox