Class: Aws::TranscribeService::Types::SentimentFilter

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb

Overview

Note:

When making an API call, you may pass SentimentFilter data as a hash:

{
  sentiments: ["POSITIVE"], # required, accepts POSITIVE, NEGATIVE, NEUTRAL, MIXED
  absolute_time_range: {
    start_time: 1,
    end_time: 1,
    first: 1,
    last: 1,
  },
  relative_time_range: {
    start_percentage: 1,
    end_percentage: 1,
    first: 1,
    last: 1,
  },
  participant_role: "AGENT", # accepts AGENT, CUSTOMER
  negate: false,
}

Flag the presence or absence of specific sentiments detected in your Call Analytics transcription output.

Rules using SentimentFilter are designed to match:

  • The presence or absence of a positive sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a negative sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a neutral sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a mixed sentiment felt by the customer, the agent, or both at specified points in the call

See Rule criteria for examples.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#absolute_time_rangeTypes::AbsoluteTimeRange

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.



3690
3691
3692
3693
3694
3695
3696
3697
3698
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3690

class SentimentFilter < Struct.new(
  :sentiments,
  :absolute_time_range,
  :relative_time_range,
  :participant_role,
  :negate)
  SENSITIVE = []
  include Aws::Structure
end

#negateBoolean

Set to TRUE to flag the sentiments you didn't include in your request. Set to FALSE to flag the sentiments you specified in your request.

Returns:

  • (Boolean)


3690
3691
3692
3693
3694
3695
3696
3697
3698
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3690

class SentimentFilter < Struct.new(
  :sentiments,
  :absolute_time_range,
  :relative_time_range,
  :participant_role,
  :negate)
  SENSITIVE = []
  include Aws::Structure
end

#participant_roleString

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.

Returns:

  • (String)


3690
3691
3692
3693
3694
3695
3696
3697
3698
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3690

class SentimentFilter < Struct.new(
  :sentiments,
  :absolute_time_range,
  :relative_time_range,
  :participant_role,
  :negate)
  SENSITIVE = []
  include Aws::Structure
end

#relative_time_rangeTypes::RelativeTimeRange

Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.



3690
3691
3692
3693
3694
3695
3696
3697
3698
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3690

class SentimentFilter < Struct.new(
  :sentiments,
  :absolute_time_range,
  :relative_time_range,
  :participant_role,
  :negate)
  SENSITIVE = []
  include Aws::Structure
end

#sentimentsArray<String>

Specify the sentiments you want to flag.

Returns:

  • (Array<String>)


3690
3691
3692
3693
3694
3695
3696
3697
3698
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3690

class SentimentFilter < Struct.new(
  :sentiments,
  :absolute_time_range,
  :relative_time_range,
  :participant_role,
  :negate)
  SENSITIVE = []
  include Aws::Structure
end