Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class AnalysisRule.
The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
Generated from protobuf message google.cloud.contactcenterinsights.v1.AnalysisRule
Namespace
Google \ Cloud \ ContactCenterInsights \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule} |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which this analysis rule was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The most recent time at which this analysis rule was updated. |
↳ display_name |
string
Display Name of the analysis rule. |
↳ conversation_filter |
string
Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. |
↳ annotator_selector |
AnnotatorSelector
Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run. |
↳ analysis_percentage |
float
Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation. |
↳ active |
bool
If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft. |
getName
Identifier. The resource name of the analysis rule.
Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the analysis rule.
Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time at which this analysis rule was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this analysis rule was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The most recent time at which this analysis rule was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The most recent time at which this analysis rule was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Display Name of the analysis rule.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayName
clearDisplayName
setDisplayName
Display Name of the analysis rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConversationFilter
Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.
| Returns | |
|---|---|
| Type | Description |
string |
|
setConversationFilter
Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotatorSelector
Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run.
| Returns | |
|---|---|
| Type | Description |
AnnotatorSelector|null |
|
hasAnnotatorSelector
clearAnnotatorSelector
setAnnotatorSelector
Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run.
| Parameter | |
|---|---|
| Name | Description |
var |
AnnotatorSelector
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnalysisPercentage
Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
| Returns | |
|---|---|
| Type | Description |
float |
|
setAnalysisPercentage
Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getActive
If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setActive
If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|