- [Resource: PhraseMatcher](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatcher)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatcher.SCHEMA_REPRESENTATION)
- [PhraseMatcherType](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatcherType)
- [PhraseMatchRuleGroup](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRuleGroup)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRuleGroup.SCHEMA_REPRESENTATION)
- [PhraseMatchRuleGroupType](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRuleGroupType)
- [PhraseMatchRule](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRule)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRule.SCHEMA_REPRESENTATION)
- [PhraseMatchRuleConfig](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRuleConfig)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRuleConfig.SCHEMA_REPRESENTATION)
- [ExactMatchConfig](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#ExactMatchConfig)
  - [JSON representation](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#ExactMatchConfig.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#METHODS_SUMMARY)

## Resource: PhraseMatcher

The phrase matcher resource.

| JSON representation |
|---|
| ``` { "name": string, "revisionId": string, "versionTag": string, "revisionCreateTime": string, "displayName": string, "type": enum (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatcherType`), "active": boolean, "phraseMatchRuleGroups": [ { object (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRuleGroup`) } ], "activationUpdateTime": string, "roleMatch": enum (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/Role`), "updateTime": string } ``` |

| Fields ||
|---|---|
| `name` | `string` The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phraseMatcher} |
| `revisionId` | `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 |
| `versionTag` | `string` The customized version tag to use for the phrase matcher. If not specified, it will default to `revisionId`. |
| `revisionCreateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `displayName` | `string` The human-readable name of the phrase matcher. |
| `type` | ``enum (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatcherType`)`` Required. The type of this phrase matcher. |
| `active` | `boolean` Applies the phrase matcher only when it is active. |
| `phraseMatchRuleGroups[]` | ``object (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRuleGroup`)`` A list of phase match rule groups that are included in this matcher. |
| `activationUpdateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The most recent time at which the activation status was updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `roleMatch` | ``enum (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/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. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The most recent time at which the phrase matcher was updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |

## PhraseMatcherType

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

| Enums ||
|---|---|
| `PHRASE_MATCHER_TYPE_UNSPECIFIED` | Unspecified. |
| `ALL_OF` | Must meet all phrase match rule groups or there is no match. |
| `ANY_OF` | If any of the phrase match rule groups are met, there is a match. |

## PhraseMatchRuleGroup

A message representing a rule in the phrase matcher.

| JSON representation |
|---|
| ``` { "type": enum (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRuleGroupType`), "phraseMatchRules": [ { object (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRule`) } ] } ``` |

| Fields ||
|---|---|
| `type` | ``enum (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRuleGroupType`)`` Required. The type of this phrase match rule group. |
| `phraseMatchRules[]` | ``object (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRule`)`` A list of phrase match rules that are included in this group. |

## PhraseMatchRuleGroupType

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

| Enums ||
|---|---|
| `PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED` | Unspecified. |
| `ALL_OF` | Must meet all phrase match rules or there is no match. |
| `ANY_OF` | If any of the phrase match rules are met, there is a match. |

## PhraseMatchRule

The data for a phrase match rule.

| JSON representation |
|---|
| ``` { "query": string, "negated": boolean, "config": { object (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRuleConfig`) } } ``` |

| Fields ||
|---|---|
| `query` | `string` Required. The phrase to be matched. |
| `negated` | `boolean` Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment. |
| `config` | ``object (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#PhraseMatchRuleConfig`)`` Provides additional information about the rule that specifies how to apply the rule. |

## PhraseMatchRuleConfig

Configuration information of a phrase match rule.

| JSON representation |
|---|
| ``` { // Union field `config` can be only one of the following: "exactMatchConfig": { object (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#ExactMatchConfig`) } // End of list of possible types for union field `config`. } ``` |

| Fields ||
|---|---|
| Union field `config`. The configuration of the phrase match rule. `config` can be only one of the following: ||
| `exactMatchConfig` | ``object (`https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers#ExactMatchConfig`)`` The configuration for the exact match rule. |

## ExactMatchConfig

Exact match configuration.

| JSON representation |
|---|
| ``` { "caseSensitive": boolean } ``` |

| Fields ||
|---|---|
| `caseSensitive` | `boolean` Whether to consider case sensitivity when performing an exact match. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers/create` | Creates a phrase matcher. |
| ### `https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers/delete` | Deletes a phrase matcher. |
| ### `https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers/get` | Gets a phrase matcher. |
| ### `https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers/list` | Lists phrase matchers. |
| ### `https://docs.cloud.google.com/gemini-enterprise-cx/insights/reference/rest/v1/projects.locations.phraseMatchers/patch` | Updates a phrase matcher. |