analyses

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

Overview

Name	analyses
Type	Resource
Id	google.contactcenterinsights.analyses

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
analysisResult	object	Output only. The result of the analysis, which is populated when the analysis finishes. (id: GoogleCloudContactcenterinsightsV1AnalysisResult)
annotatorSelector	object	To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run. (id: GoogleCloudContactcenterinsightsV1AnnotatorSelector)
createTime	string (google-datetime)	Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
requestTime	string (google-datetime)	Output only. The time at which the analysis was requested.

list

Name	Datatype	Description
name	string	Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
analysisResult	object	Output only. The result of the analysis, which is populated when the analysis finishes. (id: GoogleCloudContactcenterinsightsV1AnalysisResult)
annotatorSelector	object	To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run. (id: GoogleCloudContactcenterinsightsV1AnnotatorSelector)
createTime	string (google-datetime)	Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
requestTime	string (google-datetime)	Output only. The time at which the analysis was requested.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, conversationsId, analysesId		Gets an analysis.
list	select	projectsId, locationsId, conversationsId	filter, pageSize, pageToken	Lists analyses.
create	insert	projectsId, locationsId, conversationsId		Creates an analysis. The long running operation is done when the analysis has completed.
delete	delete	projectsId, locationsId, conversationsId, analysesId		Deletes an analysis.

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
analysesId	string
conversationsId	string
locationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets an analysis.

SELECT
name,
analysisResult,
annotatorSelector,
createTime,
requestTime
FROM google.contactcenterinsights.analyses
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND conversationsId = '{{ conversationsId }}' -- required
AND analysesId = '{{ analysesId }}' -- required
;

list

Lists analyses.

SELECT
name,
analysisResult,
annotatorSelector,
createTime,
requestTime
FROM google.contactcenterinsights.analyses
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND conversationsId = '{{ conversationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates an analysis. The long running operation is done when the analysis has completed.

INSERT INTO google.contactcenterinsights.analyses (
data__annotatorSelector,
data__name,
projectsId,
locationsId,
conversationsId
)
SELECT 
'{{ annotatorSelector }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ conversationsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: analyses
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the analyses resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the analyses resource.
  - name: conversationsId
    value: "{{ conversationsId }}"
    description: Required parameter for the analyses resource.
  - name: annotatorSelector
    description: |
      To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
    value:
      issueModels:
        - "{{ issueModels }}"
      phraseMatchers:
        - "{{ phraseMatchers }}"
      qaConfig:
        scorecardList:
          qaScorecardRevisions:
            - "{{ qaScorecardRevisions }}"
      runAutoLabelingAnnotator: {{ runAutoLabelingAnnotator }}
      runEntityAnnotator: {{ runEntityAnnotator }}
      runIntentAnnotator: {{ runIntentAnnotator }}
      runInterruptionAnnotator: {{ runInterruptionAnnotator }}
      runIssueModelAnnotator: {{ runIssueModelAnnotator }}
      runPhraseMatcherAnnotator: {{ runPhraseMatcherAnnotator }}
      runQaAnnotator: {{ runQaAnnotator }}
      runSentimentAnnotator: {{ runSentimentAnnotator }}
      runSilenceAnnotator: {{ runSilenceAnnotator }}
      runSummarizationAnnotator: {{ runSummarizationAnnotator }}
      summarizationConfig:
        conversationProfile: "{{ conversationProfile }}"
        generator: "{{ generator }}"
        summarizationModel: "{{ summarizationModel }}"
  - name: name
    value: "{{ name }}"
    description: |
      Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

DELETE examples

delete

Deletes an analysis.

DELETE FROM google.contactcenterinsights.analyses
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND conversationsId = '{{ conversationsId }}' --required
AND analysesId = '{{ analysesId }}' --required
;