Class: Aws::TranscribeService::Types::TranscriptFilter

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 TranscriptFilter data as a hash:

{
  transcript_filter_type: "EXACT", # required, accepts EXACT
  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,
  targets: ["NonEmptyString"], # required
}

Matches the output of the transcription to either the specific phrases that you specify, or the intent of the phrases that you specify.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#absolute_time_rangeTypes::AbsoluteTimeRange

A time range, set in seconds, between two points in the call.



3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3987

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

#negateBoolean

If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.

Returns:

  • (Boolean)


3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3987

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

#participant_roleString

Determines whether the customer or the agent is speaking the phrases that you've specified.

Returns:

  • (String)


3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3987

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

#relative_time_rangeTypes::RelativeTimeRange

An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.



3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3987

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

#targetsArray<String>

The phrases that you're specifying for the transcript filter to match.

Returns:

  • (Array<String>)


3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3987

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

#transcript_filter_typeString

Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.

Returns:

  • (String)


3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3987

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