GOgoogle
projects

GET /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}

Gets a phrase matcher.

Request

  • Base URL
    https://contactcenterinsights.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required
phraseMatchersIdstring required

Response

Successful response

activationUpdateTimestring google-datetime

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

activeboolean

Applies the phrase matcher only when it is active.

displayNamestring

The human-readable name of the phrase matcher.

namestring

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

revisionCreateTimestring google-datetime

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

revisionIdstring

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'ROLE_UNSPECIFIED' | 'HUMAN_AGENT' | 'AUTOMATED_AGENT' | 'END_USER' | 'ANY_AGENT'

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'PHRASE_MATCHER_TYPE_UNSPECIFIED' | 'ALL_OF' | 'ANY_OF'

Required. The type of this phrase matcher.

updateTimestring google-datetime

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

versionTagstring

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

Changes

No recorded changes to this operation across all 6 revisions of this API.