phrase_matchers

Creates, updates, deletes, gets or lists a phrase_matchers resource.

Overview

Name	phrase_matchers
Type	Resource
Id	google.contactcenterinsights.phrase_matchers

Fields

Name	Datatype	Description
name	string	The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
activationUpdateTime	string	Output only. The most recent time at which the activation status was updated.
active	boolean	Applies the phrase matcher only when it is active.
displayName	string	The human-readable name of the phrase matcher.
phraseMatchRuleGroups	array	A list of phase match rule groups that are included in this matcher.
revisionCreateTime	string	Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
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
roleMatch	string	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	string	Required. The type of this phrase matcher.
updateTime	string	Output only. The most recent time at which the phrase matcher was updated.
versionTag	string	The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, phraseMatchersId, projectsId	Gets a phrase matcher.
list	SELECT	locationsId, projectsId	Lists phrase matchers.
create	INSERT	locationsId, projectsId	Creates a phrase matcher.
delete	DELETE	locationsId, phraseMatchersId, projectsId	Deletes a phrase matcher.
patch	UPDATE	locationsId, phraseMatchersId, projectsId	Updates a phrase matcher.

SELECT examples

Lists phrase matchers.

SELECT
name,
activationUpdateTime,
active,
displayName,
phraseMatchRuleGroups,
revisionCreateTime,
revisionId,
roleMatch,
type,
updateTime,
versionTag
FROM google.contactcenterinsights.phrase_matchers
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new phrase_matchers resource.

All Properties

/*+ create */
INSERT INTO google.contactcenterinsights.phrase_matchers (
locationsId,
projectsId,
phraseMatchRuleGroups,
name,
active,
displayName,
type,
versionTag,
roleMatch
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ phraseMatchRuleGroups }}',
'{{ name }}',
{{ active }},
'{{ displayName }}',
'{{ type }}',
'{{ versionTag }}',
'{{ roleMatch }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: phraseMatchRuleGroups
      value:
        - - name: phraseMatchRules
            value:
              - - name: negated
                  value: boolean
                - name: config
                  value:
                    - name: exactMatchConfig
                      value:
                        - name: caseSensitive
                          value: boolean
                - name: query
                  value: string
          - name: type
            value: string
    - name: name
      value: string
    - name: active
      value: boolean
    - name: displayName
      value: string
    - name: type
      value: string
    - name: revisionCreateTime
      value: string
    - name: updateTime
      value: string
    - name: revisionId
      value: string
    - name: versionTag
      value: string
    - name: activationUpdateTime
      value: string
    - name: roleMatch
      value: string

UPDATE example

Updates a phrase_matchers resource.

/*+ update */
UPDATE google.contactcenterinsights.phrase_matchers
SET 
phraseMatchRuleGroups = '{{ phraseMatchRuleGroups }}',
name = '{{ name }}',
active = true|false,
displayName = '{{ displayName }}',
type = '{{ type }}',
versionTag = '{{ versionTag }}',
roleMatch = '{{ roleMatch }}'
WHERE 
locationsId = '{{ locationsId }}'
AND phraseMatchersId = '{{ phraseMatchersId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified phrase_matchers resource.

/*+ delete */
DELETE FROM google.contactcenterinsights.phrase_matchers
WHERE locationsId = '{{ locationsId }}'
AND phraseMatchersId = '{{ phraseMatchersId }}'
AND projectsId = '{{ projectsId }}';