REST Resource: projects.locations.analysisRules

Resource: 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.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "conversationFilter": string,
  "annotatorSelector": {
    object (AnnotatorSelector)
  },
  "analysisPercentage": number,
  "active": boolean,
  "displayName": string
}
Fields
name

string

Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysisRule}
createTime

string (Timestamp format)

Output only. The time at which this analysis rule was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The most recent time at which this analysis rule was updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
conversationFilter

string

Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
annotatorSelector

object (AnnotatorSelector)

Selector of annotators to run and the phrase matchers to use for conversations that matches the conversationFilter. If not specified, NO annotators will be run.
analysisPercentage

number

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

boolean

If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
displayName

string

Display Name of the analysis rule.

Methods

create

 Creates a analysis rule.

delete

 Deletes a analysis rule.

get

 Get a analysis rule.

list

 Lists analysis rules.

patch

 Updates a analysis rule.