Class PhraseMatcher (1.13.0)

PhraseMatcher(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The phrase matcher resource.

Attributes

NameDescription
name str
The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
revision_id str
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
version_tag str
The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.
revision_create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
display_name str
The human-readable name of the phrase matcher.
type_ google.cloud.contact_center_insights_v1.types.PhraseMatcher.PhraseMatcherType
Required. The type of this phrase matcher.
active bool
Applies the phrase matcher only when it is active.
phrase_match_rule_groups MutableSequence[google.cloud.contact_center_insights_v1.types.PhraseMatchRuleGroup]
A list of phase match rule groups that are included in this matcher.
activation_update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The most recent time at which the activation status was updated.
role_match google.cloud.contact_center_insights_v1.types.ConversationParticipant.Role
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.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The most recent time at which the phrase matcher was updated.

Classes

PhraseMatcherType

PhraseMatcherType(value)

Specifies how to combine each phrase match rule group to determine whether there is a match.

Values: PHRASE_MATCHER_TYPE_UNSPECIFIED (0): Unspecified. ALL_OF (1): Must meet all phrase match rule groups or there is no match. ANY_OF (2): If any of the phrase match rule groups are met, there is a match.