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,
}

An object that enables you to specify a particular customer or agent sentiment. If at least 50 percent of the conversation turns (the back-and-forth between two speakers) in a specified time period match the specified sentiment, Amazon Transcribe will consider the sentiment a match.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#absolute_time_rangeTypes::AbsoluteTimeRange

The time range, measured in seconds, of the sentiment.



3016
3017
3018
3019
3020
3021
3022
3023
3024
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3016

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

#negateBoolean

Set to TRUE to look for sentiments that weren't specified in the request.

Returns:

  • (Boolean)


3016
3017
3018
3019
3020
3021
3022
3023
3024
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3016

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

#participant_roleString

A value that determines whether the sentiment belongs to the customer or the agent.

Returns:

  • (String)


3016
3017
3018
3019
3020
3021
3022
3023
3024
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3016

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

#relative_time_rangeTypes::RelativeTimeRange

The time range, set in percentages, that correspond to proportion of the call.



3016
3017
3018
3019
3020
3021
3022
3023
3024
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3016

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

#sentimentsArray<String>

An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.

Returns:

  • (Array<String>)


3016
3017
3018
3019
3020
3021
3022
3023
3024
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3016

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