# Contact Center AI Insights V1 API - Class Google::Cloud::ContactCenterInsights::V1::PhraseMatcher (v1.10.0)

1.10.0 (latest) 1.9.0 1.8.1 1.7.0 1.6.0 1.5.1 1.4.0 1.3.0 1.2.0 1.1.0 1.0.1 0.22.0 0.21.1 0.20.1 0.19.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.2 0.7.2 0.6.0 Reference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::PhraseMatcher.

The phrase matcher resource.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #activation_update_time

    def activation_update_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Protobuf-Timestamp)) --- Output only. The most recent time at which the activation status was updated.

### #active

    def active() -> ::Boolean

**Returns**

- (::Boolean) --- Applies the phrase matcher only when it is active.

### #active=

    def active=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Applies the phrase matcher only when it is active.
**Returns**

- (::Boolean) --- Applies the phrase matcher only when it is active.

### #display_name

    def display_name() -> ::String

**Returns**

- (::String) --- The human-readable name of the phrase matcher.

### #display_name=

    def display_name=(value) -> ::String

**Parameter**

- **value** (::String) --- The human-readable name of the phrase matcher.
**Returns**

- (::String) --- The human-readable name of the phrase matcher.

### #name

    def name() -> ::String

**Returns**

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

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- 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}

### #phrase_match_rule_groups

    def phrase_match_rule_groups() -> ::Array<::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleGroup>

**Returns**

- (::Array\<[::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-PhraseMatchRuleGroup)\>) --- A list of phase match rule groups that are included in this matcher.

### #phrase_match_rule_groups=

    def phrase_match_rule_groups=(value) -> ::Array<::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleGroup>

**Parameter**

- **value** (::Array\<[::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-PhraseMatchRuleGroup)\>) --- A list of phase match rule groups that are included in this matcher.
**Returns**

- (::Array\<[::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-PhraseMatchRuleGroup)\>) --- A list of phase match rule groups that are included in this matcher.

### #revision_create_time

    def revision_create_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/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.

### #revision_id

    def revision_id() -> ::String

**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

### #role_match

    def role_match() -> ::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant::Role

**Returns**

- ([::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant::Role](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-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.

### #role_match=

    def role_match=(value) -> ::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant::Role

**Parameter**

- **value** ([::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant::Role](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-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.
**Returns**

- ([::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant::Role](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-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.

### #type

    def type() -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher::PhraseMatcherType

**Returns**

- ([::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher::PhraseMatcherType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-PhraseMatcher-PhraseMatcherType)) --- Required. The type of this phrase matcher.

### #type=

    def type=(value) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher::PhraseMatcherType

**Parameter**

- **value** ([::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher::PhraseMatcherType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-PhraseMatcher-PhraseMatcherType)) --- Required. The type of this phrase matcher.
**Returns**

- ([::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher::PhraseMatcherType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-PhraseMatcher-PhraseMatcherType)) --- Required. The type of this phrase matcher.

### #update_time

    def update_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Protobuf-Timestamp)) --- Output only. The most recent time at which the phrase matcher was updated.

### #version_tag

    def version_tag() -> ::String

**Returns**

- (::String) --- The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.

### #version_tag=

    def version_tag=(value) -> ::String

**Parameter**

- **value** (::String) --- 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`.