Google Cloud Contact Center Insights V1 Client - Class AnnotatorSelector (1.7.1)

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

Selector of all available annotators and phrase matchers to run.

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

Namespace

Google \ Cloud \ ContactCenterInsights \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ run_interruption_annotator`	`bool` Whether to run the interruption annotator.
`↳ run_silence_annotator`	`bool` Whether to run the silence annotator.
`↳ run_phrase_matcher_annotator`	`bool` Whether to run the active phrase matcher annotator(s).
`↳ phrase_matchers`	`array` The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
`↳ run_sentiment_annotator`	`bool` Whether to run the sentiment annotator.
`↳ run_entity_annotator`	`bool` Whether to run the entity annotator.
`↳ run_intent_annotator`	`bool` Whether to run the intent annotator.
`↳ run_issue_model_annotator`	`bool` Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
`↳ issue_models`	`array` The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
`↳ run_summarization_annotator`	`bool` Whether to run the summarization annotator.
`↳ summarization_config`	`Google\Cloud\ContactCenterInsights\V1\AnnotatorSelector\SummarizationConfig` Configuration for the summarization annotator.

getRunInterruptionAnnotator

Whether to run the interruption annotator.

Returns
Type	Description
`bool`

setRunInterruptionAnnotator

Whether to run the interruption annotator.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getRunSilenceAnnotator

Whether to run the silence annotator.

Returns
Type	Description
`bool`

setRunSilenceAnnotator

Whether to run the silence annotator.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getRunPhraseMatcherAnnotator

Whether to run the active phrase matcher annotator(s).

Returns
Type	Description
`bool`

setRunPhraseMatcherAnnotator

Whether to run the active phrase matcher annotator(s).

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getPhraseMatchers

The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setPhraseMatchers

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getRunSentimentAnnotator

Whether to run the sentiment annotator.

Returns
Type	Description
`bool`

setRunSentimentAnnotator

Whether to run the sentiment annotator.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getRunEntityAnnotator

Whether to run the entity annotator.

Returns
Type	Description
`bool`

setRunEntityAnnotator

Whether to run the entity annotator.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getRunIntentAnnotator

Whether to run the intent annotator.

Returns
Type	Description
`bool`

setRunIntentAnnotator

Whether to run the intent annotator.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getRunIssueModelAnnotator

Whether to run the issue model annotator. A model should have already been deployed for this to take effect.

Returns
Type	Description
`bool`

setRunIssueModelAnnotator

Whether to run the issue model annotator. A model should have already been deployed for this to take effect.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getIssueModels

The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setIssueModels

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getRunSummarizationAnnotator

Whether to run the summarization annotator.

Returns
Type	Description
`bool`

setRunSummarizationAnnotator

Whether to run the summarization annotator.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSummarizationConfig

Configuration for the summarization annotator.

Returns
Type	Description
`Google\Cloud\ContactCenterInsights\V1\AnnotatorSelector\SummarizationConfig\|null`

hasSummarizationConfig

clearSummarizationConfig

setSummarizationConfig

Configuration for the summarization annotator.

Parameter
Name	Description
`var`	`Google\Cloud\ContactCenterInsights\V1\AnnotatorSelector\SummarizationConfig`

Returns
Type	Description
`$this`