REST Resource: projects.locations.phraseMatchers

Resource: PhraseMatcher

The phrase matcher resource.

JSON representation 
{
  "name": string,
  "revisionId": string,
  "versionTag": string,
  "revisionCreateTime": string,
  "displayName": string,
  "type": enum (PhraseMatcherType),
  "active": boolean,
  "phraseMatchRuleGroups": [
    {
      object (PhraseMatchRuleGroup)
    }
  ],
  "activationUpdateTime": string,
  "roleMatch": enum (Role),
  "updateTime": string,
  "languageCode": 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 (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
displayName

string

The human-readable name of the phrase matcher.
type

enum (PhraseMatcherType)

Required. The type of this phrase matcher.
active

boolean

Applies the phrase matcher only when it is active.
phraseMatchRuleGroups[]

object (PhraseMatchRuleGroup)

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

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
roleMatch

enum (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 (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
languageCode

string

The language code of this segment as a BCP-47 language tag. Example: "en-US". If the languageCode is unspecified, it will match everything.

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 (PhraseMatchRuleGroupType),
  "phraseMatchRules": [
    {
      object (PhraseMatchRule)
    }
  ],
  "phraseMatchRuleGroups": [
    {
      object (PhraseMatchRuleGroup)
    }
  ],
  "roleMatch": enum (Role),
  "languageCode": string
}
Fields
type

enum (PhraseMatchRuleGroupType)

Required. The type of this phrase match rule group.
phraseMatchRules[]

object (PhraseMatchRule)

A list of phrase match rules that are included in this group.
phraseMatchRuleGroups[]

object (PhraseMatchRuleGroup)

A list of phrase match rule groups that are included in this group.
roleMatch

enum (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.
languageCode

string

The language code of this segment as a BCP-47 language tag. Example: "en-US". If the languageCode is unspecified, it will match everything.

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 (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 (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 (ExactMatchConfig)
  },
  "semanticMatchConfig": {
    object (SemanticMatchConfig)
  },
  "regexMatchConfig": {
    object (RegexMatchConfig)
  }
  // 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 (ExactMatchConfig)

The configuration for the exact match rule.
semanticMatchConfig

object (SemanticMatchConfig)

The configuration for the semantic match rule.
regexMatchConfig

object (RegexMatchConfig)

The configuration for the regex match rule.

ExactMatchConfig

Exact match configuration.

JSON representation 
{
  "caseSensitive": boolean
}
Fields
caseSensitive

boolean

Whether to consider case sensitivity when performing an exact match.

SemanticMatchConfig

Semantic match configuration.

JSON representation 
{
  "similarityThreshold": number
}
Fields
similarityThreshold

number

Only text with a similarity greater than or equal to the threshold will be considered to be a match to the provided query. Ranges from 0 - 1.

RegexMatchConfig

This type has no fields.

Regex match configuration.

Methods

create

 Creates a phrase matcher.

delete

 Deletes a phrase matcher.

get

 Gets a phrase matcher.

list

 Lists phrase matchers.

patch

 Updates a phrase matcher.