assessments

Creates, updates, deletes, gets or lists an assessments resource.

Overview

Name	assessments
Type	Resource
Id	google.contactcenterinsights.assessments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}
agentInfo	object	Information about the agent the assessment is for. (id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo)
createTime	string (google-datetime)	Output only. The time at which the assessment was created.
state	string	Output only. The state of the assessment. (STATE_UNSPECIFIED, DRAFT, PUBLISHED, APPEALED, FINALIZED)
updateTime	string (google-datetime)	Output only. The time at which the assessment was last updated.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}
agentInfo	object	Information about the agent the assessment is for. (id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo)
createTime	string (google-datetime)	Output only. The time at which the assessment was created.
state	string	Output only. The state of the assessment. (STATE_UNSPECIFIED, DRAFT, PUBLISHED, APPEALED, FINALIZED)
updateTime	string (google-datetime)	Output only. The time at which the assessment was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId, conversationsId, assessmentsId		Get Assessment.
list	select	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId, conversationsId	filter, pageSize, pageToken	List Assessments.
create	insert	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId, conversationsId		Create Assessment.
delete	delete	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId, conversationsId, assessmentsId	force	Delete an Assessment.
appeal	exec	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId, conversationsId, assessmentsId		Appeal an Assessment.
finalize	exec	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId, conversationsId, assessmentsId		Finalize an Assessment.
publish	exec	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId, conversationsId, assessmentsId		Publish an Assessment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
assessmentsId	string
authorizedViewSetsId	string
authorizedViewsId	string
conversationsId	string
locationsId	string
projectsId	string
filter	string
force	boolean
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Get Assessment.

SELECT
name,
agentInfo,
createTime,
state,
updateTime
FROM google.contactcenterinsights.assessments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND authorizedViewSetsId = '{{ authorizedViewSetsId }}' -- required
AND authorizedViewsId = '{{ authorizedViewsId }}' -- required
AND conversationsId = '{{ conversationsId }}' -- required
AND assessmentsId = '{{ assessmentsId }}' -- required
;

list

List Assessments.

SELECT
name,
agentInfo,
createTime,
state,
updateTime
FROM google.contactcenterinsights.assessments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND authorizedViewSetsId = '{{ authorizedViewSetsId }}' -- required
AND authorizedViewsId = '{{ authorizedViewsId }}' -- required
AND conversationsId = '{{ conversationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Create Assessment.

INSERT INTO google.contactcenterinsights.assessments (
data__agentInfo,
data__name,
projectsId,
locationsId,
authorizedViewSetsId,
authorizedViewsId,
conversationsId
)
SELECT 
'{{ agentInfo }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ authorizedViewSetsId }}',
'{{ authorizedViewsId }}',
'{{ conversationsId }}'
RETURNING
name,
agentInfo,
createTime,
state,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: assessments
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the assessments resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the assessments resource.
  - name: authorizedViewSetsId
    value: "{{ authorizedViewSetsId }}"
    description: Required parameter for the assessments resource.
  - name: authorizedViewsId
    value: "{{ authorizedViewsId }}"
    description: Required parameter for the assessments resource.
  - name: conversationsId
    value: "{{ conversationsId }}"
    description: Required parameter for the assessments resource.
  - name: agentInfo
    description: |
      Information about the agent the assessment is for.
    value:
      agentId: "{{ agentId }}"
      agentType: "{{ agentType }}"
      deploymentDisplayName: "{{ deploymentDisplayName }}"
      deploymentId: "{{ deploymentId }}"
      displayName: "{{ displayName }}"
      dispositionCode: "{{ dispositionCode }}"
      entrySubagentDisplayName: "{{ entrySubagentDisplayName }}"
      entrySubagentId: "{{ entrySubagentId }}"
      location: "{{ location }}"
      team: "{{ team }}"
      teams:
        - "{{ teams }}"
      versionDisplayName: "{{ versionDisplayName }}"
      versionId: "{{ versionId }}"
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}

DELETE examples

delete

Delete an Assessment.

DELETE FROM google.contactcenterinsights.assessments
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND authorizedViewSetsId = '{{ authorizedViewSetsId }}' --required
AND authorizedViewsId = '{{ authorizedViewsId }}' --required
AND conversationsId = '{{ conversationsId }}' --required
AND assessmentsId = '{{ assessmentsId }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

appeal

Appeal an Assessment.

EXEC google.contactcenterinsights.assessments.appeal 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@authorizedViewSetsId='{{ authorizedViewSetsId }}' --required, 
@authorizedViewsId='{{ authorizedViewsId }}' --required, 
@conversationsId='{{ conversationsId }}' --required, 
@assessmentsId='{{ assessmentsId }}' --required
;

finalize

Finalize an Assessment.

EXEC google.contactcenterinsights.assessments.finalize 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@authorizedViewSetsId='{{ authorizedViewSetsId }}' --required, 
@authorizedViewsId='{{ authorizedViewsId }}' --required, 
@conversationsId='{{ conversationsId }}' --required, 
@assessmentsId='{{ assessmentsId }}' --required
;

publish

Publish an Assessment.

EXEC google.contactcenterinsights.assessments.publish 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@authorizedViewSetsId='{{ authorizedViewSetsId }}' --required, 
@authorizedViewsId='{{ authorizedViewsId }}' --required, 
@conversationsId='{{ conversationsId }}' --required, 
@assessmentsId='{{ assessmentsId }}' --required
;