Silent mode data collection
This section contains silent mode data collection proto files.
Notes:
- To download Gatekeeper proto files, click download Gatekeeper proto files.
- Default values are determined by the gRPC specification. For more information, go to protocol buffers language guide .
smdc/silent_mode_data_collection_service.proto
SilentModeDataCollection
This service allows managing data collection.
gRPC method definitions
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| StartDataCollection | StartDataCollection Request |
StartDataCollection Response |
Starts data collection. The API triggers data collection in the background and immediately returns a response (it is a non-blocking API). If the requested channel for the same scope has started already, the specific channel start request is ignored. When failing to subscribe the requested channel, the specific channel start request is ignored. To get the status per channel, use the GetDataCollectionStats method. |
| GetDataCollectionStats | GetDataCollectionStats Request |
GetDataCollectionStats Response |
Gets the current data collection statistics. Returns information about extensions that are currently used for data collection in the specified scope. |
| StopDataCollection | StopDataCollection Request |
StopDataCollection Response |
Stops on-going data collection. If the requested channel collection is not running, the specific channel stop request is ignored. Channels that are not requested to stop continues to process calls. |
ActiveExtensionInfo
Monitored extension information.
| Field | Type | Description |
|---|---|---|
| extension | string | Required. The data collection extension. |
| data_collection_duration | google.protobuf.Duration | Required. Specified the amount of time that data is being collected. |
| processed_calls | int32 | Required. Number of calls processed so far. |
Extensions
List of extensions to include or exclude.
| Field | Type | Description |
|---|---|---|
| exclude_extensions | bool | Optional. When set to true, associated extensions are excluded from the aggregated list. Default is false. |
| from_extension | string | Required. The extension to start from when forming the extension list. Must contain only digits. |
| to_extension | string | Optional. The last extension when forming the extension list. Must contain only digits. If set, value must be higher or equal to the value of from_extension. The extension list is based on increments of one from the value of from_extension up to the value of to_extension. When not set, a single extension is aggregated based on the value of from_extension. |
| metadata | repeated Extensions.MetadataEntry | Optional. The metadata is part of Agent Session Manager’s start agent session method request. It is simulating metadata that is passed from the Web Agent Console to the Connector service. |
Extensions.MetadataEntry
| Field | Type | Description |
|---|---|---|
| key | string | |
| value | string |
GetDataCollectionStatsRequest
Input message that defines parameters for GetDataCollectionStats.
| Field | Type | Description |
|---|---|---|
| context | nuance.biosec.v1.Context | Mandatory. General request context. Only the scope ID is mandatory. |
GetDataCollectionStatsResponse
Output message that defines parameters returned by GetDataCollectionStats. If there are field violations in the request or if the client is not authroized to call this method, error status code is returned. Otherwise the returned status is OK.
| Field | Type | Description |
|---|---|---|
| status | nuance.rpc.Status | Required. General operation status. |
| active_extension_info | repeated ActiveExtensionInfo | Required. List of extensions that are currently used for data collection. An empty list indicates that currently data is not collected for the requested scope. |
StartDataCollectionRequest
Input message that defines parameters for StartDataCollection.
| Field | Type | Description |
|---|---|---|
| context | nuance.biosec.v1.Context | Mandatory. General request context. Only the scope ID is mandatory. |
| data_collection_duration | google.protobuf.Duration | Optional. Specifies the amount of time that data is being collected. If not provided, the default is 24 hours. |
| extensions | repeated Extensions | Required. List of extensions to subscribe as agents. |
| simulate_enrollment_consent | bool | Optional. When set to true, data collection includes a consent for enrollment that results in creating a voiceprint based on verification results from other calls made by the same speaker. Default is false. |
| session_override | bool | Optional. Allows overriding a session. When set to true, if a session with the specified agent_extension exists, it will be terminated. Also known as “session theft”. |
| restart_agent_session_idle_timeout | google.protobuf.Duration | Optional. Restarts the agent session if the elapsed time since the last processed call (or the start of the agent session) is equal to or greater than the duration value. |
| restart_agent_session_timeout | google.protobuf.Duration | Optional. Restarts the agent session if the elapsed time since the start of the agent session is equal to or greater than the duration value. |
StartDataCollectionResponse
Output message that defines parameters returned by StartDataCollection. If there are field violations in the request or if the client ID is not authorized to call this method, an error status code is returned. Otherwise, the method returns the OK status. To get the current channels status for a scope, use the GetDataCollectionStats method.
| Field | Type | Description |
|---|---|---|
| status | nuance.rpc.Status | Required. General operation status. |
StopDataCollectionRequest
Input message that defines parameters for StopDataCollection.
| Field | Type | Description |
|---|---|---|
| context | nuance.biosec.v1.Context | Mandatory. General request context. Only the scope ID is mandatory. |
| extensions | repeated Extensions | Optional. List of extensions to unsubscribe agents from. If no extensions are provided, all running extensions are unsubscribed. |
StopDataCollectionResponse
Output message that defines parameters returned by StopDataCollection. If there are field violations in the request or if the client ID is not authorized to call this method, an error status code is returned. Otherwise, the method returns the OK status.
| Field | Type | Description |
|---|---|---|
| status | nuance.rpc.Status | Required. General operation status. |