Class: Google::Cloud::ContactCenterInsights::V1::PhraseMatcher

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/contactcenterinsights/v1/resources.rb

Overview

The phrase matcher resource.

Defined Under Namespace

Modules: PhraseMatcherType

Instance Attribute Summary collapse

Instance Attribute Details

#activation_update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The most recent time at which the activation status was updated.

Returns:



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 979

class PhraseMatcher
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to combine each phrase match rule group to determine whether
  # there is a match.
  module PhraseMatcherType
    # Unspecified.
    PHRASE_MATCHER_TYPE_UNSPECIFIED = 0

    # Must meet all phrase match rule groups or there is no match.
    ALL_OF = 1

    # If any of the phrase match rule groups are met, there is a match.
    ANY_OF = 2
  end
end

#active ⇒ ::Boolean

Returns Applies the phrase matcher only when it is active.

Returns:

  • (::Boolean) —

    Applies the phrase matcher only when it is active.



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 979

class PhraseMatcher
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to combine each phrase match rule group to determine whether
  # there is a match.
  module PhraseMatcherType
    # Unspecified.
    PHRASE_MATCHER_TYPE_UNSPECIFIED = 0

    # Must meet all phrase match rule groups or there is no match.
    ALL_OF = 1

    # If any of the phrase match rule groups are met, there is a match.
    ANY_OF = 2
  end
end

#display_name ⇒ ::String

Returns The human-readable name of the phrase matcher.

Returns:

  • (::String) —

    The human-readable name of the phrase matcher.



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 979

class PhraseMatcher
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to combine each phrase match rule group to determine whether
  # there is a match.
  module PhraseMatcherType
    # Unspecified.
    PHRASE_MATCHER_TYPE_UNSPECIFIED = 0

    # Must meet all phrase match rule groups or there is no match.
    ALL_OF = 1

    # If any of the phrase match rule groups are met, there is a match.
    ANY_OF = 2
  end
end

#name ⇒ ::String

Returns The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}.

Returns:

  • (::String) —

    The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 979

class PhraseMatcher
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to combine each phrase match rule group to determine whether
  # there is a match.
  module PhraseMatcherType
    # Unspecified.
    PHRASE_MATCHER_TYPE_UNSPECIFIED = 0

    # Must meet all phrase match rule groups or there is no match.
    ALL_OF = 1

    # If any of the phrase match rule groups are met, there is a match.
    ANY_OF = 2
  end
end

#phrase_match_rule_groups ⇒ ::Array<::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleGroup>

Returns A list of phase match rule groups that are included in this matcher.

Returns:



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 979

class PhraseMatcher
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to combine each phrase match rule group to determine whether
  # there is a match.
  module PhraseMatcherType
    # Unspecified.
    PHRASE_MATCHER_TYPE_UNSPECIFIED = 0

    # Must meet all phrase match rule groups or there is no match.
    ALL_OF = 1

    # If any of the phrase match rule groups are met, there is a match.
    ANY_OF = 2
  end
end

#revision_create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 979

class PhraseMatcher
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to combine each phrase match rule group to determine whether
  # there is a match.
  module PhraseMatcherType
    # Unspecified.
    PHRASE_MATCHER_TYPE_UNSPECIFIED = 0

    # Must meet all phrase match rule groups or there is no match.
    ALL_OF = 1

    # If any of the phrase match rule groups are met, there is a match.
    ANY_OF = 2
  end
end

#revision_id ⇒ ::String (readonly)

Returns Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567.

Returns:

  • (::String) —

    Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 979

class PhraseMatcher
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to combine each phrase match rule group to determine whether
  # there is a match.
  module PhraseMatcherType
    # Unspecified.
    PHRASE_MATCHER_TYPE_UNSPECIFIED = 0

    # Must meet all phrase match rule groups or there is no match.
    ALL_OF = 1

    # If any of the phrase match rule groups are met, there is a match.
    ANY_OF = 2
  end
end

#role_match ⇒ ::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant::Role

Returns The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.

Returns:



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 979

class PhraseMatcher
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to combine each phrase match rule group to determine whether
  # there is a match.
  module PhraseMatcherType
    # Unspecified.
    PHRASE_MATCHER_TYPE_UNSPECIFIED = 0

    # Must meet all phrase match rule groups or there is no match.
    ALL_OF = 1

    # If any of the phrase match rule groups are met, there is a match.
    ANY_OF = 2
  end
end

#type ⇒ ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher::PhraseMatcherType

Returns Required. The type of this phrase matcher.

Returns:



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 979

class PhraseMatcher
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to combine each phrase match rule group to determine whether
  # there is a match.
  module PhraseMatcherType
    # Unspecified.
    PHRASE_MATCHER_TYPE_UNSPECIFIED = 0

    # Must meet all phrase match rule groups or there is no match.
    ALL_OF = 1

    # If any of the phrase match rule groups are met, there is a match.
    ANY_OF = 2
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The most recent time at which the phrase matcher was updated.

Returns:



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 979

class PhraseMatcher
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to combine each phrase match rule group to determine whether
  # there is a match.
  module PhraseMatcherType
    # Unspecified.
    PHRASE_MATCHER_TYPE_UNSPECIFIED = 0

    # Must meet all phrase match rule groups or there is no match.
    ALL_OF = 1

    # If any of the phrase match rule groups are met, there is a match.
    ANY_OF = 2
  end
end

#version_tag ⇒ ::String

Returns The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.

Returns:

  • (::String) —

    The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 979

class PhraseMatcher
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to combine each phrase match rule group to determine whether
  # there is a match.
  module PhraseMatcherType
    # Unspecified.
    PHRASE_MATCHER_TYPE_UNSPECIFIED = 0

    # Must meet all phrase match rule groups or there is no match.
    ALL_OF = 1

    # If any of the phrase match rule groups are met, there is a match.
    ANY_OF = 2
  end
end