revisions

Creates, updates, deletes, gets or lists a revisions resource.

Overview

Name	revisions
Type	Resource
Id	google.contactcenterinsights.revisions

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
alternateIds	array	Output only. Alternative IDs for this revision of the scorecard, e.g., latest.
createTime	string (google-datetime)	Output only. The timestamp that the revision was created.
snapshot	object	A QaScorecard represents a collection of questions to be scored during analysis. (id: GoogleCloudContactcenterinsightsV1QaScorecard)
state	string	Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
alternateIds	array	Output only. Alternative IDs for this revision of the scorecard, e.g., latest.
createTime	string (google-datetime)	Output only. The timestamp that the revision was created.
snapshot	object	A QaScorecard represents a collection of questions to be scored during analysis. (id: GoogleCloudContactcenterinsightsV1QaScorecard)
state	string	Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, qaScorecardsId, revisionsId		Gets a QaScorecardRevision.
list	select	projectsId, locationsId, qaScorecardsId	pageSize, pageToken, filter, qaScorecardSources	Lists all revisions under the parent QaScorecard.
create	insert	projectsId, locationsId, qaScorecardsId	qaScorecardRevisionId	Creates a QaScorecardRevision.
delete	delete	projectsId, locationsId, qaScorecardsId, revisionsId	force	Deletes a QaScorecardRevision.
tune_qa_scorecard_revision	exec	projectsId, locationsId, qaScorecardsId, revisionsId		Fine tune one or more QaModels.
deploy	exec	projectsId, locationsId, qaScorecardsId, revisionsId		Deploy a QaScorecardRevision.
undeploy	exec	projectsId, locationsId, qaScorecardsId, revisionsId		Undeploy a QaScorecardRevision.

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
locationsId	string
projectsId	string
qaScorecardsId	string
revisionsId	string
filter	string
force	boolean
pageSize	integer (int32)
pageToken	string
qaScorecardRevisionId	string
qaScorecardSources	string

SELECT examples

get

Gets a QaScorecardRevision.

SELECT
name,
alternateIds,
createTime,
snapshot,
state
FROM google.contactcenterinsights.revisions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND qaScorecardsId = '{{ qaScorecardsId }}' -- required
AND revisionsId = '{{ revisionsId }}' -- required;

list

Lists all revisions under the parent QaScorecard.

SELECT
name,
alternateIds,
createTime,
snapshot,
state
FROM google.contactcenterinsights.revisions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND qaScorecardsId = '{{ qaScorecardsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND qaScorecardSources = '{{ qaScorecardSources }}';

INSERT examples

create

Creates a QaScorecardRevision.

INSERT INTO google.contactcenterinsights.revisions (
data__name,
data__snapshot,
projectsId,
locationsId,
qaScorecardsId,
qaScorecardRevisionId
)
SELECT 
'{{ name }}',
'{{ snapshot }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ qaScorecardsId }}',
'{{ qaScorecardRevisionId }}'
RETURNING
name,
alternateIds,
createTime,
snapshot,
state
;

Manifest

# Description fields are for documentation purposes
- name: revisions
  props:
    - name: projectsId
      value: string
      description: Required parameter for the revisions resource.
    - name: locationsId
      value: string
      description: Required parameter for the revisions resource.
    - name: qaScorecardsId
      value: string
      description: Required parameter for the revisions resource.
    - name: name
      value: string
      description: >
        Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
        
    - name: snapshot
      value: object
      description: >
        A QaScorecard represents a collection of questions to be scored during analysis.
        
    - name: qaScorecardRevisionId
      value: string

DELETE examples

delete

Deletes a QaScorecardRevision.

DELETE FROM google.contactcenterinsights.revisions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND qaScorecardsId = '{{ qaScorecardsId }}' --required
AND revisionsId = '{{ revisionsId }}' --required
AND force = '{{ force }}';

Lifecycle Methods

tune_qa_scorecard_revision

Fine tune one or more QaModels.

EXEC google.contactcenterinsights.revisions.tune_qa_scorecard_revision 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@qaScorecardsId='{{ qaScorecardsId }}' --required, 
@revisionsId='{{ revisionsId }}' --required 
@@json=
'{
"filter": "{{ filter }}", 
"validateOnly": {{ validateOnly }}
}';

deploy

Deploy a QaScorecardRevision.

EXEC google.contactcenterinsights.revisions.deploy 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@qaScorecardsId='{{ qaScorecardsId }}' --required, 
@revisionsId='{{ revisionsId }}' --required;

undeploy

Undeploy a QaScorecardRevision.

EXEC google.contactcenterinsights.revisions.undeploy 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@qaScorecardsId='{{ qaScorecardsId }}' --required, 
@revisionsId='{{ revisionsId }}' --required;