Google Cloud Contact Center Insights V1 Client - Class PhraseMatcher (1.2.1)

Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class PhraseMatcher.

The phrase matcher resource.

Generated from protobuf message google.cloud.contactcenterinsights.v1.PhraseMatcher

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ revision_id 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

↳ version_tag string

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

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

↳ display_name string

The human-readable name of the phrase matcher.

↳ type int

Required. The type of this phrase matcher.

↳ active bool

Applies the phrase matcher only when it is active.

↳ phrase_match_rule_groups array<Google\Cloud\ContactCenterInsights\V1\PhraseMatchRuleGroup>

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

↳ activation_update_time Google\Protobuf\Timestamp

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

↳ role_match int

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

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

getName

The resource name of the phrase matcher.

Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

Returns
TypeDescription
string

setName

The resource name of the phrase matcher.

Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRevisionId

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
TypeDescription
string

setRevisionId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVersionTag

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

Returns
TypeDescription
string

setVersionTag

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRevisionCreateTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasRevisionCreateTime

clearRevisionCreateTime

setRevisionCreateTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getDisplayName

The human-readable name of the phrase matcher.

Returns
TypeDescription
string

setDisplayName

The human-readable name of the phrase matcher.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

Required. The type of this phrase matcher.

Returns
TypeDescription
int

setType

Required. The type of this phrase matcher.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getActive

Applies the phrase matcher only when it is active.

Returns
TypeDescription
bool

setActive

Applies the phrase matcher only when it is active.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getPhraseMatchRuleGroups

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPhraseMatchRuleGroups

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

Parameter
NameDescription
var array<Google\Cloud\ContactCenterInsights\V1\PhraseMatchRuleGroup>
Returns
TypeDescription
$this

getActivationUpdateTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasActivationUpdateTime

clearActivationUpdateTime

setActivationUpdateTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getRoleMatch

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
TypeDescription
int

setRoleMatch

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getUpdateTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this