--- title: "PATCH /v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}" method: PATCH path: "/v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}" tags: ["projects"] --- # PATCH /v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId} `PATCH /v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}` ## Request - Base URL: `https://contactcenterinsights.googleapis.com` - URL: `https://contactcenterinsights.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}` - 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` Updates an assessment rule. ## Path parameters - `projectsId` string, required - `locationsId` string, required - `assessmentRulesId` string, required ## Query parameters - `updateMask` string, google-fieldmask ## Request body - GoogleCloudContactcenterinsightsV1AssessmentRule: The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules. - `active` boolean: If true, apply this rule to conversations. Otherwise, this rule is inactive. - `createTime` string, google-datetime: Output only. The time at which this assessment rule was created. - `displayName` string: Display Name of the assessment rule. - `name` string: Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule} - `sampleRule` GoogleCloudContactcenterinsightsV1SampleRule: Message for sampling conversations. - `conversationFilter` string: To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations. - `dimension` string: Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'. - `samplePercentage` number, double: Percentage of conversations that we should sample based on the dimension between [0, 100]. - `sampleRow` string, int64: Number of the conversations that we should sample based on the dimension. - `satisfiesPzi` boolean: Output only. Whether this resource is zone isolated. - `satisfiesPzs` boolean: Output only. Whether this resource is zone separated. - `scheduleInfo` GoogleCloudContactcenterinsightsV1ScheduleInfo: Message for schedule info. - `endTime` string, google-datetime: End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted. - `schedule` string: The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ... - `startTime` string, google-datetime: Start time of the schedule. If not specified, will start as soon as the schedule is created. - `timeZone` string: The timezone to use for the groc expression. If not specified, defaults to UTC. - `updateTime` string, google-datetime: Output only. The most recent time at which this assessment rule was updated. ## Response `200` Successful response - GoogleCloudContactcenterinsightsV1AssessmentRule: The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules. - `active` boolean: If true, apply this rule to conversations. Otherwise, this rule is inactive. - `createTime` string, google-datetime: Output only. The time at which this assessment rule was created. - `displayName` string: Display Name of the assessment rule. - `name` string: Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule} - `sampleRule` GoogleCloudContactcenterinsightsV1SampleRule: Message for sampling conversations. - `conversationFilter` string: To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations. - `dimension` string: Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'. - `samplePercentage` number, double: Percentage of conversations that we should sample based on the dimension between [0, 100]. - `sampleRow` string, int64: Number of the conversations that we should sample based on the dimension. - `satisfiesPzi` boolean: Output only. Whether this resource is zone isolated. - `satisfiesPzs` boolean: Output only. Whether this resource is zone separated. - `scheduleInfo` GoogleCloudContactcenterinsightsV1ScheduleInfo: Message for schedule info. - `endTime` string, google-datetime: End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted. - `schedule` string: The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ... - `startTime` string, google-datetime: Start time of the schedule. If not specified, will start as soon as the schedule is created. - `timeZone` string: The timezone to use for the groc expression. If not specified, defaults to UTC. - `updateTime` string, google-datetime: Output only. The most recent time at which this assessment rule was updated. --- [API](https://skmtc.dev/google/apis/contactcenterinsights.md) - [All operations](https://skmtc.dev/google/apis/contactcenterinsights/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/contactcenterinsights/revisions/895c3ce55ea0?raw)