--- title: "POST /v1/{+parent}/analyses" method: POST path: "/v1/{+parent}/analyses" tags: ["projects"] --- # POST /v1/{+parent}/analyses `POST /v1/{+parent}/analyses` Creates an analysis. The long running operation is done when the analysis has completed. ## Path parameters - `parent` string, required ## Request body - GoogleCloudContactcenterinsightsV1Analysis — The analysis resource. - `analysisResult` GoogleCloudContactcenterinsightsV1AnalysisResult — The result of an analysis. - `endTime` string, google-datetime — The time at which the analysis ended. - `callAnalysisMetadata` GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata — Call-specific metadata created during analysis. - `annotations` GoogleCloudContactcenterinsightsV1CallAnnotation[] — A list of call annotations that apply to this call. - `annotationEndBoundary` GoogleCloudContactcenterinsightsV1AnnotationBoundary — A point in a conversation that marks the start or the end of an annotation. - `wordIndex` integer — The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. - `transcriptIndex` integer — The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. - `sentimentData` GoogleCloudContactcenterinsightsV1SentimentData — The data for a sentiment annotation. - `magnitude` number, float — A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. - `score` number, float — The sentiment score between -1.0 (negative) and 1.0 (positive). - `silenceData` GoogleCloudContactcenterinsightsV1SilenceData — The data for a silence annotation. - `annotationStartBoundary` GoogleCloudContactcenterinsightsV1AnnotationBoundary — A point in a conversation that marks the start or the end of an annotation. - `wordIndex` integer — The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. - `transcriptIndex` integer — The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. - `interruptionData` GoogleCloudContactcenterinsightsV1InterruptionData — The data for an interruption annotation. - `phraseMatchData` GoogleCloudContactcenterinsightsV1PhraseMatchData — The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. - `phraseMatcher` string — The unique identifier (the resource name) of the phrase matcher. - `displayName` string — The human-readable name of the phrase matcher. - `intentMatchData` GoogleCloudContactcenterinsightsV1IntentMatchData — The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. - `intentUniqueId` string — The id of the matched intent. Can be used to retrieve the corresponding intent information. - `channelTag` integer — The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. - `entityMentionData` GoogleCloudContactcenterinsightsV1EntityMentionData — The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. - `sentiment` GoogleCloudContactcenterinsightsV1SentimentData — The data for a sentiment annotation. - `magnitude` number, float — A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. - `score` number, float — The sentiment score between -1.0 (negative) and 1.0 (positive). - `entityUniqueId` string — The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. - `type` 'MENTION_TYPE_UNSPECIFIED' | 'PROPER' | 'COMMON' — The type of the entity mention. - `holdData` GoogleCloudContactcenterinsightsV1HoldData — The data for a hold annotation. - `issueMatchData` GoogleCloudContactcenterinsightsV1IssueMatchData — The data for an issue match annotation. - `issueAssignment` GoogleCloudContactcenterinsightsV1IssueAssignment — Information about the issue. - `issue` string — Resource name of the assigned issue. - `score` number, double — Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. - `displayName` string — Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. - `sentiments` GoogleCloudContactcenterinsightsV1ConversationLevelSentiment[] — Overall conversation-level sentiment for each channel of the call. - `sentimentData` GoogleCloudContactcenterinsightsV1SentimentData — The data for a sentiment annotation. - `magnitude` number, float — A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. - `score` number, float — The sentiment score between -1.0 (negative) and 1.0 (positive). - `channelTag` integer — The channel of the audio that the data applies to. - `silence` GoogleCloudContactcenterinsightsV1ConversationLevelSilence — Conversation-level silence data. - `silenceDuration` string, google-duration — Amount of time calculated to be in silence. - `silencePercentage` number, float — Percentage of the total conversation spent in silence. - `intents` object — All the matched intents in the call. - `issueModelResult` GoogleCloudContactcenterinsightsV1IssueModelResult — Issue Modeling result on a conversation. - `issueModel` string — Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} - `issues` GoogleCloudContactcenterinsightsV1IssueAssignment[] — All the matched issues. - `issue` string — Resource name of the assigned issue. - `score` number, double — Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. - `displayName` string — Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. - `entities` object — All the entities in the call. - `phraseMatchers` object — All the matched phrase matchers in the call. - `qaScorecardResults` GoogleCloudContactcenterinsightsV1QaScorecardResult[] — Results of scoring QaScorecards. - `normalizedScore` number, double — The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. - `createTime` string, google-datetime — Output only. The timestamp that the revision was created. - `agentId` string — ID of the agent that handled the conversation. - `potentialScore` number, double — The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. - `score` number, double — The overall numerical score of the result, incorporating any manual edits if they exist. - `scoreSources` GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource[] — List of all individual score sets. - `score` number, double — The overall numerical score of the result. - `sourceType` 'SOURCE_TYPE_UNSPECIFIED' | 'SYSTEM_GENERATED_ONLY' | 'INCLUDES_MANUAL_EDITS' — What created the score. - `qaTagResults` GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult[] — Collection of tags and their scores. - `normalizedScore` number, double — The normalized score the tag applies to. - `tag` string — The tag the score applies to. - `score` number, double — The score the tag applies to. - `potentialScore` number, double — The potential score the tag applies to. - `potentialScore` number, double — The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. - `normalizedScore` number, double — The normalized score, which is the score divided by the potential score. - `name` string — Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} - `qaAnswers` GoogleCloudContactcenterinsightsV1QaAnswer[] — Set of QaAnswers represented in the result. - `conversation` string — The conversation the answer applies to. - `qaQuestion` string — The QaQuestion answered by this answer. - `answerValue` GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue — Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. - `key` string — A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. - `skipValue` boolean — Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. - `naValue` boolean — A value of "Not Applicable (N/A)". Should only ever be `true`. - `strValue` string — String value. - `potentialScore` number, double — Output only. The maximum potential score of the question. - `normalizedScore` number, double — Output only. Normalized score of the questions. Calculated as score / potential_score. - `score` number, double — Output only. Numerical score of the answer. - `numValue` number, double — Numerical value. - `boolValue` boolean — Boolean value. - `tags` string[] — User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. - `questionBody` string — Question text. E.g., "Did the agent greet the customer?" - `answerSources` GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource[] — Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources. - `answerValue` GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue — Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. - … - `sourceType` 'SOURCE_TYPE_UNSPECIFIED' | 'SYSTEM_GENERATED' | 'MANUAL_EDIT' — What created the answer. - `qaScorecardRevision` string — The QaScorecardRevision scored by this result. - `qaTagResults` GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult[] — Collection of tags and their scores. - `normalizedScore` number, double — The normalized score the tag applies to. - `tag` string — The tag the score applies to. - `score` number, double — The score the tag applies to. - `potentialScore` number, double — The potential score the tag applies to. - `conversation` string — The conversation scored by this result. - `name` string — Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} - `requestTime` string, google-datetime — Output only. The time at which the analysis was requested. - `createTime` string, google-datetime — Output only. The time at which the analysis was created, which occurs when the long-running operation completes. - `annotatorSelector` GoogleCloudContactcenterinsightsV1AnnotatorSelector — Selector of all available annotators and phrase matchers to run. - `runEntityAnnotator` boolean — Whether to run the entity annotator. - `runPhraseMatcherAnnotator` boolean — Whether to run the active phrase matcher annotator(s). - `qaConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig — Configuration for the QA feature. - `scorecardList` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList — Container for a list of scorecards. - `qaScorecardRevisions` string[] — List of QaScorecardRevisions. - `runIntentAnnotator` boolean — Whether to run the intent annotator. - `summarizationConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig — Configuration for summarization. - `summarizationModel` 'SUMMARIZATION_MODEL_UNSPECIFIED' | 'BASELINE_MODEL' | 'BASELINE_MODEL_V2_0' — Default summarization model to be used. - `conversationProfile` string — Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} - `generator` string — The resource name of the existing created generator. Format: projects//locations//generators/ - `runSilenceAnnotator` boolean — Whether to run the silence annotator. - `runIssueModelAnnotator` boolean — Whether to run the issue model annotator. A model should have already been deployed for this to take effect. - `issueModels` string[] — The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference. - `runAutoLabelingAnnotator` boolean — Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. - `runQaAnnotator` boolean — Whether to run the QA annotator. - `runSentimentAnnotator` boolean — Whether to run the sentiment annotator. - `runSummarizationAnnotator` boolean — Whether to run the summarization annotator. - `phraseMatchers` string[] — The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - `runInterruptionAnnotator` boolean — Whether to run the interruption annotator. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/contactcenterinsights.md) · [All operations](https://skmtc.net/google/apis/contactcenterinsights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/contactcenterinsights/versions/e071ddf4dfc3/schema)