From 02b898de28c3ddda433d0b7469d77357c3e2fad9 Mon Sep 17 00:00:00 2001 From: scawful Date: Wed, 4 Feb 2026 21:45:03 +0000 Subject: [PATCH 01/25] Add AutoLabelingRule resource for Contact Center Insights --- .../AutoLabelingRule.yaml | 115 ++++++++++++++++++ ..._insights_auto_labeling_rule_basic.tf.tmpl | 11 ++ ...center_insights_auto_labeling_rule_test.go | 82 +++++++++++++ 3 files changed, 208 insertions(+) create mode 100644 mmv1/products/contactcenterinsights/AutoLabelingRule.yaml create mode 100644 mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl create mode 100644 mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go diff --git a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml new file mode 100644 index 000000000000..98e45464cd35 --- /dev/null +++ b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml @@ -0,0 +1,115 @@ +# Copyright 2026 Google Inc. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +--- +name: AutoLabelingRule +description: | + The CCAI Insights project wide auto labeling rule. This rule will be applied + to all conversations that match the filter defined in the rule. +references: + guides: + 'Configure auto labeling rules using the API': 'https://cloud.google.com/contact-center/insights/docs/auto-labeling-rule' + api: 'https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations.autoLabelingRules' +base_url: projects/{{project}}/locations/{{location}}/autoLabelingRules +update_mask: true +self_link: projects/{{project}}/locations/{{location}}/autoLabelingRules/{{name}} +create_url: projects/{{project}}/locations/{{location}}/autoLabelingRules?autoLabelingRuleId={{auto_labeling_rule_id}} +update_verb: PATCH +id_format: projects/{{project}}/locations/{{location}}/autoLabelingRules/{{name}} +import_format: + - projects/{{project}}/locations/{{location}}/autoLabelingRules/{{name}} +examples: + - name: 'contact_center_insights_auto_labeling_rule_basic' + primary_resource_id: 'auto_labeling_rule_basic' + vars: + resource_name: 'auto-labeling-rule-basic' +autogen_async: true +async: + operation: + timeouts: + insert_minutes: 20 + update_minutes: 20 + delete_minutes: 20 + base_url: '{{op_id}}' + result: + resource_inside_response: true +autogen_status: QXV0b0xhYmVsaW5nUnVsZQ== +parameters: + - name: location + type: String + required: true + description: Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. + immutable: true + url_param_only: true + - name: autoLabelingRuleId + type: String + description: |- + A unique ID for the new AutoLabelingRule. This ID will become the final + component of the AutoLabelingRule's resource name. If no ID is specified, + a server-generated ID will be used. + + This value should be 4-64 characters and must match the regular + expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + immutable: true + url_param_only: true +properties: + - name: active + type: Boolean + description: |- + Whether the rule is active. + - name: createTime + type: String + description: The time at which this rule was created. + output: true + - name: displayName + type: String + description: Display Name of the auto labeling rule. + - name: description + type: String + description: The description of the rule. + - name: name + type: String + description: |- + Identifier. The resource name of the auto labeling rule. + Format: + projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule} + output: true + custom_flatten: 'templates/terraform/custom_flatten/name_from_self_link.tmpl' + - name: labelKeyType + type: Enum + description: The type of the label key. + enum_values: + - 'LABEL_KEY_TYPE_UNSPECIFIED' + - 'LABEL_KEY_TYPE_CUSTOM' + - name: labelKey + type: String + description: The label key. + - name: conditions + type: Array + description: Conditions to apply for auto-labeling the label_key. + item_type: + type: NestedObject + properties: + - name: condition + type: String + description: |- + A optional CEL expression to be evaluated as a boolean value. + Once evaluated as true, then we will proceed with the value evaluation. + An empty condition will be auto evaluated as true. + - name: value + type: String + description: CEL expression to be evaluated as the value. + - name: updateTime + type: String + description: The most recent time at which this rule was updated. + output: true diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl new file mode 100644 index 000000000000..fd692b2c3b8b --- /dev/null +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -0,0 +1,11 @@ +resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourceId}}" { + display_name = "{{index $.Vars "resource_name"}}" + location = "us-central1" + label_key_type = "LABEL_KEY_TYPE_CUSTOM" + label_key = "{{index $.Vars "resource_name"}}" + conditions { + condition = "true" + value = ""label_value"" + } + active = true +} diff --git a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go new file mode 100644 index 000000000000..7ba9d9ab21f5 --- /dev/null +++ b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go @@ -0,0 +1,82 @@ +package contactcenterinsights_test + +import ( + "testing" + + "github.com/hashicorp/terraform-plugin-testing/helper/resource" + "github.com/hashicorp/terraform-plugin-testing/plancheck" + "github.com/hashicorp/terraform-provider-google/google/acctest" + "github.com/hashicorp/terraform-provider-google/google/envvar" +) + +func TestAccContactCenterInsightsAutoLabelingRule_update(t *testing.T) { + t.Parallel() + + context := map[string]interface{}{ + "random_suffix": acctest.RandString(t, 10), + "project_number": envvar.GetTestProjectNumberFromEnv(), + "resource_name": "tf-test-rule-" + acctest.RandString(t, 10), + } + + acctest.VcrTest(t, resource.TestCase{ + PreCheck: func() { acctest.AccTestPreCheck(t) }, + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t), + Steps: []resource.TestStep{ + { + Config: testAccContactCenterInsightsAutoLabelingRule_basic(context), + }, + { + ResourceName: "google_contact_center_insights_auto_labeling_rule.auto_labeling_rule_basic", + ImportState: true, + ImportStateVerify: true, + ImportStateVerifyIgnore: []string{"location", "auto_labeling_rule_id"}, + }, + { + Config: testAccContactCenterInsightsAutoLabelingRule_update(context), + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction("google_contact_center_insights_auto_labeling_rule.auto_labeling_rule_basic", plancheck.ResourceActionUpdate), + }, + }, + }, + { + ResourceName: "google_contact_center_insights_auto_labeling_rule.auto_labeling_rule_basic", + ImportState: true, + ImportStateVerify: true, + ImportStateVerifyIgnore: []string{"location", "auto_labeling_rule_id"}, + }, + }, + }) +} + +func testAccContactCenterInsightsAutoLabelingRule_basic(context map[string]interface{}) string { + return acctest.Nprintf(` +resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { + display_name = "auto-labeling-rule-display-name-%{random_suffix}" + location = "us-central1" + label_key_type = "LABEL_KEY_TYPE_CUSTOM" + label_key = "%{resource_name}" + conditions { + condition = "true" + value = ""label_value"" + } + active = true +} +`, context) +} + +func testAccContactCenterInsightsAutoLabelingRule_update(context map[string]interface{}) string { + return acctest.Nprintf(` +resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { + display_name = "auto-labeling-rule-display-name-%{random_suffix}-updated" + location = "us-central1" + label_key_type = "LABEL_KEY_TYPE_CUSTOM" + label_key = "%{resource_name}" + conditions { + condition = "true" + value = ""label_value_updated"" + } + active = false +} +`, context) +} From bb5073fd0fb0fa764d8e5fdc334d81efb9986ec5 Mon Sep 17 00:00:00 2001 From: scawful Date: Fri, 6 Feb 2026 20:03:07 +0000 Subject: [PATCH 02/25] Add AutoLabelingRule resource --- .../openapi/contactcenterinsights.v1.json | 42995 ++++++++++++++++ 1 file changed, 42995 insertions(+) create mode 100755 mmv1/openapi_generate/openapi/contactcenterinsights.v1.json diff --git a/mmv1/openapi_generate/openapi/contactcenterinsights.v1.json b/mmv1/openapi_generate/openapi/contactcenterinsights.v1.json new file mode 100755 index 000000000000..f14dcfb7d405 --- /dev/null +++ b/mmv1/openapi_generate/openapi/contactcenterinsights.v1.json @@ -0,0 +1,42995 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Contact Center AI Insights API", + "description": "", + "version": "v1", + "x-google-revision": "0" + }, + "servers": [ + { + "url": "https://contactcenterinsights.googleapis.com", + "description": "Global Endpoint" + } + ], + "paths": { + "/v1/projects/{project}/locations/{location}/operations": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListOperations", + "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "The standard list filter.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The standard list page size.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The standard list page token.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "returnPartialSuccess", + "description": "When set to `true`, operations that are reachable are returned as normal,\nand those that are unreachable are returned in the\nListOperationsResponse.unreachable\nfield.\n\nThis can only be `true` when reading across collections. For example, when\n`parent` is set to `\"projects/example/locations/-\"`.\n\nThis field is not supported by default and will result in an\n`UNIMPLEMENTED` error if set unless explicitly documented otherwise in\nservice or product specific documentation.", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleLongrunningListOperationsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/operations": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListOperationsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", + "x-google-operation-name" : "ListOperations", + "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "The standard list filter.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The standard list page size.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The standard list page token.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "returnPartialSuccess", + "description": "When set to `true`, operations that are reachable are returned as normal,\nand those that are unreachable are returned in the\nListOperationsResponse.unreachable\nfield.\n\nThis can only be `true` when reading across collections. For example, when\n`parent` is set to `\"projects/example/locations/-\"`.\n\nThis field is not supported by default and will result in an\n`UNIMPLEMENTED` error if set unless explicitly documented otherwise in\nservice or product specific documentation.", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleLongrunningListOperationsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/operations/{operation}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetOperation", + "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "operation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleLongrunningOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/operations/{operation}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetOperationByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndOperation", + "x-google-operation-name" : "GetOperation", + "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "operation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleLongrunningOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/operations/{operation}:cancel": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CancelOperation", + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of `1`,\ncorresponding to `Code.CANCELLED`.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "operation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/operations/{operation}:cancel": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CancelOperationByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndOperation", + "x-google-operation-name" : "CancelOperation", + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of `1`,\ncorresponding to `Code.CANCELLED`.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "operation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateConversation", + "description": "Creates a conversation.\nNote that this method does not support audio transcription or redaction.\nUse `conversations.upload` instead.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversationId", + "description": "A unique ID for the new conversation. This ID will become the final\ncomponent of the conversation's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The conversation resource to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListConversations", + "description": "Lists conversations.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "virtualAgentId", + "description": "The agent id of the Dialogflow conversation. It is specified to only list\nthe conversations under this agent.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of conversations to return in the response. A valid page\nsize ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The value returned by the last `ListConversationsResponse`. This value\nindicates that this is a continuation of a prior `ListConversations` call\nand that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "A filter to reduce results to a specific subset. Useful for querying\nconversations with specific properties.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "description": "Optional. The attribute by which to order conversations in the response.\nIf empty, conversations will be ordered by descending creation time.\nSupported values are one of the following:\n\n* create_time\n* customer_satisfaction_rating\n* duration\n* latest_analysis\n* start_time\n* turn_count\n\nThe default sort order is ascending. To specify order, append `asc` or\n`desc` (`create_time desc`).\nFor more details, see [Google AIPs\nOrdering](https://google.aip.dev/132#ordering).", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "view", + "description": "The level of details of the conversation. Default is `BASIC`.", + "in": "query", + "schema": { + "type": "string", + "x-google-enum-descriptions": [ + "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", + "Populates all fields in the conversation.", + "Populates all fields in the conversation except the transcript.", + "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." + ], + "enum": [ + "CONVERSATION_VIEW_UNSPECIFIED", + "FULL", + "BASIC", + "DF_CONVERSATION" + ] + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations:upload": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "UploadConversation", + "description": "Create a long-running conversation upload operation. This method differs\nfrom `CreateConversation` by allowing audio transcription and optional DLP\nredaction.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateConversation", + "description": "Updates a conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `agent_id`\n* `language_code`\n* `labels`\n* `metadata`\n* `quality_metadata`\n* `call_metadata`\n* `start_time`\n* `expire_time` or `ttl`\n* `data_source.gcs_source.audio_uri` or\n* `data_source.dialogflow_source.audio_uri`\n* `data_source.screen_recordings`", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + }, + { + "name": "allowMissing", + "description": "Optional. Defaults to false. If set to true, and the conversation is not found, a new\nconversation will be created. In this situation, `update_mask` is ignored.", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "conversationAutoLabelingUpdateConfig.allowAutoLabelingUpdate", + "description": "Optional. If set to true, the conversation will be updated with auto labeling\nresults.", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "requestBody": { + "description": "Required. The new values for the conversation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetConversation", + "description": "Gets a conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "view", + "description": "The level of details of the conversation. Default is `FULL`.", + "in": "query", + "schema": { + "type": "string", + "x-google-enum-descriptions": [ + "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", + "Populates all fields in the conversation.", + "Populates all fields in the conversation except the transcript.", + "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." + ], + "enum": [ + "CONVERSATION_VIEW_UNSPECIFIED", + "FULL", + "BASIC", + "DF_CONVERSATION" + ] + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteConversation", + "description": "Deletes a conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "force", + "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetConversationByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", + "x-google-operation-name" : "GetConversation", + "description": "Gets a conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "view", + "description": "The level of details of the conversation. Default is `FULL`.", + "in": "query", + "schema": { + "type": "string", + "x-google-enum-descriptions": [ + "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", + "Populates all fields in the conversation.", + "Populates all fields in the conversation except the transcript.", + "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." + ], + "enum": [ + "CONVERSATION_VIEW_UNSPECIFIED", + "FULL", + "BASIC", + "DF_CONVERSATION" + ] + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteConversationByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", + "x-google-operation-name" : "DeleteConversation", + "description": "Deletes a conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "force", + "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations/{conversation}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetConversationByProjectAndLocationAndDatasetAndConversation", + "x-google-operation-name" : "GetConversation", + "description": "Gets a conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "view", + "description": "The level of details of the conversation. Default is `FULL`.", + "in": "query", + "schema": { + "type": "string", + "x-google-enum-descriptions": [ + "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", + "Populates all fields in the conversation.", + "Populates all fields in the conversation except the transcript.", + "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." + ], + "enum": [ + "CONVERSATION_VIEW_UNSPECIFIED", + "FULL", + "BASIC", + "DF_CONVERSATION" + ] + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteConversationByProjectAndLocationAndDatasetAndConversation", + "x-google-operation-name" : "DeleteConversation", + "description": "Deletes a conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "force", + "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListConversationsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", + "x-google-operation-name" : "ListConversations", + "description": "Lists conversations.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "virtualAgentId", + "description": "The agent id of the Dialogflow conversation. It is specified to only list\nthe conversations under this agent.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of conversations to return in the response. A valid page\nsize ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The value returned by the last `ListConversationsResponse`. This value\nindicates that this is a continuation of a prior `ListConversations` call\nand that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "A filter to reduce results to a specific subset. Useful for querying\nconversations with specific properties.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "description": "Optional. The attribute by which to order conversations in the response.\nIf empty, conversations will be ordered by descending creation time.\nSupported values are one of the following:\n\n* create_time\n* customer_satisfaction_rating\n* duration\n* latest_analysis\n* start_time\n* turn_count\n\nThe default sort order is ascending. To specify order, append `asc` or\n`desc` (`create_time desc`).\nFor more details, see [Google AIPs\nOrdering](https://google.aip.dev/132#ordering).", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "view", + "description": "The level of details of the conversation. Default is `BASIC`.", + "in": "query", + "schema": { + "type": "string", + "x-google-enum-descriptions": [ + "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", + "Populates all fields in the conversation.", + "Populates all fields in the conversation except the transcript.", + "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." + ], + "enum": [ + "CONVERSATION_VIEW_UNSPECIFIED", + "FULL", + "BASIC", + "DF_CONVERSATION" + ] + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListConversationsByProjectAndLocationAndDataset", + "x-google-operation-name" : "ListConversations", + "description": "Lists conversations.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "virtualAgentId", + "description": "The agent id of the Dialogflow conversation. It is specified to only list\nthe conversations under this agent.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of conversations to return in the response. A valid page\nsize ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The value returned by the last `ListConversationsResponse`. This value\nindicates that this is a continuation of a prior `ListConversations` call\nand that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "A filter to reduce results to a specific subset. Useful for querying\nconversations with specific properties.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "description": "Optional. The attribute by which to order conversations in the response.\nIf empty, conversations will be ordered by descending creation time.\nSupported values are one of the following:\n\n* create_time\n* customer_satisfaction_rating\n* duration\n* latest_analysis\n* start_time\n* turn_count\n\nThe default sort order is ascending. To specify order, append `asc` or\n`desc` (`create_time desc`).\nFor more details, see [Google AIPs\nOrdering](https://google.aip.dev/132#ordering).", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "view", + "description": "The level of details of the conversation. Default is `BASIC`.", + "in": "query", + "schema": { + "type": "string", + "x-google-enum-descriptions": [ + "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", + "Populates all fields in the conversation.", + "Populates all fields in the conversation except the transcript.", + "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." + ], + "enum": [ + "CONVERSATION_VIEW_UNSPECIFIED", + "FULL", + "BASIC", + "DF_CONVERSATION" + ] + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}:generateSignedAudio": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GenerateConversationSignedAudio", + "description": "Gets the signed URI for the audio for the given conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}:generateSignedAudio": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GenerateConversationSignedAudioByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", + "x-google-operation-name" : "GenerateConversationSignedAudio", + "description": "Gets the signed URI for the audio for the given conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations/{conversation}:generateSignedAudio": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GenerateConversationSignedAudioByProjectAndLocationAndDatasetAndConversation", + "x-google-operation-name" : "GenerateConversationSignedAudio", + "description": "Gets the signed URI for the audio for the given conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateDataset", + "description": "Creates a dataset.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "datasetId", + "description": "Optional. The ID to use for the dataset.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The dataset to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListDatasets", + "description": "List datasets matching the input.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of datasets to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListDatasetsResponse`; indicates\nthat this is a continuation of a prior `ListDatasets` call and\nthe system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. A filter to reduce results to a specific subset. Useful for querying\ndatasets with specific properties.\nSupported fields include, for Q2 though we only support list by project:\n- `type`\n- `description`\n- `project_number`", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDatasetsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetDataset", + "description": "Gets a dataset.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateDataset", + "description": "Updates a dataset.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to update.", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The dataset to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteDataset", + "description": "Delete a dataset.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteDatasetOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations:sample": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "SampleConversations", + "description": "Samples conversations based on user configuration and handles\nthe sampled conversations for different use cases.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations:sample": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "SampleConversationsByProjectAndLocationAndDataset", + "x-google-operation-name" : "SampleConversations", + "description": "Samples conversations based on user configuration and handles\nthe sampled conversations for different use cases.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/analyses": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateAnalysis", + "description": "Creates an analysis. The long running operation is done when the analysis\nhas completed.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The analysis to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateAnalysisOperation" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListAnalyses", + "description": "Lists analyses.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of analyses to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The value returned by the last `ListAnalysesResponse`; indicates\nthat this is a continuation of a prior `ListAnalyses` call and\nthe system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "A filter to reduce results to a specific subset. Useful for querying\nconversations with specific properties.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetAnalysis", + "description": "Gets an analysis.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "analysis", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteAnalysis", + "description": "Deletes an analysis.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "analysis", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations:bulkAnalyze": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "BulkAnalyzeConversations", + "description": "Analyzes multiple conversations in a single request.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/segments:bulkAnalyze": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "BulkAnalyzeConversationsByProjectAndLocationAndConversation", + "x-google-operation-name" : "BulkAnalyzeConversations", + "description": "Analyzes multiple conversations in a single request.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations:bulkDelete": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "BulkDeleteConversations", + "description": "Deletes multiple conversations in a single request.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations:bulkDelete": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "BulkDeleteConversationsByProjectAndLocationAndDataset", + "x-google-operation-name" : "BulkDeleteConversations", + "description": "Deletes multiple conversations in a single request.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations:ingest": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "IngestConversations", + "description": "Imports conversations and processes them according to the user's\nconfiguration.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations:ingest": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "IngestConversationsByProjectAndLocationAndDataset", + "x-google-operation-name" : "IngestConversations", + "description": "Imports conversations and processes them according to the user's\nconfiguration.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "ExportInsightsData", + "description": "Export insights data to a destination defined in the request body.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "projectsId", + "description": "Part of `parent`. Required. The parent resource to export data from.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "locationsId", + "description": "Part of `parent`. See documentation of `projectsId`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataOperation" + } + } + } + } + } + } + }, + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/insightsdata:export": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "ExportInsightsDataByProjectsIdAndLocationsIdAndDatasetsId", + "x-google-operation-name" : "ExportInsightsData", + "description": "Export insights data to a destination defined in the request body.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "projectsId", + "description": "Part of `parent`. Required. The parent resource to export data from.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "locationsId", + "description": "Part of `parent`. See documentation of `projectsId`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "datasetsId", + "description": "Part of `parent`. See documentation of `projectsId`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/issueModels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateIssueModel", + "description": "Creates an issue model.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The issue model to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelOperation" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListIssueModels", + "description": "Lists issue models.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of issue models to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The value returned by the last `ListIssueModelsResponse`. This value\nindicates that this is a continuation of a prior `ListIssueModels` call and\nthat the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "A filter to reduce results to a specific subset. Useful for querying\nissue models with specific properties.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListIssueModelsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateIssueModel", + "description": "Updates an issue model.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "The list of fields to be updated.", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The new values for the issue model.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetIssueModel", + "description": "Gets an issue model.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteIssueModel", + "description": "Deletes an issue model.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}:deploy": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "DeployIssueModel", + "description": "Deploys an issue model. Returns an error if a model is already deployed.\nAn issue model can only be used in analysis after it has been deployed.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}:undeploy": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "UndeployIssueModel", + "description": "Undeploys an issue model.\nAn issue model can not be used in analysis after it has been undeployed.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}:export": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "ExportIssueModel", + "description": "Exports an issue model to the provided destination.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/issueModels:import": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "ImportIssueModel", + "description": "Imports an issue model from a Cloud Storage bucket.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}/issues/{issue}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetIssue", + "description": "Gets an issue.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateIssue", + "description": "Updates an issue.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "The list of fields to be updated.", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The new values for the issue.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteIssue", + "description": "Deletes an issue.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}/issues": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListIssues", + "description": "Lists issues.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of issues to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The value returned by the last `ListIssuesResponse`. This value indicates\nthat this is a continuation of a prior `ListIssues` call and\nthat the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse" + } + } + } + } + } + }, + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateIssue", + "description": "Creates an issue.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The values for the new issue.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}:mergeIssues": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "MergeIssues", + "description": "Merges a group of issues into a new issue.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1MergeIssuesRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1MergeIssuesOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}:calculateIssueModelStats": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "CalculateIssueModelStats", + "description": "Gets an issue model's statistics.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issuemodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/faqModels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateFaqModel", + "description": "Creates an FAQ model.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "faqModelId", + "description": "Optional. The ID to use for the FAQ model, which will become the final\ncomponent of the FAQ model's resource name.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The FAQ model to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateFaqModelOperation" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListFaqModels", + "description": "Lists FAQ models.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of FAQ models to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The value returned by the last `ListFaqModelsResponse`. This value\nindicates that this is a continuation of a prior `ListFaqModels` call and\nthat the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "A filter to reduce results to a specific subset. Useful for querying\nFAQ models with specific properties.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListFaqModelsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/faqModels/{faqmodel}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateFaqModel", + "description": "Updates an FAQ model.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "faqmodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to be updated.", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The new values for the FAQ model.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetFaqModel", + "description": "Gets an FAQ model.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "faqmodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteFaqModel", + "description": "Deletes an FAQ model.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "faqmodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteFaqModelOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/faqModels/{faqmodel}/faqEntries/{faqentry}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetFaqEntry", + "description": "Gets an FAQ entry.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "faqmodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "faqentry", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntry" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateFaqEntry", + "description": "Updates an FAQ entry.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "faqmodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "faqentry", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to be updated.", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The new values for the FAQ entry.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntry" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntry" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteFaqEntry", + "description": "Deletes an FAQ entry.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "faqmodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "faqentry", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/faqModels/{faqmodel}/faqEntries": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListFaqEntries", + "description": "Lists FAQ entries.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "faqmodel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of FAQ entries to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The value returned by the last `ListFaqsResponse`. This value indicates\nthat this is a continuation of a prior `ListFaqEntries` call and\nthat the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListFaqEntriesResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/phraseMatchers": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreatePhraseMatcher", + "description": "Creates a phrase matcher.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The phrase matcher resource to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListPhraseMatchers", + "description": "Lists phrase matchers.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of phrase matchers to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The value returned by the last `ListPhraseMatchersResponse`. This value\nindicates that this is a continuation of a prior `ListPhraseMatchers` call\nand that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "A filter to reduce results to a specific subset. Useful for querying\nphrase matchers with specific properties.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/phraseMatchers/{phrasematcher}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetPhraseMatcher", + "description": "Gets a phrase matcher.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "phrasematcher", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeletePhraseMatcher", + "description": "Deletes a phrase matcher.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "phrasematcher", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdatePhraseMatcher", + "description": "Updates a phrase matcher.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "phrasematcher", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "The list of fields to be updated.", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The new values for the phrase matcher.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations:calculateStats": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "CalculateStats", + "description": "Gets conversation statistics.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "A filter to reduce results to a specific subset. This field is useful for\ngetting statistics about conversations with specific properties.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations:calculateStats": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "CalculateStatsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", + "x-google-operation-name" : "CalculateStats", + "description": "Gets conversation statistics.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "A filter to reduce results to a specific subset. This field is useful for\ngetting statistics about conversations with specific properties.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations:calculateStats": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CalculateStatsByProjectAndLocationAndDataset", + "x-google-operation-name" : "CalculateStats", + "description": "Gets conversation statistics.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/correlationConfig": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetCorrelationConfig", + "description": "Gets correlation config.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationConfig" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateCorrelationConfig", + "description": "Updates correlation config.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to be updated.", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The new correlation config values.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationConfig" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationConfig" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}:testCorrelationConfig": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "TestCorrelationConfig", + "description": "Tests correlation config on a conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/settings": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetSettings", + "description": "Gets project-level settings.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Settings" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateSettings", + "description": "Updates project-level settings.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Required. The list of fields to be updated.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The new settings values.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Settings" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Settings" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/analysisRules": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateAnalysisRule", + "description": "Creates a analysis rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The analysis rule resource to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListAnalysisRules", + "description": "Lists analysis rules.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of analysis rule to return in the response. If this\nvalue is zero, the service will select a default size. A call may return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListAnalysisRulesResponse`; indicates\nthat this is a continuation of a prior `ListAnalysisRules` call and\nthe system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/analysisRules/{analysisrule}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetAnalysisRule", + "description": "Get a analysis rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "analysisrule", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateAnalysisRule", + "description": "Updates a analysis rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "analysisrule", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to be updated.\nIf the update_mask is not provided, the update will be applied to all\nfields.", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The new analysis rule.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteAnalysisRule", + "description": "Deletes a analysis rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "analysisrule", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/autoLabelingRules": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListAutoLabelingRules", + "description": "Lists auto labeling rules.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of auto labeling rules to return in a single response.\nIf unspecified, at most 100 rules will be returned. The maximum value is\n1000; values above 1000 will be coerced to 1000.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The next_page_token value returned from a previous List request, if any.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAutoLabelingRulesResponse" + } + } + } + } + } + }, + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateAutoLabelingRule", + "description": "Creates an auto labeling rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "autoLabelingRuleId", + "description": "Required. The ID to use for the auto labeling rule, which will become the final\ncomponent of the auto labeling rule's resource name.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The auto labeling rule to create.\nThe `name` field of this rule must be empty. The `label_key` field\nwill be used to form the resource name.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/autoLabelingRules/{autolabelingrule}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetAutoLabelingRule", + "description": "Gets an auto labeling rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "autolabelingrule", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateAutoLabelingRule", + "description": "Updates an auto labeling rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "autolabelingrule", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to be updated.", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The auto labeling rule to update.\nThe rule's `name` field is used to identify the rule to update.\nFormat:\nprojects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteAutoLabelingRule", + "description": "Deletes an auto labeling rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "autolabelingrule", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/autoLabelingRules:test": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "TestAutoLabelingRule", + "description": "Tests auto labeling rules against a conversation.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/assessmentRules": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "description": "Creates an assessment rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessmentRuleId", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The assessment rule resource to create.", + "content": { + "application/json": { + "schema": { + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "description": "Lists assessment rules.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of assessment rule to return in the response. If this\nvalue is zero, the service will select a default size. A call may return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/assessmentRules/{assessmentrule}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "description": "Get an assessment rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessmentrule", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "description": "Updates an assessment rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessmentrule", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to be updated.\nIf the update_mask is not provided, the update will be applied to all\nfields.", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The new assessment rule.", + "content": { + "application/json": { + "schema": { + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "description": "Deletes an assessment rule.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessmentrule", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/encryptionSpec": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetEncryptionSpec", + "description": "Gets location-level encryption key specification.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/encryptionSpec:initialize": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "InitializeEncryptionSpec", + "description": "Initializes a location-level encryption key specification. An error will\nresult if the location has resources already created before the\ninitialization. After the encryption specification is initialized at a\nlocation, it is immutable and all newly created resources under the\nlocation will be encrypted with the existing specification.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/views": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateView", + "description": "Creates a view.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The view resource to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListViews", + "description": "Lists views.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of views to return in the response. If this\nvalue is zero, the service will select a default size. A call may return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "The value returned by the last `ListViewsResponse`; indicates\nthat this is a continuation of a prior `ListViews` call and\nthe system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/views/{view}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetView", + "description": "Gets a view.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "view", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateView", + "description": "Updates a view.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "view", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "The list of fields to be updated.", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The new view.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteView", + "description": "Deletes a view.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "view", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}:queryMetrics": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "QueryMetrics", + "description": "Query metrics.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:queryMetrics": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "QueryMetricsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", + "x-google-operation-name" : "QueryMetrics", + "description": "Query metrics.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}:generativeInsights": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "GenerativeInsights", + "description": "Natural language based Insights which powers the next generation of\ndashboards in Insights.\nNext generation of QueryMetrics.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:generativeInsights": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "GenerativeInsightsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", + "x-google-operation-name" : "GenerativeInsights", + "description": "Natural language based Insights which powers the next generation of\ndashboards in Insights.\nNext generation of QueryMetrics.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}:queryPerformanceOverview": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "QueryPerformanceOverview", + "description": "Generates a summary of predefined performance metrics for a set of\nconversations. Conversations can be specified by specifying a time window\nand an agent id, for now. The summary includes a comparison of metrics\ncomputed for conversations in the previous time period, and also a\ncomparison with peers in the same time period.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:queryPerformanceOverview": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "QueryPerformanceOverviewByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", + "x-google-operation-name" : "QueryPerformanceOverview", + "description": "Generates a summary of predefined performance metrics for a set of\nconversations. Conversations can be specified by specifying a time window\nand an agent id, for now. The summary includes a comparison of metrics\ncomputed for conversations in the previous time period, and also a\ncomparison with peers in the same time period.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}/qaQuestions": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateQaQuestion", + "description": "Create a QaQuestion.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qaQuestionId", + "description": "Optional. A unique ID for the new question. This ID will become the final\ncomponent of the question's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The QaQuestion to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListQaQuestions", + "description": "Lists QaQuestions.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of questions to return in the response. If the value is\nzero, the service will select a default size. A call might return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListQaQuestionsResponse`. This value\nindicates that this is a continuation of a prior `ListQaQuestions` call\nand that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}/qaQuestions/{qaquestion}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetQaQuestion", + "description": "Gets a QaQuestion.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qaquestion", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateQaQuestion", + "description": "Updates a QaQuestion.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qaquestion", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Required. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `abbreviation`\n* `answer_choices`\n* `answer_instructions`\n* `order`\n* `question_body`\n* `tags`", + "in": "query", + "required": true, + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The QaQuestion to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteQaQuestion", + "description": "Deletes a QaQuestion.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qaquestion", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaQuestionTags": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateQaQuestionTag", + "description": "Creates a QaQuestionTag.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qaQuestionTagId", + "description": "Optional. A unique ID for the new QaQuestionTag. This ID will become the final\ncomponent of the QaQuestionTag's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The QaQuestionTag to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListQaQuestionTags", + "description": "Lists the question tags.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. A filter to reduce results to a specific subset. Supports conjunctions\n(ie. AND operators). Supported fields include the following:\n\n* `project_id` - id of the project to list tags for\n* `qa_scorecard_id` - id of the scorecard to list tags for\n* `revision_id` - id of the scorecard revision to list tags for`\n* `qa_question_id - id of the question to list tags for`", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaQuestionTags/{qaquestiontag}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetQaQuestionTag", + "description": "Gets a QaQuestionTag.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qaquestiontag", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateQaQuestionTag", + "description": "Updates a QaQuestionTag.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qaquestiontag", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `qa_question_tag_name` - the name of the tag\n* `qa_question_ids` - the list of questions the tag applies to", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The QaQuestionTag to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagOperation" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteQaQuestionTag", + "description": "Deletes a QaQuestionTag.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qaquestiontag", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaScorecards": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateQaScorecard", + "description": "Create a QaScorecard.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qaScorecardId", + "description": "Optional. A unique ID for the new QaScorecard. This ID will become the final\ncomponent of the QaScorecard's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The QaScorecard to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListQaScorecards", + "description": "Lists QaScorecards.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of scorecards to return in the response. If the value is\nzero, the service will select a default size. A call might return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListQaScorecardsResponse`. This value\nindicates that this is a continuation of a prior `ListQaScorecards` call\nand that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "qaScorecardSources", + "description": "Optional. The source of scorecards are based on how those Scorecards were created,\ne.g., a customer-defined scorecard, a predefined scorecard, etc.\nThis field is used to retrieve Scorecards of one or more sources.", + "in": "query", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardSource" + } + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetQaScorecard", + "description": "Gets a QaScorecard.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateQaScorecard", + "description": "Updates a QaScorecard.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Required. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `description`\n* `display_name`", + "in": "query", + "required": true, + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The QaScorecard to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteQaScorecard", + "description": "Deletes a QaScorecard.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "force", + "description": "Optional. If set to true, all of this QaScorecard's child resources will also be\ndeleted. Otherwise, the request will only succeed if it has none.", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateQaScorecardRevision", + "description": "Creates a QaScorecardRevision.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qaScorecardRevisionId", + "description": "Optional. A unique ID for the new QaScorecardRevision. This ID will become the final\ncomponent of the QaScorecardRevision's resource name. If no ID is\nspecified, a server-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The QaScorecardRevision to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListQaScorecardRevisions", + "description": "Lists all revisions under the parent QaScorecard.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of scorecard revisions to return in the response. If the\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListQaScorecardRevisionsResponse`. This\nvalue indicates that this is a continuation of a prior\n`ListQaScorecardRevisions` call and that the system should return the next\npage of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. A filter to reduce results to a specific subset. Useful for querying\nscorecard revisions with specific properties.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "qaScorecardSources", + "description": "Optional. The source of scorecards are based on how those Scorecards were created,\ne.g., a customer-defined scorecard, a predefined scorecard, etc.\nThis field is used to retrieve Scorecards Revisions from Scorecards of one\nor more sources.", + "in": "query", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardSource" + } + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetQaScorecardRevision", + "description": "Gets a QaScorecardRevision.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteQaScorecardRevision", + "description": "Deletes a QaScorecardRevision.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "force", + "description": "Optional. If set to true, all of this QaScorecardRevision's child resources will also\nbe deleted. Otherwise, the request will only succeed if it has none.", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}:tuneQaScorecardRevision": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "TuneQaScorecardRevision", + "description": "Fine tune one or more QaModels.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}:bulkUpdateQaQuestions": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "BulkUpdateQaQuestions", + "description": "Bulk updates QaQuestions that are in the same revision.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}:deploy": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "DeployQaScorecardRevision", + "description": "Deploy a QaScorecardRevision.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}:undeploy": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "UndeployQaScorecardRevision", + "description": "Undeploy a QaScorecardRevision.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qascorecard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateFeedbackLabel", + "description": "Create feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbackLabelId", + "description": "Optional. The ID of the feedback label to create.\nIf one is not specified it will be generated by the server.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The feedback label to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListFeedbackLabels", + "description": "List feedback labels.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND). Automatically sorts by conversation ID. To sort by\nall feedback labels in a project see ListAllFeedbackLabels.\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of feedback labels to return in the response. A valid\npage size ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value\nindicates that this is a continuation of a prior `ListFeedbackLabels` call\nand that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/feedbackLabels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateFeedbackLabelByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", + "x-google-operation-name" : "CreateFeedbackLabel", + "description": "Create feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbackLabelId", + "description": "Optional. The ID of the feedback label to create.\nIf one is not specified it will be generated by the server.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The feedback label to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListFeedbackLabelsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", + "x-google-operation-name" : "ListFeedbackLabels", + "description": "List feedback labels.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND). Automatically sorts by conversation ID. To sort by\nall feedback labels in a project see ListAllFeedbackLabels.\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of feedback labels to return in the response. A valid\npage size ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value\nindicates that this is a continuation of a prior `ListFeedbackLabels` call\nand that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations/{conversation}/feedbackLabels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateFeedbackLabelByProjectAndLocationAndDatasetAndConversation", + "x-google-operation-name" : "CreateFeedbackLabel", + "description": "Create feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbackLabelId", + "description": "Optional. The ID of the feedback label to create.\nIf one is not specified it will be generated by the server.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The feedback label to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListFeedbackLabelsByProjectAndLocationAndDatasetAndConversation", + "x-google-operation-name" : "ListFeedbackLabels", + "description": "List feedback labels.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND). Automatically sorts by conversation ID. To sort by\nall feedback labels in a project see ListAllFeedbackLabels.\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of feedback labels to return in the response. A valid\npage size ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value\nindicates that this is a continuation of a prior `ListFeedbackLabels` call\nand that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedbacklabel}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetFeedbackLabel", + "description": "Get feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbacklabel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateFeedbackLabel", + "description": "Update feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbacklabel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Required. The list of fields to be updated.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The feedback label to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteFeedbackLabel", + "description": "Delete feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbacklabel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/feedbackLabels/{feedbacklabel}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetFeedbackLabelByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndFeedbacklabel", + "x-google-operation-name" : "GetFeedbackLabel", + "description": "Get feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbacklabel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateFeedbackLabelByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndFeedbacklabel", + "x-google-operation-name" : "UpdateFeedbackLabel", + "description": "Update feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbacklabel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Required. The list of fields to be updated.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The feedback label to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteFeedbackLabelByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndFeedbacklabel", + "x-google-operation-name" : "DeleteFeedbackLabel", + "description": "Delete feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbacklabel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations/{conversation}/feedbackLabels/{feedbacklabel}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetFeedbackLabelByProjectAndLocationAndDatasetAndConversationAndFeedbacklabel", + "x-google-operation-name" : "GetFeedbackLabel", + "description": "Get feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbacklabel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateFeedbackLabelByProjectAndLocationAndDatasetAndConversationAndFeedbacklabel", + "x-google-operation-name" : "UpdateFeedbackLabel", + "description": "Update feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbacklabel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Required. The list of fields to be updated.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The feedback label to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteFeedbackLabelByProjectAndLocationAndDatasetAndConversationAndFeedbacklabel", + "x-google-operation-name" : "DeleteFeedbackLabel", + "description": "Delete feedback label.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "feedbacklabel", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}:listAllFeedbackLabels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListAllFeedbackLabels", + "description": "List all feedback labels by project number.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of feedback labels to return in the response. A valid\npage size ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value\nindicates that this is a continuation of a prior `ListAllFeedbackLabels`\ncall and that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. A filter to reduce results to a specific subset in the entire project.\nSupports disjunctions (OR) and conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}:listAllFeedbackLabels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListAllFeedbackLabelsByProjectAndLocationAndDataset", + "x-google-operation-name" : "ListAllFeedbackLabels", + "description": "List all feedback labels by project number.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of feedback labels to return in the response. A valid\npage size ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value\nindicates that this is a continuation of a prior `ListAllFeedbackLabels`\ncall and that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. A filter to reduce results to a specific subset in the entire project.\nSupports disjunctions (OR) and conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}:bulkUploadFeedbackLabels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "BulkUploadFeedbackLabels", + "description": "Upload feedback labels from an external source in bulk.\nCurrently supports labeling Quality AI example conversations.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}:bulkUploadFeedbackLabels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "BulkUploadFeedbackLabelsByProjectAndLocationAndDataset", + "x-google-operation-name" : "BulkUploadFeedbackLabels", + "description": "Upload feedback labels from an external source in bulk.\nCurrently supports labeling Quality AI example conversations.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}:bulkDownloadFeedbackLabels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "BulkDownloadFeedbackLabels", + "description": "Download feedback labels in bulk from an external source.\nCurrently supports exporting Quality AI example conversations with\ntranscripts and question bodies.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}:bulkDownloadFeedbackLabels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "BulkDownloadFeedbackLabelsByProjectAndLocationAndDataset", + "x-google-operation-name" : "BulkDownloadFeedbackLabels", + "description": "Download feedback labels in bulk from an external source.\nCurrently supports exporting Quality AI example conversations with\ntranscripts and question bodies.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}:bulkDeleteFeedbackLabels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "BulkDeleteFeedbackLabels", + "description": "Delete feedback labels in bulk using a filter.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/datasets/{dataset}:bulkDeleteFeedbackLabels": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "BulkDeleteFeedbackLabelsByProjectAndLocationAndDataset", + "x-google-operation-name" : "BulkDeleteFeedbackLabels", + "description": "Delete feedback labels in bulk using a filter.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dataset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateAuthorizedViewSet", + "description": "Create AuthorizedViewSet", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedViewSetId", + "description": "Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final\ncomponent of the AuthorizedViewSet's resource name. If no ID is specified,\na server-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See\nhttps://google.aip.dev/122#resource-id-segments", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The AuthorizedViewSet to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListAuthorizedViewSets", + "description": "List AuthorizedViewSets", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of view sets to return in the response. If the value is\nzero, the service will select a default size. A call might return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListAuthorizedViewSetsResponse`. This value\nindicates that this is a continuation of a prior `ListAuthorizedViewSets`\ncall and that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. The filter expression to filter authorized view sets listed in the\nresponse.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "description": "Optional. The order by expression to order authorized view sets listed in the\nresponse.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetAuthorizedViewSet", + "description": "Get AuthorizedViewSet", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateAuthorizedViewSet", + "description": "Updates an AuthorizedViewSet.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `display_name`", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The AuthorizedViewSet to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteAuthorizedViewSet", + "description": "Deletes an AuthorizedViewSet.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "force", + "description": "Optional. If set to true, all of this AuthorizedViewSet's child resources will also\nbe deleted. Otherwise, the request will only succeed if it has none.", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateAuthorizedView", + "description": "Create AuthorizedView", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedViewId", + "description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final\ncomponent of the AuthorizedView's resource name. If no ID is specified,\na server-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See\nhttps://google.aip.dev/122#resource-id-segments", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The AuthorizedView to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListAuthorizedViews", + "description": "List AuthorizedViewSets", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of view to return in the response. If the value is\nzero, the service will select a default size. A call might return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value\nindicates that this is a continuation of a prior `ListAuthorizedViews`\ncall and that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. The filter expression to filter authorized views listed in the response.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "description": "Optional. The order by expression to order authorized views listed in the response.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetAuthorizedView", + "description": "Get AuthorizedView", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateAuthorizedView", + "description": "Updates an AuthorizedView.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `conversation_filter`\n* `display_name`", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The AuthorizedView to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteAuthorizedView", + "description": "Deletes an AuthorizedView.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews:search": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "SearchAuthorizedViews", + "description": "SearchAuthorizedViewSets", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of view to return in the response. If the value is\nzero, the service will select a default size. A call might return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value\nindicates that this is a continuation of a prior `ListAuthorizedViews`\ncall and that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "query", + "description": "Optional. The query expression to search authorized views.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "description": "Optional. The order by expression to order authorized views listed in the response.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateAssessment", + "description": "Create Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The assessment to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListAssessments", + "description": "List Assessments.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of assessments to list. If zero, the service will select\na default size. A call may return fewer objects than requested. A non-empty\n`next_page_token` in the response indicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. A filter to reduce results to a specific subset.\nSupported filters include:\n\n* `state` - The state of the assessment\n* `agent_info.agent_id` - The ID of the agent the assessment is for", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAssessmentsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", + "x-google-operation-name" : "CreateAssessment", + "description": "Create Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The assessment to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListAssessmentsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", + "x-google-operation-name" : "ListAssessments", + "description": "List Assessments.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "The maximum number of assessments to list. If zero, the service will select\na default size. A call may return fewer objects than requested. A non-empty\n`next_page_token` in the response indicates that more data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. A filter to reduce results to a specific subset.\nSupported filters include:\n\n* `state` - The state of the assessment\n* `agent_info.agent_id` - The ID of the agent the assessment is for", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAssessmentsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetAssessment", + "description": "Get Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteAssessment", + "description": "Delete an Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "force", + "description": "Optional. If set to true, all of this assessment's notes will also be deleted.\nOtherwise, the request will only succeed if it has no notes.", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", + "x-google-operation-name" : "GetAssessment", + "description": "Get Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", + "x-google-operation-name" : "DeleteAssessment", + "description": "Delete an Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "force", + "description": "Optional. If set to true, all of this assessment's notes will also be deleted.\nOtherwise, the request will only succeed if it has no notes.", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}:publish": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "PublishAssessment", + "description": "Publish an Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PublishAssessmentRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}:publish": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "PublishAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", + "x-google-operation-name" : "PublishAssessment", + "description": "Publish an Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PublishAssessmentRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}:appeal": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "AppealAssessment", + "description": "Appeal an Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AppealAssessmentRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}:appeal": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "AppealAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", + "x-google-operation-name" : "AppealAssessment", + "description": "Appeal an Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AppealAssessmentRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}:finalize": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "FinalizeAssessment", + "description": "Finalize an Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}:finalize": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "FinalizeAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", + "x-google-operation-name" : "FinalizeAssessment", + "description": "Finalize an Assessment.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateNote", + "description": "Create Note.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The note resource to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListNotes", + "description": "List Notes.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of notes to return in the response. If zero the service\nwill select a default size. A call might return fewer objects than\nrequested. A non-empty `next_page_token` in the response indicates that\nmore data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListNotesResponse`. This value indicates\nthat this is a continuation of a prior `ListNotes` call and that the system\nshould return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListNotesResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}/notes": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateNoteByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", + "x-google-operation-name" : "CreateNote", + "description": "Create Note.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The note resource to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListNotesByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", + "x-google-operation-name" : "ListNotes", + "description": "List Notes.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of notes to return in the response. If zero the service\nwill select a default size. A call might return fewer objects than\nrequested. A non-empty `next_page_token` in the response indicates that\nmore data is available.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListNotesResponse`. This value indicates\nthat this is a continuation of a prior `ListNotes` call and that the system\nshould return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListNotesResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateNote", + "description": "Update Note.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "note", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to be updated. If the update_mask is empty, all\nupdateable fields will be updated. Acceptable fields include:\n* `content`", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The note to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteNote", + "description": "Deletes a Note.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "note", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}/notes/{note}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateNoteByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessmentAndNote", + "x-google-operation-name" : "UpdateNote", + "description": "Update Note.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "note", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. The list of fields to be updated. If the update_mask is empty, all\nupdateable fields will be updated. Acceptable fields include:\n* `content`", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The note to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteNoteByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessmentAndNote", + "x-google-operation-name" : "DeleteNote", + "description": "Deletes a Note.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "conversation", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "assessment", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "note", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/dashboards": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateDashboard", + "description": "Creates a Dashboard.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dashboardId", + "description": "Optional. A unique ID for the new Dashboard. This ID will become the final\ncomponent of the Dashboard's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The dashboard to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListDashboards", + "description": "Lists Dashboards.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of dashboards to return. The service may return fewer\nthan this value.\nThe default and maximum value is 100.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListDashboardsResponse`. This value\nindicates that this is a continuation of a prior `ListDashboards` call\nand that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. The filter expression to filter dashboards listed in the response.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "description": "Optional. The order by expression to order dashboards listed in the response.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDashboardsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/dashboards/{dashboard}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetDashboard", + "description": "Gets a Dashboard.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dashboard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateDashboard", + "description": "Updates a Dashboard.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dashboard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. List of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `display_name`\n* `root_container`", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The dashboard to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteDashboard", + "description": "Deletes a Dashboard.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dashboard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/dashboards/{dashboard}/charts": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateChart", + "description": "Creates a Chart.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dashboard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "chartId", + "description": "Optional. A unique ID for the new Chart. This ID will become the final\ncomponent of the Chart's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The chart to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListCharts", + "description": "Lists Charts.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dashboard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListChartsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetChart", + "description": "Gets a Chart.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dashboard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "chart", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateChart", + "description": "Updates a Chart.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dashboard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "chart", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. List of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `display_name`", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The chart to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteChart", + "description": "Deletes a Chart.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dashboard", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "chart", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListDiscoveryWorkspaces", + "description": "Lists DiscoveryWorkspaces.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of discovery workspaces to return. The service may\nreturn fewer than this value.\nThe default and maximum value is 100.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListDiscoveryWorkspacesResponse`. This\nvalue indicates that this is a continuation of a prior\n`ListDiscoveryWorkspaces` call and that the system should return the next\npage of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. The filter expression to filter discovery workspaces listed in the\nresponse. Filter should adhere to https://google.aip.dev/160. Supported\nfilter fields:\n- `display_name`: returns discovery workspaces with root discovery display\nname equal to value.\n- `language_code`: returns discovery workspaces with root discovery\nlanguage code equal to value.\n- `deployment_spec`: returns discovery workspaces with deployment spec\ndisplay name equal to value.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDiscoveryWorkspacesResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetDiscoveryWorkspace", + "description": "Gets a DiscoveryWorkspace.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspace" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteDiscoveryWorkspace", + "description": "Deletes a DiscoveryWorkspace. All resources associated with the\nDiscoveryWorkspace will also be deleted.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "force", + "description": "Optional. If set to true, any child resources of this discovery workspace will also\nbe deleted. (Otherwise, the request will only work if the discovery\nworkspace has no child resources.)", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}:fetchTree": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "FetchDiscoveryWorkspaceTree", + "description": "Retrieves a DiscoveryWorkspace tree. By default, this method will return\nthe latest revision of all Discoveries in the tree starting with the\noverall root Discovery. To retrieve the tree with specific non-latest\nrevisions, specify the revision name or names as filters.\nThe .snapshot.display_name field of all discovery revisions in the response\nwill be populated with the display name of parent discovery at its latest\nstate.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryRevisionFilter", + "description": "Optional. Optional filter to specify which revision(s) of the tree's Discoveries to\ninclude. If empty, the latest revision of each Discovery in the tree will\nbe used. Accepts the suffix \"/revisions/latest\".", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FetchDiscoveryWorkspaceTreeResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}:deploy": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "DeployDiscoveryWorkspace", + "description": "Deploys a Discovery tree in a DiscoveryWorkspace for live inference. The\ndiscovery workspace will have the discoveryWorkspace.deployment_spec\npopulated with the deployed discovery revisions. An optional rediscovery\nschedule can be specified that will periodically regenerate the deployed\ndiscovery tree and use it to update the deployment spec.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployDiscoveryWorkspaceRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployDiscoveryWorkspaceResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}:undeploy": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "UndeployDiscoveryWorkspace", + "description": "Undeploys a Discovery tree in a DiscoveryWorkspace for live inference.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployDiscoveryWorkspaceRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployDiscoveryWorkspaceResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces:generate": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "GenerateDiscovery", + "description": "Generates a Discovery in a DiscoveryWorkspace. The discovery could be the\ninitial discovery or a drill down discovery.\nWhen this method is called to generate the initial discovery, client can\nspecify the parent discovery workspace name with a wildcard `-` (i.e.\nprojects/123/locations/global/discoveryWorkspaces/-/discoveries:generate)\nand the discovery workspace will be automatically created with a randomly\ngenerated id.\nWhen the discovery is a drill down discovery, discovery workspace resource\nfield in request.parent must be consistent with the workspace\nresource id section in discovery.drill_down_parent.\nWhen LRO finishes, the resulting discovery will contain the initial\ndiscoveryRevision that holds the initial discovery results. This method\nwill not run simultaneously with create discovery revision LROs as create\ndiscovery revision LRO will be blocked unless the latest revision under a\ndiscovery is finalized.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries:generate": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "GenerateDiscoveryByProjectAndLocationAndDiscoveryworkspace", + "x-google-operation-name" : "GenerateDiscovery", + "description": "Generates a Discovery in a DiscoveryWorkspace. The discovery could be the\ninitial discovery or a drill down discovery.\nWhen this method is called to generate the initial discovery, client can\nspecify the parent discovery workspace name with a wildcard `-` (i.e.\nprojects/123/locations/global/discoveryWorkspaces/-/discoveries:generate)\nand the discovery workspace will be automatically created with a randomly\ngenerated id.\nWhen the discovery is a drill down discovery, discovery workspace resource\nfield in request.parent must be consistent with the workspace\nresource id section in discovery.drill_down_parent.\nWhen LRO finishes, the resulting discovery will contain the initial\ndiscoveryRevision that holds the initial discovery results. This method\nwill not run simultaneously with create discovery revision LROs as create\ndiscovery revision LRO will be blocked unless the latest revision under a\ndiscovery is finalized.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryRequest" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryOperation" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListDiscoveries", + "description": "Lists Discoveries.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of discoveries to return. The service may return fewer\nthan this value.\nThe default and maximum value is 100.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListDiscoveriesResponse`. This value\nindicates that this is a continuation of a prior `ListDiscoveries` call\nand that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. The filter expression to filter discoveries listed in the response.\n## Supported filters:\n\n\u201Dcontains(\u2018project/../locations/../discoveryWorkspaces/../discoveries/../revisions/\u2026\u2019)\u201D\nreturns all discoveries in the discovery tree (linked by\nDiscovery.drill_down_parent and DiscoveryResult.drill_down_children\nfields) where the specified revision is a member of.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDiscoveriesResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries/{discovery}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetDiscovery", + "description": "Gets a Discovery.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discovery", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" + } + } + } + } + } + }, + "delete": { + "tags": ["contactcenterinsights"], + "operationId": "DeleteDiscovery", + "description": "Deletes a Discovery.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discovery", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "force", + "description": "Optional. If set to true, any child resources of this discovery will also be\ndeleted. (Otherwise, the request will only work if the discovery has no\nchild resources.)", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + } + } + }, + "patch": { + "tags": ["contactcenterinsights"], + "operationId": "UpdateDiscovery", + "description": "Updates a Discovery.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discovery", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "updateMask", + "description": "Optional. List of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `description`\n* `display_name`", + "in": "query", + "schema": { + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + ], + "requestBody": { + "description": "Required. The discovery to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries/{discovery}/revisions": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights"], + "operationId": "CreateDiscoveryRevision", + "description": "Creates a DiscoveryRevision. This is used to refine the Discovery's head\nrevision with feedbacks. This method expect feedbacks passed into\ndiscovery_revision to be finalized.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discovery", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryRevisionId", + "description": "Optional. The ID of the discovery revision to create.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Required. The discovery revision to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" + } + } + } + }, + "x-google-lro" : "true", + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionOperation" + } + } + } + } + } + }, + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListDiscoveryRevisions", + "description": "List discovery revisions.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discovery", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of discovery revisions to return. The service may\nreturn fewer than this value.\nThe default and maximum value is 100.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListDiscoveryRevisionsResponse`. This value\nindicates that this is a continuation of a prior `ListDiscoveryRevisions`\ncall and that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. The filter expression to filter discovery revisions listed in the response.\nSupported filters:\n* \u201Dcontains(\u2018project/../locations/../discoveryWorkspaces/../discoveries/../revisions/\u2026\u2019)\u201D\n returns all discovery revisions in the discovery tree (linked by\n Discovery.drill_down_parent and DiscoveryResult.drill_down_children\n fields) where the specified revision is a member.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDiscoveryRevisionsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries/{discovery}/revisions/{revision}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetDiscoveryRevision", + "description": "Get a discovery result revision.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discovery", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries/{discovery}/revisions/{revision}/results": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "ListDiscoveryResults", + "description": "List discovery result entries.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discovery", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "description": "Optional. The maximum number of discovery results to return. The service may return\nfewer than this value. The default and maximum value is 100.", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageToken", + "description": "Optional. The value returned by the last `ListDiscoveryResultsResponse`. This value\nindicates that this is a continuation of a prior `ListDiscoveryResults`\ncall and that the system should return the next page of data.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Optional. The filter expression to filter discovery results listed in the response.\nSupported filters:\n* \u201Dcontains(\u2018project/../locations/../discoveryWorkspaces/../discoveries/../revisions/../results/\u2026\u2019)\u201D\n returns all discovery results in the discovery tree (linked by\n Discovery.drill_down_parent and DiscoveryResult.drill_down_children\n fields) where the specified revision is a member.", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDiscoveryResultsResponse" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries/{discovery}/revisions/{revision}/results/{result}": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights"], + "operationId": "GetDiscoveryResult", + "description": "Get a discovery result.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discoveryworkspace", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discovery", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "result", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryResult" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:setIamPolicy": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights", "SetIamPolicy"], + "operationId": "SetIamPolicy", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleIamV1SetIamPolicyRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleIamV1Policy" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:getIamPolicy": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "get": { + "tags": ["contactcenterinsights", "GetIamPolicy"], + "operationId": "GetIamPolicy", + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "options.requestedPolicyVersion", + "description": "Optional. The maximum policy version that will be used to format the\npolicy.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional role bindings must specify\nversion 3. Policies with no conditional role bindings may specify any valid\nvalue or leave the field unset.\n\nThe policy in the response might use the policy version that you specified,\nor it might use a lower policy version. For example, if you specify version\n3, but the policy has no conditional role bindings, the response uses\nversion 1.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleIamV1Policy" + } + } + } + } + } + } + }, + "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:testIamPermissions": { + "parameters": [ + { "$ref": "#/components/parameters/alt"}, + { "$ref": "#/components/parameters/callback"}, + { "$ref": "#/components/parameters/prettyPrint"}, + { "$ref": "#/components/parameters/_.xgafv"} + ], + "post": { + "tags": ["contactcenterinsights", "TestIamPermissions"], + "operationId": "TestIamPermissions", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "security": [ + { + "google_oauth_implicit": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "google_oauth_code": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + { + "bearer_auth": [] + } + ], + "parameters": [ + { + "name": "project", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "location", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedviewset", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "authorizedview", + "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The request body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleIamV1TestIamPermissionsRequest" + } + } + } + }, + "responses": { + "default": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GoogleIamV1TestIamPermissionsResponse" + } + } + } + } + } + } + } + }, + "components": { + "parameters": { + "alt": { + "name": "$alt", + "description": "Data format for response.", + "schema": { + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "x-google-enum-descriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "type": "string" + }, + "in": "query" + }, + "callback": { + "name": "$callback", + "description": "JSONP", + "schema": { + "type": "string" + }, + "in": "query" + }, + "prettyPrint": { + "name": "$prettyPrint", + "description": "Returns response with indentations and line breaks.", + "schema": { + "default": "true", + "type": "boolean" + }, + "in": "query" + }, + "_.xgafv": { + "name": "$.xgafv", + "description": "V1 error format.", + "schema": { + "enum": [ + "1", + "2" + ], + "x-google-enum-descriptions": [ + "v1 error format", + "v2 error format" + ], + "type": "string" + }, + "in": "query" + } + }, + "securitySchemes": { + "google_oauth_implicit": { + "type": "oauth2", + "description": "Google Oauth 2.0 implicit authentication flow.", + "flows": { + "implicit": { + "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "google_oauth_code": { + "type": "oauth2", + "description": "Google Oauth 2.0 authorizationCode authentication flow.", + "flows": { + "authorizationCode": { + "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", + "tokenUrl": "https://oauth2.googleapis.com/token", + "refreshUrl": "https://oauth2.googleapis.com/token", + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "bearer_auth": { + "type": "http", + "description": "Http bearer authentication.", + "scheme": "bearer" + } + }, + "schemas": { + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "type": "object", + "properties": { + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleLongrunningOperation" + } + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets\n`ListOperationsRequest.return_partial_success` and reads across\ncollections. For example, when attempting to list all resources across all\nsupported locations.", + "x-google-unordered-list": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleRpcStatus": { + "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "type": "object", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "type": "integer", + "format": "int32" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "type": "string" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL." + } + } + } + } + }, + "GoogleProtobufEmpty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1Conversation": { + "description": "The conversation resource.", + "type": "object", + "properties": { + "callMetadata": { + "description": "Call-specific metadata.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata" + }] + }, + "expireTime": { + "description": "The time at which this conversation should expire. After this time, the\nconversation data and any associated analyses will be deleted.", + "type": "string", + "format": "date-time" + }, + "ttl": { + "description": "Input only. The TTL for this resource. If specified, then this TTL will\nbe used to calculate the expire time.", + "writeOnly": true, + "type": "string", + "format": "google-duration" + }, + "name": { + "description": "Immutable. The resource name of the conversation.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}", + "x-google-immutable": true, + "type": "string" + }, + "dataSource": { + "description": "The source of the audio and transcription for the conversation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource" + }] + }, + "createTime": { + "description": "Output only. The time at which the conversation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the conversation was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "startTime": { + "description": "The time at which the conversation started.", + "type": "string", + "format": "date-time" + }, + "languageCode": { + "description": "A user-specified language code for the conversation.", + "type": "string" + }, + "agentId": { + "description": "An opaque, user-specified string representing the human agent who handled\nthe conversation.", + "type": "string" + }, + "customerId": { + "description": "An opaque, user-specified string representing the customer identifier.", + "type": "string" + }, + "labels": { + "description": "A map for the user to specify any custom fields. A maximum of 100 labels\nper conversation is allowed, with a maximum of 256 characters per entry.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "qualityMetadata": { + "description": "Conversation metadata related to quality management.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata" + }] + }, + "metadataJson": { + "description": "Input only. JSON metadata encoded as a string.\nThis field is primarily used by Insights integrations with various\ntelephony systems and must be in one of Insight's supported formats.", + "writeOnly": true, + "type": "string" + }, + "transcript": { + "description": "Output only. The conversation transcript.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript" + }] + }, + "medium": { + "description": "Immutable. The conversation medium.", + "x-google-immutable": true, + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "The format for conversations that took place over the phone.", + "The format for conversations that took place over chat." + ], + "enum": [ + "MEDIUM_UNSPECIFIED", + "PHONE_CALL", + "CHAT" + ] + }, + "duration": { + "description": "Output only. The duration of the conversation.", + "readOnly": true, + "type": "string", + "format": "google-duration" + }, + "turnCount": { + "description": "Output only. The number of turns in the conversation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "latestAnalysis": { + "description": "Output only. The conversation's latest analysis, if one exists.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis" + }] + }, + "latestSummary": { + "description": "Output only. Latest summary of the conversation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" + }] + }, + "runtimeAnnotations": { + "description": "Output only. The annotations that were generated during the customer and agent\ninteraction.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation" + } + }, + "dialogflowIntents": { + "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a\nDialogflow intent, format:\nprojects/{project}/agent/{agent}/intents/{intent}", + "readOnly": true, + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent" + } + }, + "obfuscatedUserId": { + "description": "Obfuscated user ID which the customer sent to us.", + "type": "string" + }, + "dialogflowCxConversationData": { + "description": "The Dialogflow conversation raw data. It will only be populated when\nConversationView is DF_CONVERSATION_BASIC or DF_CONVERSATION_FULL.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowCxConversationData" + }] + }, + "aaSupervisorMonitoringStatus": { + "description": "Output only. Data from the monitoring status of a conversation by a human supervisor in\nAA. A human supervisor is a human agent that is monitoring virtual agent\nconversations.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationAgentAssistSupervisorMonitoringStatus" + }] + }, + "correlationInfo": { + "description": "Output only. Info for correlating across conversations.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationCallMetadata": { + "description": "Call-specific metadata.", + "type": "object", + "properties": { + "customerChannel": { + "description": "The audio channel that contains the customer.", + "type": "integer", + "format": "int32" + }, + "agentChannel": { + "description": "The audio channel that contains the agent.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationDataSource": { + "description": "The conversation source, which is a combination of transcript and audio.", + "type": "object", + "properties": { + "gcsSource": { + "description": "A Cloud Storage location specification for the audio and transcript.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource" + }] + }, + "dialogflowSource": { + "description": "The source when the conversation comes from Dialogflow.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource" + }] + }, + "metadataUri": { + "description": "Cloud Storage URI that points to a file that contains the conversation\nmetadata.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1GcsSource": { + "description": "A Cloud Storage source of conversation data.", + "type": "object", + "properties": { + "audioUri": { + "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", + "type": "string" + }, + "transcriptUri": { + "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation\ntranscript.", + "x-google-immutable": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DialogflowSource": { + "description": "A Dialogflow source of conversation data.", + "type": "object", + "properties": { + "dialogflowConversation": { + "description": "Output only. The name of the Dialogflow conversation that this conversation\nresource is derived from. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}", + "readOnly": true, + "type": "string" + }, + "audioUri": { + "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata": { + "description": "Conversation metadata related to quality management.", + "type": "object", + "properties": { + "customerSatisfactionRating": { + "description": "An arbitrary integer value indicating the customer's satisfaction rating.", + "type": "integer", + "format": "int32" + }, + "waitDuration": { + "description": "The amount of time the customer waited to connect with an agent.", + "type": "string", + "format": "google-duration" + }, + "menuPath": { + "description": "An arbitrary string value specifying the menu path the customer took.", + "type": "string" + }, + "agentInfo": { + "description": "Information about agents involved in the call.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" + } + }, + "feedbackLabels": { + "description": "Input only. The feedback labels associated with the conversation.", + "writeOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo": { + "description": "Information about an agent involved in the conversation.", + "type": "object", + "properties": { + "agentId": { + "description": "A user-specified string representing the agent.", + "type": "string" + }, + "displayName": { + "description": "The agent's name.", + "type": "string" + }, + "team": { + "description": "A user-specified string representing the agent's team. Deprecated in\nfavor of the `teams` field.", + "deprecated": true, + "type": "string" + }, + "teams": { + "description": "User-specified strings representing the agent's teams.", + "type": "array", + "items": { + "type": "string" + } + }, + "dispositionCode": { + "description": "A user-provided string indicating the outcome of the agent's segment of\nthe call.", + "type": "string" + }, + "agentType": { + "description": "The agent type, e.g. HUMAN_AGENT.", + "type": "string", + "x-google-enum-descriptions": [ + "Participant's role is not set.", + "Participant is a human agent.", + "Participant is an automated agent.", + "Participant is an end user who conversed with the contact center.", + "Participant is either a human or automated agent." + ], + "enum": [ + "ROLE_UNSPECIFIED", + "HUMAN_AGENT", + "AUTOMATED_AGENT", + "END_USER", + "ANY_AGENT" + ] + }, + "location": { + "description": "The agent's location.", + "type": "string" + }, + "deploymentId": { + "description": "The agent's deployment ID. Only applicable to automated agents.", + "type": "string" + }, + "deploymentDisplayName": { + "description": "The agent's deployment display name. Only applicable to automated\nagents.", + "type": "string" + }, + "versionId": { + "description": "The agent's version ID. Only applicable to automated agents.", + "type": "string" + }, + "versionDisplayName": { + "description": "The agent's version display name. Only applicable to automated agents.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1FeedbackLabel": { + "description": "Represents a conversation, resource, and label provided by the user.\nCan take the form of a string label or a QaAnswer label.\nQaAnswer labels are used for Quality AI example conversations.\nString labels are used for Topic Modeling.\nAgentAssistSummary labels are used for Agent Assist Summarization.", + "type": "object", + "properties": { + "label": { + "description": "String label used for Topic Modeling.", + "type": "string" + }, + "qaAnswerLabel": { + "description": "QaAnswer label used for Quality AI example conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" + }] + }, + "name": { + "description": "Immutable. Resource name of the FeedbackLabel.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", + "x-google-immutable": true, + "type": "string" + }, + "labeledResource": { + "description": "Name of the resource to be labeled.\nSupported resources are:\n\n* `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}`\n* `projects/{project}/locations/{location}/issueModels/{issue_model}`\n* `projects/{project}/locations/{location}/generators/{generator_id}`", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the label.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. Update time of the label.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue": { + "description": "Message for holding the value of a QaAnswer.\nQaQuestion.AnswerChoice defines the possible answer values for a\nquestion.", + "type": "object", + "properties": { + "strValue": { + "description": "String value.", + "type": "string" + }, + "numValue": { + "description": "Numerical value.", + "type": "number", + "format": "double" + }, + "boolValue": { + "description": "Boolean value.", + "type": "boolean" + }, + "naValue": { + "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", + "type": "boolean" + }, + "skipValue": { + "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`.\nIf a question receives this answer, it will be excluded from any score\ncalculations. This would mean that the question was not evaluated.", + "readOnly": true, + "type": "boolean" + }, + "key": { + "description": "A short string used as an identifier. Matches the value used in\nQaQuestion.AnswerChoice.key.", + "type": "string" + }, + "score": { + "description": "Output only. Numerical score of the answer.", + "readOnly": true, + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "Output only. The maximum potential score of the question.", + "readOnly": true, + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", + "readOnly": true, + "type": "number", + "format": "double" + }, + "rationale": { + "description": "Output only. The rationale for the answer. This field is only populated for answers\nthat are generated by the LLM. Manual edits currently do not have\nrationales.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale": { + "description": "Wrapper for the rationale for the answer.", + "type": "object", + "properties": { + "rationale": { + "description": "The rationale string for the answer.", + "type": "string" + }, + "rationaleSource": { + "description": "The source of the rationale. A manual edit AnswerValue could still\ncontain a system generated rationale if user didn't provide one. Manual\nedit would override the system generated rationale.", + "type": "string", + "x-google-enum-descriptions": [ + "The rationale source is unspecified. This value should generally not\nbe used.", + "The rationale is system generated.", + "The rationale is manually added by the user." + ], + "enum": [ + "RATIONALE_SOURCE_UNSPECIFIED", + "RATIONALE_SOURCE_SYSTEM_GENERATED", + "RATIONALE_SOURCE_MANUAL_EDIT" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationTranscript": { + "description": "A message representing the transcript of a conversation.", + "type": "object", + "properties": { + "transcriptSegments": { + "description": "A list of sequential transcript segments that comprise the conversation.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment": { + "description": "A segment of a full transcript.", + "type": "object", + "properties": { + "messageTime": { + "description": "The time that the message occurred, if provided.", + "type": "string", + "format": "date-time" + }, + "text": { + "description": "The text of this segment.", + "type": "string" + }, + "confidence": { + "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nsegment. A default value of 0.0 indicates that the value is unset.", + "type": "number", + "format": "float" + }, + "words": { + "description": "A list of the word-specific information for each word in the segment.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" + } + }, + "languageCode": { + "description": "The language code of this segment as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".", + "type": "string" + }, + "channelTag": { + "description": "For conversations derived from multi-channel audio, this is the channel\nnumber corresponding to the audio from that channel. For\naudioChannelCount = N, its output values can range from '1' to 'N'. A\nchannel tag of 0 indicates that the audio is mono.", + "type": "integer", + "format": "int32" + }, + "segmentParticipant": { + "description": "The participant of this segment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant" + }] + }, + "dialogflowSegmentMetadata": { + "description": "CCAI metadata relating to the current transcript segment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" + }] + }, + "sentiment": { + "description": "The sentiment for this transcript segment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo": { + "description": "Word-level info for words in a transcript.", + "type": "object", + "properties": { + "startOffset": { + "description": "Time offset of the start of this word relative to the beginning of\nthe total conversation.", + "type": "string", + "format": "google-duration" + }, + "endOffset": { + "description": "Time offset of the end of this word relative to the beginning of the\ntotal conversation.", + "type": "string", + "format": "google-duration" + }, + "word": { + "description": "The word itself. Includes punctuation marks that surround the word.", + "type": "string" + }, + "confidence": { + "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nword. A default value of 0.0 indicates that the value is unset.", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationParticipant": { + "description": "The call participant speaking for a given utterance.", + "type": "object", + "properties": { + "dialogflowParticipantName": { + "description": "The name of the participant provided by Dialogflow. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", + "type": "string" + }, + "userId": { + "description": "A user-specified ID representing the participant.", + "type": "string" + }, + "dialogflowParticipant": { + "description": "Deprecated. Use `dialogflow_participant_name` instead.\nThe name of the Dialogflow participant. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", + "deprecated": true, + "type": "string" + }, + "obfuscatedExternalUserId": { + "description": "Obfuscated user ID from Dialogflow.", + "type": "string" + }, + "role": { + "description": "The role of the participant.", + "type": "string", + "x-google-enum-descriptions": [ + "Participant's role is not set.", + "Participant is a human agent.", + "Participant is an automated agent.", + "Participant is an end user who conversed with the contact center.", + "Participant is either a human or automated agent." + ], + "enum": [ + "ROLE_UNSPECIFIED", + "HUMAN_AGENT", + "AUTOMATED_AGENT", + "END_USER", + "ANY_AGENT" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { + "description": "Metadata from Dialogflow relating to the current transcript segment.", + "type": "object", + "properties": { + "smartReplyAllowlistCovered": { + "description": "Whether the transcript segment was covered under the configured smart\nreply allowlist in Agent Assist.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1SentimentData": { + "description": "The data for a sentiment annotation.", + "type": "object", + "properties": { + "magnitude": { + "description": "A non-negative number from 0 to infinity which represents the absolute\nmagnitude of sentiment regardless of score.", + "type": "number", + "format": "float" + }, + "score": { + "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", + "type": "number", + "format": "float" + }, + "rationale": { + "description": "The rationale for the sentiment result.", + "type": "string" + }, + "modelType": { + "description": "The sentiment model used to produce the sentiment result.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified model type.", + "V1 model.", + "V2 LLM model." + ], + "enum": [ + "SENTIMENT_MODEL_TYPE_UNSPECIFIED", + "SENTIMENT_MODEL_TYPE_V1", + "SENTIMENT_MODEL_TYPE_V2" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1Analysis": { + "description": "The analysis resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the analysis.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", + "x-google-immutable": true, + "type": "string" + }, + "requestTime": { + "description": "Output only. The time at which the analysis was requested.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "createTime": { + "description": "Output only. The time at which the analysis was created, which occurs when the\nlong-running operation completes.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "analysisResult": { + "description": "Output only. The result of the analysis, which is populated when the analysis\nfinishes.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult" + }] + }, + "annotatorSelector": { + "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1AnalysisResult": { + "description": "The result of an analysis.", + "type": "object", + "properties": { + "callAnalysisMetadata": { + "description": "Call-specific metadata created by the analysis.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata" + }] + }, + "endTime": { + "description": "The time at which the analysis ended.", + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { + "description": "Call-specific metadata created during analysis.", + "type": "object", + "properties": { + "annotations": { + "description": "A list of call annotations that apply to this call.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation" + } + }, + "entities": { + "description": "All the entities in the call.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Entity" + } + }, + "sentiments": { + "description": "Overall conversation-level sentiment for each channel of the call.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" + } + }, + "silence": { + "description": "Overall conversation-level silence during the call.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence" + }] + }, + "intents": { + "description": "All the matched intents in the call.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Intent" + } + }, + "phraseMatchers": { + "description": "All the matched phrase matchers in the call.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData" + } + }, + "issueModelResult": { + "description": "Overall conversation-level issue modeling result.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelResult" + }] + }, + "semanticMatchMetadata": { + "description": "Metadata used in the semantic match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SemanticMatchMetadata" + }] + }, + "qaScorecardResults": { + "description": "Results of scoring QaScorecards.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1CallAnnotation": { + "description": "A piece of metadata that applies to a window of a call.", + "type": "object", + "properties": { + "interruptionData": { + "description": "Data specifying an interruption.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData" + }] + }, + "sentimentData": { + "description": "Data specifying sentiment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData" + }] + }, + "silenceData": { + "description": "Data specifying silence.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData" + }] + }, + "holdData": { + "description": "Data specifying a hold.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData" + }] + }, + "entityMentionData": { + "description": "Data specifying an entity mention.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData" + }] + }, + "intentMatchData": { + "description": "Data specifying an intent match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData" + }] + }, + "phraseMatchData": { + "description": "Data specifying a phrase match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData" + }] + }, + "issueMatchData": { + "description": "Data specifying an issue match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData" + }] + }, + "channelTag": { + "description": "The channel of the audio where the annotation occurs. For single-channel\naudio, this field is not populated.", + "type": "integer", + "format": "int32" + }, + "annotationStartBoundary": { + "description": "The boundary in the conversation where the annotation starts, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary" + }] + }, + "annotationEndBoundary": { + "description": "The boundary in the conversation where the annotation ends, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1InterruptionData": { + "description": "The data for an interruption annotation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1SilenceData": { + "description": "The data for a silence annotation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1HoldData": { + "description": "The data for a hold annotation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1EntityMentionData": { + "description": "The data for an entity mention annotation.\nThis represents a mention of an `Entity` in the conversation.", + "type": "object", + "properties": { + "entityUniqueId": { + "description": "The key of this entity in conversation entities.\nCan be used to retrieve the exact `Entity` this mention is attached to.", + "type": "string" + }, + "type": { + "description": "The type of the entity mention.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Proper noun.", + "Common noun (or noun compound)." + ], + "enum": [ + "MENTION_TYPE_UNSPECIFIED", + "PROPER", + "COMMON" + ] + }, + "sentiment": { + "description": "Sentiment expressed for this mention of the entity.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1IntentMatchData": { + "description": "The data for an intent match.\nRepresents an intent match for a text segment in the conversation. A text\nsegment can be part of a sentence, a complete sentence, or an utterance\nwith multiple sentences.", + "type": "object", + "properties": { + "intentUniqueId": { + "description": "The id of the matched intent.\nCan be used to retrieve the corresponding intent information.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1PhraseMatchData": { + "description": "The data for a matched phrase matcher.\nRepresents information identifying a phrase matcher for a given match.", + "type": "object", + "properties": { + "phraseMatcher": { + "description": "The unique identifier (the resource name) of the phrase matcher.", + "type": "string" + }, + "displayName": { + "description": "The human-readable name of the phrase matcher.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1IssueMatchData": { + "description": "The data for an issue match annotation.", + "type": "object", + "properties": { + "issueAssignment": { + "description": "Information about the issue's assignment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1IssueAssignment": { + "description": "Information about the issue.", + "type": "object", + "properties": { + "issue": { + "description": "Resource name of the assigned issue.", + "type": "string" + }, + "score": { + "description": "Score indicating the likelihood of the issue assignment.\ncurrently bounded on [0,1].", + "type": "number", + "format": "double" + }, + "displayName": { + "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis\nand immutable since then.", + "x-google-immutable": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1AnnotationBoundary": { + "description": "A point in a conversation that marks the start or the end of an annotation.", + "type": "object", + "properties": { + "wordIndex": { + "description": "The word index of this boundary with respect to the first word in the\ntranscript piece. This index starts at zero.", + "type": "integer", + "format": "int32" + }, + "transcriptIndex": { + "description": "The index in the sequence of transcribed pieces of the conversation where\nthe boundary is located. This index starts at zero.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1Entity": { + "description": "The data for an entity annotation.\nRepresents a phrase in the conversation that is a known entity, such\nas a person, an organization, or location.", + "type": "object", + "properties": { + "displayName": { + "description": "The representative name for the entity.", + "type": "string" + }, + "type": { + "description": "The entity type.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Person.", + "Location.", + "Organization.", + "Event.", + "Artwork.", + "Consumer product.", + "Other types of entities.", + "Phone number.\n\nThe metadata lists the phone number (formatted according to local\nconvention), plus whichever additional elements appear in the text:\n\n* `number` - The actual number, broken down into sections according to\nlocal convention.\n* `national_prefix` - Country code, if detected.\n* `area_code` - Region or area code, if detected.\n* `extension` - Phone extension (to be dialed after connection), if\ndetected.", + "Address.\n\nThe metadata identifies the street number and locality plus whichever\nadditional elements appear in the text:\n\n* `street_number` - Street number.\n* `locality` - City or town.\n* `street_name` - Street/route name, if detected.\n* `postal_code` - Postal code, if detected.\n* `country` - Country, if detected.\n* `broad_region` - Administrative area, such as the state, if detected.\n* `narrow_region` - Smaller administrative area, such as county, if\ndetected.\n* `sublocality` - Used in Asian addresses to demark a district within a\ncity, if detected.", + "Date.\n\nThe metadata identifies the components of the date:\n\n* `year` - Four digit year, if detected.\n* `month` - Two digit month number, if detected.\n* `day` - Two digit day number, if detected.", + "Number.\n\nThe metadata is the number itself.", + "Price.\n\nThe metadata identifies the `value` and `currency`." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "PERSON", + "LOCATION", + "ORGANIZATION", + "EVENT", + "WORK_OF_ART", + "CONSUMER_GOOD", + "OTHER", + "PHONE_NUMBER", + "ADDRESS", + "DATE", + "NUMBER", + "PRICE" + ] + }, + "metadata": { + "description": "Metadata associated with the entity.\n\nFor most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)\nand Knowledge Graph MID (`mid`), if they are available. For the metadata\nassociated with other entity types, see the Type table below.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "salience": { + "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.", + "type": "number", + "format": "float" + }, + "sentiment": { + "description": "The aggregate sentiment expressed for this entity in the conversation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment": { + "description": "One channel of conversation-level sentiment data.", + "type": "object", + "properties": { + "channelTag": { + "description": "The channel of the audio that the data applies to.", + "type": "integer", + "format": "int32" + }, + "sentimentData": { + "description": "Data specifying sentiment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationLevelSilence": { + "description": "Conversation-level silence data.", + "type": "object", + "properties": { + "silenceDuration": { + "description": "Amount of time calculated to be in silence.", + "type": "string", + "format": "google-duration" + }, + "silencePercentage": { + "description": "Percentage of the total conversation spent in silence.", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudContactcenterinsightsV1Intent": { + "description": "The data for an intent.\nRepresents a detected intent in the conversation, for example MAKES_PROMISE.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the intent.", + "type": "string" + }, + "displayName": { + "description": "The human-readable name of the intent.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1IssueModelResult": { + "description": "Issue Modeling result on a conversation.", + "type": "object", + "properties": { + "issueModel": { + "description": "Issue model that generates the result.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", + "type": "string" + }, + "issues": { + "description": "All the matched issues.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1SemanticMatchMetadata": { + "description": "Semantic match metadata used in an analysis.", + "type": "object", + "properties": { + "issueModel": { + "description": "Issue model that's used in the semantic match.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1QaScorecardResult": { + "description": "The results of scoring a single conversation against a QaScorecard. Contains\na collection of QaAnswers and aggregate score.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The name of the scorecard result.\nFormat:\nprojects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", + "x-google-identifier": true, + "type": "string" + }, + "qaScorecardRevision": { + "description": "The QaScorecardRevision scored by this result.", + "type": "string" + }, + "conversation": { + "description": "The conversation scored by this result.", + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp that the revision was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "agentId": { + "description": "ID of the agent that handled the conversation.", + "type": "string" + }, + "qaAnswers": { + "description": "Set of QaAnswers represented in the result.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswer" + } + }, + "score": { + "description": "The overall numerical score of the result, incorporating any manual edits\nif they exist.", + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "The normalized score, which is the score divided by the potential score.\nAny manual edits are included if they exist.", + "type": "number", + "format": "double" + }, + "qaTagResults": { + "description": "Collection of tags and their scores.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" + } + }, + "scoreSources": { + "description": "List of all individual score sets.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1QaAnswer": { + "description": "An answer to a QaQuestion.", + "type": "object", + "properties": { + "qaQuestion": { + "description": "The QaQuestion answered by this answer.", + "type": "string" + }, + "conversation": { + "description": "The conversation the answer applies to.", + "type": "string" + }, + "questionBody": { + "description": "Question text. E.g., \"Did the agent greet the customer?\"", + "type": "string" + }, + "answerValue": { + "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" + }] + }, + "tags": { + "description": "User-defined list of arbitrary tags. Matches the value from\nQaScorecard.ScorecardQuestion.tags. Used for grouping/organization and\nfor weighting the score of each answer.", + "type": "array", + "items": { + "type": "string" + } + }, + "answerSources": { + "description": "Lists all answer sources containing one or more answer values of a\nspecific source type, e.g., all system-generated answer sources, or all\nmanual edit answer sources.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource": { + "description": "A question may have multiple answers from varying sources, one of which\nbecomes the \"main\" answer above. AnswerSource represents each individual\nanswer.", + "type": "object", + "properties": { + "sourceType": { + "description": "What created the answer.", + "type": "string", + "x-google-enum-descriptions": [ + "Source type is unspecified.", + "Answer was system-generated; created during an Insights analysis.", + "Answer was created by a human via manual edit." + ], + "enum": [ + "SOURCE_TYPE_UNSPECIFIED", + "SYSTEM_GENERATED", + "MANUAL_EDIT" + ] + }, + "answerValue": { + "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult": { + "description": "Tags and their corresponding results.", + "type": "object", + "properties": { + "tag": { + "description": "The tag the score applies to.", + "type": "string" + }, + "score": { + "description": "The score the tag applies to.", + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "The potential score the tag applies to.", + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "The normalized score the tag applies to.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource": { + "description": "A scorecard result may have multiple sets of scores from varying sources,\none of which becomes the \"main\" answer above. A ScoreSource represents\neach individual set of scores.", + "type": "object", + "properties": { + "sourceType": { + "description": "What created the score.", + "type": "string", + "x-google-enum-descriptions": [ + "Source type is unspecified.", + "Score is derived only from system-generated answers.", + "Score is derived from both system-generated answers, and includes\nany manual edits if they exist." + ], + "enum": [ + "SOURCE_TYPE_UNSPECIFIED", + "SYSTEM_GENERATED_ONLY", + "INCLUDES_MANUAL_EDITS" + ] + }, + "score": { + "description": "The overall numerical score of the result.", + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "The normalized score, which is the score divided by the potential score.", + "type": "number", + "format": "double" + }, + "qaTagResults": { + "description": "Collection of tags and their scores.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1AnnotatorSelector": { + "description": "Selector of all available annotators and phrase matchers to run.", + "type": "object", + "properties": { + "runInterruptionAnnotator": { + "description": "Whether to run the interruption annotator.", + "type": "boolean" + }, + "runSilenceAnnotator": { + "description": "Whether to run the silence annotator.", + "type": "boolean" + }, + "runPhraseMatcherAnnotator": { + "description": "Whether to run the active phrase matcher annotator(s).", + "type": "boolean" + }, + "phraseMatchers": { + "description": "The list of phrase matchers to run. If not provided, all active phrase\nmatchers will be used. If inactive phrase matchers are provided, they will\nnot be used. Phrase matchers will be run only if\nrun_phrase_matcher_annotator is set to true. Format:\nprojects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", + "type": "array", + "items": { + "type": "string" + } + }, + "runSentimentAnnotator": { + "description": "Whether to run the sentiment annotator.", + "type": "boolean" + }, + "runEntityAnnotator": { + "description": "Whether to run the entity annotator.", + "type": "boolean" + }, + "runIntentAnnotator": { + "description": "Whether to run the intent annotator.", + "type": "boolean" + }, + "runIssueModelAnnotator": { + "description": "Whether to run the issue model annotator. A model should have already been\ndeployed for this to take effect.", + "type": "boolean" + }, + "issueModels": { + "description": "The issue model to run. If not provided, the most recently deployed topic\nmodel will be used. The provided issue model will only be used for\ninference if the issue model is deployed and if run_issue_model_annotator\nis set to true. If more than one issue model is provided, only the first\nprovided issue model will be used for inference.", + "type": "array", + "items": { + "type": "string" + } + }, + "runSummarizationAnnotator": { + "description": "Whether to run the summarization annotator.", + "type": "boolean" + }, + "summarizationConfig": { + "description": "Configuration for the summarization annotator.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig" + }] + }, + "runQaAnnotator": { + "description": "Whether to run the QA annotator.", + "type": "boolean" + }, + "qaConfig": { + "description": "Configuration for the QA annotator.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig": { + "description": "Configuration for summarization.", + "type": "object", + "properties": { + "conversationProfile": { + "description": "Resource name of the Dialogflow conversation profile.\nFormat:\nprojects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", + "type": "string" + }, + "summarizationModel": { + "description": "Default summarization model to be used.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified summarization model.", + "The CCAI baseline model. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead.", + "The CCAI baseline model, V2.0. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead." + ], + "x-google-enum-deprecated": [ + false, + true, + true + ], + "enum": [ + "SUMMARIZATION_MODEL_UNSPECIFIED", + "BASELINE_MODEL", + "BASELINE_MODEL_V2_0" + ] + }, + "generator": { + "description": "The resource name of the existing created generator. Format:\nprojects//locations//generators/", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig": { + "description": "Configuration for the QA feature.", + "type": "object", + "properties": { + "scorecardList": { + "description": "A manual list of scorecards to score.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList": { + "description": "Container for a list of scorecards.", + "type": "object", + "properties": { + "qaScorecardRevisions": { + "description": "List of QaScorecardRevisions.", + "type": "array", + "items": { + "type": "string" + } + }, + "predefinedQaScorecards": { + "description": "List of predefined scorecards.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PredefinedQaScorecardType" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData": { + "description": "Conversation summarization suggestion data.", + "type": "object", + "properties": { + "text": { + "description": "The summarization content that is concatenated into one string.", + "type": "string" + }, + "textSections": { + "description": "The summarization content that is divided into sections. The key is the\nsection's name and the value is the section's content. There is no\nspecific format for the key or value.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "confidence": { + "description": "The confidence score of the summarization.", + "type": "number", + "format": "float" + }, + "metadata": { + "description": "A map that contains metadata about the summarization and the document\nfrom which it originates.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "answerRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + }, + "conversationModel": { + "description": "The name of the model that generates this summary.\nFormat:\nprojects/{project}/locations/{location}/conversationModels/{conversation_model}", + "type": "string" + }, + "generatorId": { + "description": "Agent Assist generator ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1RuntimeAnnotation": { + "description": "An annotation that was generated during the customer and agent interaction.", + "type": "object", + "properties": { + "articleSuggestion": { + "description": "Agent Assist Article Suggestion data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ArticleSuggestionData" + }] + }, + "faqAnswer": { + "description": "Agent Assist FAQ answer data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData" + }] + }, + "smartReply": { + "description": "Agent Assist Smart Reply data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData" + }] + }, + "smartComposeSuggestion": { + "description": "Agent Assist Smart Compose suggestion data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData" + }] + }, + "dialogflowInteraction": { + "description": "Dialogflow interaction data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData" + }] + }, + "conversationSummarizationSuggestion": { + "description": "Conversation summarization suggestion data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" + }] + }, + "annotationId": { + "description": "The unique identifier of the annotation.\nFormat:\nprojects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", + "type": "string" + }, + "createTime": { + "description": "The time at which this annotation was created.", + "type": "string", + "format": "date-time" + }, + "startBoundary": { + "description": "The boundary in the conversation where the annotation starts, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary" + }] + }, + "endBoundary": { + "description": "The boundary in the conversation where the annotation ends, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary" + }] + }, + "answerFeedback": { + "description": "The feedback that the customer has about the answer in `data`.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback" + }] + }, + "userInput": { + "description": "Explicit input used for generating the answer", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ArticleSuggestionData": { + "description": "Agent Assist Article Suggestion data.", + "type": "object", + "properties": { + "title": { + "description": "Article title.", + "type": "string" + }, + "uri": { + "description": "Article URI.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this article is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "float" + }, + "metadata": { + "description": "Map that contains metadata about the Article Suggestion and the document\nthat it originates from.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + }, + "source": { + "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1FaqAnswerData": { + "description": "Agent Assist frequently-asked-question answer data.", + "type": "object", + "properties": { + "answer": { + "description": "The piece of text from the `source` knowledge base document.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this answer is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "float" + }, + "question": { + "description": "The corresponding FAQ question.", + "type": "string" + }, + "metadata": { + "description": "Map that contains metadata about the FAQ answer and the document that\nit originates from.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + }, + "source": { + "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1SmartReplyData": { + "description": "Agent Assist Smart Reply data.", + "type": "object", + "properties": { + "reply": { + "description": "The content of the reply.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this reply is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "double" + }, + "metadata": { + "description": "Map that contains metadata about the Smart Reply and the document from\nwhich it originates.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData": { + "description": "Agent Assist Smart Compose suggestion data.", + "type": "object", + "properties": { + "suggestion": { + "description": "The content of the suggestion.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this suggestion is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "double" + }, + "metadata": { + "description": "Map that contains metadata about the Smart Compose suggestion and the\ndocument from which it originates.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { + "description": "Dialogflow interaction data.", + "type": "object", + "properties": { + "dialogflowIntentId": { + "description": "The Dialogflow intent resource path. Format:\nprojects/{project}/agent/{agent}/intents/{intent}", + "type": "string" + }, + "confidence": { + "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0\n(completely certain).", + "type": "number", + "format": "float" + }, + "detectIntentRequest": { + "description": "The Dialogflow conversation DetectIntentRequest raw data of this turn. This\nfield will only be populated in the GetConversation response and its data\nformat should be same as Dialogflow [DetectIntentRequest] of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL." + } + }, + "detectIntentResponse": { + "description": "The Dialogflow conversation DetectIntentResponse raw data of this turn.\nThis field will only be populated in the GetConversation response and its\ndata format should be same as Dialogflow DetectIntentResponse of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL." + } + }, + "flowId": { + "description": "The Dialogflow flow id.", + "type": "string" + }, + "flowDisplayName": { + "description": "The Dialogflow flow display name.\nThe Dialogflow environment display name.", + "type": "string" + }, + "pageId": { + "description": "The Dialogflow page ID.", + "type": "string" + }, + "pageDisplayName": { + "description": "The Dialogflow page display name.\nThe Dialogflow environment display name.", + "type": "string" + }, + "intentId": { + "description": "The Dialogflow intent ID.", + "type": "string" + }, + "intentDisplayName": { + "description": "The Dialogflow intent display name.\nThe Dialogflow environment display name.", + "type": "string" + }, + "endFlowOrSession": { + "description": "The turn reaches END_FLOW or END_SESSION.", + "type": "boolean" + }, + "liveAgentHandoff": { + "description": "Whether the turn was handed off to a human agent.", + "type": "boolean" + }, + "inputType": { + "description": "The input type in this turn.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified. Should never be used.", + "Text input.", + "Intent input.", + "Audio input.", + "Event input.", + "DTMF input." + ], + "enum": [ + "INPUT_TYPE_UNSPECIFIED", + "INPUT_TYPE_TEXT", + "INPUT_TYPE_INTENT", + "INPUT_TYPE_AUDIO", + "INPUT_TYPE_EVENT", + "INPUT_TYPE_DTMF" + ] + }, + "matchType": { + "description": "The match type in this turn.", + "type": "string", + "x-google-enum-descriptions": [ + "Not specified. Should never be used.", + "An intent is matched.", + "The input is an intent.", + "The input is for parameter filling.", + "No intent match for the input.", + "Indicates an empty input.", + "The input is an event." + ], + "enum": [ + "MATCH_TYPE_UNSPECIFIED", + "MATCH_TYPE_INTENT", + "MATCH_TYPE_DIRECT_INTENT", + "MATCH_TYPE_PARAMETER_FILLING", + "MATCH_TYPE_NO_MATCH", + "MATCH_TYPE_NO_INPUT", + "MATCH_TYPE_EVENT" + ] + }, + "detectIntentResponseV3": { + "description": "The Dialogflow v3 DetectIntentResponse raw data of this turn.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DetectIntentResponse" + }] + } + } + }, + "GoogleCloudDialogflowV3alpha1DetectIntentResponse": { + "description": "The message returned from the DetectIntent method.", + "type": "object", + "properties": { + "responseId": { + "description": "Output only. The unique identifier of the response. It can be used to\nlocate a response in the training example set or for reporting issues.", + "type": "string" + }, + "queryResult": { + "description": "The result of the conversational query.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1QueryResult" + }] + }, + "outputAudio": { + "description": "The audio data bytes encoded as specified in the request.\nNote: The output audio is generated based on the values of default platform\ntext responses found in the\n`query_result.response_messages` field. If\nmultiple default text responses exist, they will be concatenated when\ngenerating audio. If no default platform text responses exist, the\ngenerated audio content will be empty.\n\nIn some scenarios, multiple output audio fields may be present in the\nresponse structure. In these cases, only the top-most-level audio output\nhas content.", + "type": "string", + "format": "byte" + }, + "outputAudioConfig": { + "description": "The config used by the speech synthesizer to generate the output audio.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1OutputAudioConfig" + }] + }, + "responseType": { + "description": "Response type.", + "type": "string", + "x-google-enum-descriptions": [ + "Not specified. This should never happen.", + "Partial response. e.g. Aggregated responses in a Fulfillment that enables\n`return_partial_response` can be returned as partial response.\nWARNING: partial response is not eligible for barge-in.", + "Final response." + ], + "enum": [ + "RESPONSE_TYPE_UNSPECIFIED", + "PARTIAL", + "FINAL" + ] + }, + "allowCancellation": { + "description": "Indicates whether the partial response can be cancelled when a later\nresponse arrives. e.g. if the agent specified some music as partial\nresponse, it can be cancelled.", + "type": "boolean" + }, + "features": { + "description": "List of features used during the request processing.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DetectIntentResponseFeatureUsage" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1QueryResult": { + "description": "Represents the result of a conversational query.", + "type": "object", + "properties": { + "text": { + "description": "If natural language text was provided as input, this field\nwill contain a copy of the text.", + "type": "string" + }, + "triggerIntent": { + "description": "If an intent was provided as input, this field will\ncontain a copy of the intent identifier.\nFormat:\n`projects//locations//agents//intents/`.", + "type": "string" + }, + "transcript": { + "description": "If natural language speech audio was provided as input,\nthis field will contain the transcript for the audio.", + "type": "string" + }, + "triggerEvent": { + "description": "If an event was provided as input, this field will contain\nthe name of the event.", + "type": "string" + }, + "dtmf": { + "description": "If a DTMF was provided as input, this field will contain\na copy of the DtmfInput.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DtmfInput" + }] + }, + "languageCode": { + "description": "The language that was triggered during intent detection.\nSee [Language\nSupport](https://cloud.google.com/dialogflow/docs/reference/language)\nfor a list of the currently supported language codes.", + "type": "string" + }, + "parameters": { + "description": "The collected session parameters.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n* MapKey type: string\n* MapKey value: parameter name\n* MapValue type: If parameter's entity type is a composite entity then use\nmap, otherwise, depending on the parameter value type, it could be one of\nstring, number, boolean, null, list or map.\n* MapValue value: If parameter's entity type is a composite entity then use\nmap from composite entity property names to property values, otherwise,\nuse parameter value.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "responseMessages": { + "description": "The list of rich messages returned to the client. Responses vary from\nsimple text messages to more sophisticated, structured payloads used\nto drive complex logic.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessage" + } + }, + "webhookIds": { + "description": "The list of webhook ids in the order of call sequence.", + "type": "array", + "items": { + "type": "string" + } + }, + "webhookDisplayNames": { + "description": "The list of webhook display names in the order of call sequence.", + "type": "array", + "items": { + "type": "string" + } + }, + "webhookLatencies": { + "description": "The list of webhook latencies in the order of call sequence.", + "type": "array", + "items": { + "type": "string", + "format": "google-duration" + } + }, + "webhookTags": { + "description": "The list of webhook tags in the order of call sequence.", + "type": "array", + "items": { + "type": "string" + } + }, + "webhookStatuses": { + "description": "The list of webhook call status in the order of call sequence.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "webhookPayloads": { + "description": "The list of webhook payload in WebhookResponse.payload, in\nthe order of call sequence. If some webhook call fails or doesn't return\nany payload, an empty `Struct` would be used instead.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + }, + "currentPage": { + "description": "The current Page. Some, not all fields are filled in this message,\nincluding but not limited to `name` and `display_name`.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Page" + }] + }, + "currentFlow": { + "description": "The current Flow. Some, not all fields are filled in this message,\nincluding but not limited to `name` and `display_name`.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Flow" + }] + }, + "intent": { + "description": "The Intent that matched the conversational query. Some, not all fields\nare filled in this message, including but not limited to: `name` and\n`display_name`.\nThis field is deprecated, please use QueryResult.match instead.", + "deprecated": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Intent" + }] + }, + "intentDetectionConfidence": { + "description": "The intent detection confidence. Values range from 0.0 (completely\nuncertain) to 1.0 (completely certain).\nThis value is for informational purpose only and is only used to\nhelp match the best intent within the classification threshold.\nThis value may change for the same end-user expression at any time due to a\nmodel retraining or change in implementation.\nThis field is deprecated, please use QueryResult.match instead.", + "deprecated": true, + "type": "number", + "format": "float" + }, + "match": { + "description": "Intent match result, could be an intent or an event.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Match" + }] + }, + "diagnosticInfo": { + "description": "The free-form diagnostic info. For example, this field could contain\nwebhook call latency. The fields of this data can change without notice,\nso you should not write code that depends on its structure.\n\nOne of the fields is called \"Alternative Matched Intents\", which may\naid with debugging. The following describes these intent results:\n\n- The list is empty if no intent was matched to end-user input.\n- Only intents that are referenced in the currently active flow are\n included.\n- The matched intent is included.\n- Other intents that could have matched end-user input, but did not match\n because they are referenced by intent routes that are out of\n [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope),\n are included.\n- Other intents referenced by intent routes in scope that matched end-user\n input, but had a lower confidence score.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "generativeInfo": { + "description": "The information of a query if handled by generative agent resources.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1GenerativeInfo" + }] + }, + "sentimentAnalysisResult": { + "description": "The sentiment analysis result, which depends on\n`analyze_query_text_sentiment`, specified in the request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1SentimentAnalysisResult" + }] + }, + "advancedSettings": { + "description": "Returns the current advanced settings including IVR settings. Even though\nthe operations configured by these settings are performed by Dialogflow,\nthe client may need to perform special logic at the moment. For example, if\nDialogflow exports audio to Google Cloud Storage, then the client may need\nto wait for the resulting object to appear in the bucket before proceeding.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettings" + }] + }, + "allowAnswerFeedback": { + "description": "Indicates whether the Thumbs up/Thumbs down rating controls are need to be\nshown for the response in the Dialogflow Messenger widget.", + "type": "boolean" + }, + "callCompanionAuthCode": { + "description": "The auth code for accessing Call Companion UI.", + "type": "string", + "format": "byte" + }, + "dataStoreConnectionSignals": { + "description": "Optional. Data store connection feature output signals.\nFilled only when data stores are involved in serving the query.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignals" + }] + } + } + }, + "GoogleCloudDialogflowV3alpha1DtmfInput": { + "description": "Represents the input for dtmf event.", + "type": "object", + "properties": { + "digits": { + "description": "The dtmf digits.", + "type": "string" + }, + "finishDigit": { + "description": "The finish digit (if any).", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1ResponseMessage": { + "description": "Represents a response message that can be returned by a conversational agent.\n\nResponse messages are also used for output audio synthesis. The approach is\nas follows:\n\n* If at least one OutputAudioText response is present, then all\n OutputAudioText responses are linearly concatenated, and the result is used\n for output audio synthesis.\n* If the OutputAudioText responses are a mixture of text and SSML, then the\n concatenated result is treated as SSML; otherwise, the result is treated as\n either text or SSML as appropriate. The agent designer should ideally use\n either text or SSML consistently throughout the bot design.\n* Otherwise, all Text responses are linearly concatenated, and the result is\n used for output audio synthesis.\n\nThis approach allows for more sophisticated user experience scenarios, where\nthe text displayed to the user may differ from what is heard.", + "type": "object", + "properties": { + "text": { + "description": "Returns a text response.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageText" + }] + }, + "payload": { + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "conversationSuccess": { + "description": "Indicates that the conversation succeeded.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageConversationSuccess" + }] + }, + "outputAudioText": { + "description": "A text or ssml response that is preferentially used for TTS output audio\nsynthesis, as described in the comment on the ResponseMessage message.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageOutputAudioText" + }] + }, + "liveAgentHandoff": { + "description": "Hands off conversation to a human agent.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageLiveAgentHandoff" + }] + }, + "endInteraction": { + "description": "Output only. A signal that indicates the interaction with the Dialogflow agent has\nended.\nThis message is generated by Dialogflow only when the conversation\nreaches `END_SESSION` page. It is not supposed to be defined by the user.\n\nIt's guaranteed that there is at most one such message in each response.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageEndInteraction" + }] + }, + "playAudio": { + "description": "Signal that the client should play an audio clip hosted at a\nclient-specific URI. Dialogflow uses this to construct\nmixed_audio. However, Dialogflow itself\ndoes not try to read or process the URI in any way.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessagePlayAudio" + }] + }, + "mixedAudio": { + "description": "Output only. An audio response message composed of both the synthesized Dialogflow\nagent responses and responses defined via\nplay_audio.\nThis message is generated by Dialogflow only and not supposed to be\ndefined by the user.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageMixedAudio" + }] + }, + "telephonyTransferCall": { + "description": "A signal that the client should transfer the phone call connected to\nthis agent to a third-party endpoint.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageTelephonyTransferCall" + }] + }, + "knowledgeInfoCard": { + "description": "Represents info card for knowledge answers, to be better rendered in\nDialogflow Messenger.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageKnowledgeInfoCard" + }] + }, + "toolCall": { + "description": "Returns the definition of a tool call that should be executed by the\nclient.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ToolCall" + }] + }, + "dataStoreTextResponse": { + "description": "Text response from data store.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageDataStoreTextResponse" + }] + }, + "responseType": { + "description": "Response type.", + "type": "string", + "x-google-enum-descriptions": [ + "Not specified.", + "The response is from an entry prompt in the\npage.", + "The response is from form-filling prompt\nin the page.", + "The response is from a transition route or an event\nhandler in the page or flow or transition route group." + ], + "enum": [ + "RESPONSE_TYPE_UNSPECIFIED", + "ENTRY_PROMPT", + "PARAMETER_PROMPT", + "HANDLER_PROMPT" + ] + }, + "channel": { + "description": "The channel which the response is associated with. Clients can specify the\nchannel via QueryParameters.channel, and only associated channel\nresponse will be returned.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1ResponseMessageText": { + "description": "The text response message.", + "type": "object", + "properties": { + "text": { + "description": "Required. A collection of text response variants. If multiple variants are\ndefined, only one text response variant is returned at runtime.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end\nuser's speech and the client can then starts the next Dialogflow\nrequest.", + "readOnly": true, + "type": "boolean" + } + }, + "required": [ + "text" + ] + }, + "GoogleCloudDialogflowV3alpha1ResponseMessageConversationSuccess": { + "description": "Indicates that the conversation succeeded, i.e., the bot handled the issue\nthat the customer talked to it about.\n\nDialogflow only uses this to determine which conversations should be\ncounted as successful and doesn't process the metadata in this message in\nany way. Note that Dialogflow also considers conversations that get to the\nconversation end page as successful even if they don't return\nConversationSuccess.\n\nYou may set this, for example:\n* In the entry_fulfillment of a Page if\n entering the page indicates that the conversation succeeded.\n* In a webhook response when you determine that you handled the customer\n issue.", + "type": "object", + "properties": { + "metadata": { + "description": "Custom metadata. Dialogflow doesn't impose any structure on this.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudDialogflowV3alpha1ResponseMessageOutputAudioText": { + "description": "A text or ssml response that is preferentially used for TTS output audio\nsynthesis, as described in the comment on the ResponseMessage message.", + "type": "object", + "properties": { + "text": { + "description": "The raw text to be synthesized.", + "type": "string" + }, + "ssml": { + "description": "The SSML text to be synthesized. For more information, see\n[SSML](/speech/text-to-speech/docs/ssml).", + "type": "string" + }, + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end\nuser's speech and the client can then starts the next Dialogflow\nrequest.", + "readOnly": true, + "type": "boolean" + } + } + }, + "GoogleCloudDialogflowV3alpha1ResponseMessageLiveAgentHandoff": { + "description": "Indicates that the conversation should be handed off to a live agent.\n\nDialogflow only uses this to determine which conversations were handed off\nto a human agent for measurement purposes. What else to do with this signal\nis up to you and your handoff procedures.\n\nYou may set this, for example:\n* In the entry_fulfillment of a Page if\n entering the page indicates something went extremely wrong in the\n conversation.\n* In a webhook response when you determine that the customer issue can only\n be handled by a human.", + "type": "object", + "properties": { + "metadata": { + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose\nany structure on this.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudDialogflowV3alpha1ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended.\nThis message is generated by Dialogflow only and not supposed to be\ndefined by the user.", + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1ResponseMessagePlayAudio": { + "description": "Specifies an audio clip to be played by the client as part of the response.", + "type": "object", + "properties": { + "audioUri": { + "description": "Required. URI of the audio clip. Dialogflow does not impose any validation on this\nvalue. It is specific to the client that reads it.", + "type": "string" + }, + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end\nuser's speech and the client can then starts the next Dialogflow\nrequest.", + "readOnly": true, + "type": "boolean" + } + }, + "required": [ + "audioUri" + ] + }, + "GoogleCloudDialogflowV3alpha1ResponseMessageMixedAudio": { + "description": "Represents an audio message that is composed of both segments\nsynthesized from the Dialogflow agent prompts and ones hosted externally\nat the specified URIs.\nThe external URIs are specified via\nplay_audio.\nThis message is generated by Dialogflow only and not supposed to be\ndefined by the user.", + "type": "object", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageMixedAudioSegment" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "type": "object", + "properties": { + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using\nthe output config specified in the request.", + "type": "string", + "format": "byte" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the\nclient. Dialogflow does not impose any validation on it.", + "type": "string" + }, + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this segment can be interrupted by the end\nuser's speech and the client should then start the next Dialogflow\nrequest.", + "readOnly": true, + "type": "boolean" + } + } + }, + "GoogleCloudDialogflowV3alpha1ResponseMessageTelephonyTransferCall": { + "description": "Represents the signal that telles the client to transfer the phone call\nconnected to the agent to a third-party endpoint.", + "type": "object", + "properties": { + "phoneNumber": { + "description": "Transfer the call to a phone number\nin [E.164 format](https://en.wikipedia.org/wiki/E.164).", + "type": "string" + }, + "useOriginatingTrunk": { + "description": "Whether to use the originating SIP trunk of the incoming call to make the\noutbound call for the transfer.", + "type": "boolean" + } + } + }, + "GoogleCloudDialogflowV3alpha1ResponseMessageKnowledgeInfoCard": { + "description": "Represents info card response. If the response contains generative\nknowledge prediction, Dialogflow will return a payload with Infobot\nMessenger compatible info card.\n\nOtherwise, the info card response is skipped.", + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "type": "object", + "properties": { + "tool": { + "description": "Required. The tool associated with this call.\nFormat:\n`projects//locations//agents//tools/`.", + "type": "string" + }, + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "inputParameters": { + "description": "Optional. The action's input parameters.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + }, + "required": [ + "tool", + "action" + ] + }, + "GoogleCloudDialogflowV3alpha1ResponseMessageDataStoreTextResponse": { + "description": "The data store text response message. Rendered as a text response to\nthe caller.", + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1Page": { + "description": "A Dialogflow CX conversation (session) can be described and visualized as a\nstate machine. The states of a CX session are represented by pages.\n\nFor each flow, you define many pages, where your combined pages can handle a\ncomplete conversation on the topics the flow is designed for. At any given\nmoment, exactly one page is the current page, the current page is considered\nactive, and the flow associated with that page is considered active. Every\nflow has a special start page. When a flow initially becomes active, the\nstart page page becomes the current page. For each conversational turn, the\ncurrent page will either stay the same or transition to another page.\n\nYou configure each page to collect information from the end-user that is\nrelevant for the conversational state represented by the page.\n\nFor more information, see the\n[Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).", + "type": "object", + "properties": { + "name": { + "description": "The unique identifier of the page.\nRequired for the Pages.UpdatePage method. Pages.CreatePage\npopulates the name automatically.\nFormat:\n`projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the page, unique within the flow.", + "type": "string" + }, + "description": { + "description": "The description of the page. The maximum length is 500 characters.", + "type": "string" + }, + "entryFulfillment": { + "description": "The fulfillment to call when the session is entering the page.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Fulfillment" + }] + }, + "form": { + "description": "The form associated with the page, used for collecting parameters\nrelevant to the page.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Form" + }] + }, + "transitionRouteGroups": { + "description": "Ordered list of `TransitionRouteGroups` added to\nthe page. Transition route groups must be unique within a page. If the page\nlinks both flow-level transition route groups and agent-level transition\nroute groups, the flow-level ones will have higher priority and will be put\nbefore the agent-level ones.\n\n* If multiple transition routes within a page scope refer to the same\n intent, then the precedence order is: page's transition route -> page's\n transition route group -> flow's transition routes.\n\n* If multiple transition route groups within a page contain the same\n intent, then the first group in the ordered list takes precedence.\n\nFormat:`projects//locations//agents//flows//transitionRouteGroups/`\nor\n`projects//locations//agents//transitionRouteGroups/`\nfor agent-level groups.", + "type": "array", + "items": { + "type": "string" + } + }, + "transitionRoutes": { + "description": "A list of transitions for the transition rules of this page.\nThey route the conversation to another page in the same flow, or another\nflow.\n\nWhen we are in a certain page, the TransitionRoutes are evaluated in the\nfollowing order:\n\n* TransitionRoutes defined in the page with intent specified.\n* TransitionRoutes defined in the\n transition route groups with intent\n specified.\n* TransitionRoutes defined in flow with intent specified.\n* TransitionRoutes defined in the\n transition route groups with intent\n specified.\n* TransitionRoutes defined in the page with only condition specified.\n* TransitionRoutes defined in the\n transition route groups with only\n condition specified.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1TransitionRoute" + } + }, + "eventHandlers": { + "description": "Handlers associated with the page to handle events such as webhook errors,\nno match or no input.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1EventHandler" + } + }, + "advancedSettings": { + "description": "Hierarchical advanced settings for this page. The settings exposed at the\nlower level overrides the settings exposed at the higher level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettings" + }] + }, + "knowledgeConnectorSettings": { + "description": "Optional. Knowledge connector configuration.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1KnowledgeConnectorSettings" + }] + } + }, + "required": [ + "displayName" + ] + }, + "GoogleCloudDialogflowV3alpha1Fulfillment": { + "description": "A fulfillment can do one or more of the following actions at the same time:\n * Generate rich message responses.\n * Set parameter values.\n * Call the webhook.\nFulfillments can be called at various stages in the Page or\nForm lifecycle. For example, when a DetectIntentRequest drives a\nsession to enter a new page, the page's entry fulfillment can add a static\nresponse to the QueryResult in the returning DetectIntentResponse,\ncall the webhook (e.g., to load user data from a database), or both.", + "type": "object", + "properties": { + "messages": { + "description": "The list of rich message responses to present to the user.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessage" + } + }, + "webhook": { + "description": "The webhook to call.\nFormat:\n`projects//locations//agents//webhooks/`.", + "type": "string" + }, + "returnPartialResponses": { + "description": "Whether Dialogflow should return currently queued fulfillment response\nmessages in streaming APIs. If a webhook is specified, it happens before\nDialogflow invokes webhook.\nWarning:\n1) This flag only affects streaming API. Responses are still queued\nand returned once in non-streaming API.\n2) The flag can be enabled in any fulfillment but only the first 3 partial\nresponses will be returned. You may only want to apply it to fulfillments\nthat have slow webhooks.", + "type": "boolean" + }, + "tag": { + "description": "The value of this field will be populated in the WebhookRequest\n`fulfillmentInfo.tag` field by Dialogflow when the associated webhook is\ncalled.\nThe tag is typically used by the webhook service to identify which\nfulfillment is being called, but it could be used for other purposes.\nThis field is required if `webhook` is specified.", + "type": "string" + }, + "setParameterActions": { + "description": "Set parameter values before executing the webhook.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentSetParameterAction" + } + }, + "conditionalCases": { + "description": "Conditional cases for this fulfillment.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentConditionalCases" + } + }, + "advancedSettings": { + "description": "Hierarchical advanced settings for this fulfillment. The settings exposed\nat the lower level overrides the settings exposed at the higher level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettings" + }] + }, + "enableGenerativeFallback": { + "description": "If the flag is true, the agent will utilize LLM to generate a text\nresponse. If LLM generation fails, the defined\nresponses in the fulfillment will be respected.\nThis flag is only useful for fulfillments associated with no-match event\nhandlers.", + "type": "boolean" + }, + "generators": { + "description": "A list of Generators to be called during this fulfillment.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentGeneratorSettings" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1FulfillmentSetParameterAction": { + "description": "Setting a parameter value.", + "type": "object", + "properties": { + "parameter": { + "description": "Display name of the parameter.", + "type": "string" + }, + "value": { + "description": "The new value of the parameter. A null value clears the parameter." + } + } + }, + "GoogleCloudDialogflowV3alpha1FulfillmentConditionalCases": { + "description": "A list of cascading if-else conditions. Cases are mutually exclusive.\nThe first one with a matching condition is selected, all the rest ignored.", + "type": "object", + "properties": { + "cases": { + "description": "A list of cascading if-else conditions.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentConditionalCasesCase" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1FulfillmentConditionalCasesCase": { + "description": "Each case has a Boolean condition. When it is evaluated to be True, the\ncorresponding messages will be selected and evaluated recursively.", + "type": "object", + "properties": { + "condition": { + "description": "The condition to activate and select this case. Empty means the\ncondition is always true. The condition is evaluated against form\nparameters or session\nparameters.\n\nSee the [conditions\nreference](https://cloud.google.com/dialogflow/priv/docs/v3/condition).", + "type": "string" + }, + "caseContent": { + "description": "A list of case content.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentConditionalCasesCaseCaseContent" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1FulfillmentConditionalCasesCaseCaseContent": { + "description": "The list of messages or conditional cases to activate for this case.", + "type": "object", + "properties": { + "message": { + "description": "Returned message.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessage" + }] + }, + "additionalCases": { + "description": "Additional cases to be evaluated.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentConditionalCases" + }] + } + } + }, + "GoogleCloudDialogflowV3alpha1AdvancedSettings": { + "description": "Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.\nSettings exposed at lower level overrides the settings exposed at higher\nlevel. Overriding occurs at the sub-setting level. For example, the\nplayback_interruption_settings at fulfillment level only overrides the\nplayback_interruption_settings at the agent level, leaving other settings\nat the agent level unchanged.\n\nDTMF settings does not override each other. DTMF settings set at different\nlevels define DTMF detections running in parallel.\n\nHierarchy: Agent->Flow->Page->Fulfillment/Parameter.", + "type": "object", + "properties": { + "audioExportGcsDestination": { + "description": "If present, incoming audio is exported by Dialogflow to the configured\nGoogle Cloud Storage destination.\nExposed at the following levels:\n- Agent level\n- Flow level", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1GcsDestination" + }] + }, + "dtmfSettings": { + "description": "Settings for DTMF.\nExposed at the following levels:\n- Agent level\n- Flow level\n- Page level\n- Parameter level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettingsDtmfSettings" + }] + }, + "loggingSettings": { + "description": "Settings for logging.\nSettings for Dialogflow History, Contact Center messages, StackDriver logs,\nand speech logging.\nExposed at the following levels:\n- Agent level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettingsLoggingSettings" + }] + }, + "dtmfSettingsList": { + "description": "Output only. List of DtmfSettings emitted from different levels of agent.\nEach DtmfSettings in the list has higher priority than the ones before it\nin the list, with the last one having the highest priority.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettingsDtmfSettings" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1GcsDestination": { + "description": "Google Cloud Storage location for a Dialogflow operation that writes or\nexports objects (e.g. exported agent or transcripts) outside of Dialogflow.", + "type": "object", + "properties": { + "uri": { + "description": "Required. The Google Cloud Storage URI for the exported objects. A URI is of the\nform:\n`gs://bucket/object-name-or-prefix`\nWhether a full object name, or just a prefix, its usage depends on the\nDialogflow operation.", + "type": "string" + } + }, + "required": [ + "uri" + ] + }, + "GoogleCloudDialogflowV3alpha1AdvancedSettingsDtmfSettings": { + "description": "Define behaviors for DTMF (dual tone multi frequency).", + "type": "object", + "properties": { + "enabled": { + "description": "If true, incoming audio is processed for DTMF (dual tone multi frequency)\nevents. For example, if the caller presses a button on their telephone\nkeypad and DTMF processing is enabled, Dialogflow will detect the\nevent (e.g. a \"3\" was pressed) in the incoming audio and pass the event\nto the bot to drive business logic (e.g. when 3 is pressed, return the\naccount balance).", + "type": "boolean" + }, + "maxDigits": { + "description": "Max length of DTMF digits.", + "type": "integer", + "format": "int32" + }, + "finishDigit": { + "description": "The digit that terminates a DTMF digit sequence.", + "type": "string" + }, + "disableSpeechDetection": { + "description": "If true, disable speech detection when DTMF detection is running.", + "type": "boolean" + } + } + }, + "GoogleCloudDialogflowV3alpha1AdvancedSettingsLoggingSettings": { + "description": "Define behaviors on logging.", + "type": "object", + "properties": { + "enableStackdriverLogging": { + "description": "Enables Google Cloud Logging.", + "type": "boolean" + }, + "enableInteractionLogging": { + "description": "Enables DF Interaction logging.", + "type": "boolean" + }, + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined\nsession parameter `$session.params.conversation-redaction` will be\nused to determine if the utterance should be redacted.", + "type": "boolean" + } + } + }, + "GoogleCloudDialogflowV3alpha1FulfillmentGeneratorSettings": { + "description": "Generator settings used by the LLM to generate a text response.", + "type": "object", + "properties": { + "generator": { + "description": "Required. The generator to call.\nFormat:\n`projects//locations//agents//generators/`.", + "type": "string" + }, + "inputParameters": { + "description": "Map from placeholder parameter in the\nGenerator to corresponding session parameters. By default,\nDialogflow uses the session parameter with the same name to fill in the\ngenerator template. e.g. If there is a placeholder parameter `city` in\nthe Generator, Dialogflow default to fill in the `$city` with\n`$session.params.city`. However, you may choose to fill `$city` with\n`$session.params.desination-city`.\n- Map key: parameter ID\n- Map value: session parameter name", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "outputParameter": { + "description": "Required. Output parameter which should contain the generator response.", + "type": "string" + } + }, + "required": [ + "generator", + "outputParameter" + ] + }, + "GoogleCloudDialogflowV3alpha1Form": { + "description": "A form is a data model that groups related parameters that can be collected\nfrom the user. The process in which the agent prompts the user and collects\nparameter values from the user is called form filling. A form can be added to\na page. When form filling is done, the filled parameters will be\nwritten to the session.", + "type": "object", + "properties": { + "parameters": { + "description": "Parameters to collect from the user.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FormParameter" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1FormParameter": { + "description": "Represents a form parameter.", + "type": "object", + "properties": { + "displayName": { + "description": "Required. The human-readable name of the parameter, unique within the\nform.", + "type": "string" + }, + "required": { + "description": "Indicates whether the parameter is required. Optional parameters will not\ntrigger prompts; however, they are filled if the user specifies them.\nRequired parameters must be filled before form filling concludes.", + "type": "boolean" + }, + "entityType": { + "description": "Required. The entity type of the parameter.\nFormat:\n`projects/-/locations/-/agents/-/entityTypes/` for\nsystem entity types (for example,\n`projects/-/locations/-/agents/-/entityTypes/sys.date`), or\n`projects//locations//agents//entityTypes/`\nfor developer entity types.", + "type": "string" + }, + "isList": { + "description": "Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "fillBehavior": { + "description": "Required. Defines fill behavior for the parameter.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FormParameterFillBehavior" + }] + }, + "defaultValue": { + "description": "The default value of an optional parameter. If the parameter is required,\nthe default value will be ignored." + }, + "redact": { + "description": "Indicates whether the parameter content should be redacted in log. If\nredaction is enabled, the parameter content will be replaced by parameter\nname during logging.\nNote: the parameter content is subject to redaction if either parameter\nlevel redaction or entity type level redaction is\nenabled.", + "type": "boolean" + }, + "advancedSettings": { + "description": "Hierarchical advanced settings for this parameter. The settings exposed\nat the lower level overrides the settings exposed at the higher level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettings" + }] + } + }, + "required": [ + "displayName", + "entityType", + "fillBehavior" + ] + }, + "GoogleCloudDialogflowV3alpha1FormParameterFillBehavior": { + "description": "Configuration for how the filling of a parameter should be handled.", + "type": "object", + "properties": { + "initialPromptFulfillment": { + "description": "Required. The fulfillment to provide the initial prompt that the agent\ncan present to the user in order to fill the parameter.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Fulfillment" + }] + }, + "repromptEventHandlers": { + "description": "The handlers for parameter-level events, used to provide reprompt for\nthe parameter or transition to a different page/flow. The supported\nevents are:\n* `sys.no-match-`, where N can be from 1 to 6\n* `sys.no-match-default`\n* `sys.no-input-`, where N can be from 1 to 6\n* `sys.no-input-default`\n* `sys.invalid-parameter`\n\n`initial_prompt_fulfillment` provides the first prompt for the\nparameter.\n\nIf the user's response does not fill the parameter, a\nno-match/no-input event will be triggered, and the fulfillment\nassociated with the `sys.no-match-1`/`sys.no-input-1` handler (if\ndefined) will be called to provide a prompt. The\n`sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to\nthe next no-match/no-input event, and so on.\n\nA `sys.no-match-default` or `sys.no-input-default` handler will be used\nto handle all following no-match/no-input events after all numbered\nno-match/no-input handlers for the parameter are consumed.\n\nA `sys.invalid-parameter` handler can be defined to handle the case\nwhere the parameter values have been `invalidated` by webhook. For\nexample, if the user's response fill the parameter, however the\nparameter was invalidated by webhook, the fulfillment associated with\nthe `sys.invalid-parameter` handler (if defined) will be called to\nprovide a prompt.\n\nIf the event handler for the corresponding event can't be found on the\nparameter, `initial_prompt_fulfillment` will be re-prompted.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1EventHandler" + } + } + }, + "required": [ + "initialPromptFulfillment" + ] + }, + "GoogleCloudDialogflowV3alpha1EventHandler": { + "description": "An event handler specifies an event that can be handled\nduring a session. When the specified event happens, the following actions are\ntaken in order:\n\n* If there is a\n`trigger_fulfillment` associated with\nthe event, it will be called.\n* If there is a `target_page` associated\nwith the event, the session will transition into the specified page.\n* If there is a `target_flow` associated\nwith the event, the session will transition into the specified flow.", + "type": "object", + "properties": { + "name": { + "description": "Output only. The unique identifier of this event handler.", + "readOnly": true, + "type": "string" + }, + "event": { + "description": "Required. The name of the event to handle.", + "type": "string" + }, + "triggerFulfillment": { + "description": "The fulfillment to call when the event occurs.\nHandling webhook errors with a fulfillment enabled with webhook could\ncause infinite loop. It is invalid to specify such fulfillment for a\nhandler handling webhooks.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Fulfillment" + }] + }, + "targetPage": { + "description": "The target page to transition to.\nFormat:\n`projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "targetFlow": { + "description": "The target flow to transition to.\nFormat:\n`projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPlaybook": { + "description": "The target playbook to transition to.\nFormat:\n`projects//locations//agents//playbooks/`.", + "type": "string" + } + }, + "required": [ + "event" + ] + }, + "GoogleCloudDialogflowV3alpha1TransitionRoute": { + "description": "A transition route specifies a intent that can be matched and/or a\ndata condition that can be evaluated during a session. When a specified\ntransition is matched, the following actions are taken in order:\n\n* If there is a\n`trigger_fulfillment` associated with\nthe transition, it will be called.\n* If there is a `target_page` associated\nwith the transition, the session will transition into the specified page.\n* If there is a `target_flow` associated\nwith the transition, the session will transition into the specified flow.", + "type": "object", + "properties": { + "name": { + "description": "Output only. The unique identifier of this transition route.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the transition route. The maximum length is 500\ncharacters.", + "type": "string" + }, + "intent": { + "description": "The unique identifier of an Intent.\nFormat:\n`projects//locations//agents//intents/`.\nIndicates that the transition can only happen when the given intent is\nmatched.\nAt least one of `intent` or `condition` must be specified. When both\n`intent` and `condition` are specified, the transition can only happen\nwhen both are fulfilled.", + "type": "string" + }, + "condition": { + "description": "The condition to evaluate against form parameters or\nsession parameters.\n\nSee the [conditions\nreference](https://cloud.google.com/dialogflow/priv/docs/v3/condition).\nAt least one of `intent` or `condition` must be specified. When both\n`intent` and `condition` are specified, the transition can only happen\nwhen both are fulfilled.", + "type": "string" + }, + "triggerFulfillment": { + "description": "The fulfillment to call when the condition is satisfied. At least one of\n`trigger_fulfillment` and `target` must be specified. When both are\ndefined, `trigger_fulfillment` is executed first.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Fulfillment" + }] + }, + "targetPage": { + "description": "The target page to transition to.\nFormat:\n`projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "targetFlow": { + "description": "The target flow to transition to.\nFormat:\n`projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPlaybook": { + "description": "The target playbook to transition to.\nFormat:\n`projects//locations//agents//playbooks/`.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1KnowledgeConnectorSettings": { + "description": "The Knowledge Connector settings for this page or flow.\nThis includes information such as the attached Knowledge Bases, and the way\nto execute fulfillment.", + "type": "object", + "properties": { + "enabled": { + "description": "Whether Knowledge Connector is enabled or not.", + "type": "boolean" + }, + "triggerFulfillment": { + "description": "The fulfillment to be triggered.\n\nWhen the answers from the Knowledge Connector are selected by Dialogflow,\nyou can utitlize the request scoped parameter `$request.knowledge.answers`\n(contains up to the 5 highest confidence answers) and\n`$request.knowledge.questions` (contains the corresponding questions) to\nconstruct the fulfillment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Fulfillment" + }] + }, + "targetPage": { + "description": "The target page to transition to.\nFormat:\n`projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "targetFlow": { + "description": "The target flow to transition to.\nFormat:\n`projects//locations//agents//flows/`.", + "type": "string" + }, + "dataStoreConnections": { + "description": "Optional. List of related data store connections.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnection" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnection": { + "description": "A data store connection. It represents a data store in Discovery Engine and\nthe type of the contents it contains.", + "type": "object", + "properties": { + "dataStoreType": { + "description": "The type of the connected data store.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreType" + }] + }, + "dataStore": { + "description": "The full name of the referenced data store.\nFormats:\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`\n`projects/{project}/locations/{location}/dataStores/{data_store}`", + "type": "string" + }, + "languageCode": { + "description": "The language for which the data store connection is applied.\n\nIn normal cases, we don't need to populate `language_code` as only\ndata store connections of the requested language are returned. However we\nneed to store the data store connections of all languages for changelog, so\nthat we can revert back the entire resource.", + "type": "string" + }, + "documentProcessingMode": { + "description": "The document processing mode for the data store connection. Should only be\nset for PUBLIC_WEB and UNSTRUCTURED data stores. If not set it is\nconsidered as DOCUMENTS, as this is the legacy mode.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DocumentProcessingMode" + }] + }, + "aclConfig": { + "description": "The ACL config for the data store connection. It is only used for data\nstore of type `STRUCTURED`.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AclConfig" + }] + }, + "engineType": { + "description": "The engine type for the data store connection. It will default to Agent\nbuilder chat.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1EngineType" + }] + }, + "connectorConfig": { + "description": "The connector config for the data store connection.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionConnectorConfig" + }] + }, + "createTime": { + "description": "Timestamp the data store was created at.", + "type": "string", + "format": "date-time" + }, + "displayName": { + "description": "Display name of the data store connection.", + "type": "string" + }, + "dialogflowAddTime": { + "description": "Timestamp the data store was added to dialogflow.", + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudDialogflowV3alpha1AclConfig": { + "description": "ACL config for a data store connection.", + "type": "object", + "properties": { + "idpType": { + "description": "Identity provider type set at project/datastore level.", + "type": "string", + "x-google-enum-descriptions": [ + "Default value. ACL search not enabled.", + "Google 1P provider.", + "External 3P provider." + ], + "enum": [ + "IDP_TYPE_NONE", + "IDP_TYPE_GSUITE", + "IDP_TYPE_3P" + ] + }, + "externalIdpConfig": { + "description": "External Identity provider config. Should be set only if idp_type is\nIDP_TYPE_3P.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AclConfigExternalIdpConfig" + }] + } + } + }, + "GoogleCloudDialogflowV3alpha1AclConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "type": "object", + "properties": { + "workforcePoolName": { + "description": "Workforce pool name.\nFormat:\n`locations//workforcePools/`.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionConnectorConfig": { + "description": "The connector config for the data store connection.", + "type": "object", + "properties": { + "collection": { + "description": "Resource name of the collection the data store belongs to.\nFormat:\n`projects/{project}/locations/{location}/collections/{collection_id}`.", + "type": "string" + }, + "collectionDisplayName": { + "description": "Display name of the collection the data store belongs to.", + "type": "string" + }, + "dataSource": { + "description": "The name of the data source.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1Flow": { + "description": "Flows represents the conversation flows when you build your chatbot agent.\n\nA flow consists of many pages connected by the transition routes.\nConversations always start with the built-in Start Flow (with an all-0 ID).\nTransition routes can direct the conversation session from the current flow\n(parent flow) to another flow (sub flow). When the sub flow is finished,\nDialogflow will bring the session back to the parent flow, where the sub flow\nis started.\n\nUsually, when a transition route is followed by a matched intent, the intent\nwill be \"consumed\". This means the intent won't activate more transition\nroutes. However, when the followed transition route moves the conversation\nsession into a different flow, the matched intent can be carried over and to\nbe consumed in the target flow.", + "type": "object", + "properties": { + "name": { + "description": "The unique identifier of the flow.\nFormat:\n`projects//locations//agents//flows/`.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the flow.", + "type": "string" + }, + "description": { + "description": "The description of the flow. The maximum length is 500 characters. If\nexceeded, the request is rejected.", + "type": "string" + }, + "transitionRoutes": { + "description": "A flow's transition routes serve two purposes:\n\n* They are responsible for matching the user's first utterances in the\nflow.\n* They are inherited by every page's transition\nroutes and can support use cases such as the user\nsaying \"help\" or \"can I talk to a human?\", which can be handled in a common\nway regardless of the current page. Transition routes defined in the page\nhave higher priority than those defined in the flow.\n\nTransitionRoutes are evaluated in the following order:\n\n* TransitionRoutes with intent specified.\n* TransitionRoutes with only condition specified.\n\nTransitionRoutes with intent specified are inherited by pages in the flow.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1TransitionRoute" + } + }, + "eventHandlers": { + "description": "A flow's event handlers serve two purposes:\n\n* They are responsible for handling events (e.g. no match,\nwebhook errors) in the flow.\n* They are inherited by every page's event\nhandlers, which can be used to handle common events\nregardless of the current page. Event handlers defined in the page\nhave higher priority than those defined in the flow.\n\nUnlike transition_routes, these handlers are\nevaluated on a first-match basis. The first one that matches the event\nget executed, with the rest being ignored.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1EventHandler" + } + }, + "transitionRouteGroups": { + "description": "Ordered list of `TransitionRouteGroups` added to\nthe flow. If the flow links both flow-level transition route groups and\nagent-level transition route groups, the flow-level ones will have higher\npriority and will be put before the agent-level ones.\n\nA flow's transition route group serve two purposes:\n\n* They are responsible for matching the user's first utterances in the\nflow.\n* They are inherited by every page's transition\nroute groups. Transition route groups\ndefined in the page have higher priority than those defined in the flow.\n\nFormat:`projects//locations//agents//flows//transitionRouteGroups/`\nor\n`projects//locations//agents//transitionRouteGroups/`\nfor agent-level groups.", + "type": "array", + "items": { + "type": "string" + } + }, + "nluSettings": { + "description": "NLU related settings of the flow.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1NluSettings" + }] + }, + "advancedSettings": { + "description": "Hierarchical advanced settings for this flow. The settings exposed at the\nlower level overrides the settings exposed at the higher level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettings" + }] + }, + "knowledgeConnectorSettings": { + "description": "Optional. Knowledge connector configuration.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1KnowledgeConnectorSettings" + }] + }, + "inputParameterDefinitions": { + "description": "Optional. Defined structured input parameters for this flow.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ParameterDefinition" + } + }, + "outputParameterDefinitions": { + "description": "Optional. Defined structured output parameters for this flow.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ParameterDefinition" + } + }, + "multiLanguageSettings": { + "description": "Optional. Multi-lingual agent settings for this flow.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FlowMultiLanguageSettings" + }] + }, + "locked": { + "description": "Indicates whether the flow is locked for changes. If the flow is locked,\nmodifications to the flow will be rejected.", + "type": "boolean" + } + }, + "required": [ + "displayName" + ] + }, + "GoogleCloudDialogflowV3alpha1NluSettings": { + "description": "Settings related to NLU.", + "type": "object", + "properties": { + "modelType": { + "description": "Indicates the type of NLU model.", + "type": "string", + "x-google-enum-descriptions": [ + "Not specified. `MODEL_TYPE_STANDARD` will be used.", + "Use standard NLU model.", + "Use advanced NLU model." + ], + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "MODEL_TYPE_STANDARD", + "MODEL_TYPE_ADVANCED" + ] + }, + "classificationThreshold": { + "description": "To filter out false positive results and still get variety in matched\nnatural language inputs for your agent, you can tune the machine learning\nclassification threshold. If the returned score value is less than the\nthreshold value, then a no-match event will be triggered. The score values\nrange from 0.0 (completely uncertain) to 1.0 (completely certain). If set\nto 0.0, the default of 0.3 is used. You can set a separate classification\nthreshold for the flow in each language enabled for the agent.", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudDialogflowV3alpha1ParameterDefinition": { + "description": "Defines the properties of a parameter.\nUsed to define parameters used in the agent and the\ninput / output parameters for each fulfillment.", + "type": "object", + "properties": { + "name": { + "description": "Required. Name of parameter.", + "type": "string" + }, + "type": { + "description": "Type of parameter.", + "deprecated": true, + "type": "string", + "x-google-enum-descriptions": [ + "Not specified. No validation will be performed.", + "Represents any string value.", + "Represents any number value.", + "Represents a boolean value.", + "Represents a null value.", + "Represents any object value.", + "Represents a repeated value." + ], + "enum": [ + "PARAMETER_TYPE_UNSPECIFIED", + "STRING", + "NUMBER", + "BOOLEAN", + "NULL", + "OBJECT", + "LIST" + ] + }, + "typeSchema": { + "description": "Optional. Type schema of parameter.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1TypeSchema" + }] + }, + "description": { + "description": "Human-readable description of the parameter. Limited to 300 characters.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudDialogflowV3alpha1TypeSchema": { + "description": "Encapsulates different type schema variations: either a reference to an\na schema that's already defined by a tool, or an inline definition.", + "type": "object", + "properties": { + "inlineSchema": { + "description": "Set if this is an inline schema definition.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1InlineSchema" + }] + }, + "schemaReference": { + "description": "Set if this is a schema reference.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1TypeSchemaSchemaReference" + }] + }, + "resourceReference": { + "description": "Set if this is a reference to an agent property, such as entity ID or\nan existing parameter, e.g. sessionId.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1InlineSchema": { + "description": "A type schema object that's specified inline.", + "type": "object", + "properties": { + "type": { + "description": "Data type of the schema.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataType" + }] + }, + "items": { + "description": "Schema of the elements if this is an ARRAY type.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1TypeSchema" + }] + } + } + }, + "GoogleCloudDialogflowV3alpha1TypeSchemaSchemaReference": { + "description": "A reference to the schema of an existing tool.", + "type": "object", + "properties": { + "tool": { + "description": "The tool that contains this schema definition.\nFormat:\n`projects//locations//agents//tools/`.", + "type": "string" + }, + "schema": { + "description": "The name of the schema.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1FlowMultiLanguageSettings": { + "description": "Settings for multi-lingual agents.", + "type": "object", + "properties": { + "enableMultiLanguageDetection": { + "description": "Optional. Enable multi-language detection for this flow. This can be set only if\nagent level multi language\nsetting is enabled.", + "type": "boolean" + }, + "supportedResponseLanguageCodes": { + "description": "Optional. Agent will respond in the detected language if the detected language code\nis in the supported resolved languages for this flow. This will be used\nonly if multi-language training is enabled in the\nagent and multi-language\ndetection is enabled in the\nflow. The\nsupported languages must be a subset of the languages supported by the\nagent.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1Intent": { + "description": "An intent represents a user's intent to interact with a conversational agent.\n\nYou can provide information for the Dialogflow API to use to match user input\nto an intent by adding training phrases (i.e., examples of user input) to\nyour intent.", + "type": "object", + "properties": { + "name": { + "description": "The unique identifier of the intent.\nRequired for the Intents.UpdateIntent method. Intents.CreateIntent\npopulates the name automatically.\nFormat:\n`projects//locations//agents//intents/`.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the intent, unique within the agent.", + "type": "string" + }, + "trainingPhrases": { + "description": "The collection of training phrases the agent is trained on to identify the\nintent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1IntentTrainingPhrase" + } + }, + "parameters": { + "description": "The collection of parameters associated with the intent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1IntentParameter" + } + }, + "priority": { + "description": "The priority of this intent. Higher numbers represent higher\npriorities.\n\n- If the supplied value is unspecified or 0, the service\n translates the value to 500,000, which corresponds to the\n `Normal` priority in the console.\n- If the supplied value is negative, the intent is ignored\n in runtime detect intent requests.", + "type": "integer", + "format": "int32" + }, + "isFallback": { + "description": "Indicates whether this is a fallback intent. Currently only default\nfallback intent is allowed in the agent, which is added upon agent\ncreation.\nAdding training phrases to fallback intent is useful in the case of\nrequests that are mistakenly matched, since training phrases assigned to\nfallback intents act as negative examples that triggers no-match event.", + "type": "boolean" + }, + "labels": { + "description": "The key/value metadata to label an intent. Labels can contain\nlowercase letters, digits and the symbols '-' and '_'. International\ncharacters are allowed, including letters from unicase alphabets. Keys must\nstart with a letter. Keys and values can be no longer than 63 characters\nand no more than 128 bytes.\n\nPrefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed\nDialogflow defined labels include:\n* sys-head\n* sys-contextual\nThe above labels do not require value. \"sys-head\" means the intent is a\nhead intent. \"sys-contextual\" means the intent is a contextual intent.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "description": { + "description": "Human readable description for better understanding an intent like its\nscope, content, result etc. Maximum character limit: 140 characters.", + "type": "string" + } + }, + "required": [ + "displayName" + ] + }, + "GoogleCloudDialogflowV3alpha1IntentTrainingPhrase": { + "description": "Represents an example that the agent is trained on to identify the intent.", + "type": "object", + "properties": { + "id": { + "description": "Output only. The unique identifier of the training phrase.", + "readOnly": true, + "type": "string" + }, + "parts": { + "description": "Required. The ordered list of training phrase parts.\nThe parts are concatenated in order to form the training phrase.\n\nNote: The API does not automatically annotate training phrases like the\nDialogflow Console does.\n\nNote: Do not forget to include whitespace at part boundaries, so the\ntraining phrase is well formatted when the parts are concatenated.\n\nIf the training phrase does not need to be annotated with parameters,\nyou just need a single part with only the Part.text field set.\n\nIf you want to annotate the training phrase, you must create multiple\nparts, where the fields of each part are populated in one of two ways:\n\n- `Part.text` is set to a part of the phrase that has no parameters.\n- `Part.text` is set to a part of the phrase that you want to annotate,\n and the `parameter_id` field is set.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1IntentTrainingPhrasePart" + } + }, + "repeatCount": { + "description": "Indicates how many times this example was added to the intent.", + "type": "integer", + "format": "int32" + }, + "synthetic": { + "description": "Optional. Indicates whether this training phrase is synthetically generated.", + "type": "boolean" + } + }, + "required": [ + "parts" + ] + }, + "GoogleCloudDialogflowV3alpha1IntentTrainingPhrasePart": { + "description": "Represents a part of a training phrase.", + "type": "object", + "properties": { + "text": { + "description": "Required. The text for this part.", + "type": "string" + }, + "parameterId": { + "description": "The parameter used to annotate this part of the\ntraining phrase. This field is required for annotated parts of the\ntraining phrase.", + "type": "string" + } + }, + "required": [ + "text" + ] + }, + "GoogleCloudDialogflowV3alpha1IntentParameter": { + "description": "Represents an intent parameter.", + "type": "object", + "properties": { + "id": { + "description": "Required. The unique identifier of the parameter. This field\nis used by training phrases to annotate their\nparts.", + "type": "string" + }, + "entityType": { + "description": "Required. The entity type of the parameter.\nFormat:\n`projects/-/locations/-/agents/-/entityTypes/` for\nsystem entity types (for example,\n`projects/-/locations/-/agents/-/entityTypes/sys.date`), or\n`projects//locations//agents//entityTypes/`\nfor developer entity types.", + "type": "string" + }, + "isList": { + "description": "Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "redact": { + "description": "Indicates whether the parameter content should be redacted in log. If\nredaction is enabled, the parameter content will be replaced by parameter\nname during logging.\nNote: the parameter content is subject to redaction if either parameter\nlevel redaction or entity type level redaction is\nenabled.", + "type": "boolean" + } + }, + "required": [ + "id", + "entityType" + ] + }, + "GoogleCloudDialogflowV3alpha1Match": { + "description": "Represents one match result of MatchIntent.", + "type": "object", + "properties": { + "intent": { + "description": "The Intent that matched the query. Some, not all fields are filled in\nthis message, including but not limited to: `name` and `display_name`. Only\nfilled for `INTENT` match type.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Intent" + }] + }, + "event": { + "description": "The event that matched the query. Filled for\n`EVENT`, `NO_MATCH` and\n`NO_INPUT` match types.", + "type": "string" + }, + "parameters": { + "description": "The collection of parameters extracted from the query.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n* MapKey type: string\n* MapKey value: parameter name\n* MapValue type: If parameter's entity type is a composite entity then use\nmap, otherwise, depending on the parameter value type, it could be one of\nstring, number, boolean, null, list or map.\n* MapValue value: If parameter's entity type is a composite entity then use\nmap from composite entity property names to property values, otherwise,\nuse parameter value.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "resolvedInput": { + "description": "Final text input which was matched during MatchIntent. This value can be\ndifferent from original input sent in request because of spelling\ncorrection or other processing.", + "type": "string" + }, + "matchType": { + "description": "Type of this Match.", + "type": "string", + "x-google-enum-descriptions": [ + "Not specified. Should never be used.", + "The query was matched to an intent.", + "The query directly triggered an intent.", + "The query was used for parameter filling.", + "No match was found for the query.", + "Indicates an empty query.", + "The query directly triggered an event.", + "The query was matched to a Knowledge Connector answer.", + "The query was handled by a `Playbook`." + ], + "enum": [ + "MATCH_TYPE_UNSPECIFIED", + "INTENT", + "DIRECT_INTENT", + "PARAMETER_FILLING", + "NO_MATCH", + "NO_INPUT", + "EVENT", + "KNOWLEDGE_CONNECTOR", + "PLAYBOOK" + ] + }, + "confidence": { + "description": "The confidence of this match. Values range from 0.0 (completely uncertain)\nto 1.0 (completely certain).\nThis value is for informational purpose only and is only used to help match\nthe best intent within the classification threshold. This value may change\nfor the same end-user expression at any time due to a model retraining or\nchange in implementation.", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudDialogflowV3alpha1GenerativeInfo": { + "description": "Represents the information of a query if handled by generative agent\nresources.", + "type": "object", + "properties": { + "currentPlaybooks": { + "description": "The stack of playbooks that the conversation has\ncurrently entered, with the most recent one on the top.", + "type": "array", + "items": { + "type": "string" + } + }, + "actionTracingInfo": { + "description": "The actions performed by the generative playbook for the current agent\nresponse.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Example" + }] + } + } + }, + "GoogleCloudDialogflowV3alpha1Example": { + "description": "Example represents a sample execution of the playbook in the conversation.\n\nAn example consists of a list of ordered actions performed by end user\nor Dialogflow agent according the playbook instructions to fulfill the task.", + "type": "object", + "properties": { + "name": { + "description": "The unique identifier of the playbook example.\nFormat:\n`projects//locations//agents//playbooks//examples/`.", + "type": "string" + }, + "playbookInput": { + "description": "Optional. The input to the playbook in the example.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookInput" + }] + }, + "playbookOutput": { + "description": "Optional. The output of the playbook in the example.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookOutput" + }] + }, + "actions": { + "description": "Required. The ordered list of actions performed by the end user and the Dialogflow\nagent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Action" + } + }, + "displayName": { + "description": "Required. The display name of the example.", + "type": "string" + }, + "description": { + "description": "Optional. The high level concise description of the example. The max number of\ncharacters is 200.", + "type": "string" + }, + "tokenCount": { + "description": "Output only. Estimated number of tokes current example takes when sent to the LLM.", + "readOnly": true, + "type": "string", + "format": "int64" + }, + "createTime": { + "description": "Output only. The timestamp of initial example creation.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. Last time the example was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "conversationState": { + "description": "Required. Example's output state.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1OutputState" + }] + }, + "languageCode": { + "description": "Optional. The language code of the example.\nIf not specified, the agent's default language is used.\nNote: languages must be enabled in the agent before they can be used.\nNote: example's language code is not currently used in dialogflow agents.", + "type": "string" + } + }, + "required": [ + "actions", + "displayName", + "conversationState" + ] + }, + "GoogleCloudDialogflowV3alpha1PlaybookInput": { + "description": "Input of the playbook.", + "type": "object", + "properties": { + "precedingConversationSummary": { + "description": "Optional. Summary string of the preceding conversation for the child playbook\ninvocation.", + "type": "string" + }, + "actionParameters": { + "description": "Optional. A list of input parameters for the action.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudDialogflowV3alpha1PlaybookOutput": { + "description": "Output of the playbook.", + "type": "object", + "properties": { + "executionSummary": { + "description": "Optional. Summary string of the execution result of the child playbook.", + "type": "string" + }, + "state": { + "description": "End state of the playbook.", + "deprecated": true, + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified state.", + "Playbook succeeded.", + "Playbook cancelled.", + "Playbook failed.", + "Playbook failed due to escalation." + ], + "enum": [ + "STATE_UNSPECIFIED", + "OK", + "CANCELLED", + "FAILED", + "ESCALATED" + ] + }, + "actionParameters": { + "description": "Optional. A Struct object of output parameters for the action.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudDialogflowV3alpha1Action": { + "description": "Action performed by end user or Dialogflow agent in the conversation.", + "type": "object", + "properties": { + "userUtterance": { + "description": "Optional. Agent obtained a message from the customer.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1UserUtterance" + }] + }, + "event": { + "description": "Optional. The agent received an event from the customer or a system event is\nemitted.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Event" + }] + }, + "agentUtterance": { + "description": "Optional. Action performed by the agent as a message.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AgentUtterance" + }] + }, + "toolUse": { + "description": "Optional. Action performed on behalf of the agent by calling a plugin tool.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ToolUse" + }] + }, + "llmCall": { + "description": "Optional. Output only. LLM call performed by the agent.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1LlmCall" + }] + }, + "intentMatch": { + "description": "Optional. Output only. Intent Match in flows.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionIntentMatch" + }] + }, + "flowStateUpdate": { + "description": "Optional. Output only. The state machine update in flows.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionFlowStateUpdate" + }] + }, + "playbookInvocation": { + "description": "Optional. Action performed on behalf of the agent by invoking a child playbook.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookInvocation" + }] + }, + "flowInvocation": { + "description": "Optional. Action performed on behalf of the agent by invoking a CX flow.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FlowInvocation" + }] + }, + "playbookTransition": { + "description": "Optional. Action performed on behalf of the agent by transitioning to a target\nplaybook.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookTransition" + }] + }, + "flowTransition": { + "description": "Optional. Action performed on behalf of the agent by transitioning to a target CX\nflow.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FlowTransition" + }] + }, + "tts": { + "description": "Optional. Text-to-speech action performed by the agent.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionTTS" + }] + }, + "stt": { + "description": "Optional. Speech-to-text action performed by the agent.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionSTT" + }] + }, + "displayName": { + "description": "Output only. The display name of the action.", + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Output only. Timestamp of the start of the agent action.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "completeTime": { + "description": "Output only. Timestamp of the completion of the agent action.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "subExecutionSteps": { + "description": "Optional. The detailed tracing information for sub execution steps of the action.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Span" + } + }, + "status": { + "description": "Optional. Output only. The status of the action.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Status" + }] + } + } + }, + "GoogleCloudDialogflowV3alpha1UserUtterance": { + "description": "UserUtterance represents one message sent by the customer.", + "type": "object", + "properties": { + "text": { + "description": "Required. Message content in text.", + "type": "string" + }, + "audioTokens": { + "description": "Optional. Tokens of the audio input.", + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "audio": { + "description": "Optional. Audio input.", + "type": "string", + "format": "byte" + } + }, + "required": [ + "text" + ] + }, + "GoogleCloudDialogflowV3alpha1Event": { + "description": "Event represents the event sent by the customer.", + "type": "object", + "properties": { + "event": { + "description": "Required. Name of the event.", + "type": "string" + }, + "text": { + "description": "Optional. Unstructured text payload of the event.", + "type": "string" + } + }, + "required": [ + "event" + ] + }, + "GoogleCloudDialogflowV3alpha1AgentUtterance": { + "description": "AgentUtterance represents one message sent by the agent.", + "type": "object", + "properties": { + "text": { + "description": "Required. Message content in text.", + "type": "string" + }, + "requireGeneration": { + "description": "Optional. True if the agent utterance needs to be generated by the LLM. Only used in\nwebhook response to differentiate from empty text.\nRevisit whether we need this field or mark `text` as optional when we\nexpose webhook interface to customer.", + "type": "boolean" + } + }, + "required": [ + "text" + ] + }, + "GoogleCloudDialogflowV3alpha1ToolUse": { + "description": "Stores metadata of the invocation of an action supported by a tool.", + "type": "object", + "properties": { + "tool": { + "description": "Required. The tool that should be used.\nFormat:\n`projects//locations//agents//tools/`.", + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the tool.", + "readOnly": true, + "type": "string" + }, + "action": { + "description": "Optional. Name of the action to be called during the tool use.", + "type": "string" + }, + "inputActionParameters": { + "description": "Optional. A list of input parameters for the action.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "outputActionParameters": { + "description": "Optional. A list of output parameters generated by the action.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "dataStoreToolTrace": { + "description": "Optional. Data store tool trace.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ToolUseDataStoreToolTrace" + }] + }, + "webhookToolTrace": { + "description": "Optional. Webhook tool trace.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ToolUseWebhookToolTrace" + }] + } + }, + "required": [ + "tool" + ] + }, + "GoogleCloudDialogflowV3alpha1ToolUseDataStoreToolTrace": { + "description": "The tracing information for the data store tool.", + "type": "object", + "properties": { + "dataStoreConnectionSignals": { + "description": "Optional. Data store connection feature output signals.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignals" + }] + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignals": { + "description": "Data store connection feature output signals.\nMight be only partially field if processing stop before the final answer.\nReasons for this can be, but are not limited to: empty UCS search results,\npositive RAI check outcome, grounding failure, ...", + "type": "object", + "properties": { + "rewriterModelCallSignals": { + "description": "Optional. Diagnostic info related to the rewriter model call.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsRewriterModelCallSignals" + }] + }, + "rewrittenQuery": { + "description": "Optional. Rewritten string query used for search.", + "type": "string" + }, + "searchSnippets": { + "description": "Optional. Search snippets included in the answer generation prompt.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSearchSnippet" + } + }, + "answerGenerationModelCallSignals": { + "description": "Optional. Diagnostic info related to the answer generation model call.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsAnswerGenerationModelCallSignals" + }] + }, + "answer": { + "description": "Optional. The final compiled answer.", + "type": "string" + }, + "answerParts": { + "description": "Optional. Answer parts with relevant citations.\nConcatenation of texts should add up the `answer` (not counting\nwhitespaces).", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsAnswerPart" + } + }, + "citedSnippets": { + "description": "Optional. Snippets cited by the answer generation model from the most to least\nrelevant.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsCitedSnippet" + } + }, + "groundingSignals": { + "description": "Optional. Grounding signals.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignals" + }] + }, + "safetySignals": { + "description": "Optional. Safety check result.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSafetySignals" + }] + }, + "securitySignals": { + "description": "Optional. Security check result.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSecuritySignals" + }] + }, + "stabilitySignals": { + "description": "Optional. Stability check result.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsStabilitySignals" + }] + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsRewriterModelCallSignals": { + "description": "Diagnostic info related to the rewriter model call.", + "type": "object", + "properties": { + "renderedPrompt": { + "description": "Prompt as sent to the model.", + "type": "string" + }, + "modelOutput": { + "description": "Output of the generative model.", + "type": "string" + }, + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\",\n\"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSearchSnippet": { + "description": "Search snippet details.", + "type": "object", + "properties": { + "documentTitle": { + "description": "Title of the enclosing document.", + "type": "string" + }, + "documentUri": { + "description": "Uri for the document. Present if specified for the document.", + "type": "string" + }, + "text": { + "description": "Text included in the prompt.", + "type": "string" + }, + "metadata": { + "description": "Metadata associated with the document.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsAnswerGenerationModelCallSignals": { + "description": "Diagnostic info related to the answer generation model call.", + "type": "object", + "properties": { + "renderedPrompt": { + "description": "Prompt as sent to the model.", + "type": "string" + }, + "modelOutput": { + "description": "Output of the generative model.", + "type": "string" + }, + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\",\n\"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsAnswerPart": { + "description": "Answer part with citation.", + "type": "object", + "properties": { + "text": { + "description": "Substring of the answer.", + "type": "string" + }, + "supportingIndices": { + "description": "Citations for this answer part. Indices of `search_snippets`.", + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsCitedSnippet": { + "description": "Snippet cited by the answer generation model.", + "type": "object", + "properties": { + "searchSnippet": { + "description": "Details of the snippet.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSearchSnippet" + }] + }, + "snippetIndex": { + "description": "Index of the snippet in `search_snippets` field.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignals": { + "description": "Grounding signals.", + "type": "object", + "properties": { + "decision": { + "description": "Represents the decision of the grounding check.", + "type": "string", + "x-google-enum-descriptions": [ + "Decision not specified.", + "Grounding have accepted the answer.", + "Grounding have rejected the answer." + ], + "enum": [ + "GROUNDING_DECISION_UNSPECIFIED", + "ACCEPTED_BY_GROUNDING", + "REJECTED_BY_GROUNDING" + ] + }, + "score": { + "description": "Grounding score bucket setting.", + "type": "string", + "x-google-enum-descriptions": [ + "Score not specified.", + "We have very low confidence that the answer is grounded.", + "We have low confidence that the answer is grounded.", + "We have medium confidence that the answer is grounded.", + "We have high confidence that the answer is grounded.", + "We have very high confidence that the answer is grounded." + ], + "enum": [ + "GROUNDING_SCORE_BUCKET_UNSPECIFIED", + "VERY_LOW", + "LOW", + "MEDIUM", + "HIGH", + "VERY_HIGH" + ] + }, + "renderedAnswerCandidates": { + "description": "Rendered answer candidates presented to the grounding component.", + "type": "array", + "items": { + "type": "string" + } + }, + "renderedFacts": { + "description": "Rendered facts presented to the grounding component.", + "type": "array", + "items": { + "type": "string" + } + }, + "factTemplate": { + "description": "The fact template string.", + "type": "string" + }, + "factSubstitutions": { + "description": "The fact substitution applied to the template string.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsFactSubstitutions" + } + }, + "explanation": { + "description": "Optional. Explanation for rejecting grounding.", + "type": "string", + "x-google-enum-descriptions": [ + "Explanation not specified.", + "Internal error happened.", + "Grounding was disabled.", + "Source was configured to be ignored.", + "Grounding score was below the threshold.", + "No citations were found.", + "Heuristic number checker rejection.", + "Heuristic pattern checker rejection." + ], + "enum": [ + "GROUNDING_EXPLANATION_UNSPECIFIED", + "INTERNAL_ERROR", + "GROUNDING_DISABLED", + "IGNORE_SOURCE", + "SCORE_BELOW_THRESHOLD", + "NO_CITATIONS", + "HEURISTIC_NUMBER_REJECTED", + "HEURISTIC_PATTERN_REJECTED" + ] + }, + "groundingHeuristicSignals": { + "description": "Grounding heuristic signals, includes information about the execution and\nresult of the grounding heuristics.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsGroundingHeuristicSignals" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsFactSubstitutions": { + "description": "Fact substitutions.", + "type": "object", + "properties": { + "factKeywordSubstitutions": { + "description": "The list of keyword substitutions.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsFactKeywordSubstitution" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsFactKeywordSubstitution": { + "description": "Keyword substitution in the fact template.", + "type": "object", + "properties": { + "key": { + "description": "The template key.", + "type": "string" + }, + "value": { + "description": "The substitution text.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsGroundingHeuristicSignals": { + "description": "Grounding heuristic signals, includes information about the execution and\nresult of the grounding heuristics.", + "type": "object", + "properties": { + "heuristicType": { + "description": "The type of the heuristic.", + "type": "string", + "x-google-enum-descriptions": [ + "Heuristic type not specified.", + "Factual numeral checker.", + "Pattern checker." + ], + "enum": [ + "HEURISTIC_TYPE_UNSPECIFIED", + "HEURISTIC_TYPE_NUMBER", + "HEURISTIC_TYPE_PATTERN" + ] + }, + "accepted": { + "description": "Whether the heuristic accepted the answer.", + "type": "boolean" + }, + "debugInfo": { + "description": "Human readable debug information about the execution and result of the\nheuristic. This field is not meant to be consumed programtically or\nexpected to contain specific information.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSafetySignals": { + "description": "Safety check results.", + "type": "object", + "properties": { + "decision": { + "description": "Safety decision.", + "type": "string", + "x-google-enum-descriptions": [ + "Decision not specified.", + "No manual or automatic safety check fired.", + "One ore more safety checks fired." + ], + "enum": [ + "SAFETY_DECISION_UNSPECIFIED", + "ACCEPTED_BY_SAFETY_CHECK", + "REJECTED_BY_SAFETY_CHECK" + ] + }, + "bannedPhraseMatch": { + "description": "Specifies banned phrase match subject.", + "type": "string", + "x-google-enum-descriptions": [ + "No banned phrase check was executed.", + "All banned phrase checks led to no match.", + "A banned phrase matched the query.", + "A banned phrase matched the response." + ], + "enum": [ + "BANNED_PHRASE_MATCH_UNSPECIFIED", + "BANNED_PHRASE_MATCH_NONE", + "BANNED_PHRASE_MATCH_QUERY", + "BANNED_PHRASE_MATCH_RESPONSE" + ] + }, + "matchedBannedPhrase": { + "description": "The matched banned phrase if there was a match.", + "type": "string" + }, + "violatedSafetyCategories": { + "description": "The list of violated safety categories.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSecuritySignals": { + "description": "Prompt security signals.", + "type": "object", + "properties": { + "renderedPrompt": { + "description": "Optional. Security prompt as sent to the model.", + "type": "string" + }, + "modelOutput": { + "description": "Optional. Raw output of the generative model.", + "type": "string" + }, + "filtered": { + "description": "Whether the user request was blocked by security check.", + "type": "boolean" + }, + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\",\n\"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsStabilitySignals": { + "description": "Diagnostic info related to the stability module.", + "type": "object", + "properties": { + "relevance": { + "description": "ConversationHistoryRelevance decision.", + "type": "string", + "x-google-enum-descriptions": [ + "The decision is not specified.", + "The conversation history is related to the query.", + "The conversation history is unrelated to the query." + ], + "enum": [ + "CONVERSATION_HISTORY_RELEVANCE_UNSPECIFIED", + "RELEVANT", + "IRRELEVANT" + ] + }, + "decontextualizedQuery": { + "description": "Optional. Deprecated: Stability check no longer returns the decontextualized query.", + "deprecated": true, + "type": "string" + }, + "renderedPrompt": { + "description": "Prompt as sent to the model.", + "type": "string" + }, + "modelOutput": { + "description": "Output of the generative model.", + "type": "string" + }, + "model": { + "description": "Name of the generative model used for stability check.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1ToolUseWebhookToolTrace": { + "description": "The tracing information for the webhook tool.", + "type": "object", + "properties": { + "webhookTag": { + "description": "Optional. The tag of the webhook.", + "type": "string" + }, + "webhookUri": { + "description": "Optional. The url of the webhook.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1LlmCall": { + "description": "Stores metadata of the call of an LLM.", + "type": "object", + "properties": { + "retrievedExamples": { + "description": "A list of relevant examples used for the LLM prompt.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1LlmCallRetrievedExample" + } + }, + "tokenCount": { + "description": "The token counts of the LLM call.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1LlmCallTokenCount" + }] + }, + "model": { + "description": "The model of the LLM call.", + "type": "string" + }, + "temperature": { + "description": "The temperature of the LLM call.", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudDialogflowV3alpha1LlmCallRetrievedExample": { + "description": "Relevant example used for the LLM prompt.", + "type": "object", + "properties": { + "exampleId": { + "description": "The id of the example.", + "type": "string" + }, + "exampleDisplayName": { + "description": "The display name of the example.", + "type": "string" + }, + "retrievalStrategy": { + "description": "Retrieval strategy of the example.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1RetrievalStrategy" + }] + }, + "matchedRetrievalLabel": { + "description": "Optional. The matched retrieval label of this LLM call.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1LlmCallTokenCount": { + "description": "Stores token counts of the LLM call.", + "type": "object", + "properties": { + "totalInputTokenCount": { + "description": "The total number of tokens used for the input to the LLM call.", + "type": "string", + "format": "int64" + }, + "conversationContextTokenCount": { + "description": "The number of tokens used for the conversation history in the prompt.", + "type": "string", + "format": "int64" + }, + "exampleTokenCount": { + "description": "The number of tokens used for the retrieved examples in the prompt.", + "type": "string", + "format": "int64" + }, + "totalOutputTokenCount": { + "description": "The total number of tokens used for the output of the LLM call.", + "type": "string", + "format": "int64" + } + } + }, + "GoogleCloudDialogflowV3alpha1ActionIntentMatch": { + "description": "Stores metadata of the intent match action.", + "type": "object", + "properties": { + "matchedIntents": { + "description": "The matched intent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionIntentMatchMatchedIntent" + } + } + } + }, + "GoogleCloudDialogflowV3alpha1ActionIntentMatchMatchedIntent": { + "description": "Stores the matched intent, which is the result of the intent match\naction.", + "type": "object", + "properties": { + "intentId": { + "description": "The ID of the matched intent.", + "type": "string" + }, + "displayName": { + "description": "The display name of the matched intent.", + "type": "string" + }, + "score": { + "description": "The score of the matched intent.", + "type": "number", + "format": "float" + }, + "generativeFallback": { + "description": "The generative fallback response of the matched intent.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudDialogflowV3alpha1ActionFlowStateUpdate": { + "description": "Stores metadata of the state update action, such as a state machine\nexecution in flows.", + "type": "object", + "properties": { + "eventType": { + "description": "The type of the event that triggered the state update.", + "type": "string" + }, + "pageState": { + "description": "The updated page and flow state.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionFlowStateUpdatePageState" + }] + }, + "updatedParameters": { + "description": "The updated parameters.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "destination": { + "description": "The destination of the transition.\nFormat:\n`projects//locations//agents//flows//pages/`\nor\n`projects//locations//agents//playbooks/`.", + "type": "string" + }, + "functionCall": { + "description": "The function call to execute.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionFlowStateUpdateFunctionCall" + }] + } + } + }, + "GoogleCloudDialogflowV3alpha1ActionFlowStateUpdatePageState": { + "description": "Stores the state of a page and its flow.", + "type": "object", + "properties": { + "page": { + "description": "The ID of the page.\nFormat:\n`projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "displayName": { + "description": "The display name of the page.", + "type": "string" + }, + "status": { + "description": "The status of the page.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1ActionFlowStateUpdateFunctionCall": { + "description": "Stores the metadata of a function call to execute.", + "type": "object", + "properties": { + "name": { + "description": "The name of the function call.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1PlaybookInvocation": { + "description": "Stores metadata of the invocation of a child playbook. Playbook invocation\nactions enter the child playbook.", + "type": "object", + "properties": { + "playbook": { + "description": "Required. The unique identifier of the playbook.\nFormat:\n`projects//locations//agents//playbooks/`.", + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the playbook.", + "readOnly": true, + "type": "string" + }, + "playbookInput": { + "description": "Optional. Input of the child playbook invocation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookInput" + }] + }, + "playbookOutput": { + "description": "Optional. Output of the child playbook invocation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookOutput" + }] + }, + "playbookState": { + "description": "Required. Playbook invocation's output state.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1OutputState" + }] + } + }, + "required": [ + "playbook", + "playbookState" + ] + }, + "GoogleCloudDialogflowV3alpha1FlowInvocation": { + "description": "Stores metadata of the invocation of a child CX flow. Flow invocation actions\nenter the child flow.", + "type": "object", + "properties": { + "flow": { + "description": "Required. The unique identifier of the flow.\nFormat:\n`projects//locations//agents/`.", + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the flow.", + "readOnly": true, + "type": "string" + }, + "inputActionParameters": { + "description": "Optional. A list of input parameters for the flow.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "outputActionParameters": { + "description": "Optional. A list of output parameters generated by the flow invocation.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "flowState": { + "description": "Required. Flow invocation's output state.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1OutputState" + }] + } + }, + "required": [ + "flow", + "flowState" + ] + }, + "GoogleCloudDialogflowV3alpha1PlaybookTransition": { + "description": "Stores metadata of the transition to another target playbook. Playbook\ntransition actions exit the caller playbook and enter the target playbook.", + "type": "object", + "properties": { + "playbook": { + "description": "Required. The unique identifier of the playbook.\nFormat:\n`projects//locations//agents//playbooks/`.", + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the playbook.", + "readOnly": true, + "type": "string" + }, + "inputActionParameters": { + "description": "A list of input parameters for the action.", + "deprecated": true, + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + }, + "required": [ + "playbook" + ] + }, + "GoogleCloudDialogflowV3alpha1FlowTransition": { + "description": "Stores metadata of the transition to a target CX flow. Flow transition\nactions exit the caller playbook and enter the child flow.", + "type": "object", + "properties": { + "flow": { + "description": "Required. The unique identifier of the flow.\nFormat:\n`projects//locations//agents/`.", + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the flow.", + "readOnly": true, + "type": "string" + }, + "inputActionParameters": { + "description": "A list of input parameters for the action.", + "deprecated": true, + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + }, + "required": [ + "flow" + ] + }, + "GoogleCloudDialogflowV3alpha1ActionTTS": { + "description": "Stores metadata of the Text-to-Speech action.", + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1ActionSTT": { + "description": "Stores metadata of the Speech-to-Text action.", + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1Span": { + "description": "A span represents a sub execution step of an action.", + "type": "object", + "properties": { + "name": { + "description": "The name of the span.", + "type": "string" + }, + "tags": { + "description": "The metadata tags of the span such as span type.", + "type": "array", + "items": { + "type": "string" + } + }, + "metrics": { + "description": "The unordered collection of metrics in this span.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1NamedMetric" + } + }, + "startTime": { + "description": "Timestamp of the start of the span.", + "type": "string", + "format": "date-time" + }, + "completeTime": { + "description": "Timestamp of the completion of the span.", + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudDialogflowV3alpha1NamedMetric": { + "description": "A named metric is a metric with name, value and unit.", + "type": "object", + "properties": { + "name": { + "description": "The name of the metric.", + "type": "string" + }, + "value": { + "description": "The value of the metric." + }, + "unit": { + "description": "The unit in which this metric is reported. Follows [The Unified Code for\nUnits of Measure](https://unitsofmeasure.org/ucum.html) standard.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1Status": { + "description": "The status of the action.", + "type": "object", + "properties": { + "exception": { + "description": "Optional. The exception thrown during the execution of the action.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ExceptionDetail" + }] + } + } + }, + "GoogleCloudDialogflowV3alpha1ExceptionDetail": { + "description": "Exception thrown during the execution of an action.", + "type": "object", + "properties": { + "errorMessage": { + "description": "Optional. The error message.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1SentimentAnalysisResult": { + "description": "The result of sentiment analysis. Sentiment analysis inspects user input\nand identifies the prevailing subjective opinion, especially to determine a\nuser's attitude as positive, negative, or neutral.", + "type": "object", + "properties": { + "score": { + "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive\n sentiment).", + "type": "number", + "format": "float" + }, + "magnitude": { + "description": "A non-negative number in the [0, +inf) range, which represents the absolute\nmagnitude of sentiment, regardless of score (positive or negative).", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudDialogflowV3alpha1OutputAudioConfig": { + "description": "Instructs the speech synthesizer how to generate the output audio content.", + "type": "object", + "properties": { + "audioEncoding": { + "description": "Required. Audio encoding of the synthesized audio content.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1OutputAudioEncoding" + }] + }, + "sampleRateHertz": { + "description": "Optional. The synthesis sample rate (in hertz) for this audio. If not\nprovided, then the synthesizer will use the default sample rate based on\nthe audio encoding. If this is different from the voice's natural sample\nrate, then the synthesizer will honor this request by converting to the\ndesired sample rate (which might result in worse audio quality).", + "type": "integer", + "format": "int32" + }, + "synthesizeSpeechConfig": { + "description": "Optional. Configuration of how speech should be synthesized.\nIf not specified, Agent.text_to_speech_settings is applied.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1SynthesizeSpeechConfig" + }] + } + }, + "required": [ + "audioEncoding" + ] + }, + "GoogleCloudDialogflowV3alpha1SynthesizeSpeechConfig": { + "description": "Configuration of how speech should be synthesized.", + "type": "object", + "properties": { + "speakingRate": { + "description": "Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal\nnative speed supported by the specific voice. 2.0 is twice as fast, and\n0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any\nother values < 0.25 or > 4.0 will return an error.", + "type": "number", + "format": "double" + }, + "pitch": { + "description": "Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20\nsemitones from the original pitch. -20 means decrease 20 semitones from the\noriginal pitch.", + "type": "number", + "format": "double" + }, + "volumeGainDb": { + "description": "Optional. Volume gain (in dB) of the normal native volume supported by the\nspecific voice, in the range [-96.0, 16.0]. If unset, or set to a value of\n0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)\nwill play at approximately half the amplitude of the normal native signal\namplitude. A value of +6.0 (dB) will play at approximately twice the\namplitude of the normal native signal amplitude. We strongly recommend not\nto exceed +10 (dB) as there's usually no effective increase in loudness for\nany value greater than that.", + "type": "number", + "format": "double" + }, + "effectsProfileId": { + "description": "Optional. An identifier which selects 'audio effects' profiles that are\napplied on (post synthesized) text to speech. Effects are applied on top of\neach other in the order they are given.", + "type": "array", + "items": { + "type": "string" + } + }, + "voice": { + "description": "Optional. The desired voice of the synthesized audio.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1VoiceSelectionParams" + }] + }, + "pronunciations": { + "description": "Optional. The custom pronunciations for the synthesized audio.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1CustomPronunciationParams" + } + }, + "speakingPace": { + "description": "Adjusts the speaking pace based on the voice's learned speed distribution\nby the model in the range [-3.0, 3.0] (e.g., 1.0 is 1 standard deviation\nfaster).\n- 0.0: Represents the average/neutral speaking pace.\n- Positive values (>0.0): Make the speech pace faster.\n- Negative values (<0.0): Make the speech pace slower.\nRecommended for achieving consistent speech pace eg. customer care bots.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudDialogflowV3alpha1VoiceSelectionParams": { + "description": "Description of which voice to use for speech synthesis.", + "type": "object", + "properties": { + "name": { + "description": "Optional. The name of the voice. If not set, the service will choose a\nvoice based on the other parameters such as language_code and\nssml_gender.\n\nFor the list of available voices, please refer to [Supported voices and\nlanguages](https://cloud.google.com/text-to-speech/docs/voices).", + "type": "string" + }, + "ssmlGender": { + "description": "Optional. The preferred gender of the voice. If not set, the service will\nchoose a voice based on the other parameters such as language_code and\nname. Note that this is only a preference, not requirement. If a\nvoice of the appropriate gender is not available, the synthesizer should\nsubstitute a voice with a different gender rather than failing the request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1SsmlVoiceGender" + }] + }, + "customVoice": { + "description": "Optional. Configuration for a custom synthesis voice. If specified, the service will\nuse this custom voice instead of taking name and ssml_gender into\naccount to select a voice. If the custom voice doesn't exist or isn't\naccessible, Dialogflow will return an error.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1VoiceSelectionParamsCustomVoiceParams" + }] + }, + "voiceCloningKey": { + "description": "Optional. Key that is generated by Cloud TTS for the voice to clone. If specified,\nDialogflow will pass the key to Cloud TTS.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1VoiceSelectionParamsCustomVoiceParams": { + "description": "Configuration for a custom synthesis voice.", + "type": "object", + "properties": { + "model": { + "description": "Required. The name of the AutoML model that synthesizes the custom voice.", + "type": "string" + }, + "reportedUsage": { + "description": "Optional. The usage of the synthesized audio to be reported.", + "type": "string", + "x-google-enum-descriptions": [ + "Request with reported usage unspecified will be rejected.", + "For scenarios where the synthesized audio is not downloadable and can\nonly be used once. For example, real-time request in IVR system.", + "For scenarios where the synthesized audio is downloadable and can be\nreused. For example, the synthesized audio is downloaded, stored in\ncustomer service system and played repeatedly." + ], + "enum": [ + "REPORTED_USAGE_UNSPECIFIED", + "REALTIME", + "OFFLINE" + ] + } + }, + "required": [ + "model" + ] + }, + "GoogleCloudDialogflowV3alpha1CustomPronunciationParams": { + "description": "Pronunciation customization for a phrase.", + "type": "object", + "properties": { + "phrase": { + "description": "The phrase to which the customization is applied.\nThe phrase can be multiple words, such as proper nouns, but shouldn't span\nthe length of the sentence.", + "type": "string" + }, + "phoneticEncoding": { + "description": "The phonetic encoding of the phrase.", + "type": "string", + "x-google-enum-descriptions": [ + "Not specified.", + "IPA, such as apple -> \u02C8\u00E6p\u0259l.\nhttps://en.wikipedia.org/wiki/International_Phonetic_Alphabet", + "X-SAMPA, such as apple -> \"{p@l\".\nhttps://en.wikipedia.org/wiki/X-SAMPA" + ], + "enum": [ + "PHONETIC_ENCODING_UNSPECIFIED", + "PHONETIC_ENCODING_IPA", + "PHONETIC_ENCODING_X_SAMPA" + ] + }, + "pronunciation": { + "description": "The pronunciation of the phrase. This must be in the phonetic encoding\nspecified above.", + "type": "string" + } + } + }, + "GoogleCloudDialogflowV3alpha1DetectIntentResponseFeatureUsage": { + "description": "Describes feature used during request processing.", + "type": "object", + "properties": { + "feature": { + "description": "Feature name.", + "type": "string", + "x-google-enum-descriptions": [ + "No Feature specified.", + "Generative playbook.", + "Generator.", + "Infobot (data store invocation).", + "Hyper human listening feature.", + "Generative fallback." + ], + "enum": [ + "FEATURE_UNSPECIFIED", + "PLAYBOOK", + "GENERATOR", + "DATA_STORE", + "HYPER_HUMAN_LISTENING", + "GENERATIVE_FALLBACK" + ] + }, + "metrics": { + "description": "Map of feature specific metrics.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudContactcenterinsightsV1AnswerFeedback": { + "description": "The feedback that the customer has about a certain answer in the\nconversation.", + "type": "object", + "properties": { + "correctnessLevel": { + "description": "The correctness level of an answer.", + "type": "string", + "x-google-enum-descriptions": [ + "Correctness level unspecified.", + "Answer is totally wrong.", + "Answer is partially correct.", + "Answer is fully correct." + ], + "enum": [ + "CORRECTNESS_LEVEL_UNSPECIFIED", + "NOT_CORRECT", + "PARTIALLY_CORRECT", + "FULLY_CORRECT" + ] + }, + "clicked": { + "description": "Indicates whether an answer or item was clicked by the human agent.", + "type": "boolean" + }, + "displayed": { + "description": "Indicates whether an answer or item was displayed to the human agent in the\nagent desktop UI.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput": { + "description": "Explicit input used for generating the answer", + "type": "object", + "properties": { + "query": { + "description": "Query text. Article Search uses this to store the input query used\nto generate the search results.", + "type": "string" + }, + "generatorName": { + "description": "The resource name of associated generator. Format:\n`projects//locations//generators/`", + "type": "string" + }, + "querySource": { + "description": "Query source for the answer.", + "type": "string", + "x-google-enum-descriptions": [ + "Unknown query source.", + "The query is from agents.", + "The query is a query from previous suggestions, e.g. from a preceding\nSuggestKnowledgeAssist response.", + "The query is from the end user." + ], + "enum": [ + "QUERY_SOURCE_UNSPECIFIED", + "AGENT_QUERY", + "SUGGESTED_QUERY", + "END_USER_QUERY" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1DialogflowIntent": { + "description": "The data for a Dialogflow intent.\nRepresents a detected intent in the conversation, e.g. MAKES_PROMISE.", + "type": "object", + "properties": { + "displayName": { + "description": "The human-readable name of the intent.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DialogflowCxConversationData": { + "description": "The metadata for a Dialogflow CX conversation.", + "type": "object", + "properties": { + "virtualAgentId": { + "description": "The virtual agent id of this conversation.", + "type": "string" + }, + "flowIds": { + "description": "The deduped flow UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "flowDisplayNames": { + "description": "The deduped flow display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "pageIds": { + "description": "The deduped page UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "pageDisplayNames": { + "description": "The deduped page display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "intentIds": { + "description": "The deduped intent UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "intentDisplayNames": { + "description": "The deduped intent display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "experimentIds": { + "description": "The deduped experiment UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "experimentDisplayNames": { + "description": "The deduped experiment display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "inputAudioDuration": { + "description": "The total duration of the user input audio in this conversation.", + "type": "string", + "format": "google-duration" + }, + "outputAudioDuration": { + "description": "The total duration of the agent output audio in this conversation.", + "type": "string", + "format": "google-duration" + }, + "queryInputStats": { + "description": "Query input stats", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowCxConversationDataQueryInputStats" + }] + }, + "matchTypeStats": { + "description": "Match type stats.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowCxConversationDataMatchTypeStats" + }] + }, + "averageMatchConfidence": { + "description": "Average match confidence for all the initent matches in this conversation.", + "type": "number", + "format": "float" + }, + "endSessionExit": { + "description": "Whether the conversation reaches END_FLOW or END_SESSION.", + "type": "boolean" + }, + "maxWebhookLatency": { + "description": "The maximum webhook latency for an individual webhook call in this\nconversation.", + "type": "string", + "format": "google-duration" + }, + "liveAgentHandoff": { + "description": "Whether the conversation was handed off to a human agent.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1DialogflowCxConversationDataQueryInputStats": { + "description": "Count by input types in this conversation", + "type": "object", + "properties": { + "textCount": { + "description": "The number of requests with text input.", + "type": "integer", + "format": "int32" + }, + "intentCount": { + "description": "The number of requests with intent input.", + "type": "integer", + "format": "int32" + }, + "audioCount": { + "description": "The number of requests with audio input.", + "type": "integer", + "format": "int32" + }, + "eventCount": { + "description": "The number of requests with event input.", + "type": "integer", + "format": "int32" + }, + "dtmfCount": { + "description": "The number of requests with DTMF input.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1DialogflowCxConversationDataMatchTypeStats": { + "description": "Count by match types in this conversation .", + "type": "object", + "properties": { + "intentCount": { + "description": "The number of responses with match type INTENT.", + "type": "integer", + "format": "int32" + }, + "directIntentCount": { + "description": "The number of responses with match type DIRECT_INTENT.", + "type": "integer", + "format": "int32" + }, + "parameterFillingCount": { + "description": "The number of responses with match type PARAMETER_FILLING.", + "type": "integer", + "format": "int32" + }, + "noMatchCount": { + "description": "The number of responses with match type NO_MATCH.", + "type": "integer", + "format": "int32" + }, + "noInputCount": { + "description": "The number of responses with match type NO_INPUT.", + "type": "integer", + "format": "int32" + }, + "eventCount": { + "description": "The number of responses with match type EVENT.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationAgentAssistSupervisorMonitoringStatus": { + "description": "Tracks the status of an AA supervisor monitoring a conversation.", + "type": "object", + "properties": { + "monitored": { + "description": "The conversation was monitored by an AA supervisor.", + "type": "boolean" + }, + "escalatedToSupervisor": { + "description": "The conversation was escalated to an AA supervisor for intervention.", + "type": "boolean" + }, + "assignedSupervisor": { + "description": "The ID of the assigned AA supervisor.", + "type": "string" + }, + "transferredToHumanAgent": { + "description": "The conversation was transferred to a human agent by the AA supervisor.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo": { + "description": "Info for correlating across conversations.", + "type": "object", + "properties": { + "fullConversationCorrelationId": { + "description": "Output only. The full conversation correlation id this conversation is a segment of.", + "readOnly": true, + "type": "string" + }, + "mergedFullConversationCorrelationId": { + "description": "Output only. The full conversation correlation id this conversation is a merged\nconversation of.", + "readOnly": true, + "type": "string" + }, + "correlationTypes": { + "description": "Output only. The correlation types of this conversation. A single conversation can\nhave multiple correlation types. For example a conversation that only has\na single segment is both a SEGMENT and a FULL_CONVERSATION.", + "readOnly": true, + "type": "array", + "items": { + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "This conversation represents a segment of a full conversation. The\nlowest level of granularity.", + "This conversation represents a partial conversation of potentially\nmultiple segments but is not a full conversation.", + "This conversation represents a full conversation of potentially\nmultiple segments.", + "This conversation represents a synthetic conversation." + ], + "enum": [ + "CORRELATION_TYPE_UNSPECIFIED", + "SEGMENT", + "PARTIAL", + "FULL", + "SYNTHETIC" + ] + } + } + } + }, + "GoogleCloudContactcenterinsightsV1UploadConversationRequest": { + "description": "Request to upload a conversation.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the conversation.", + "type": "string" + }, + "conversation": { + "description": "Required. The conversation resource to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + }] + }, + "conversationId": { + "description": "Optional. A unique ID for the new conversation. This ID will become the final\ncomponent of the conversation's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", + "type": "string" + }, + "redactionConfig": { + "description": "Optional. DLP settings for transcript redaction. Will default to the config specified\nin Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig" + }] + }, + "speechConfig": { + "description": "Optional. Speech-to-Text configuration. Will default to the config specified\nin Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig" + }] + } + }, + "required": [ + "parent", + "conversation" + ] + }, + "GoogleCloudContactcenterinsightsV1RedactionConfig": { + "description": "DLP resources used for redaction while ingesting conversations.\nDLP settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint or the Dialogflow / Agent\nAssist runtime integrations. When using Dialogflow / Agent Assist runtime\nintegrations, redaction should be performed in Dialogflow / Agent Assist.", + "type": "object", + "properties": { + "deidentifyTemplate": { + "description": "The fully-qualified DLP deidentify template resource name.\nFormat:\n`projects/{project}/deidentifyTemplates/{template}`", + "type": "string" + }, + "inspectTemplate": { + "description": "The fully-qualified DLP inspect template resource name.\nFormat:\n`projects/{project}/locations/{location}/inspectTemplates/{template}`", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1SpeechConfig": { + "description": "Speech-to-Text configuration.\nSpeech-to-Text settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint.", + "type": "object", + "properties": { + "speechRecognizer": { + "description": "The fully-qualified Speech Recognizer resource name.\nFormat:\n`projects/{project_id}/locations/{location}/recognizer/{recognizer}`", + "type": "string" + }, + "disableWordTimeOffsets": { + "description": "Whether to disable word time offsets.\nIf true, the `enable_word_time_offsets` field in the recognition config\nwill be set to false.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1UploadConversationMetadata": { + "description": "The metadata for an `UploadConversation` operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest" + }] + }, + "analysisOperation": { + "description": "Output only. The operation name for a successfully created analysis operation, if any.", + "readOnly": true, + "type": "string" + }, + "appliedRedactionConfig": { + "description": "Output only. The redaction config applied to the uploaded conversation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ListConversationsResponse": { + "description": "The response of listing conversations.", + "type": "object", + "properties": { + "conversations": { + "description": "The conversations that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + } + }, + "nextPageToken": { + "description": "A token which can be sent as `page_token` to retrieve the next page. If\nthis field is set, it means there is another page available. If it is not\nset, it means no other pages are available.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse": { + "description": "The response from a GenerateConversationSignedAudio request.", + "type": "object", + "properties": { + "signedAudioUris": { + "description": "The signed uris for the audio.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SignedAudioUris" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1SignedAudioUris": { + "description": "Signed audio URIs for a conversation.", + "type": "object", + "properties": { + "signedGcsAudioUri": { + "description": "The signed URI for the audio from the Cloud Storage conversation source.", + "type": "string" + }, + "signedDialogflowAudioUri": { + "description": "The signed URI for the audio from the Dialogflow conversation source.", + "type": "string" + }, + "signedTurnLevelAudios": { + "description": "The signed URI for the audio corresponding to each turn in the\nconversation.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio": { + "description": "A wrapper for holding the audio for any given turn.", + "type": "object", + "properties": { + "audioGcsUri": { + "description": "The Cloud Storage URI of the audio for any given turn.", + "type": "string" + }, + "audioDuration": { + "description": "The duration of the audio.", + "type": "string", + "format": "google-duration" + } + } + }, + "GoogleCloudContactcenterinsightsV1Dataset": { + "description": "Dataset resource represents a collection of conversations\nthat may be bounded (Static Dataset, e.g. golden dataset for training),\nor unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", + "type": "object", + "properties": { + "name": { + "description": "Immutable. Identifier. Resource name of the dataset.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}", + "x-google-immutable": true, + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "Display name for the dataaset", + "type": "string" + }, + "description": { + "description": "Dataset description.", + "type": "string" + }, + "type": { + "description": "Dataset usage type.", + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "For evals only.", + "Dataset with new conversations coming in regularly (Insights legacy\nconversations and AI trainer)" + ], + "enum": [ + "TYPE_UNSPECIFIED", + "EVAL", + "LIVE" + ] + }, + "ttl": { + "description": "Optional. Option TTL for the dataset.", + "type": "string", + "format": "google-duration" + }, + "createTime": { + "description": "Output only. Dataset create time.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. Dataset update time.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListDatasetsResponse": { + "description": "The response to list datasets.", + "type": "object", + "properties": { + "datasets": { + "description": "The datasets that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DeleteDatasetMetadata": { + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1SampleConversationsRequest": { + "description": "The request to sample conversations to a dataset.", + "type": "object", + "properties": { + "destinationDataset": { + "description": "The dataset resource to copy the sampled conversations to.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" + }] + }, + "parent": { + "description": "Required. The parent resource of the dataset.", + "type": "string" + }, + "sampleRule": { + "description": "Optional. The sample rule used for sampling conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleRule" + }] + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1SampleRule": { + "description": "Message for sampling conversations.", + "type": "object", + "properties": { + "samplePercentage": { + "description": "Percentage of conversations that we should sample based on the dimension\nbetween [0, 100].", + "type": "number", + "format": "double" + }, + "sampleRow": { + "description": "Number of the conversations that we should sample based on the dimension.", + "type": "string", + "format": "int64" + }, + "dimension": { + "description": "Optional. Group by dimension to sample the conversation. If no dimension is\nprovided, the sampling will be applied to the project level.\nCurrent supported dimensions is 'quality_metadata.agent_info.agent_id'.", + "type": "string" + }, + "conversationFilter": { + "description": "To specify the filter for the conversions that should apply this sample\nrule. An empty filter means this sample rule applies to all conversations.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1SampleConversationsResponse": { + "description": "The response to an SampleConversations operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata": { + "description": "The metadata for an SampleConversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for sample conversations to dataset.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsRequest" + }] + }, + "partialErrors": { + "description": "Output only. Partial errors during sample conversations operation that might\ncause the operation output to be incomplete.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "sampleConversationsStats": { + "description": "Output only. Statistics for SampleConversations operation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats": { + "description": "Statistics for SampleConversations operation.", + "type": "object", + "properties": { + "successfulSampleCount": { + "description": "Output only. The number of new conversations added during this sample operation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "failedSampleCount": { + "description": "Output only. The number of objects which were unable to be sampled due to errors.\nThe errors are populated in the partial_errors field.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata": { + "description": "Metadata for a create analysis operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "conversation": { + "description": "Output only. The Conversation that this Analysis Operation belongs to.", + "readOnly": true, + "type": "string" + }, + "annotatorSelector": { + "description": "Output only. The annotator selector used for the analysis (if any).", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ListAnalysesResponse": { + "description": "The response to list analyses.", + "type": "object", + "properties": { + "analyses": { + "description": "The analyses that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest": { + "description": "The request to analyze conversations in bulk.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource to create analyses in.", + "type": "string" + }, + "filter": { + "description": "Required. Filter used to select the subset of conversations to analyze.", + "type": "string" + }, + "analysisPercentage": { + "description": "Required. Percentage of selected conversation to analyze, between\n[0, 100].", + "type": "number", + "format": "float" + }, + "annotatorSelector": { + "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector" + }] + } + }, + "required": [ + "parent", + "filter", + "analysisPercentage" + ] + }, + "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse": { + "description": "The response for a bulk analyze conversations operation.", + "type": "object", + "properties": { + "successfulAnalysisCount": { + "description": "Count of successful analyses.", + "type": "integer", + "format": "int32" + }, + "failedAnalysisCount": { + "description": "Count of failed analyses.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata": { + "description": "The metadata for a bulk analyze conversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for bulk analyze.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" + }] + }, + "completedAnalysesCount": { + "description": "The number of requested analyses that have completed successfully so far.", + "type": "integer", + "format": "int32" + }, + "failedAnalysesCount": { + "description": "The number of requested analyses that have failed so far.", + "type": "integer", + "format": "int32" + }, + "totalRequestedAnalysesCount": { + "description": "Total number of analyses requested. Computed by the number of conversations\nreturned by `filter` multiplied by `analysis_percentage` in the request.", + "type": "integer", + "format": "int32" + }, + "partialErrors": { + "description": "Output only. Partial errors during bulk analyze operation that might cause the operation\noutput to be incomplete.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest": { + "description": "The request to delete conversations in bulk.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource to delete conversations from.\nFormat:\nprojects/{project}/locations/{location}", + "type": "string" + }, + "filter": { + "description": "Filter used to select the subset of conversations to delete.", + "type": "string" + }, + "maxDeleteCount": { + "description": "Maximum number of conversations to delete.", + "type": "integer", + "format": "int32" + }, + "force": { + "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", + "type": "boolean" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse": { + "description": "The response for a bulk delete conversations operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata": { + "description": "The metadata for a bulk delete conversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for bulk delete.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during bulk delete conversations operation that might cause\nthe operation output to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1IngestConversationsRequest": { + "description": "The request to ingest conversations.", + "type": "object", + "properties": { + "gcsSource": { + "description": "A cloud storage bucket source. Note that any previously ingested objects\nfrom the source will be skipped to avoid duplication.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource" + }] + }, + "transcriptObjectConfig": { + "description": "Configuration for when `source` contains conversation transcripts.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig" + }] + }, + "parent": { + "description": "Required. The parent resource for new conversations.", + "type": "string" + }, + "conversationConfig": { + "description": "Configuration that applies to all conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig" + }] + }, + "redactionConfig": { + "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config\nspecified in Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig" + }] + }, + "speechConfig": { + "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config\nspecified in Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig" + }] + }, + "sampleSize": { + "description": "Optional. If set, this fields indicates the number of objects to ingest from the\nCloud Storage bucket. If empty, the entire bucket will be ingested.\nUnless they are first deleted, conversations produced through sampling\nwon't be ingested by subsequent ingest requests.", + "type": "integer", + "format": "int32" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource": { + "description": "Configuration for Cloud Storage bucket sources.", + "type": "object", + "properties": { + "bucketUri": { + "description": "Optional. The Cloud Storage bucket containing source objects.\nAvoid passing this. Pass this through one of `transcript_bucket_uri` or\n`audio_bucket_uri`.", + "type": "string" + }, + "bucketObjectType": { + "description": "Optional. Specifies the type of the objects in `bucket_uri`.\nAvoid passing this. This is inferred from the `transcript_bucket_uri`,\n`audio_bucket_uri`.", + "type": "string", + "x-google-enum-descriptions": [ + "The object type is unspecified and will default to `TRANSCRIPT`.", + "The object is a transcript.", + "The object is an audio file." + ], + "enum": [ + "BUCKET_OBJECT_TYPE_UNSPECIFIED", + "TRANSCRIPT", + "AUDIO" + ] + }, + "transcriptBucketUri": { + "description": "Optional. The Cloud Storage path to the conversation transcripts. Note\nthat: [1] Transcript files are expected to be in JSON format. [2]\nTranscript, audio, metadata files must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", + "type": "string" + }, + "audioBucketUri": { + "description": "Optional. The Cloud Storage path to the conversation audio file.\nNote that: [1] Audio files will be transcribed if not already.\n[2] Audio files and transcript files must be in separate\nbuckets / folders.\n[3] A source file and its corresponding audio file\nmust share the same name to\n be properly ingested, E.g.\n `gs://bucket/transcript/conversation1.json` and\n `gs://bucket/audio/conversation1.mp3`.", + "type": "string" + }, + "metadataBucketUri": { + "description": "Optional. The Cloud Storage path to the conversation metadata. Note that:\n[1] Metadata files are expected to be in JSON format.\n[2] Metadata and source files (transcripts or audio) must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", + "type": "string" + }, + "customMetadataKeys": { + "description": "Optional. Custom keys to extract as conversation labels from metadata files in\n`metadata_bucket_uri`. Keys not included in this field will be ignored.\nNote that there is a limit of 100 labels per conversation.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig": { + "description": "Configuration for processing transcript objects.", + "type": "object", + "properties": { + "medium": { + "description": "Required. The medium transcript objects represent.", + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "The format for conversations that took place over the phone.", + "The format for conversations that took place over chat." + ], + "enum": [ + "MEDIUM_UNSPECIFIED", + "PHONE_CALL", + "CHAT" + ] + } + }, + "required": [ + "medium" + ] + }, + "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig": { + "description": "Configuration that applies to all conversations.", + "type": "object", + "properties": { + "agentId": { + "description": "Optional. An opaque, user-specified string representing a human agent who handled\nall conversations in the import. Note that this will be overridden if\nper-conversation metadata is provided through the `metadata_bucket_uri`.", + "type": "string" + }, + "agentChannel": { + "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", + "type": "integer", + "format": "int32" + }, + "customerChannel": { + "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1IngestConversationsResponse": { + "description": "The response to an IngestConversations operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata": { + "description": "The metadata for an IngestConversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for ingest.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest" + }] + }, + "partialErrors": { + "description": "Output only. Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "ingestConversationsStats": { + "description": "Output only. Statistics for IngestConversations operation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats" + }] + }, + "sampledConversations": { + "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats": { + "description": "Statistics for IngestConversations operation.", + "type": "object", + "properties": { + "processedObjectCount": { + "description": "Output only. The number of objects processed during the ingest operation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "duplicatesSkippedCount": { + "description": "Output only. The number of objects skipped because another conversation with the same\ntranscript uri had already been ingested.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "successfulIngestCount": { + "description": "Output only. The number of new conversations added during this ingest operation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "failedIngestCount": { + "description": "Output only. The number of objects which were unable to be ingested due to errors.\nThe errors are populated in the partial_errors field.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest": { + "description": "The request to export insights.", + "type": "object", + "properties": { + "bigQueryDestination": { + "description": "Specified if sink is a BigQuery table.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination" + }] + }, + "parent": { + "description": "Required. The parent resource to export data from.", + "type": "string" + }, + "filter": { + "description": "A filter to reduce results to a specific subset. Useful for exporting\nconversations with specific properties.", + "type": "string" + }, + "kmsKey": { + "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK.\nFormat:\nprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", + "type": "string" + }, + "writeDisposition": { + "description": "Options for what to do if the destination table already exists.", + "type": "string", + "x-google-enum-descriptions": [ + "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", + "If the table already exists, BigQuery will overwrite the table data and\nuse the schema from the load.", + "If the table already exists, BigQuery will append data to the table." + ], + "enum": [ + "WRITE_DISPOSITION_UNSPECIFIED", + "WRITE_TRUNCATE", + "WRITE_APPEND" + ] + }, + "exportSchemaVersion": { + "description": "Optional. Version of the export schema.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified. Defaults to EXPORT_V3.", + "Export schema version 1.", + "Export schema version 2.", + "Export schema version 3.", + "Export schema version 4.", + "Export schema version 5.", + "Export schema version 6.", + "Export schema version 7.", + "Export schema version 8.", + "Export schema version 9.", + "Export schema version 10.", + "Export schema version 11.", + "Export schema version 12.", + "Export schema version 13.", + "Export schema version 14.", + "Export schema version 15.", + "Export schema version 16.", + "Export schema version 17.", + "Export schema version latest available." + ], + "enum": [ + "EXPORT_SCHEMA_VERSION_UNSPECIFIED", + "EXPORT_V1", + "EXPORT_V2", + "EXPORT_V3", + "EXPORT_V4", + "EXPORT_V5", + "EXPORT_V6", + "EXPORT_V7", + "EXPORT_V8", + "EXPORT_V9", + "EXPORT_V10", + "EXPORT_V11", + "EXPORT_V12", + "EXPORT_V13", + "EXPORT_V14", + "EXPORT_V15", + "EXPORT_V16", + "EXPORT_V17", + "EXPORT_VERSION_LATEST_AVAILABLE" + ] + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination": { + "description": "A BigQuery Table Reference.", + "type": "object", + "properties": { + "projectId": { + "description": "A project ID or number. If specified, then export will attempt to\nwrite data to this project instead of the resource project. Otherwise,\nthe resource project will be used.", + "type": "string" + }, + "dataset": { + "description": "Required. The name of the BigQuery dataset that the snapshot result should be\nexported to. If this dataset does not exist, the export call returns an\nINVALID_ARGUMENT error.", + "type": "string" + }, + "table": { + "description": "The BigQuery table name to which the insights data should be written.\nIf this table does not exist, the export call returns an INVALID_ARGUMENT\nerror.", + "type": "string" + } + }, + "required": [ + "dataset" + ] + }, + "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse": { + "description": "Response for an export insights operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata": { + "description": "Metadata for an export insights operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for export.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during export operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "completedExportCount": { + "description": "The number of conversations that were exported successfully.", + "type": "integer", + "format": "int32" + }, + "failedExportCount": { + "description": "The number of conversations that failed to be exported.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1IssueModel": { + "description": "The issue model resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the issue model.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The representative name for the issue model.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this issue model was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the issue model was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "issueCount": { + "description": "Output only. Number of issues in this issue model.", + "readOnly": true, + "type": "string", + "format": "int64" + }, + "state": { + "description": "Output only. State of the model.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Model is not deployed but is ready to deploy.", + "Model is being deployed.", + "Model is deployed and is ready to be used. A model can only be used in\nanalysis if it's in this state.", + "Model is being undeployed.", + "Model is being deleted." + ], + "enum": [ + "STATE_UNSPECIFIED", + "UNDEPLOYED", + "DEPLOYING", + "DEPLOYED", + "UNDEPLOYING", + "DELETING" + ] + }, + "inputDataConfig": { + "description": "Configs for the input data that used to create the issue model.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig" + }] + }, + "trainingStats": { + "description": "Output only. Immutable. The issue model's label statistics on its training data.", + "readOnly": true, + "x-google-immutable": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats" + }] + }, + "modelType": { + "description": "Type of the model.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified model type.", + "Type V1.", + "Type V2." + ], + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "TYPE_V1", + "TYPE_V2" + ] + }, + "languageCode": { + "description": "Language of the model.", + "type": "string" + }, + "multiLingualMatch": { + "description": "Whether the model can be used for analysis with conversations in multiple\nlanguages. The topic names and descriptions will be in the `language_code`\nspecified, but the matching will be performed against conversations in any\nlanguage.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig": { + "description": "Configs for the input data used to create the issue model.", + "type": "object", + "properties": { + "medium": { + "description": "Medium of conversations used in training data. This field is being\ndeprecated. To specify the medium to be used in training a new issue\nmodel, set the `medium` field on `filter`.", + "deprecated": true, + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "The format for conversations that took place over the phone.", + "The format for conversations that took place over chat." + ], + "enum": [ + "MEDIUM_UNSPECIFIED", + "PHONE_CALL", + "CHAT" + ] + }, + "trainingConversationsCount": { + "description": "Output only. Number of conversations used in training. Output only.", + "readOnly": true, + "type": "string", + "format": "int64" + }, + "filter": { + "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", + "type": "string" + }, + "customTaxonomy": { + "description": "Custom supplied taxonomy.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelCustomTaxonomy" + }] + }, + "issueGranularity": { + "description": "Issue granularity preference for model training.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Granularity much coarser than default.", + "Granularity coarser than default.", + "Default granularity.", + "Granularity finer than default.", + "Granularity much finer than default." + ], + "enum": [ + "ISSUE_GRANULARITY_UNSPECIFIED", + "MORE_COARSE", + "COARSE", + "STANDARD", + "FINE", + "MORE_FINE" + ] + }, + "industry": { + "description": "Customer industry, used to improve specificity of the topic model.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1IssueModelCustomTaxonomy": { + "description": "Structure for custom supplied taxonomy. A custom taxonomy consists of\nmultiple taxonomy entries organized in a hierarchical way.", + "type": "object", + "properties": { + "taxonomyEntries": { + "description": "List of taxonomy entries.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelCustomTaxonomyTaxonomyEntry" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1IssueModelCustomTaxonomyTaxonomyEntry": { + "description": "Structure for a taxonomy entry.", + "type": "object", + "properties": { + "id": { + "description": "Immutable. The Id of the taxonomy entry", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The content of the taxonomy entry.", + "type": "string" + }, + "parents": { + "description": "Ids of parent taxonomy entries.", + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "The description of the taxonomy entry.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1IssueModelLabelStats": { + "description": "Aggregated statistics about an issue model.", + "type": "object", + "properties": { + "analyzedConversationsCount": { + "description": "Number of conversations the issue model has analyzed at this point in time.", + "type": "string", + "format": "int64" + }, + "unclassifiedConversationsCount": { + "description": "Number of analyzed conversations for which no issue was applicable at this\npoint in time.", + "type": "string", + "format": "int64" + }, + "issueStats": { + "description": "Statistics on each issue. Key is the issue's resource name.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats": { + "description": "Aggregated statistics about an issue.", + "type": "object", + "properties": { + "issue": { + "description": "Issue resource.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", + "type": "string" + }, + "labeledConversationsCount": { + "description": "Number of conversations attached to the issue at this point in time.", + "type": "string", + "format": "int64" + }, + "displayName": { + "description": "Display name of the issue.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata": { + "description": "Metadata for creating an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for creation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest": { + "description": "The request to create an issue model.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the issue model.", + "type": "string" + }, + "issueModel": { + "description": "Required. The issue model to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" + }] + } + }, + "required": [ + "parent", + "issueModel" + ] + }, + "GoogleCloudContactcenterinsightsV1ListIssueModelsResponse": { + "description": "The response of listing issue models.", + "type": "object", + "properties": { + "issueModels": { + "description": "The issue models that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata": { + "description": "Metadata for deleting an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for deletion.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest": { + "description": "The request to delete an issue model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The name of the issue model to delete.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest": { + "description": "The request to deploy an issue model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The issue model to deploy.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse": { + "description": "The response to deploy an issue model.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata": { + "description": "Metadata for deploying an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for deployment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest": { + "description": "The request to undeploy an issue model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The issue model to undeploy.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse": { + "description": "The response to undeploy an issue model.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata": { + "description": "Metadata for undeploying an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for undeployment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest": { + "description": "Request to export an issue model.", + "type": "object", + "properties": { + "gcsDestination": { + "description": "Google Cloud Storage URI to export the issue model to.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination" + }] + }, + "name": { + "description": "Required. The issue model to export.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination": { + "description": "Google Cloud Storage Object URI to save the issue model to.", + "type": "object", + "properties": { + "objectUri": { + "description": "Required. Format: `gs:///`", + "type": "string" + } + }, + "required": [ + "objectUri" + ] + }, + "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse": { + "description": "Response from export issue model", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata": { + "description": "Metadata used for export issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original export request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest": { + "description": "Request to import an issue model.", + "type": "object", + "properties": { + "gcsSource": { + "description": "Google Cloud Storage source message.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource" + }] + }, + "parent": { + "description": "Required. The parent resource of the issue model.", + "type": "string" + }, + "createNewModel": { + "description": "Optional. If set to true, will create an issue model from the imported file with\nrandomly generated IDs for the issue model and corresponding issues.\nOtherwise, replaces an existing model with the same ID as the file.", + "type": "boolean" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource": { + "description": "Google Cloud Storage Object URI to get the issue model file from.", + "type": "object", + "properties": { + "objectUri": { + "description": "Required. Format: `gs:///`", + "type": "string" + } + }, + "required": [ + "objectUri" + ] + }, + "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse": { + "description": "Response from import issue model", + "type": "object", + "properties": { + "issueModel": { + "description": "The issue model that was imported.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata": { + "description": "Metadata used for import issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original import request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1Issue": { + "description": "The issue resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the issue.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The representative name for the issue.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this issue was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time that this issue was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "representativeConversationNames": { + "description": "Output only. Resource names of the most representative conversations matched.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "sampleUtterances": { + "description": "Output only. Resource names of the sample representative utterances that match to this\nissue.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "source": { + "description": "Source of the topic", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Generated based on the customers data - i.e. topic discovered by model.", + "Taxonomy provided by the customer (topic come from custom taxonomy)." + ], + "enum": [ + "ISSUE_SOURCE_UNSPECIFIED", + "GENERATED", + "CUSTOMER_PROVIDED" + ] + }, + "parentIssues": { + "description": "Unique identifiers of the parent topics for hierarchical representation.\nFormat is\n`projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}`", + "type": "array", + "items": { + "type": "string" + } + }, + "alternatives": { + "description": "Additional topic descriptions.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueAlternative" + } + }, + "displayDescription": { + "description": "Representative description of the issue.", + "type": "string" + }, + "matchTarget": { + "description": "Target used for semantic similarity comparisons.\nPopulated on V2 models if the display name was renamed.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1IssueAlternative": { + "description": "Alternative topic names or descriptions to improve inference.", + "type": "object", + "properties": { + "alternative": { + "description": "An alternative topic name.", + "type": "string" + }, + "description": { + "description": "An alternative topic description.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListIssuesResponse": { + "description": "The response of listing issues.", + "type": "object", + "properties": { + "issues": { + "description": "The issues that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1CreateIssueMetadata": { + "description": "Metadata for creating an issue.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for creation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1CreateIssueRequest": { + "description": "The request to create an issue.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the issue.", + "type": "string" + }, + "issue": { + "description": "Required. The values for the new issue.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" + }] + } + }, + "required": [ + "parent", + "issue" + ] + }, + "GoogleCloudContactcenterinsightsV1MergeIssuesRequest": { + "description": "The request to merge issues.", + "type": "object", + "properties": { + "issues": { + "description": "Required. The list of issue resource names to merge.", + "type": "array", + "items": { + "type": "string" + } + }, + "displayName": { + "description": "Required. The display name for the new issue.", + "type": "string" + }, + "displayDescription": { + "description": "Required. The display description for the new issue.", + "type": "string" + } + }, + "required": [ + "issues", + "displayName", + "displayDescription" + ] + }, + "GoogleCloudContactcenterinsightsV1MergeIssuesMetadata": { + "description": "Metadata for creating an issue.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse": { + "description": "Response of querying an issue model's statistics.", + "type": "object", + "properties": { + "currentStats": { + "description": "The latest label statistics for the queried issue model. Includes results\non both training data and data labeled after deployment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1FaqModel": { + "description": "The FAQ model resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the FAQ model.\nFormat:\nprojects/{project}/locations/{location}/faqModels/{faq_model}", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The representative name for the FAQ model.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this FAQ model was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the FAQ model was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "faqEntryCount": { + "description": "Output only. Number of FAQ entries in this FAQ model.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "state": { + "description": "Output only. State of the FAQ model.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Model is not deployed but is ready to deploy.", + "Model is being deleted." + ], + "enum": [ + "STATE_UNSPECIFIED", + "UNDEPLOYED", + "DELETING" + ] + }, + "inputDataConfig": { + "description": "Configs for the input data used to create the FAQ model.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModelInputDataConfig" + }] + }, + "modelTrainingStats": { + "description": "Output only. Immutable. The model statistics on its training data.", + "readOnly": true, + "x-google-immutable": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModelModelStats" + }] + }, + "infobotAgent": { + "description": "Immutable. The resource name of the infobot agent to be used to create generative\nanswers. Format: projects/{project}/locations/{location}/agents/{agent}", + "x-google-immutable": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1FaqModelInputDataConfig": { + "description": "Configs for the input data used to create the FAQ model.", + "type": "object", + "properties": { + "trainingConversationsCount": { + "description": "Output only. Number of conversations used in training. Output only.", + "readOnly": true, + "type": "string", + "format": "int64" + }, + "filter": { + "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1FaqModelModelStats": { + "description": "Train/inference statistics for the model.", + "type": "object", + "properties": { + "totalConversationsCount": { + "description": "Total number of conversations analyzed at this point in time.", + "type": "integer", + "format": "int32" + }, + "skippedConversationsCount": { + "description": "Number of analyzed conversations which were skipped e.g. customer\ndisconnected from the call.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1CreateFaqModelMetadata": { + "description": "Metadata for creating an FAQ model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for creation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateFaqModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1CreateFaqModelRequest": { + "description": "The request to create an FAQ model.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the FAQ model.", + "type": "string" + }, + "faqModel": { + "description": "Required. The FAQ model to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" + }] + }, + "faqModelId": { + "description": "Optional. The ID to use for the FAQ model, which will become the final\ncomponent of the FAQ model's resource name.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", + "type": "string" + } + }, + "required": [ + "parent", + "faqModel" + ] + }, + "GoogleCloudContactcenterinsightsV1ListFaqModelsResponse": { + "description": "The response of listing FAQ models.", + "type": "object", + "properties": { + "faqModels": { + "description": "The FAQ models that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DeleteFaqModelMetadata": { + "description": "Metadata for deleting an FAQ model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for deletion.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteFaqModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1DeleteFaqModelRequest": { + "description": "The request to delete an FAQ model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The name of the FAQ model to delete.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1FaqEntry": { + "description": "The FAQ entry resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the FAQ entry.\nFormat:\nprojects/{project}/locations/{location}/faqModels/{faq_model}/faqEntries/{faq_entry}", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "Representative name of the FAQ entry, typically the question text.", + "type": "string" + }, + "question": { + "description": "Output only. Question of the FAQ.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. FAQ entry creation time.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. FAQ entry last update time.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "representativeConversationNames": { + "description": "Output only. Resource names of the most representative conversations matched.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}\nDeprecated. Use `representative_conversations` instead.", + "readOnly": true, + "deprecated": true, + "type": "array", + "items": { + "type": "string" + } + }, + "trainingStats": { + "description": "Output only. Statistics of the FAQ entry computed from training data.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntryStats" + }] + }, + "botAnswers": { + "description": "Output only. Answers from the bot for the question.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntryBotAnswer" + } + }, + "insightsAnswers": { + "description": "Output only. Answers based on conversation history and live agent questions.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntryInsightsAnswer" + } + }, + "representativeConversations": { + "description": "Output only. Examples of conversations representative of the FaqEntry", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntryRepresentativeConversation" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1FaqEntryStats": { + "description": "Training/inference statistics for the FAQ entry.", + "type": "object", + "properties": { + "conversationCount": { + "description": "Number of conversations asking the faq question.", + "type": "integer", + "format": "int32" + }, + "averageHandlingTime": { + "description": "Average handling time for all conversations.", + "type": "string", + "format": "google-duration" + }, + "trafficPercentage": { + "description": "Percentage of traffic in all conversations.", + "type": "number", + "format": "float" + }, + "averageTurnCount": { + "description": "Average turn count.", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudContactcenterinsightsV1FaqEntryBotAnswer": { + "description": "An answer from the bot for the question.", + "type": "object", + "properties": { + "answer": { + "description": "Answer text.", + "type": "string" + }, + "matchingQuestion": { + "description": "The matching question from the bot (e.g. from FAQ Assist).", + "type": "string" + }, + "snippets": { + "description": "All snippets used for this answer, with their source URI\nand data.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntryBotAnswerSnippet" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1FaqEntryBotAnswerSnippet": { + "description": "Snippet Source for a bot answer.", + "type": "object", + "properties": { + "uri": { + "description": "URI the data is sourced from.", + "type": "string" + }, + "text": { + "description": "Text taken from that URI.", + "type": "string" + }, + "title": { + "description": "Title of the document.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1FaqEntryInsightsAnswer": { + "description": "An answer based on conversation history and live agent\nquestions.", + "type": "object", + "properties": { + "answer": { + "description": "Answer text.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1FaqEntryRepresentativeConversation": { + "description": "Represents a point in a conversation that is representative of the parent\nFaqEntry", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the conversation.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}", + "x-google-immutable": true, + "type": "string" + }, + "startTime": { + "description": "The time at which the conversation started.", + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListFaqEntriesResponse": { + "description": "The response of listing FAQ entries.", + "type": "object", + "properties": { + "faqEntries": { + "description": "The FAQ entries that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntry" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1PhraseMatcher": { + "description": "The phrase matcher resource.", + "type": "object", + "properties": { + "name": { + "description": "The resource name of the phrase matcher.\nFormat:\nprojects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", + "type": "string" + }, + "revisionId": { + "description": "Output only. Immutable. The revision ID of the phrase matcher.\nA new revision is committed whenever the matcher is changed, except when it\nis activated or deactivated. A server generated random ID will be used.\nExample: locations/global/phraseMatchers/my-first-matcher@1234567", + "readOnly": true, + "x-google-immutable": true, + "type": "string" + }, + "versionTag": { + "description": "The customized version tag to use for the phrase matcher. If not specified,\nit will default to `revision_id`.", + "type": "string" + }, + "revisionCreateTime": { + "description": "Output only. The timestamp of when the revision was created. It is also the create time\nwhen a new matcher is added.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "displayName": { + "description": "The human-readable name of the phrase matcher.", + "type": "string" + }, + "type": { + "description": "Required. The type of this phrase matcher.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Must meet all phrase match rule groups or there is no match.", + "If any of the phrase match rule groups are met, there is a match." + ], + "enum": [ + "PHRASE_MATCHER_TYPE_UNSPECIFIED", + "ALL_OF", + "ANY_OF" + ] + }, + "active": { + "description": "Applies the phrase matcher only when it is active.", + "type": "boolean" + }, + "phraseMatchRuleGroups": { + "description": "A list of phase match rule groups that are included in this matcher.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup" + } + }, + "activationUpdateTime": { + "description": "Output only. The most recent time at which the activation status was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "roleMatch": { + "description": "The role whose utterances the phrase matcher should be matched\nagainst. If the role is ROLE_UNSPECIFIED it will be matched against any\nutterances in the transcript.", + "type": "string", + "x-google-enum-descriptions": [ + "Participant's role is not set.", + "Participant is a human agent.", + "Participant is an automated agent.", + "Participant is an end user who conversed with the contact center.", + "Participant is either a human or automated agent." + ], + "enum": [ + "ROLE_UNSPECIFIED", + "HUMAN_AGENT", + "AUTOMATED_AGENT", + "END_USER", + "ANY_AGENT" + ] + }, + "updateTime": { + "description": "Output only. The most recent time at which the phrase matcher was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "languageCode": { + "description": "The language code of this segment as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".\nIf the language_code is unspecified, it will match everything.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup": { + "description": "A message representing a rule in the phrase matcher.", + "type": "object", + "properties": { + "type": { + "description": "Required. The type of this phrase match rule group.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Must meet all phrase match rules or there is no match.", + "If any of the phrase match rules are met, there is a match." + ], + "enum": [ + "PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED", + "ALL_OF", + "ANY_OF" + ] + }, + "phraseMatchRules": { + "description": "A list of phrase match rules that are included in this group.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule" + } + }, + "phraseMatchRuleGroups": { + "description": "A list of phrase match rule groups that are included in this group.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup" + } + }, + "roleMatch": { + "description": "The role whose utterances the phrase matcher should be matched\nagainst. If the role is ROLE_UNSPECIFIED it will be matched against any\nutterances in the transcript.", + "type": "string", + "x-google-enum-descriptions": [ + "Participant's role is not set.", + "Participant is a human agent.", + "Participant is an automated agent.", + "Participant is an end user who conversed with the contact center.", + "Participant is either a human or automated agent." + ], + "enum": [ + "ROLE_UNSPECIFIED", + "HUMAN_AGENT", + "AUTOMATED_AGENT", + "END_USER", + "ANY_AGENT" + ] + }, + "languageCode": { + "description": "The language code of this segment as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".\nIf the language_code is unspecified, it will match everything.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "GoogleCloudContactcenterinsightsV1PhraseMatchRule": { + "description": "The data for a phrase match rule.", + "type": "object", + "properties": { + "query": { + "description": "Required. The phrase to be matched.", + "type": "string" + }, + "negated": { + "description": "Specifies whether the phrase must be missing from the transcript segment or\npresent in the transcript segment.", + "type": "boolean" + }, + "config": { + "description": "Provides additional information about the rule that specifies how to apply\nthe rule.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig" + }] + } + }, + "required": [ + "query" + ] + }, + "GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig": { + "description": "Configuration information of a phrase match rule.", + "type": "object", + "properties": { + "exactMatchConfig": { + "description": "The configuration for the exact match rule.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExactMatchConfig" + }] + }, + "semanticMatchConfig": { + "description": "The configuration for the semantic match rule.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SemanticMatchConfig" + }] + }, + "regexMatchConfig": { + "description": "The configuration for the regex match rule.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RegexMatchConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ExactMatchConfig": { + "description": "Exact match configuration.", + "type": "object", + "properties": { + "caseSensitive": { + "description": "Whether to consider case sensitivity when performing an exact match.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1SemanticMatchConfig": { + "description": "Semantic match configuration.", + "type": "object", + "properties": { + "similarityThreshold": { + "description": "Only text with a similarity greater than or equal to the threshold will be\nconsidered to be a match to the provided query. Ranges from 0 - 1.", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudContactcenterinsightsV1RegexMatchConfig": { + "description": "Regex match configuration.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse": { + "description": "The response of listing phrase matchers.", + "type": "object", + "properties": { + "phraseMatchers": { + "description": "The phrase matchers that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1CalculateStatsResponse": { + "description": "The response for calculating conversation statistics.", + "type": "object", + "properties": { + "averageDuration": { + "description": "The average duration of all conversations. The average is calculated using\nonly conversations that have a time duration.", + "type": "string", + "format": "google-duration" + }, + "averageTurnCount": { + "description": "The average number of turns per conversation.", + "type": "integer", + "format": "int32" + }, + "conversationCount": { + "description": "The total number of conversations.", + "type": "integer", + "format": "int32" + }, + "smartHighlighterMatches": { + "description": "A map associating each smart highlighter display name with its respective\nnumber of matches in the set of conversations.", + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32" + } + }, + "customHighlighterMatches": { + "description": "A map associating each custom highlighter resource name with its respective\nnumber of matches in the set of conversations.", + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32" + } + }, + "issueMatches": { + "description": "A map associating each issue resource name with its respective number of\nmatches in the set of conversations. Key has the format:\n`projects//locations//issueModels//issues/`\nDeprecated, use `issue_matches_stats` field instead.", + "deprecated": true, + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32" + } + }, + "issueMatchesStats": { + "description": "A map associating each issue resource name with its respective number of\nmatches in the set of conversations. Key has the format:\n`projects//locations//issueModels//issues/`", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" + } + }, + "conversationCountTimeSeries": { + "description": "A time series representing the count of conversations created over time\nthat match that requested filter criteria.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries": { + "description": "A time series representing conversations over time.", + "type": "object", + "properties": { + "intervalDuration": { + "description": "The duration of each interval.", + "type": "string", + "format": "google-duration" + }, + "points": { + "description": "An ordered list of intervals from earliest to latest, where each interval\nrepresents the number of conversations that transpired during the time\nwindow.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval": { + "description": "A single interval in a time series.", + "type": "object", + "properties": { + "startTime": { + "description": "The start time of this interval.", + "type": "string", + "format": "date-time" + }, + "conversationCount": { + "description": "The number of conversations created in this interval.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1CalculateStatsRequest": { + "description": "The request for calculating conversation statistics.", + "type": "object", + "properties": { + "filter": { + "description": "A filter to reduce results to a specific subset. This field is useful for\ngetting statistics about conversations with specific properties.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1CorrelationConfig": { + "description": "A configuration that defines how to correlate conversations for a given\na given project.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. Identifier. The resource name of the correlation config.\nFormat:\nprojects/{project}/locations/{location}/correlationConfig", + "x-google-immutable": true, + "x-google-identifier": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which the correlation config was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The time at which the correlation config was last updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "fullConversationConfig": { + "description": "The correlation type config for full conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationTypeConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1CorrelationTypeConfig": { + "description": "A list of correlation rules for a given correlation type.", + "type": "object", + "properties": { + "correlationRules": { + "description": "A list of correlation rules to be evaluated for correlation.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationRule" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1CorrelationRule": { + "description": "A correlation rule that defines how to join conversations for a given\ncorrelation type.", + "type": "object", + "properties": { + "ruleId": { + "description": "Required. The unique identifier of the rule.", + "type": "string" + }, + "active": { + "description": "Optional. Whether the config is active to be evaluated.", + "type": "boolean" + }, + "joinKeyExpression": { + "description": "Optional. A cel expression (go/cel) to be evaluated as a string value. This string\nvalue will be used as the join key for the correlation.", + "type": "string" + }, + "constraintExpression": { + "description": "Optional. A cel expression (go/cel) to be evaluated as a boolean value.\nTwo variables conversation_a and conversation_b will be available for\nevaluation. This expression should evaluate to true if conversation_a and\nconversation_b should be joined. This is used as an extra constraint on top\nof the join_key_expression to further refine the group of conversations\nthat are joined together and will be evaluated in both directions.\nfor two conversations c1 and c2 and the result will be OR'd. We will\nevaluate: f(c1, c2) OR f(c2, c1)", + "type": "string" + } + }, + "required": [ + "ruleId" + ] + }, + "GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequest": { + "description": "The request to test correlation config.", + "type": "object", + "properties": { + "filter": { + "description": "Optional. Filter to select conversations to test correlation against.\nConversations matching this filter will be sampled based on start time.\nThe most recent `max_sample_count` conversations will be selected.\nIf no conversations match the filter, the request will fail with an\n`INVALID_ARGUMENT` error.", + "type": "string" + }, + "conversations": { + "description": "Optional. A list of conversations to test against.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequestConversations" + }] + }, + "correlationConfig": { + "description": "Required. The correlation config to test.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationConfig" + }] + }, + "maxSampleCount": { + "description": "Optional. The maximum number of conversations to sample when using the `filter`.\nIf not set, defaults to 1000. Values greater than 1000 are coerced to 1000.\nThis field is ignored if `conversations` is provided.", + "type": "integer", + "format": "int32" + } + }, + "required": [ + "correlationConfig" + ] + }, + "GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequestConversations": { + "description": "Wrapper for a list of conversations.", + "type": "object", + "properties": { + "conversations": { + "description": "Optional. The conversations.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse": { + "description": "The response of testing correlation config.", + "type": "object", + "properties": { + "detailedResults": { + "description": "Results for the DETAILED_SYNC execution mode.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults" + }] + }, + "partialErrors": { + "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults": { + "description": "Wrapper for detailed, step-by-step results.", + "type": "object", + "properties": { + "joinKeyResults": { + "description": "A list of join key correlation results for each conversation tested.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCorrelationResult" + } + }, + "constraintResults": { + "description": "A list of constraint evaluation results for each pair of conversations.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult": { + "description": "The result of testing correlation config on a single conversation.", + "type": "object", + "properties": { + "conversation": { + "description": "The conversation resource name.", + "type": "string" + }, + "ruleResults": { + "description": "The results for each correlation rule.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult": { + "description": "The result of a single correlation rule.", + "type": "object", + "properties": { + "correlationId": { + "description": "The correlation ID generated by the join key expression.", + "type": "string" + }, + "error": { + "description": "The error status if the join key expression failed to evaluate.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleRpcStatus" + }] + }, + "ruleId": { + "description": "The rule ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult": { + "description": "The result of testing a constraint expression on a pair of conversations.", + "type": "object", + "properties": { + "conversationA": { + "description": "The first conversation resource name.", + "type": "string" + }, + "conversationB": { + "description": "The second conversation resource name.", + "type": "string" + }, + "ruleConstraintResults": { + "description": "The results for each applicable constraint rule.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult": { + "description": "The result of a single constraint rule on the pair of conversations.", + "type": "object", + "properties": { + "constraintMet": { + "description": "Whether the constraint expression evaluated to true for (A, B) or (B,\nA).", + "type": "boolean" + }, + "error": { + "description": "The error status if the constraint expression failed to evaluate.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleRpcStatus" + }] + }, + "ruleId": { + "description": "The rule ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata": { + "description": "Metadata for testing correlation config.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "dataset": { + "description": "The dataset used for sampling conversations.", + "type": "string" + }, + "stats": { + "description": "The statistics for the operation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats": { + "description": "Statistics for TestCorrelationConfig operation.", + "type": "object", + "properties": { + "sampledConversationsCount": { + "description": "The number of conversations sampled.", + "type": "integer", + "format": "int32" + }, + "correlatedConversationsCount": { + "description": "The number of conversations correlated.", + "type": "integer", + "format": "int32" + }, + "failedConversationsCount": { + "description": "The number of conversations that failed correlation.", + "type": "integer", + "format": "int32" + }, + "partialErrors": { + "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "conversationCorrelationErrors": { + "description": "A list of errors that occurred during correlation, one for each\nconversation that failed.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { + "description": "An error that occurred during correlation for a specific conversation.", + "type": "object", + "properties": { + "conversation": { + "description": "The conversation resource name that had an error during correlation.", + "type": "string" + }, + "status": { + "description": "The error status.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleRpcStatus" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1Settings": { + "description": "The CCAI Insights project wide settings.\nUse these settings to configure the behavior of Insights.\nView these settings with\n[`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings)\nand change the settings with\n[`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings).", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the settings resource.\nFormat:\nprojects/{project}/locations/{location}/settings", + "x-google-immutable": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which the settings was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The time at which the settings were last updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "languageCode": { + "description": "A language code to be applied to each transcript segment unless the segment\nalready specifies a language code. Language code defaults to \"en-US\" if it\nis neither specified on the segment nor here.", + "type": "string" + }, + "conversationTtl": { + "description": "The default TTL for newly-created conversations. If a conversation has a\nspecified expiration, that value will be used instead. Changing this\nvalue will not change the expiration of existing conversations.\nConversations with no expire time persist until they are deleted.", + "type": "string", + "format": "google-duration" + }, + "pubsubNotificationSettings": { + "description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a\nspecified trigger occurs, Insights will notify the corresponding Pub/Sub\ntopic.\n\nKeys are notification triggers. Supported keys are:\n\n* \"all-triggers\": Notify each time any of the supported triggers occurs.\n* \"create-analysis\": Notify each time an analysis is created.\n* \"create-conversation\": Notify each time a conversation is created.\n* \"export-insights-data\": Notify each time an export is complete.\n* \"ingest-conversations\": Notify each time an IngestConversations LRO is\ncomplete.\n* \"update-conversation\": Notify each time a conversation is updated via\nUpdateConversation.\n* \"upload-conversation\": Notify when an UploadConversation LRO is complete.\n* \"update-or-analyze-conversation\": Notify when an analysis for a\nconversation is completed or when the conversation is updated. The message\nwill contain the conversation with transcript, analysis and other metadata.\n\nValues are Pub/Sub topics. The format of each Pub/Sub topic is:\nprojects/{project}/topics/{topic}", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "analysisConfig": { + "description": "Default analysis settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig" + }] + }, + "enableCustomerAgentDetection": { + "description": "Whether to enable customer-agent detection. If specified, then Insights\nwill infer which speakers are customers and which are agents when a\nconversation is created. If a conversation specifies the roles of the\nspeakers, then those roles will be used instead of the detection.", + "type": "boolean" + }, + "redactionConfig": { + "description": "Default DLP redaction resources to be applied while ingesting\nconversations. This applies to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversations coming from CCAI Platform.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig" + }] + }, + "speechConfig": { + "description": "Optional. Default Speech-to-Text resources to use while ingesting audio files.\nOptional, CCAI Insights will create a default if not provided. This applies\nto conversations ingested from the `UploadConversation` and\n`IngestConversations` endpoints, including conversations coming from CCAI\nPlatform.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig" + }] + }, + "screenRecordingBucketUri": { + "description": "Optional. The path to a Cloud Storage bucket containing conversation screen\nrecordings. If provided, Insights will search in the bucket for a screen\nrecording file matching the conversation data source object name prefix. If\nmatches are found, these file URIs will be stored in the conversation\nscreen recordings field.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig": { + "description": "Default configuration when creating Analyses in Insights.", + "type": "object", + "properties": { + "runtimeIntegrationAnalysisPercentage": { + "description": "Percentage of conversations created using Dialogflow runtime integration\nto analyze automatically, between [0, 100].", + "type": "number", + "format": "double" + }, + "uploadConversationAnalysisPercentage": { + "description": "Percentage of conversations created using the UploadConversation endpoint\nto analyze automatically, between [0, 100].", + "type": "number", + "format": "double" + }, + "smartHighlightCustomAgent": { + "description": "Unique ID of the custom Dialogflow agent that is used to produce Smart\nHighlights in addition to the default IDs.\nFormat:\nprojects/{project_id}/locations/{location}/agents/{agent}", + "type": "string" + }, + "disableIssueModeling": { + "description": "Whether to disable issue model inference during analysis.\nBy default issue modeling will be included in analysis if there is an\nactive issue model for the project.", + "deprecated": true, + "type": "boolean" + }, + "annotatorSelector": { + "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1AnalysisRule": { + "description": "The CCAI Insights project wide analysis rule. This rule will be applied to\nall conversations that match the filter defined in the rule. For a\nconversation matches the filter, the annotators specified in the rule will be\nrun. If a conversation matches multiple rules, a union of all the annotators\nwill be run. One project can have multiple analysis rules.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The resource name of the analysis rule.\nFormat:\nprojects/{project}/locations/{location}/analysisRules/{analysis_rule}", + "x-google-identifier": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this analysis rule was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which this analysis rule was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "displayName": { + "description": "Display Name of the analysis rule.", + "type": "string" + }, + "conversationFilter": { + "description": "Filter for the conversations that should apply this analysis\nrule. An empty filter means this analysis rule applies to all\nconversations.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", + "type": "string" + }, + "annotatorSelector": { + "description": "Selector of annotators to run and the phrase matchers to use for\nconversations that matches the conversation_filter. If not specified, NO\nannotators will be run.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector" + }] + }, + "analysisPercentage": { + "description": "Percentage of conversations that we should apply this analysis setting\nautomatically, between [0, 1]. For example, 0.1 means 10%. Conversations\nare sampled in a determenestic way. The original runtime_percentage &\nupload percentage will be replaced by defining filters on the conversation.", + "type": "number", + "format": "double" + }, + "active": { + "description": "If true, apply this rule to conversations. Otherwise, this rule is\ninactive and saved as a draft.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse": { + "description": "The response of listing views.", + "type": "object", + "properties": { + "analysisRules": { + "description": "The analysis_rule that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListAutoLabelingRulesResponse": { + "description": "The response message for listing auto labeling rules.", + "type": "object", + "properties": { + "autoLabelingRules": { + "description": "The auto labeling rules.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1AutoLabelingRule": { + "description": "Rule for auto-labeling conversations.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The resource name of the auto-labeling rule.\nFormat:\nprojects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", + "x-google-identifier": true, + "type": "string" + }, + "active": { + "description": "Whether the rule is active.", + "type": "boolean" + }, + "displayName": { + "description": "The user-provided display name of the rule.", + "type": "string" + }, + "description": { + "description": "The description of the rule.", + "type": "string" + }, + "labelKeyType": { + "description": "The type of the label key.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified label key type.", + "The label key is custom defined by the user." + ], + "enum": [ + "LABEL_KEY_TYPE_UNSPECIFIED", + "LABEL_KEY_TYPE_CUSTOM" + ] + }, + "labelKey": { + "description": "The label key. This is also the {auto_labeling_rule} in the resource name.\nOnly settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.", + "type": "string" + }, + "conditions": { + "description": "Conditions to apply for auto-labeling the label_key.\nRepresenting sequential block of if .. else if .. else statements.\nThe value of the first matching condition will be used.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRuleLabelingCondition" + } + }, + "createTime": { + "description": "Output only. The time at which this rule was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the rule was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1AutoLabelingRuleLabelingCondition": { + "description": "Condition for auto-labeling conversations.", + "type": "object", + "properties": { + "condition": { + "description": "A optional CEL expression to be evaluated as a boolean value.\nOnce evaluated as true, then we will proceed with the value evaluation.\nAn empty condition will be auto evaluated as true.", + "type": "string" + }, + "value": { + "description": "CEL expression to be evaluated as the value.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleRequest": { + "description": "The request message for testing auto labeling rules.", + "type": "object", + "properties": { + "conversation": { + "description": "Required. Conversation data to test rules against.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + }] + }, + "autoLabelingRule": { + "description": "Required. The auto labeling rule to test.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" + }] + } + }, + "required": [ + "conversation", + "autoLabelingRule" + ] + }, + "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleResponse": { + "description": "The response message for testing auto labeling rules.", + "type": "object", + "properties": { + "labelResult": { + "description": "The result of the test auto labeling rule.", + "type": "string" + } + } + }, + "description": "The CCAI Insights project wide assessment rule. This assessment rule will be\napplied to all conversations from the previous sampling cycle that match the\nsample rule defined in the assessment rule. One project can have multiple\nassessment rules.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The resource name of the assessment rule.\nFormat:\nprojects/{project}/locations/{location}/assessmentRules/{assessment_rule}", + "x-google-identifier": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this assessment rule was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which this assessment rule was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "active": { + "description": "If true, apply this rule to conversations. Otherwise, this rule is\ninactive.", + "type": "boolean" + }, + "displayName": { + "description": "Display Name of the assessment rule.", + "type": "string" + }, + "sampleRule": { + "description": "The sample rule for the assessment rule.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleRule" + }] + }, + "scheduleInfo": { + "description": "Schedule info for the assessment rule.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ScheduleInfo" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ScheduleInfo": { + "description": "Message for schedule info.", + "type": "object", + "properties": { + "startTime": { + "description": "Start time of the schedule. If not specified, will start as soon as the\nschedule is created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "End time of the schedule. If not specified, will keep scheduling new\npipelines for execution util the schedule is no longer active or deleted.", + "type": "string", + "format": "date-time" + }, + "schedule": { + "description": "The groc expression.\nFormat: `every number [synchronized]`\nTime units can be: minutes, hours\nSynchronized is optional and indicates that the schedule should be\nsynchronized to the start of the interval: every 5 minutes synchronized\nmeans 00:00, 00:05 ...\nOtherwise the start time is random within the interval.\nExample: `every 5 minutes`\ncould be 00:02, 00:07, 00:12, ...", + "type": "string" + }, + "timeZone": { + "description": "The timezone to use for the groc expression.\nIf not specified, defaults to UTC.", + "type": "string" + } + } + }, + "description": "The response of listing assessment rules.", + "type": "object", + "properties": { + "assessmentRules": { + "description": "The assessment rules that match the request.", + "type": "array", + "items": { + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all\ncreated resources (e.g. `Conversation`).", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the encryption key specification resource.\nFormat:\nprojects/{project}/locations/{location}/encryptionSpec", + "x-google-immutable": true, + "type": "string" + }, + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to\nsecure a resource and its sub-resources. If empty, the resource is secured\nby our default encryption key. Only the key in the same location as this\nresource is allowed to be used for encryption. Format:\n`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + } + }, + "required": [ + "kmsKey" + ] + }, + "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "type": "object", + "properties": { + "encryptionSpec": { + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms\nkey is in the same region as the endpoint. The same key will be used for\nall provisioned resources, if encryption is available. If the\n`kms_key_name` field is left empty, no encryption will be enforced.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec" + }] + } + }, + "required": [ + "encryptionSpec" + ] + }, + "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { + "description": "The response to initialize a location-level encryption specification.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for initialization.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during initializing operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1View": { + "description": "The View resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the view.\nFormat:\nprojects/{project}/locations/{location}/views/{view}", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The human-readable display name of the view.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this view was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the view was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "value": { + "description": "A filter to reduce conversation results to a specific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListViewsResponse": { + "description": "The response of listing views.", + "type": "object", + "properties": { + "views": { + "description": "The views that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryMetricsRequest": { + "description": "The request for querying metrics.", + "type": "object", + "properties": { + "filter": { + "description": "Required. Filter to select a subset of conversations to compute the metrics. Must\nspecify a window of the conversation create time to compute the metrics.\nThe returned metrics will be from the range\n[DATE(starting create time), DATE(ending create time)).", + "type": "string" + }, + "timeGranularity": { + "description": "The time granularity of each data point in the time series.\nDefaults to NONE if this field is unspecified.", + "type": "string", + "x-google-enum-descriptions": [ + "The time granularity is unspecified and will default to NONE.", + "No time granularity. The response won't contain a time series.\nThis is the default value if no time granularity is specified.", + "Data points in the time series will aggregate at a daily granularity.\n1 day means [midnight to midnight).", + "Data points in the time series will aggregate at a daily granularity.\n1 HOUR means [01:00 to 02:00).", + "Data points in the time series will aggregate at a daily granularity.\nPER_MINUTE means [01:00 to 01:01).", + "Data points in the time series will aggregate at a 1 minute granularity.\nPER_5_MINUTES means [01:00 to 01:05).", + "Data points in the time series will aggregate at a monthly granularity.\n1 MONTH means [01st of the month to 1st of the next month)." + ], + "enum": [ + "TIME_GRANULARITY_UNSPECIFIED", + "NONE", + "DAILY", + "HOURLY", + "PER_MINUTE", + "PER_5_MINUTES", + "MONTHLY" + ] + }, + "dimensions": { + "description": "The dimensions that determine the grouping key for the query. Defaults to\nno dimension if this field is unspecified. If a dimension is specified,\nits key must also be specified. Each dimension's key must be unique.\n\nIf a time granularity is also specified, metric values in the dimension\nwill be bucketed by this granularity.\n\nUp to one dimension is supported for now.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dimension" + } + }, + "measureMask": { + "description": "Measures to return. Defaults to all measures if this field is unspecified.\nA valid mask should traverse from the `measure` field from the response.\nFor example, a path from a measure mask to get the conversation count is\n\"conversation_measure.count\".", + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + }, + "required": [ + "filter" + ] + }, + "GoogleCloudContactcenterinsightsV1Dimension": { + "description": "A dimension determines the grouping key for the query. In SQL terms, these\nwould be part of both the \"SELECT\" and \"GROUP BY\" clauses.", + "type": "object", + "properties": { + "issueDimensionMetadata": { + "description": "Output only. Metadata about the issue dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata" + }] + }, + "agentDimensionMetadata": { + "description": "Output only. Metadata about the agent dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata" + }] + }, + "qaQuestionDimensionMetadata": { + "description": "Output only. Metadata about the QA question dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata" + }] + }, + "qaQuestionAnswerDimensionMetadata": { + "description": "Output only. Metadata about the QA question-answer dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata" + }] + }, + "qaScorecardDimensionMetadata": { + "description": "Output only. Metadata about the QA scorecard dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata" + }] + }, + "conversationProfileDimensionMetadata": { + "description": "Output only. Metadata about the conversation profile dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata" + }] + }, + "mediumDimensionMetadata": { + "description": "Output only. Metadata about the conversation medium dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata" + }] + }, + "conversationalAgentsPlaybookDimensionMetadata": { + "description": "Output only. Metadata about the Conversational Agents playbook dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata" + }] + }, + "conversationalAgentsToolDimensionMetadata": { + "description": "Output only. Metadata about the Conversational Agents tool dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata" + }] + }, + "clientSentimentCategoryDimensionMetadata": { + "description": "Output only. Metadata about the client sentiment category dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata" + }] + }, + "agentAssistSupervisorDimensionMetadata": { + "description": "Output only. Metadata about the supervisor for virtual agents dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionAgentAssistSupervisorDimensionMetadata" + }] + }, + "labelDimensionMetadata": { + "description": "Output only. Metadata about conversation labels.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata" + }] + }, + "dimensionKey": { + "description": "The key of the dimension.", + "type": "string", + "x-google-enum-descriptions": [ + "The key of the dimension is unspecified.", + "The dimension is keyed by issues.", + "The dimension is keyed by issue names.", + "The dimension is keyed by agents.", + "The dimension is keyed by agent teams.", + "The dimension is keyed by QaQuestionIds.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing stats for\nthe same question across different scorecard revisions.", + "The dimension is keyed by QaQuestionIds-Answer value pairs.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing\ndistribution of answers per question across different scorecard\nrevisions.", + "The dimension is keyed by QaScorecardIds.\nNote that: We only group by the ScorecardId and not the revision-id of\nthe scorecard. This allows for showing stats for the same scorecard\nacross different revisions.\nThis metric is mostly only useful if querying the average normalized\nscore per scorecard.", + "The dimension is keyed by the conversation profile ID.", + "The dimension is keyed by the conversation medium.", + "The dimension is keyed by the Conversational Agents playbook ID.", + "The dimension is keyed by the Conversational Agents playbook display\nname.", + "The dimension is keyed by the Conversational Agents tool ID.", + "The dimension is keyed by the Conversational Agents tool display name.", + "The dimension is keyed by the client sentiment category.", + "The dimension is keyed by the agent version ID.", + "The dimension is keyed by the agent deployment ID.", + "The dimension is keyed by the supervisor ID of the assigned human\nsupervisor for virtual agents.", + "The dimension is keyed by label keys.", + "The dimension is keyed by label values.", + "The dimension is keyed by label key-value pairs." + ], + "enum": [ + "DIMENSION_KEY_UNSPECIFIED", + "ISSUE", + "ISSUE_NAME", + "AGENT", + "AGENT_TEAM", + "QA_QUESTION_ID", + "QA_QUESTION_ANSWER_VALUE", + "QA_SCORECARD_ID", + "CONVERSATION_PROFILE_ID", + "MEDIUM", + "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", + "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", + "CONVERSATIONAL_AGENTS_TOOL_ID", + "CONVERSATIONAL_AGENTS_TOOL_NAME", + "CLIENT_SENTIMENT_CATEGORY", + "AGENT_VERSION_ID", + "AGENT_DEPLOYMENT_ID", + "AGENT_ASSIST_SUPERVISOR_ID", + "LABEL_KEY", + "LABEL_VALUE", + "LABEL_KEY_AND_VALUE" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata": { + "description": "Metadata about the issue dimension.", + "type": "object", + "properties": { + "issueId": { + "description": "The issue ID.", + "type": "string" + }, + "issueDisplayName": { + "description": "The issue display name.", + "type": "string" + }, + "issueModelId": { + "description": "The parent issue model ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata": { + "description": "Metadata about the agent dimension.", + "type": "object", + "properties": { + "agentId": { + "description": "Optional. A user-specified string representing the agent.\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentDisplayName": { + "description": "Optional. The agent's name\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentTeam": { + "description": "Optional. A user-specified string representing the agent's team.", + "type": "string" + }, + "agentVersionDisplayName": { + "description": "Optional. The agent's version display name. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentVersionId": { + "description": "Optional. The agent's version ID. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentDeploymentDisplayName": { + "description": "Optional. The agent's deployment display name. Only applicable to automated agents.\nThis will be populated for AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentDeploymentId": { + "description": "Optional. The agent's deployment ID. Only applicable to automated agents.\nThis will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata": { + "description": "Metadata about the QA question dimension.", + "type": "object", + "properties": { + "qaScorecardId": { + "description": "Optional. The QA scorecard ID.", + "type": "string" + }, + "qaQuestionId": { + "description": "Optional. The QA question ID.", + "type": "string" + }, + "questionBody": { + "description": "Optional. The full body of the question.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata": { + "description": "Metadata about the QA question-answer dimension.\nThis is useful for showing the answer distribution for questions for a\ngiven scorecard.", + "type": "object", + "properties": { + "qaScorecardId": { + "description": "Optional. The QA scorecard ID.", + "type": "string" + }, + "qaQuestionId": { + "description": "Optional. The QA question ID.", + "type": "string" + }, + "questionBody": { + "description": "Optional. The full body of the question.", + "type": "string" + }, + "answerValue": { + "description": "Optional. The full body of the question.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata": { + "description": "Metadata about the QA scorecard dimension.", + "type": "object", + "properties": { + "qaScorecardId": { + "description": "Optional. The QA scorecard ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata": { + "description": "Metadata about the conversation profile dimension.", + "type": "object", + "properties": { + "conversationProfileId": { + "description": "Optional. The conversation profile ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata": { + "description": "Metadata about the conversation medium dimension.", + "type": "object", + "properties": { + "medium": { + "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata": { + "description": "Metadata about the Conversational Agents playbook dimension.", + "type": "object", + "properties": { + "playbookId": { + "description": "Optional. The dialogflow playbook ID.", + "type": "string" + }, + "playbookDisplayName": { + "description": "Optional. The dialogflow playbook display name.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata": { + "description": "Metadata about the Conversational Agents tool dimension.", + "type": "object", + "properties": { + "toolId": { + "description": "Optional. The dialogflow tool ID.", + "type": "string" + }, + "toolDisplayName": { + "description": "Optional. The dialogflow tool display name.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata": { + "description": "Metadata about the client sentiment category dimension.", + "type": "object", + "properties": { + "sentimentCategory": { + "description": "Optional. The client sentiment category.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionAgentAssistSupervisorDimensionMetadata": { + "description": "Metadata about AA's human supervisor dimension.", + "type": "object", + "properties": { + "supervisorId": { + "description": "Optional. ID of the assigned supervisor.", + "type": "string" + }, + "supervisorUsername": { + "description": "Optional. User name of the assigned supervisor.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata": { + "description": "Metadata about conversation labels.", + "type": "object", + "properties": { + "labelKey": { + "description": "Optional. The label key.", + "type": "string" + }, + "labelValue": { + "description": "Optional. The label value.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryMetricsResponse": { + "description": "The response for querying metrics.", + "type": "object", + "properties": { + "location": { + "description": "Required. The location of the data.\n\"projects/{project}/locations/{location}\"", + "type": "string" + }, + "updateTime": { + "description": "The metrics last update time.", + "type": "string", + "format": "date-time" + }, + "slices": { + "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" + } + }, + "macroAverageSlice": { + "description": "The macro average slice contains aggregated averages across all selected\ndimensions. i.e. if group_by agent and scorecard_id is specified, this\nfield will contain the average across all agents and all scorecards. This\nfield is only populated if the request specifies a Dimension.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" + }] + } + }, + "required": [ + "location" + ] + }, + "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice": { + "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.\n\nFor example, if the request specifies a single ISSUE dimension and it has a\ncardinality of 2 (i.e. the data used to compute the metrics has 2 issues in\ntotal), the response will have 2 slices:\n\n* Slice 1 -> dimensions=[Issue 1]\n* Slice 2 -> dimensions=[Issue 2]", + "type": "object", + "properties": { + "dimensions": { + "description": "A unique combination of dimensions that this slice represents.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dimension" + } + }, + "total": { + "description": "The total metric value. The interval of this data point is\n[starting create time, ending create time) from the request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" + }] + }, + "timeSeries": { + "description": "A time series of metric values. This is only populated if the request\nspecifies a time granularity other than NONE.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint": { + "description": "A data point contains the metric values mapped to an interval.", + "type": "object", + "properties": { + "conversationMeasure": { + "description": "The measure related to conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure" + }] + }, + "dialogflowInteractionMeasure": { + "description": "The measure related to dialogflow interactions.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" + }] + }, + "interval": { + "description": "The interval that this data point represents.\n\n* If this is the total data point, the interval is\n[starting create time, ending create time) from the request.\n* If this a data point from the time series, the interval is\n[time, time + time granularity from the request).", + "allOf": [{ + "$ref": "#/components/schemas/GoogleTypeInterval" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure": { + "description": "The measure related to conversations.", + "type": "object", + "properties": { + "conversationCount": { + "description": "The conversation count.", + "type": "integer", + "format": "int32" + }, + "averageSilencePercentage": { + "description": "The average silence percentage.", + "type": "number", + "format": "float" + }, + "averageDuration": { + "description": "The average duration.", + "type": "string", + "format": "google-duration" + }, + "averageTurnCount": { + "description": "The average turn count.", + "type": "number", + "format": "float" + }, + "averageAgentSentimentScore": { + "description": "The average agent's sentiment score.", + "type": "number", + "format": "float" + }, + "averageClientSentimentScore": { + "description": "The average client's sentiment score.", + "type": "number", + "format": "float" + }, + "averageCustomerSatisfactionRating": { + "description": "The average customer satisfaction rating.", + "type": "number", + "format": "double" + }, + "averageQaNormalizedScore": { + "description": "The average normalized QA score for a scorecard. When computing the\naverage across a set of conversations, if a conversation has been\nevaluated with multiple revisions of a scorecard, only the latest\nrevision results will be used. Will exclude 0's in average\ncalculation. Will be only populated if the request specifies a\ndimension of QA_SCORECARD_ID.", + "type": "number", + "format": "double" + }, + "qaTagScores": { + "description": "Average QA normalized score for all the tags.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" + } + }, + "averageQaQuestionNormalizedScore": { + "description": "Average QA normalized score averaged for questions averaged across\nall revisions of the parent scorecard.\nWill be only populated if the request specifies a dimension of\nQA_QUESTION_ID.", + "type": "number", + "format": "double" + }, + "knowledgeSearchResultCount": { + "description": "Count of knowledge search results (Generative Knowledge\nAssist) shown to the user.", + "type": "integer", + "format": "int32" + }, + "knowledgeSearchAgentQuerySourceRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nmade by the agent compared to the total number of knowledge search\nqueries made.", + "type": "number", + "format": "double" + }, + "knowledgeSearchSuggestedQuerySourceRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nsuggested compared to the total number of knowledge search\nqueries made.", + "type": "number", + "format": "double" + }, + "knowledgeAssistResultCount": { + "description": "Count of knowledge assist results (Proactive Generative Knowledge\nAssist) shown to the user.", + "type": "integer", + "format": "int32" + }, + "knowledgeSearchUriClickRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had a URL clicked.", + "type": "number", + "format": "double" + }, + "knowledgeAssistUriClickRatio": { + "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had a URL clicked.", + "type": "number", + "format": "double" + }, + "knowledgeSearchPositiveFeedbackRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had positive feedback.", + "type": "number", + "format": "double" + }, + "knowledgeSearchNegativeFeedbackRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had negative feedback.", + "type": "number", + "format": "double" + }, + "knowledgeAssistPositiveFeedbackRatio": { + "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had positive feedback.", + "type": "number", + "format": "double" + }, + "knowledgeAssistNegativeFeedbackRatio": { + "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had negative feedback.", + "type": "number", + "format": "double" + }, + "summarizationSuggestionEditRatio": { + "description": "Proportion of summarization suggestions that were manually edited.", + "type": "number", + "format": "double" + }, + "averageSummarizationSuggestionEditDistance": { + "description": "Average edit distance of the summarization suggestions. Edit\ndistance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion.", + "type": "number", + "format": "double" + }, + "averageSummarizationSuggestionNormalizedEditDistance": { + "description": "Normalized Average edit distance of the summarization suggestions.\nEdit distance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion. Normalized edit distance is the average of (edit distance\n/ summary length).", + "type": "number", + "format": "double" + }, + "conversationSuggestedSummaryRatio": { + "description": "Proportion of conversations that had a suggested summary.", + "type": "number", + "format": "double" + }, + "summarizationSuggestionResultCount": { + "description": "Count of summarization suggestions results.", + "type": "integer", + "format": "int32" + }, + "dialogflowInteractionsNoMatchRatio": { + "description": "Proportion of dialogflow interactions that has no intent match for\nthe input.", + "type": "number", + "format": "double" + }, + "dialogflowInteractionsNoInputRatio": { + "description": "Proportion of dialogflow interactions that has empty input.", + "type": "number", + "format": "double" + }, + "dialogflowWebhookFailureRatio": { + "description": "Proportion of dialogflow webhook calls that failed.", + "type": "number", + "format": "double" + }, + "dialogflowWebhookTimeoutRatio": { + "description": "Proportion of dialogflow webhook calls that timed out.", + "type": "number", + "format": "double" + }, + "dialogflowAverageWebhookLatency": { + "description": "Average latency of dialogflow webhook calls.", + "type": "number", + "format": "double" + }, + "dialogflowConversationsEscalationRatio": { + "description": "Proportion of conversations that was handed off from virtual agent to\nhuman agent.", + "type": "number", + "format": "double" + }, + "dialogflowConversationsEscalationCount": { + "description": "count of conversations that was handed off from virtual agent to\nhuman agent.", + "type": "number", + "format": "double" + }, + "conversationalAgentsToolCallSuccessRatio": { + "description": "Proportion of conversational agents' tool calls that were successful.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageToolCallLatency": { + "description": "Average latency of conversational agents' tool calls.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageTtsLatency": { + "description": "The macro average latency of conversational agents' TTS latency\nper interaction.\nThis is computed as the average of the all the interactions' TTS\nlatencies in a conversation and averaged across conversations.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageLlmCallLatency": { + "description": "The average latency of conversational agents' LLM call latency\nper interaction. This is computed as the average of the all the\ninteractions LLM call latencies in a conversation and averaged across\nconversations.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageAudioInAudioOutLatency": { + "description": "The average latency of conversational agents' audio in audio\nout latency per interaction.\nThis is computed as the average of the all the interactions' audio in\naudio out latencies in a conversation and averaged across\nconversations.", + "type": "number", + "format": "double" + }, + "conversationAiCoachSuggestionRatio": { + "description": "Proportion of conversations that has Ai Coach Suggestions.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionAgentUsageRatio": { + "description": "Proportion of Ai Coach Suggestion that has been used by agents.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionCustomerMessageTriggerRatio": { + "description": "Proportion of customer messages that triggered an Ai Coach\nSuggestion.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageEndToEndLatency": { + "description": "The average latency of conversational agents' latency per\ninteraction. This is computed as the average of the all the\niteractions' end to end latencies in a conversation and averaged\nacross conversations. The e2e latency is the time between the end of\nthe user utterance and the start of the agent utterance on the\ninteraction level.", + "type": "number", + "format": "double" + }, + "conversationAiCoachSuggestionCount": { + "description": "Count of conversations that has Ai Coach Suggestions.", + "type": "integer", + "format": "int32" + }, + "aiCoachSuggestionAgentUsageCount": { + "description": "Count of Ai Coach Suggestion that has been used by agents.", + "type": "integer", + "format": "int32" + }, + "aiCoachSuggestionCustomerMessageTriggerCount": { + "description": "Count of customer messages that triggered an Ai Coach\nSuggestion.", + "type": "integer", + "format": "int32" + }, + "aiCoachSuggestionAgentMessageTriggerCount": { + "description": "Count of agent messages that triggered an Ai Coach Suggestion.", + "type": "integer", + "format": "int32" + }, + "conversationTotalCustomerMessageCount": { + "description": "The customer message count.", + "type": "integer", + "format": "int32" + }, + "conversationTotalAgentMessageCount": { + "description": "The agent message count.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorMonitoredConversationsCount": { + "description": "The number of conversations scanned by the AA human supervisor.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorEscalatedConversationsCount": { + "description": "The number of conversations that were escalated to an AA human\nsupervisor for intervention.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorAssignedConversationsCount": { + "description": "The number of conversations that were assigned to an AA human\nsupervisor.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorDroppedConversationsCount": { + "description": "The number of conversations that were dropped, i.e. escalated but not\nassigned to an AA human supervisor.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorTransferredToHumanAgentConvCount": { + "description": "The number of conversations transferred to a human agent.", + "type": "integer", + "format": "int32" + }, + "avgConversationClientTurnSentimentEma": { + "description": "The exponential moving average of the sentiment score of client turns\nin the conversation.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionMessageTriggerRatio": { + "description": "Proportion of end_of_utterance trigger event messages that triggered\nan Ai Coach Suggestion.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionMessageTriggerCount": { + "description": "Count of end_of_utterance trigger event messages that triggered an Ai\nCoach Suggestion.", + "type": "integer", + "format": "int32" + }, + "containedConversationCount": { + "description": "The number of conversations that were contained.", + "type": "integer", + "format": "int32" + }, + "containedConversationRatio": { + "description": "The percentage of conversations that were contained.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { + "description": "Average QA normalized score for the tag.", + "type": "object", + "properties": { + "tag": { + "description": "Tag name.", + "type": "string" + }, + "averageTagNormalizedScore": { + "description": "Average tag normalized score per tag.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { + "description": "The measure related to dialogflow interactions.", + "type": "object", + "properties": { + "percentileAudioInAudioOutLatency": { + "description": "The percentile result for audio in audio out latency in milliseconds\nper dialogflow interaction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileLlmCallLatency": { + "description": "The percentile result for LLM latency in milliseconds per dialogflow\ninteraction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileTtsLatency": { + "description": "The percentile result for TTS latency in milliseconds per dialogflow\ninteraction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileToolUseLatency": { + "description": "The percentile result for tool use latency in milliseconds per\ndialogflow interaction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileEndToEndLatency": { + "description": "The percentile result for end to end chat latency in milliseconds per\ndialogflow interaction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult": { + "description": "The percentile result. Currently supported percentiles are 50th, 90th,\nand 99th.", + "type": "object", + "properties": { + "p50": { + "description": "The 50th percentile value.", + "type": "number", + "format": "double" + }, + "p90": { + "description": "The 90th percentile value.", + "type": "number", + "format": "double" + }, + "p99": { + "description": "The 99th percentile value.", + "type": "number", + "format": "double" + } + } + }, + "GoogleTypeInterval": { + "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a\nTimestamp end (exclusive).\n\nThe start must be less than or equal to the end.\nWhen the start equals the end, the interval is empty (matches no time).\nWhen both start and end are unspecified, the interval matches any time.", + "type": "object", + "properties": { + "startTime": { + "description": "Optional. Inclusive start of the interval.\n\nIf specified, a Timestamp matching this interval will have to be the same\nor after the start.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Optional. Exclusive end of the interval.\n\nIf specified, a Timestamp matching this interval will have to be before the\nend.", + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries": { + "description": "A time series of metric values.", + "type": "object", + "properties": { + "dataPoints": { + "description": "The data points that make up the time series .", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata": { + "description": "The metadata from querying metrics.", + "type": "object", + "properties": { + "resultIsTruncated": { + "description": "Whether the result rows were truncated because the result row size is too\nlarge to materialize.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsRequest": { + "description": "The request for generative insights.", + "type": "object", + "properties": { + "naturalLanguageQuery": { + "description": "The natural language query specified by the user. If this field is\nspecified, `sql_query` will be ignored.", + "type": "string" + }, + "chart": { + "description": "The full name of the chart resource this request corresponds to.\nFormat:\nprojects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", + "type": "string" + }, + "filter": { + "description": "Filter for the data that can be specified in addition to the natural\nlanguage query. Users are encouraged to use this field to populate\ntime-windows.", + "type": "string" + }, + "comparisonFilter": { + "description": "Optional. Filter for the data that can be specified in addition to the natural\nlanguage query. This `filter` is specifically used for charts where\ncomparisons are possible. For example, \"compare to last month\" or\n\"compare to previous quarter\".", + "type": "string" + }, + "sqlQuery": { + "description": "Optional. The SQL query specified by the user. This query must be in BigQuery SQL\ndialect. The `filter` field will also be ignored, as it is assumed that\nany filtering is already included in the SQL query.", + "type": "string" + }, + "sqlComparisonKey": { + "description": "Optional. For charts with comparison, this key will determine the metric that will be\ncompared between the current and another dataset.", + "type": "string" + }, + "sessionId": { + "description": "Optional. The session id of the conversation. If the session id is not specified,\nbackend will generate a random session id. If the session id is specified,\nwill associate user-provided user_query with the provided session id.", + "type": "string" + }, + "revisionId": { + "description": "Optional. The revision id that maps to the state of the chart state revision.\nWhen specified, the backend will reload the chart with the sql and visual\nspec from that revision.", + "type": "string" + }, + "userProvidedChartSpec": { + "description": "Optional. The user provided chart spec for the chart. This will be used to override\nthe visual spec generated by the LLM.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse": { + "description": "The response for generative insights.", + "type": "object", + "properties": { + "generativeResponses": { + "description": "The full list of generative responses.\nEach response is ordered by time.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse" + } + }, + "transcript": { + "description": "The transcript of the generative insights conversation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse": { + "description": "Wrapper for storing the generative response for a chart.", + "type": "object", + "properties": { + "textOutput": { + "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", + "deprecated": true, + "type": "string" + }, + "generatedSqlQuery": { + "description": "The generated SQL query from the LLM. Will be populated during the\nchart building phase. The generated SQL will be cached in the\ncorresponding chart resource.", + "type": "string" + }, + "chartSpec": { + "description": "The chart spec for the data.\nThis will be specified in the vega-lite or vega format.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "textMessage": { + "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput": { + "description": "Wrapper for text output.", + "type": "object", + "properties": { + "text": { + "description": "The text output from the LLM.", + "type": "array", + "items": { + "type": "string" + } + }, + "textType": { + "description": "The type of text output.", + "type": "string", + "x-google-enum-descriptions": [ + "The type is unspecified.", + "The text is part of LLM reasoning.", + "The text is the final answer from LLM.", + "The text is an informational message about the agent's progress, such\nas a tool being invoked. This is distinct from the agent's internal\nthought process (`THOUGHT`) and the final answer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the agent's\nactions." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "THOUGHT", + "FINAL_RESPONSE", + "PROGRESS" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript": { + "description": "The conversation transcript for the chart.", + "type": "object", + "properties": { + "conversationId": { + "description": "The conversation id of the chart.", + "type": "string" + }, + "createTime": { + "description": "Output only. The create time of the conversation.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The update time of the conversation.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "messages": { + "description": "Ordered list of messages, including user inputs and system responses.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage": { + "description": "The message in the conversation.", + "type": "object", + "properties": { + "userMessage": { + "description": "A message from the user that is interacting with the system.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage" + }] + }, + "systemMessageWrapper": { + "description": "A wrapper for system messages per turn.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages" + }] + }, + "messageId": { + "description": "The message id of the message.", + "type": "string" + }, + "createTime": { + "description": "Output only. For user messages, this is the time at which the system received the\nmessage. For system messages, this is the time at which the system\ngenerated the message.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage": { + "description": "The user message.", + "type": "object", + "properties": { + "text": { + "description": "A message from the user that is interacting with the system.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages": { + "description": "A wrapper for system messages per turn.", + "type": "object", + "properties": { + "systemMessages": { + "description": "A message from the system in response to the user.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage": { + "description": "A message from the system in response to the user. This message can\nalso be a message from the user as historical context for multiturn\nconversations with the system.", + "type": "object", + "properties": { + "textMessage": { + "description": "A direct natural language response to the user message.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" + }] + }, + "generatedSqlQuery": { + "description": "Raw SQL from LLM, before templatization", + "type": "string" + }, + "chartSpec": { + "description": "Chart spec from LLM", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "userProvidedSqlQuery": { + "description": "Optional. User provided SQL query", + "type": "string" + }, + "userProvidedChartSpec": { + "description": "Optional. User provided chart spec", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { + "description": "A text output message from the system.", + "type": "object", + "properties": { + "text": { + "description": "The parts of the message.", + "type": "array", + "items": { + "type": "string" + } + }, + "textType": { + "description": "The type of the text message.", + "type": "string", + "x-google-enum-descriptions": [ + "The default text type.", + "The text is a thinking plan generated by the thinking tool.", + "The text is a final response to the user question.", + "The text is an informational message about the agent's\nprogress, such as a tool being invoked. This is distinct from\nthe agent's internal thought process (`THOUGHT`) and the final\nanswer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the\nagent's actions." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "THOUGHT", + "FINAL_RESPONSE", + "PROGRESS" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata": { + "description": "The metadata for generative insights.", + "type": "object", + "properties": { + "errorMessages": { + "description": "The error message when the generative insights request fails.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest": { + "description": "The request for summarizing performance according to different metrics for\nconversations over a specified time window.", + "type": "object", + "properties": { + "agentPerformanceSource": { + "description": "Conversations are from a single agent.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequestAgentSource" + }] + }, + "filter": { + "description": "Optional. Filter to select a subset of conversations to compute the performance\noverview. Supports the same filters as the filter field in\nQueryMetricsRequest. The source and query interval/comparison query\ninterval should not be included here.", + "type": "string" + }, + "queryInterval": { + "description": "Required. The time window of the conversations to derive performance stats from.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryInterval" + }] + }, + "comparisonQueryInterval": { + "description": "The time window of the conversations to compare the performance to.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryInterval" + }] + } + }, + "required": [ + "queryInterval" + ] + }, + "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequestAgentSource": { + "description": "The entity whose performance is being queried is a single agent.", + "type": "object", + "properties": { + "agentId": { + "description": "Required. Agent id to query performance overview for.", + "type": "string" + } + }, + "required": [ + "agentId" + ] + }, + "GoogleCloudContactcenterinsightsV1QueryInterval": { + "description": "A time window for querying conversations.", + "type": "object", + "properties": { + "startTime": { + "description": "Required. The start time of the time window.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Required. The end time of the time window.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "startTime", + "endTime" + ] + }, + "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse": { + "description": "The response for querying performance overview.", + "type": "object", + "properties": { + "summaryText": { + "description": "The summary text of the performance.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata": { + "description": "The metadata for querying performance overview.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1QaQuestion": { + "description": "A single question to be scored by the Insights QA feature.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The resource name of the question.\nFormat:\nprojects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", + "x-google-identifier": true, + "type": "string" + }, + "abbreviation": { + "description": "Short, descriptive string, used in the UI where it's not practical\nto display the full question body. E.g., \"Greeting\".", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this question was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the question was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "questionType": { + "description": "The type of question.", + "type": "string", + "x-google-enum-descriptions": [ + "The type of the question is unspecified.", + "The default question type. The question is fully customizable by the\nuser.", + "The question type is using a predefined model provided by CCAI\nteams. Users are not allowed to edit the question_body, answer_choices,\nupload feedback labels for the question nor fine-tune the question.\nHowever, users may edit other fields like question tags, question order,\netc." + ], + "enum": [ + "QA_QUESTION_TYPE_UNSPECIFIED", + "CUSTOMIZABLE", + "PREDEFINED" + ] + }, + "questionMedium": { + "description": "The medium of the question.", + "type": "string", + "x-google-enum-descriptions": [ + "The medium of the question is unspecified.", + "The question is for chat conversations and will expect a chat transcript\nto be present before scoring.", + "The question is for voice conversations and does NOT expect any chat\ntranscripts to be present before scoring." + ], + "enum": [ + "QA_QUESTION_MEDIUM_UNSPECIFIED", + "CHAT", + "VOICE" + ] + }, + "qaQuestionDataOptions": { + "description": "Options for configuring the data used to generate the QA question.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionQaQuestionDataOptions" + }] + }, + "predefinedQuestionConfig": { + "description": "The configuration of the predefined question. This field will only be set\nif the Question Type is predefined.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionPredefinedQuestionConfig" + }] + }, + "questionBody": { + "description": "Question text. E.g., \"Did the agent greet the customer?\"", + "type": "string" + }, + "answerInstructions": { + "description": "Instructions describing how to determine the answer.", + "type": "string" + }, + "answerChoices": { + "description": "A list of valid answers to the question, which the LLM must choose from.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice" + } + }, + "tags": { + "description": "Questions are tagged for categorization and scoring. Tags can either be:\n- Default Tags: These are predefined categories. They are identified by\ntheir string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\").\n- Custom Tags: These are user-defined categories. They are identified by\ntheir full resource name (e.g.,\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}).\nBoth default and custom tags are used to group questions and to influence\nthe scoring of each question.", + "type": "array", + "items": { + "type": "string" + } + }, + "order": { + "description": "Defines the order of the question within its parent scorecard revision.", + "type": "integer", + "format": "int32" + }, + "metrics": { + "description": "Metrics of the underlying tuned LLM over a holdout/test set while fine\ntuning the underlying LLM for the given question. This field will only be\npopulated if and only if the question is part of a scorecard revision that\nhas been tuned.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionMetrics" + }] + }, + "tuningMetadata": { + "description": "Metadata about the tuning operation for the question.This field will only\nbe populated if and only if the question is part of a scorecard revision\nthat has been tuned.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1QaQuestionQaQuestionDataOptions": { + "description": "Options for configuring the data used to generate the QA question.", + "type": "object", + "properties": { + "conversationDataOptions": { + "description": "Options for configuring the conversation data used to generate the QA\nquestion.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataOptions" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ConversationDataOptions": { + "description": "Options for configuring what metadata is included in the conversation data\nused in QAI and Discovery Engine.", + "type": "object", + "properties": { + "includeDialogflowInteractionData": { + "description": "Whether to include the per turn Dialogflow interaction data in conversation\ntranscript.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1QaQuestionPredefinedQuestionConfig": { + "description": "Configuration for a predefined question. This field will only be set if the\nQuestion Type is predefined.", + "type": "object", + "properties": { + "type": { + "description": "The type of the predefined question.", + "type": "string", + "x-google-enum-descriptions": [ + "The type of the predefined question is unspecified.", + "A prebuilt classifier classfying the outcome of the conversation.\nFor example, if the customer issue mentioned in a conversation has\nbeen resolved or not.", + "A prebuilt classifier classfying the initiator of the conversation\nescalation. For example, if it was initiated by the customer or the\nagent." + ], + "enum": [ + "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", + "CONVERSATION_OUTCOME", + "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice": { + "description": "Message representing a possible answer to the question.", + "type": "object", + "properties": { + "strValue": { + "description": "String value.", + "type": "string" + }, + "numValue": { + "description": "Numerical value.", + "type": "number", + "format": "double" + }, + "boolValue": { + "description": "Boolean value.", + "type": "boolean" + }, + "naValue": { + "description": "A value of \"Not Applicable (N/A)\". If provided, this field may only\nbe set to `true`. If a question receives this answer, it will be\nexcluded from any score calculations.", + "type": "boolean" + }, + "key": { + "description": "A short string used as an identifier.", + "type": "string" + }, + "score": { + "description": "Numerical score of the answer, used for generating the overall score of\na QaScorecardResult. If the answer uses na_value, this field is unused.", + "type": "number", + "format": "double" + }, + "nextActionConfig": { + "description": "Configuration for the next action to take if this answerChoice is\nselected for this question.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfig": { + "description": "The configuration for the next action. This is used to configure the next\naction to take if an answer choice is selected.", + "type": "object", + "properties": { + "runChildQaQuestionsAction": { + "description": "The list of questions to evaluate next, i.e., child questions.\nRequirements for this action are the following:\n1. The current question and child questions must be in the same\n scorecard and present in the same scorecard revision.\n2. The current question and child questions must not introduce a\n cycle, i.e., Q1 -> [Q2, Q3], then Q2 -> [Q1] should not be\n allowed, where Q1, Q2, and Q3 are questions.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction" + }] + }, + "terminateChildQaQuestionsAction": { + "description": "Terminate any further evaluation of child questions.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction": { + "description": "The configuration for evaluating child questions.", + "type": "object", + "properties": { + "childQaQuestionNames": { + "description": "A list of resource names representing the child questions to evaluate\nnext. The format for each question resource name is:\nprojects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions": { + "description": "Indicates termination.", + "type": "object", + "properties": { + "terminationType": { + "description": "The type of termination to perform.", + "type": "string", + "x-google-enum-descriptions": [ + "The termination type is unspecified.", + "A failed scorecard would mean the overall scorecard score will be\nzeroed out, i.e., the scorecard score will be 0.", + "The overall scorecard score will be calculated based on the\nscores of the questions answered in the chain up until the last\nscored question that was answered. This is the default behavior." + ], + "enum": [ + "TERMINATION_TYPE_UNSPECIFIED", + "TERMINATE_WITH_SCORECARD_FAILURE", + "TERMINATE_WITH_CALCULATED_SCORE" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1QaQuestionMetrics": { + "description": "A wrapper representing metrics calculated against a test-set on a LLM that\nwas fine tuned for this question.", + "type": "object", + "properties": { + "accuracy": { + "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the\nmodel gave on the test set.", + "readOnly": true, + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata": { + "description": "Metadata about the tuning operation for the question. Will only be set if a\nscorecard containing this question has been tuned.", + "type": "object", + "properties": { + "totalValidLabelCount": { + "description": "Total number of valid labels provided for the question at the time of\ntuining.", + "type": "string", + "format": "int64" + }, + "datasetValidationWarnings": { + "description": "A list of any applicable data validation warnings about the question's\nfeedback labels.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DatasetValidationWarning" + } + }, + "tuningError": { + "description": "Error status of the tuning operation for the question. Will only be set\nif the tuning operation failed.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse": { + "description": "The response from a ListQaQuestions request.", + "type": "object", + "properties": { + "qaQuestions": { + "description": "The QaQuestions under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1QaQuestionTag": { + "description": "A tag is a resource which aims to categorize a set of questions across\nmultiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Resource name for the QaQuestionTag\nFormat\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}\nIn the above format, the last segment, i.e., qa_question_tag, is a\nserver-generated ID corresponding to the tag resource.", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "Required. A user-specified display name for the tag.", + "type": "string" + }, + "qaQuestionIds": { + "description": "Optional. The list of Scorecard Question IDs that the tag applies to.\nEach QaQuestionId is represented as a full resource name containing the\nQuestion ID. Lastly, Since a tag may not necessarily be referenced by any\nScorecard Questions, we treat this field as optional.", + "type": "array", + "items": { + "type": "string" + } + }, + "createTime": { + "description": "Output only. The time at which the question tag was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the question tag was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + }, + "required": [ + "displayName" + ] + }, + "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata": { + "description": "The metadata for updating a QaQuestionTag Resource.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest": { + "description": "The request for updating a QaQuestionTag.", + "type": "object", + "properties": { + "qaQuestionTag": { + "description": "Required. The QaQuestionTag to update.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" + }] + }, + "updateMask": { + "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `qa_question_tag_name` - the name of the tag\n* `qa_question_ids` - the list of questions the tag applies to", + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + }, + "required": [ + "qaQuestionTag" + ] + }, + "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata": { + "description": "The metadata for deleting a QaQuestionTag Resource.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest": { + "description": "The request for deleting a QaQuestionTag.", + "type": "object", + "properties": { + "name": { + "description": "Required. The name of the QaQuestionTag to delete.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse": { + "description": "The response from a ListQaQuestionTags request.", + "type": "object", + "properties": { + "qaQuestionTags": { + "description": "The parent resource of the questions.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1QaScorecard": { + "description": "A QaScorecard represents a collection of questions to be scored during\nanalysis.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The scorecard name.\nFormat:\nprojects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "The user-specified display name of the scorecard.", + "type": "string" + }, + "description": { + "description": "A text description explaining the intent of the scorecard.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this scorecard was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the scorecard was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "isDefault": { + "description": "Whether the scorecard is the default one for the project.\nA default scorecard cannot be deleted and will always appear first in\nscorecard selector.", + "type": "boolean" + }, + "source": { + "description": "Output only. The source of the scorecard.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardSource" + }] + }, + "isArchived": { + "description": "Whether the scorecard is archived. Archived scorecards will not be shown\nnor used in analyses of conversations. Similarly, archived scorecards and\nany sub-resources of the scorecard (e.g., questions) will not be used to\nfilter conversations. To emphasize, arhiving scorecards will not delete\nthe scorecard (or any of its sub-resources), nor will it delete any past\nanalyses that have been ran using the scorecard. Lastly, archived\nscorecards can be unarchived.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse": { + "description": "The response from a ListQaScorecards request.", + "type": "object", + "properties": { + "qaScorecards": { + "description": "The QaScorecards under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1QaScorecardRevision": { + "description": "A revision of a QaScorecard.\n\nModifying published scorecard fields would invalidate existing scorecard\nresults \u2014 the questions may have changed, or the score weighting will make\nexisting scores impossible to understand. So changes must create a new\nrevision, rather than modifying the existing resource.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The name of the scorecard revision.\nFormat:\nprojects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}", + "x-google-identifier": true, + "type": "string" + }, + "snapshot": { + "description": "The snapshot of the scorecard at the time of this revision's creation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" + }] + }, + "createTime": { + "description": "Output only. The timestamp that the revision was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "alternateIds": { + "description": "Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "state": { + "description": "Output only. State of the scorecard revision, indicating whether it's ready to\nbe used in analysis.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "The scorecard revision can be edited.", + "Scorecard model training is in progress.", + "Scorecard revision model training failed.", + "The revision can be used in analysis.", + "Scorecard is being deleted.", + "Scorecard model training was explicitly cancelled by the user." + ], + "enum": [ + "STATE_UNSPECIFIED", + "EDITABLE", + "TRAINING", + "TRAINING_FAILED", + "READY", + "DELETING", + "TRAINING_CANCELLED" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest": { + "description": "Request for TuneQaScorecardRevision endpoint.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource for new fine tuning job instance.", + "type": "string" + }, + "filter": { + "description": "Required. Filter for selecting the feedback labels that needs to be\nused for training.\nThis filter can be used to limit the feedback labels used for tuning to a\nfeedback labels created or updated for a specific time-window etc.", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Run in validate only mode, no fine tuning will actually run.\nData quality validations like training data distributions will run.\nEven when set to false, the data quality validations will still run but\nonce the validations complete we will proceed with the fine tune, if\napplicable.", + "type": "boolean" + } + }, + "required": [ + "parent", + "filter" + ] + }, + "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionResponse": { + "description": "Response for TuneQaScorecardRevision endpoint.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadata": { + "description": "Metadata for TuneQaScorecardRevision endpoint.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest" + }] + }, + "qaQuestionDatasetValidationResults": { + "description": "Output only. The results of data validation per question in the request.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetValidationResult" + } + }, + "qaQuestionDatasetTuningMetrics": { + "description": "Output only. The metrics for each QaQuestion in the TuneScorecardRevision request.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetTuningMetrics" + } + }, + "tuningCompletionRatio": { + "description": "Output only. The percentage of the tuning job that has completed. Always between 0 and 1\nwhere 0 indicates the job has not started i.e. 0% and 1 indicates the job\nhas completed i.e. 100%.", + "readOnly": true, + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetValidationResult": { + "description": "Contains validation results for a question in the tuning request.", + "type": "object", + "properties": { + "question": { + "description": "Output only. The resource path of the question whose dataset was evaluated for tuning.", + "readOnly": true, + "type": "string" + }, + "datasetValidationWarnings": { + "description": "A list of any applicable data validation warnings about the question's\nfeedback labels.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DatasetValidationWarning" + } + }, + "validFeedbackLabelsCount": { + "description": "The number of valid feedback labels in the question's dataset.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetTuningMetrics": { + "description": "Contains performance metrics for each QaQuestion in the\nTuneScorecardRevision request.", + "type": "object", + "properties": { + "question": { + "description": "Output only. The resource path of the question whose dataset was evaluated for tuning.", + "readOnly": true, + "type": "string" + }, + "metrics": { + "description": "Output only. The metrics for the question's dataset.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetTuningMetricsMetrics" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetTuningMetricsMetrics": { + "description": "Performance metrics for the question's dataset calculated over the tuned\nmodel.", + "type": "object", + "properties": { + "accuracy": { + "description": "Accuracy of the question's dataset.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsRequest": { + "description": "The request for bulk updating QaQuestions.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource for the bulk update job instance.", + "type": "string" + }, + "qaQuestions": { + "description": "Required. All the questions to be updated", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" + } + }, + "updateMask": { + "description": "Optional. All questions will be updated with the same mask.\nAn empty mask will means updating all updatable fields.", + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + }, + "required": [ + "parent", + "qaQuestions" + ] + }, + "GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsResponse": { + "description": "The response for bulk updating QaQuestions.", + "type": "object", + "properties": { + "qaQuestions": { + "description": "The QaQuestions that were updated.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsMetadata": { + "description": "The metadata for bulk updating QaQuestions.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest": { + "description": "The request to deploy a QaScorecardRevision", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest": { + "description": "The request to undeploy a QaScorecardRevision", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse": { + "description": "The response from a ListQaScorecardRevisions request.", + "type": "object", + "properties": { + "qaScorecardRevisions": { + "description": "The QaScorecards under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse": { + "description": "The response for listing feedback labels.", + "type": "object", + "properties": { + "feedbackLabels": { + "description": "The feedback labels that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + }, + "nextPageToken": { + "description": "The next page token.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse": { + "description": "The response for listing all feedback labels.", + "type": "object", + "properties": { + "feedbackLabels": { + "description": "The feedback labels that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest": { + "description": "The request for bulk uploading feedback labels.", + "type": "object", + "properties": { + "gcsSource": { + "description": "A cloud storage bucket source.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource" + }] + }, + "sheetsSource": { + "description": "A sheets document source.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource" + }] + }, + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, upload will not happen and the labels will be validated.\nIf not set, then default behavior will be to upload the labels after\nvalidation is complete.", + "type": "boolean" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource": { + "description": "Google Cloud Storage Object details to get the feedback label file from.", + "type": "object", + "properties": { + "format": { + "description": "Required. File format which will be ingested.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified format.", + "CSV format.", + "JSON format." + ], + "enum": [ + "FORMAT_UNSPECIFIED", + "CSV", + "JSON" + ] + }, + "objectUri": { + "description": "Required. The Google Cloud Storage URI of the file to import.\nFormat: `gs://bucket_name/object_name`", + "type": "string" + } + }, + "required": [ + "format", + "objectUri" + ] + }, + "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource": { + "description": "Google Sheets document details to get the feedback label file from.", + "type": "object", + "properties": { + "spreadsheetUri": { + "description": "Required. The Google Sheets document to write the feedback labels to.\nRetrieved from Google Sheets URI.\nE.g. `https://docs.google.com/spreadsheets/d/1234567890`\nThe spreadsheet must be shared with the Insights P4SA.", + "type": "string" + } + }, + "required": [ + "spreadsheetUri" + ] + }, + "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsResponse": { + "description": "Response for the Bulk Upload Feedback Labels API.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsMetadata": { + "description": "Metadata for the Bulk Upload Feedback Labels API.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for ingest.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "uploadStats": { + "description": "Output only. Statistics for BulkUploadFeedbackLabels operation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsMetadataUploadStats" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsMetadataUploadStats": { + "description": "Statistics for BulkUploadFeedbackLabels operation.", + "type": "object", + "properties": { + "processedObjectCount": { + "description": "The number of objects processed during the upload operation.", + "type": "integer", + "format": "int32" + }, + "failedValidationCount": { + "description": "The number of objects skipped because of failed validation", + "type": "integer", + "format": "int32" + }, + "successfulUploadCount": { + "description": "The number of new feedback labels added during this ingest operation.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest": { + "description": "Request for the BulkDownloadFeedbackLabel endpoint.", + "type": "object", + "properties": { + "gcsDestination": { + "description": "A cloud storage bucket destination.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination" + }] + }, + "sheetsDestination": { + "description": "A sheets document destination.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination" + }] + }, + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "type": "string" + }, + "filter": { + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "type": "string" + }, + "maxDownloadCount": { + "description": "Optional. Limits the maximum number of feedback labels that will be downloaded.\nThe first `N` feedback labels will be downloaded.", + "type": "integer", + "format": "int32" + }, + "feedbackLabelType": { + "description": "Optional. The type of feedback labels that will be downloaded.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified format", + "Downloaded file will contain all Quality AI labels from the latest\nscorecard revision.", + "Downloaded file will contain only Topic Modeling labels.", + "Agent Assist Summarization labels." + ], + "enum": [ + "FEEDBACK_LABEL_TYPE_UNSPECIFIED", + "QUALITY_AI", + "TOPIC_MODELING", + "AGENT_ASSIST_SUMMARY" + ] + }, + "conversationFilter": { + "description": "Optional. Filter parent conversations to download feedback labels for.\nWhen specified, the feedback labels will be downloaded for the\nconversations that match the filter.\nIf `template_qa_scorecard_id` is set, all the conversations that match the\nfilter will be paired with the questions under the scorecard for labeling.", + "type": "string" + }, + "templateQaScorecardId": { + "description": "Optional. If set, a template for labeling conversations and scorecard questions will\nbe created from the conversation_filter and the questions under the\nscorecard(s). The feedback label `filter` will be ignored.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination": { + "description": "Google Cloud Storage Object details to write the feedback labels to.", + "type": "object", + "properties": { + "format": { + "description": "Required. File format in which the labels will be exported.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified format.", + "CSV format.\n1,000 labels are stored per CSV file by default.", + "JSON format.\n1 label stored per JSON file by default." + ], + "enum": [ + "FORMAT_UNSPECIFIED", + "CSV", + "JSON" + ] + }, + "objectUri": { + "description": "Required. The Google Cloud Storage URI to write the feedback labels to.\nThe file name will be used as a prefix for the files written to the\nbucket if the output needs to be split across multiple files, otherwise\nit will be used as is. The file extension will be appended to the file\nname based on the format selected.\n E.g. `gs://bucket_name/object_uri_prefix`", + "type": "string" + }, + "addWhitespace": { + "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases\nfile size. Only applicable for JSON format.", + "type": "boolean" + }, + "alwaysPrintEmptyFields": { + "description": "Optional. Always print fields with no presence.\nThis is useful for printing fields that are not set, like implicit 0\nvalue or empty lists/maps. Only applicable for JSON format.", + "type": "boolean" + }, + "recordsPerFileCount": { + "description": "Optional. The number of records per file. Applicable for either format.", + "type": "string", + "format": "int64" + } + }, + "required": [ + "format", + "objectUri" + ] + }, + "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination": { + "description": "Google Sheets document details to write the feedback labels to.", + "type": "object", + "properties": { + "spreadsheetUri": { + "description": "Required. The Google Sheets document to write the feedback labels to.\nRetrieved from Google Sheets URI.\nE.g. `https://docs.google.com/spreadsheets/d/1234567890`\nThe spreadsheet must be shared with the Insights P4SA.\nThe spreadsheet ID written to will be returned as `file_names` in the\nBulkDownloadFeedbackLabelsMetadata.", + "type": "string" + }, + "sheetTitle": { + "description": "Optional. The title of the new sheet to write the feedback labels to.", + "type": "string" + } + }, + "required": [ + "spreadsheetUri" + ] + }, + "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse": { + "description": "Response for the BulkDownloadFeedbackLabel endpoint.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata": { + "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for download.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "downloadStats": { + "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats": { + "description": "Statistics for BulkDownloadFeedbackLabels operation.", + "type": "object", + "properties": { + "processedObjectCount": { + "description": "The number of objects processed during the download operation.", + "type": "integer", + "format": "int32" + }, + "successfulDownloadCount": { + "description": "The number of new feedback labels downloaded during this operation.\nDifferent from \"processed\" because some labels might not be downloaded\nbecause an error.", + "type": "integer", + "format": "int32" + }, + "totalFilesWritten": { + "description": "Total number of files written to the provided Cloud Storage bucket.", + "type": "integer", + "format": "int32" + }, + "fileNames": { + "description": "Output only. Full name of the files written to Cloud storage.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest": { + "description": "Request for the BulkDeleteFeedbackLabels endpoint.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "type": "string" + }, + "filter": { + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "type": "string" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse": { + "description": "Response for the BulkDeleteFeedbackLabels endpoint.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata": { + "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", + "type": "object", + "properties": { + "request": { + "description": "Output only. The original request for delete.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during deletion operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1AuthorizedViewSet": { + "description": "An AuthorizedViewSet contains a set of AuthorizedView resources.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The resource name of the AuthorizedViewSet.\nFormat:\nprojects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "Display Name. Limit 64 characters.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. Update time.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse": { + "description": "The response from a ListAuthorizedViewSet request.", + "type": "object", + "properties": { + "authorizedViewSets": { + "description": "The AuthorizedViewSets under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1AuthorizedView": { + "description": "An AuthorizedView represents a view of accessible Insights resources (for\nexample, Conversation and Scorecard). Who have read access to the\nAuthorizedView resource will have access to these Insight resources as well.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The resource name of the AuthorizedView.\nFormat:\nprojects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "Display Name. Limit 64 characters.", + "type": "string" + }, + "conversationFilter": { + "description": "A filter to reduce conversation results to a specific subset.\nThe AuthorizedView's assigned permission (read/write) could be applied to\nthe subset of conversations.\n\nIf conversation_filter is empty, there is no restriction on the\nconversations that the AuthorizedView can access.\n\nHaving *authorizedViews.get* access to the AuthorizedView means having the\nsame read/write access to the Conversations (as well as\nmetadata/annotations linked to the conversation) that this AuthorizedView\nhas.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which the authorized view was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the authorized view was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse": { + "description": "The response from a ListAuthorizedViews request.", + "type": "object", + "properties": { + "authorizedViews": { + "description": "The AuthorizedViews under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse": { + "description": "The response from a ListAuthorizedViews request.", + "type": "object", + "properties": { + "authorizedViews": { + "description": "The AuthorizedViews under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1Assessment": { + "description": "The assessment resource.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The resource name of the assessment.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}", + "x-google-identifier": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which the assessment was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The time at which the assessment was last updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "state": { + "description": "Output only. The state of the assessment.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "The state is unspecified. This value should not be used.", + "The default state of all new assessments.", + "The assessment has been published.", + "The assessment has been appealed.", + "The assessment has been finalized." + ], + "enum": [ + "STATE_UNSPECIFIED", + "DRAFT", + "PUBLISHED", + "APPEALED", + "FINALIZED" + ] + }, + "agentInfo": { + "description": "Information about the agent the assessment is for.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ListAssessmentsResponse": { + "description": "The response of listing assessments.", + "type": "object", + "properties": { + "assessments": { + "description": "The assessments that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1PublishAssessmentRequest": { + "description": "The message to publish an assessment. Draft and appealed assessments can be\npublished. Publishing simply changes the state of the assessment to\npublished, allowing the console and authorized views to filter on the state.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1AppealAssessmentRequest": { + "description": "The message to appeal an assessment.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest": { + "description": "The message to finalize an assessment. Finalizing makes an assessment and\nits notes immutable.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1Note": { + "description": "The conversation assessment note resource.", + "type": "object", + "properties": { + "conversationTurnNote": { + "description": "The note is associated with a conversation turn.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1NoteConversationTurnNote" + }] + }, + "qaQuestionNote": { + "description": "The note is associated with a QA question in one of the conversation's\nscorecard results.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1NoteQaQuestionNote" + }] + }, + "assessmentNote": { + "description": "The note is associated to the entire parent assessment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1NoteAssessmentNote" + }] + }, + "name": { + "description": "Identifier. The resource name of the note.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", + "x-google-identifier": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which the note was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The time at which the note was last updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "noteCreator": { + "description": "Output only. The user that created the note.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UserInfo" + }] + }, + "content": { + "description": "The note content.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1NoteConversationTurnNote": { + "description": "A note about a conversation turn.", + "type": "object", + "properties": { + "turnIndex": { + "description": "The conversation turn index that the note is associated with.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1NoteQaQuestionNote": { + "description": "A note about a QA question.", + "type": "object", + "properties": { + "qaQuestion": { + "description": "The question resource that the note is associated with.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1NoteAssessmentNote": { + "description": "A note about the entire parent assessment.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1UserInfo": { + "description": "Information about a user.", + "type": "object", + "properties": { + "username": { + "description": "The user's username.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListNotesResponse": { + "description": "The response of listing notes.", + "type": "object", + "properties": { + "notes": { + "description": "The notes that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1Dashboard": { + "description": "Configurable dashboard", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Dashboard resource name.\nFormat:\nprojects/{project}/locations/{location}/dashboards/{dashboard}", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "User provided display name of the dashboard.", + "type": "string" + }, + "rootContainer": { + "description": "The dashboard's root widget container. We want to display the dashboard\nlayout in a tree-like structure, where the root container contains other\nwidgets (containers or charts) as children.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Container" + }] + }, + "description": { + "description": "Dashboard description", + "type": "string" + }, + "createTime": { + "description": "Output only. Dashboard creation time.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. Dashboard last update time.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "filter": { + "description": "Filter applied to all charts in the dashboard.\nShould support scope later.", + "type": "string" + }, + "dateRangeConfig": { + "description": "Date range config applied to all charts in the dashboard.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DateRangeConfig" + }] + }, + "readOnly": { + "description": "Output only. Whether the dashboard is read-only. All predefined dashboards are\nread-only and cannot be modified by the user.", + "readOnly": true, + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1Container": { + "description": "Configurable dashboard's container. Container can contain multiple widgets.", + "type": "object", + "properties": { + "displayName": { + "description": "User provided display name of the Container.", + "type": "string" + }, + "widgets": { + "description": "Widgets in the Container.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Widget" + } + }, + "description": { + "description": "Container description", + "type": "string" + }, + "filter": { + "description": "Filter applied to all charts in the container.\nShould support scope later.", + "type": "string" + }, + "width": { + "description": "The width of the container in grid units.", + "type": "integer", + "format": "int32" + }, + "height": { + "description": "The height of the container in grid units.", + "type": "integer", + "format": "int32" + }, + "containerId": { + "description": "Output only. Unique ID for the container.", + "readOnly": true, + "type": "string" + }, + "dateRangeConfig": { + "description": "Date range config applied to all charts in the container.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DateRangeConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1Widget": { + "description": "Represents a dashboard element, could be a nested Container or Chart.", + "type": "object", + "properties": { + "container": { + "description": "A container widget.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Container" + }] + }, + "chart": { + "description": "A chart widget.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" + }] + }, + "chartReference": { + "description": "A reference to a chart widget.\nFormat:\nprojects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", + "type": "string" + }, + "filter": { + "description": "Filter applied to all charts in the container.\nShould support scope later.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1Chart": { + "description": "Configurable dashboard's widget that displays data as a chart.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Chart resource name.\nFormat:\nprojects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "User provided display name of the chart.", + "type": "string" + }, + "description": { + "description": "Chart description", + "type": "string" + }, + "chartVisualizationType": { + "description": "Chart visualization type.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ChartVisualizationType" + }] + }, + "width": { + "description": "The width of the chart in grid units.", + "type": "integer", + "format": "int32" + }, + "height": { + "description": "The height of the chart in grid units.", + "type": "integer", + "format": "int32" + }, + "createTime": { + "description": "Output only. Chart create time.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. Chart last update time.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "chartType": { + "description": "Output only. Chart type.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified chart type.", + "Pre-defined chart type.", + "Configurable chart type." + ], + "enum": [ + "CHART_TYPE_UNSPECIFIED", + "SYSTEM_DEFINED", + "USER_DEFINED" + ] + }, + "dataSource": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ChartDataSource" + }, + "filter": { + "description": "Filter applied to all charts in the container.\nShould support scope later.", + "type": "string" + }, + "dateRangeConfig": { + "description": "Date range config applied to the chart.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DateRangeConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1ChartDataSource": { + "description": "The request data for visualizing the dataset in the chart.", + "type": "object", + "properties": { + "generativeInsights": { + "description": "Use natural language query to generate the chart.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsights" + }] + }, + "queryMetrics": { + "description": "Use the existing QueryMetrics to generate the chart.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetrics" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsights": { + "description": "Request that use natural language query to generate the chart.", + "type": "object", + "properties": { + "request": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL." + } + }, + "chartSpec": { + "description": "Chart spec for the chart.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "sqlQuery": { + "description": "SQL query used to generate the chart.", + "type": "string" + }, + "sqlComparisonKey": { + "description": "Optional. For charts with comparison, this key will determine the metric that will be\ncompared between the current and another dataset.", + "type": "string" + }, + "chartConversations": { + "description": "Output only. The chart conversations used to generate the chart.", + "readOnly": true, + "deprecated": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversation" + } + }, + "chartCheckpoint": { + "description": "The chart checkpoint used to generate the chart.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartCheckpoint" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversation": { + "description": "The conversation used to generate the chart.", + "type": "object", + "properties": { + "conversationId": { + "description": "The conversation id of the chart.", + "type": "string" + }, + "createTime": { + "description": "The create time of the conversation.", + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "The update time of the conversation.", + "type": "string", + "format": "date-time" + }, + "messages": { + "description": "Ordered list of messages, including user inputs and system responses.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessage" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessage": { + "description": "The message in the conversation.", + "type": "object", + "properties": { + "userMessage": { + "description": "A message from the user that is interacting with the system.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageUserMessage" + }] + }, + "systemMessage": { + "description": "A message from the system in response to the user.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessage" + }] + }, + "messageId": { + "description": "The message id of the message.", + "type": "string" + }, + "createTime": { + "description": "For user messages, this is the time at which the system received the\nmessage. For system messages, this is the time at which the system\ngenerated the message.", + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageUserMessage": { + "description": "The user message.", + "type": "object", + "properties": { + "text": { + "description": "A message from the user that is interacting with the system.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessage": { + "description": "A message from the system in response to the user. This message can\nalso be a message from the user as historical context for multiturn\nconversations with the system.", + "type": "object", + "properties": { + "textOutput": { + "description": "A direct natural language response to the user message.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessageTextOutput" + }] + }, + "generatedSqlQuery": { + "description": "Raw SQL from LLM, before templatization", + "type": "string" + }, + "chartSpec": { + "description": "Chart spec from LLM", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessageTextOutput": { + "description": "A text output message from the system.", + "type": "object", + "properties": { + "texts": { + "description": "The parts of the message.", + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "description": "The type of the text message.", + "type": "string", + "x-google-enum-descriptions": [ + "The default text type.", + "The text is a thinking plan generated by the thinking tool.", + "The text is a final response to the user question.", + "The text is an informational message about the agent's\nprogress, such as a tool being invoked. This is distinct from\nthe agent's internal thought process (`THOUGHT`) and the final\nanswer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the\nagent's actions." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "THOUGHT", + "FINAL_RESPONSE", + "PROGRESS" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartCheckpoint": { + "description": "The current chart checkpoint state.", + "type": "object", + "properties": { + "sessionId": { + "description": "The session id of the chart.", + "type": "string" + }, + "revisionId": { + "description": "The revision id of the chart.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1QueryMetrics": { + "description": "Request data that use the existing QueryMetrics.", + "type": "object", + "properties": { + "request": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL." + } + } + } + }, + "GoogleCloudContactcenterinsightsV1DateRangeConfig": { + "description": "Date range configuration for dashboard charts.", + "type": "object", + "properties": { + "relativeDateRange": { + "description": "A relative date range.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DateRangeConfigRelativeDateRange" + }] + }, + "absoluteDateRange": { + "description": "An absolute date range.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryInterval" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1DateRangeConfigRelativeDateRange": { + "description": "Relative date range configuration.", + "type": "object", + "properties": { + "quantity": { + "description": "Required. The quantity of units in the past.", + "type": "string", + "format": "int64" + }, + "unit": { + "description": "Required. The unit of time.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Day.", + "Week.", + "Month.", + "Quarter.", + "Year." + ], + "enum": [ + "TIME_UNIT_UNSPECIFIED", + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR" + ] + } + }, + "required": [ + "quantity", + "unit" + ] + }, + "GoogleCloudContactcenterinsightsV1ListDashboardsResponse": { + "description": "The response of listing dashboards.", + "type": "object", + "properties": { + "dashboards": { + "description": "The dashboards under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" + } + }, + "nextPageToken": { + "description": "The value returned by the last `ListDashboardsResponse`. This value\nindicates that this is a continuation of a prior `ListDashboards` call and\nthat the system should return the next page of data.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListChartsResponse": { + "description": "The response of listing charts.", + "type": "object", + "properties": { + "charts": { + "description": "The charts under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" + } + }, + "nextPageToken": { + "description": "The value returned by the last `ListChartsResponse`. This value\nindicates that this is a continuation of a prior `ListCharts` call and\nthat the system should return the next page of data.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListDiscoveryWorkspacesResponse": { + "description": "The response of listing discovery workspaces.", + "type": "object", + "properties": { + "discoveryWorkspaces": { + "description": "The discovery workspaces under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspace" + } + }, + "nextPageToken": { + "description": "The value returned by the last `ListDiscoveryWorkspacesResponse`. This\nvalue indicates that this is a continuation of a prior\n`ListDiscoveryWorkspaces` call and that the system should return the next\npage of data.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryWorkspace": { + "description": "The discovery workspace resource. One discovery workspace can only have one\ndiscovery tree. It stores pointers to the root of discovery tree and snapshot\nof the tree used for analysis.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Resource name of the discovery workspace.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}", + "x-google-identifier": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this discovery workspace was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the discovery workspace was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "rootDiscovery": { + "description": "Output only. The id for the discovery at the root of the discovery workspace.", + "readOnly": true, + "type": "string" + }, + "deploymentSpec": { + "description": "Output only. The configuration used for running analysis with a snapshot of the\ndiscovery workspace. When this field is set, the discovery workspace can be\nused for live inference.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspaceDeploymentSpec" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryWorkspaceDeploymentSpec": { + "description": "Specifies the discovery subtree chosen for running analysis and the\nQaScorecard/QaQuestions resources backing the analysis.", + "type": "object", + "properties": { + "qaScorecardRevision": { + "description": "The QA scorecard revision to use for live inference. Format:\nprojects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}", + "type": "string" + }, + "discoveryRevisionMappings": { + "description": "The mappings of discovery revisions to QA questions.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspaceDeploymentSpecDiscoveryRevisionMapping" + } + }, + "rediscoveryConfig": { + "description": "Optional. Configuration specifying how rediscovery should be run.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RediscoveryConfig" + }] + }, + "analysisRule": { + "description": "Optional. The analysis rule to be applied to the conversations selected under\nthis deployment. Format:\nprojects/{project}/locations/{location}/analysisRules/{analysis_rule}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryWorkspaceDeploymentSpecDiscoveryRevisionMapping": { + "description": "The mapping of discovery revisions to QA questions.", + "type": "object", + "properties": { + "discoveryRevision": { + "description": "A discovery revision in the live tree. Format:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discoveryWorkspace}/discoveries/{discovery}/revisions/{revision}", + "type": "string" + }, + "qaQuestion": { + "description": "The QaQuestion resource name corresponding to the discovery revision in\nthe live tree. Format:\nprojects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}", + "type": "string" + }, + "questionAbbreviation": { + "description": "The display name of the question. Used to reference the discovery goal\nof the discovery revision in the UI.", + "type": "string" + }, + "answerChoices": { + "description": "The answer choices for the question, corresponding to the discovery\ndiscovery results of the revision.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1RediscoveryConfig": { + "description": "Configuration specifying how rediscovery should be run.", + "type": "object", + "properties": { + "rediscoveryFrequency": { + "type": "string", + "x-google-enum-descriptions": [ + "", + "Detect emerging results less frequently than standard. Currently this\nwill configure rediscovery to run quarterly.", + "Detect emerging results on a monthly basis.", + "Detect emerging results more frequently than standard. Currently this\nwill configure rediscovery to run weekly." + ], + "enum": [ + "REDISCOVERY_FREQUENCY_UNSPECIFIED", + "LESS_SENSITIVE", + "STANDARD", + "MORE_SENSITIVE" + ] + }, + "disableRediscoveryAutoDeployment": { + "description": "If true, the rediscovery tree will not be automatically deployed. Defaults\nto false. i.e. the rediscovery tree will be automatically deployed.", + "type": "boolean" + }, + "scheduleId": { + "description": "The schedule id for the rediscovery pipeline. When not provided, a new\nschedule will be created. Otherwise, the schedule will be updated.\nThe primary key for the PipelineSchedules table.", + "type": "string", + "format": "int64" + } + } + }, + "GoogleCloudContactcenterinsightsV1FetchDiscoveryWorkspaceTreeResponse": { + "description": "The response of fetching a discovery workspace tree.", + "type": "object", + "properties": { + "parent": { + "description": "The workspace parent of the tree.", + "type": "string" + }, + "discoveryRevisions": { + "description": "The tree of discoveries at specific revisions.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" + } + }, + "otherDiscoveryRevisions": { + "description": "A list of the other revisions of each Discovery in the tree. Defaults to\nthe latest 200 revisions of each Discovery.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" + } + }, + "discoveryResults": { + "description": "A list of results in the tree.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryRevision": { + "description": "The discovery result revision resource. A revision is created when client\nspecifically requests via calling CreateDiscoveryRevision API. This\nusually happens when client is finalizing the feedbacks to previous revision.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Resource name of the DiscoveryRevision.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", + "x-google-identifier": true, + "type": "string" + }, + "snapshot": { + "description": "Output only. The snapshot of the discovery result at this revision.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" + }] + }, + "createTime": { + "description": "Output only. The time at which this discovery result revision was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the discovery result revision was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "feedback": { + "description": "The feedback for the discovery result under source_revision.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevisionFeedback" + }] + }, + "inputData": { + "description": "The input data to be used to create this revision.\nWhen not provided, the input data from the source revision will be used.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryInputDataConfig" + }] + }, + "sourceRevision": { + "description": "Immutable. The source of this discovery revision. i.e. this discovery revision is\nthe result of applying changes on top of source_revision. Format:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", + "x-google-immutable": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the discovery.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "This value is unused.", + "The discovery is running. There may be discovery results generated but\nthe final list or distributions are not finalized.", + "The discovery is completed. The final list or distributions are\nfinalized." + ], + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "COMPLETED" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1Discovery": { + "description": "The discovery resource.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Resource name of the discovery.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "User provided display name of the discovery. Modifying this will not change\nthe discovery result or behaviour.", + "type": "string" + }, + "languageCode": { + "description": "Immutable. The language code of the discovery results. When drill_down_parent is\nspecified, this field is inherited from the parent discovery.\nWhen neither language_code nor drill_down_parent is specified, defaults to\nen.", + "x-google-immutable": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this discovery was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the discovery was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "drillDownParent": { + "description": "Name of the discovery discovery result this discovery is a drill down of.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}\nIf empty, this discovery is a top level discovery.\nServer enforces at discovery resource creation time that this resource\nreference creates a tree structure and there's no cycle in the resource\nhierarchy. This field should not be updated once the discovery is created.", + "type": "string" + }, + "discoveryGoal": { + "description": "Required. Immutable. User specified goal for the discovery. This field is immutable once the\ndiscovery is created.", + "x-google-immutable": true, + "type": "string" + }, + "inputData": { + "description": "Specs for the input data used for this discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryInputDataConfig" + }] + }, + "customTaxonomy": { + "description": "User provided taxonomy to guide the discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryCustomTaxonomy" + }] + }, + "advancedOptions": { + "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryDiscoveryAdvancedOptions" + }] + } + }, + "required": [ + "discoveryGoal" + ] + }, + "GoogleCloudContactcenterinsightsV1DiscoveryInputDataConfig": { + "description": "Configuration for the input data used for discovery.", + "type": "object", + "properties": { + "conversationFilter": { + "description": "Optional. The filter for querying conversations.", + "type": "string" + }, + "maxSampleSize": { + "description": "Optional. Maximum number of conversations to sample.", + "type": "string", + "format": "int64" + }, + "dataset": { + "description": "Optional. The resource name of the Dataset to scope the discovery to.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}\nIf provided, discovery will only run on conversations within this dataset.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryCustomTaxonomy": { + "description": "User provided taxonomy to guide the discovery.", + "type": "object", + "properties": { + "taxonomyEntries": { + "description": "Entries in the custom taxonomy.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryCustomTaxonomyTaxonomyEntry" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryCustomTaxonomyTaxonomyEntry": { + "description": "A single entry in the custom taxonomy.", + "type": "object", + "properties": { + "displayName": { + "description": "Name of the taxonomy entry.", + "type": "string" + }, + "description": { + "description": "Description of the taxonomy entry.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryDiscoveryAdvancedOptions": { + "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", + "type": "object", + "properties": { + "conversationDataOptions": { + "description": "Options for configuring what metadata goes into conversation\ntranscript.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataOptions" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryRevisionFeedback": { + "description": "Feedback for the discovery results under previous_revision.", + "type": "object", + "properties": { + "resultFeedback": { + "description": "DiscoveryResult level feedback.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevisionFeedbackResultFeedback" + } + }, + "revisionFeedback": { + "description": "DiscoveryRevision level feedback.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryRevisionFeedbackResultFeedback": { + "description": "Content of a DiscoveryResult level feedback. i.e. Feedback applied\nspecifically to a DiscoveryResult.", + "type": "object", + "properties": { + "result": { + "description": "Resource name of the discovery result this feedback is for.\nThe parent discovery revision of the result must be the same as what's\nspecified in the source_revision field.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}", + "type": "string" + }, + "feedback": { + "description": "The feedback for the discovery result.", + "type": "string" + }, + "userAction": { + "description": "The user action for the entry feedback.", + "type": "string", + "x-google-enum-descriptions": [ + "Default value.", + "The user wants to remove the discovery result.", + "The user provides an exact replacement for the display name.", + "The user provides an exact replacement for the description.", + "The user provides comments/instructions on how to modify the display\nname.", + "The user provides comments/instructions on how to modify the\ndescription." + ], + "enum": [ + "USER_ACTION_UNSPECIFIED", + "REMOVE", + "SET_DISPLAY_NAME", + "SET_DESCRIPTION", + "SUGGEST_DISPLAY_NAME_EDIT", + "SUGGEST_DESCRIPTION_EDIT" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryResult": { + "description": "The discovery result resource. This resource is read only.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Resource name of the DiscoveryResult.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "Output only. Display name of the discovery result.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Output only. Description of the discovery result.", + "readOnly": true, + "type": "string" + }, + "relativeConversationCount": { + "description": "Number of conversations assigned to this discovery result for the purpose\nof calculating conversation volume distribution. The conversation volume of\neach discovery result doesn't add up to the total conversation volume of\nthe discovery.", + "type": "string", + "format": "int64" + }, + "drillDownChildren": { + "description": "Output only. The Discovery resource names that's a drill down of this discovery result.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "source": { + "description": "Output only. The source of the discovery result.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "The source is unspecified.", + "The discovery result is emerged from data that's not already covered by\nby provided taxonomy.", + "The discovery result is from provided customer taxonomy." + ], + "enum": [ + "SOURCE_UNSPECIFIED", + "EMERGED", + "CUSTOMER_PROVIDED" + ] + }, + "exampleConversations": { + "description": "Example conversations assigned to this discovery result.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryResultExampleConversation" + } + }, + "suggestedDrillDownQuestions": { + "description": "Output only. Unordered list. Suggested questions for drill down into this discovery result.\nA maximum of 5 suggestions can be returned. Each suggestion is limited to\n128 characters.", + "readOnly": true, + "x-google-unordered-list": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryResultExampleConversation": { + "description": "An example conversation assigned to this discovery result.", + "type": "object", + "properties": { + "name": { + "description": "The conversation name.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}", + "type": "string" + }, + "summary": { + "description": "The summary of the conversation.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DeployDiscoveryWorkspaceRequest": { + "description": "The request to deploy a discovery workspace.", + "type": "object", + "properties": { + "displayName": { + "description": "Required. The display name to set for the discovery workspace deployment and the\nassociated QaScorecard.", + "type": "string" + }, + "discoveryRevisions": { + "description": "Required. The discovery revisions to deploy.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "displayName", + "discoveryRevisions" + ] + }, + "GoogleCloudContactcenterinsightsV1DeployDiscoveryWorkspaceResponse": { + "description": "The response of deploying a discovery workspace.", + "type": "object", + "properties": { + "discoveryWorkspace": { + "description": "The deployed discovery workspace.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspace" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1UndeployDiscoveryWorkspaceRequest": { + "description": "The request to undeploy a discovery workspace.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1UndeployDiscoveryWorkspaceResponse": { + "description": "The response of undeploying a discovery workspace.", + "type": "object", + "properties": { + "discoveryWorkspace": { + "description": "The undeployed discovery workspace.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspace" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1GenerateDiscoveryRequest": { + "description": "The request to generate a discovery.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent of generated discovery request.\nWhen it's a Location resource, this operation creates a root discovery and\nits discovery workspace will be automatically created.\nWhen it's a discovery workspace resource, this operation creates a drill\ndown discovery. discovery.drill_down_parent should have the same discovery\nworkspace as the parent.", + "type": "string" + }, + "discovery": { + "description": "Required. Specifies the discovery to generate. The name field of the discovery will\nbe ignored.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" + }] + } + }, + "required": [ + "parent", + "discovery" + ] + }, + "GoogleCloudContactcenterinsightsV1GenerateDiscoveryResponse": { + "description": "The response of generating a discovery.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1GenerateDiscoveryMetadata": { + "description": "Metadata for GenerateDiscovery operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The request to create the discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryRequest" + }] + }, + "progress": { + "description": "The progress of the discovery creation operation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryProgress" + }] + }, + "resultRevision": { + "description": "Output only. The DiscoveryRevision resource name that contains the result entries\ngenerated in this discovery.", + "readOnly": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1DiscoveryProgress": { + "description": "Progress information for a discovery.", + "type": "object", + "properties": { + "progressState": { + "description": "Output only. The state of the discovery creation or refinement.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "Default value. This value is unused.", + "The input data is being preprocessed.", + "Summarizing the conversations to extract features.", + "Generating the results based on the features.", + "Calculating the distributions for the results.", + "The discovery is being finalized.", + "The GenerateDiscovery operation has completed successfully." + ], + "enum": [ + "PROGRESS_STATE_UNSPECIFIED", + "PREPROCESSING", + "SUMMARIZING", + "GENERATING_RESULTS", + "COMPUTING_DISTRIBUTIONS", + "FINALIZING", + "SUCCEEDED" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1ListDiscoveriesResponse": { + "description": "The response of listing discoveries.", + "type": "object", + "properties": { + "discoveries": { + "description": "The discoveries under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" + } + }, + "nextPageToken": { + "description": "The value returned by the last `ListDiscoveriesResponse`. This value\nindicates that this is a continuation of a prior `ListDiscoveries` call and\nthat the system should return the next page of data.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionMetadata": { + "description": "Metadata for a discovery revision creation operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The request to create the discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionRequest" + }] + }, + "progress": { + "description": "The progress of the discovery creation operation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryProgress" + }] + }, + "resultRevision": { + "description": "Output only. The newly created discovery revision resource name.", + "readOnly": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionRequest": { + "description": "The request to create a discovery revision.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the discovery.", + "type": "string" + }, + "discoveryRevision": { + "description": "Required. The discovery revision to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" + }] + }, + "discoveryRevisionId": { + "description": "Optional. The ID of the discovery revision to create.", + "type": "string" + } + }, + "required": [ + "parent", + "discoveryRevision" + ] + }, + "GoogleCloudContactcenterinsightsV1ListDiscoveryRevisionsResponse": { + "description": "Response of listing discovery revisions.", + "type": "object", + "properties": { + "discoveryRevisions": { + "description": "The discovery revisions under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" + } + }, + "nextPageToken": { + "description": "The value returned by the last `ListDiscoveryRevisionsResponse`. This\nvalue indicates that this is a continuation of a prior\n`ListDiscoveryRevisions` call and that the system should return the next\npage of data.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1ListDiscoveryResultsResponse": { + "description": "Response of listing discovery results.", + "type": "object", + "properties": { + "discoveryResults": { + "description": "The discovery results under the parent.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryResult" + } + }, + "nextPageToken": { + "description": "The value returned by the last `ListDiscoveryResultsResponse`. This\nvalue indicates that this is a continuation of a prior\n`ListDiscoveryResults` call and that the system should return the\nnext page of data.", + "type": "string" + } + } + }, + "GoogleIamV1SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "type": "object", + "properties": { + "policy": { + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Google Cloud services (such as Projects)\nmight reject them.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleIamV1Policy" + }] + }, + "updateMask": { + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\n\n`paths: \"bindings, etag\"`", + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + } + }, + "GoogleIamV1Policy": { + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members`, or principals, to a single `role`. Principals can be user\naccounts, service accounts, Google groups, and domains (such as G Suite). A\n`role` is a named list of permissions; each `role` can be an IAM predefined\nrole or a user-created custom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n```\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n```\n\n**YAML example:**\n\n```\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n etag: BwWWja0YfJA=\n version: 3\n```\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "type": "object", + "properties": { + "version": { + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "type": "integer", + "format": "int32" + }, + "bindings": { + "description": "Associates a list of `members`, or principals, with a `role`. Optionally,\nmay specify a `condition` that determines how and when the `bindings` are\napplied. Each of the `bindings` must contain at least one principal.\n\nThe `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250\nof these principals can be Google groups. Each occurrence of a principal\ncounts towards these limits. For example, if the `bindings` grant 50\ndifferent roles to `user:alice@example.com`, and not to any other\nprincipal, then you can add another 1,450 principals to the `bindings` in\nthe `Policy`.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleIamV1Binding" + } + }, + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleIamV1AuditConfig" + } + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.", + "type": "string", + "format": "byte" + } + } + }, + "GoogleIamV1Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "type": "object", + "properties": { + "role": { + "description": "Role that is assigned to the list of `members`, or principals.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\n\nFor an overview of the IAM roles and permissions, see the\n[IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For\na list of the available pre-defined roles, see\n[here](https://cloud.google.com/iam/docs/understanding-roles).", + "type": "string" + }, + "members": { + "description": "Specifies the principals requesting access for a Google Cloud resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n Does not include identities that come from external identity providers\n (IdPs) through identity federation.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a Google\n service account. For example,\n `my-other-app@appspot.gserviceaccount.com`.\n\n* `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An\n identifier for a\n [Kubernetes service\n account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).\n For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n\n\n\n* `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:\n A single identity in a workforce identity pool.\n\n* `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:\n All workforce identities in a group.\n\n* `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:\n All workforce identities with a specific attribute value.\n\n* `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:\n All identities in a workforce identity pool.\n\n* `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:\n A single identity in a workload identity pool.\n\n* `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:\n A workload identity pool group.\n\n* `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:\n All identities in a workload identity pool with a certain attribute.\n\n* `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:\n All identities in a workload identity pool.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n* `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:\n Deleted single identity in a workforce identity pool. For example,\n `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", + "type": "array", + "items": { + "type": "string" + } + }, + "condition": { + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the principals in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "allOf": [{ + "$ref": "#/components/schemas/GoogleTypeExpr" + }] + } + } + }, + "GoogleTypeExpr": { + "description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.", + "type": "object", + "properties": { + "expression": { + "description": "Textual representation of an expression in Common Expression Language\nsyntax.", + "type": "string" + }, + "title": { + "description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", + "type": "string" + }, + "description": { + "description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.", + "type": "string" + } + } + }, + "GoogleIamV1AuditConfig": { + "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\",\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\"\n },\n {\n \"log_type\": \"ADMIN_READ\"\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\",\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\"\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts `jose@example.com` from DATA_READ logging, and\n`aliya@example.com` from DATA_WRITE logging.", + "type": "object", + "properties": { + "service": { + "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", + "type": "string" + }, + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleIamV1AuditLogConfig" + } + } + } + }, + "GoogleIamV1AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\"\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.", + "type": "object", + "properties": { + "logType": { + "description": "The log type that this config enables.", + "type": "string", + "x-google-enum-descriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ] + }, + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleIamV1TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as `*` or `storage.*`) are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleIamV1TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata": { + "description": "The metadata for a bulk analyze conversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for bulk analyze.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" + }] + }, + "completedAnalysesCount": { + "description": "The number of requested analyses that have completed successfully so far.", + "type": "integer", + "format": "int32" + }, + "failedAnalysesCount": { + "description": "The number of requested analyses that have failed so far.", + "type": "integer", + "format": "int32" + }, + "totalRequestedAnalysesCount": { + "description": "Total number of analyses requested. Computed by the number of conversations\nreturned by `filter` multiplied by `analysis_percentage` in the request.", + "type": "integer", + "format": "int32" + }, + "partialErrors": { + "description": "Output only. Partial errors during bulk analyze operation that might cause the operation\noutput to be incomplete.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest": { + "description": "The request to analyze conversations in bulk.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource to create analyses in.", + "type": "string" + }, + "filter": { + "description": "Required. Filter used to select the subset of conversations to analyze.", + "type": "string" + }, + "analysisPercentage": { + "description": "Required. Percentage of selected conversation to analyze, between\n[0, 100].", + "type": "number", + "format": "float" + }, + "annotatorSelector": { + "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" + }] + } + }, + "required": [ + "parent", + "filter", + "analysisPercentage" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector": { + "description": "Selector of all available annotators and phrase matchers to run.", + "type": "object", + "properties": { + "runInterruptionAnnotator": { + "description": "Whether to run the interruption annotator.", + "type": "boolean" + }, + "runSilenceAnnotator": { + "description": "Whether to run the silence annotator.", + "type": "boolean" + }, + "runPhraseMatcherAnnotator": { + "description": "Whether to run the active phrase matcher annotator(s).", + "type": "boolean" + }, + "phraseMatchers": { + "description": "The list of phrase matchers to run. If not provided, all active phrase\nmatchers will be used. If inactive phrase matchers are provided, they will\nnot be used. Phrase matchers will be run only if\nrun_phrase_matcher_annotator is set to true. Format:\nprojects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", + "type": "array", + "items": { + "type": "string" + } + }, + "runSentimentAnnotator": { + "description": "Whether to run the sentiment annotator.", + "type": "boolean" + }, + "runEntityAnnotator": { + "description": "Whether to run the entity annotator.", + "type": "boolean" + }, + "runIntentAnnotator": { + "description": "Whether to run the intent annotator.", + "type": "boolean" + }, + "runIssueModelAnnotator": { + "description": "Whether to run the issue model annotator. A model should have already been\ndeployed for this to take effect.", + "type": "boolean" + }, + "issueModels": { + "description": "The issue model to run. If not provided, the most recently deployed topic\nmodel will be used. The provided issue model will only be used for\ninference if the issue model is deployed and if run_issue_model_annotator\nis set to true. If more than one issue model is provided, only the first\nprovided issue model will be used for inference.", + "type": "array", + "items": { + "type": "string" + } + }, + "runSummarizationAnnotator": { + "description": "Whether to run the summarization annotator.", + "type": "boolean" + }, + "summarizationConfig": { + "description": "Configuration for the summarization annotator.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig" + }] + }, + "runQaAnnotator": { + "description": "Whether to run the QA annotator.", + "type": "boolean" + }, + "qaConfig": { + "description": "Configuration for the QA annotator.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig": { + "description": "Configuration for summarization.", + "type": "object", + "properties": { + "conversationProfile": { + "description": "Resource name of the Dialogflow conversation profile.\nFormat:\nprojects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", + "type": "string" + }, + "summarizationModel": { + "description": "Default summarization model to be used.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified summarization model.", + "The CCAI baseline model. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead.", + "The CCAI baseline model, V2.0. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead." + ], + "x-google-enum-deprecated": [ + false, + true, + true + ], + "enum": [ + "SUMMARIZATION_MODEL_UNSPECIFIED", + "BASELINE_MODEL", + "BASELINE_MODEL_V2_0" + ] + }, + "generator": { + "description": "The resource name of the existing created generator. Format:\nprojects//locations//generators/", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig": { + "description": "Configuration for the QA feature.", + "type": "object", + "properties": { + "scorecardList": { + "description": "A manual list of scorecards to score.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList": { + "description": "Container for a list of scorecards.", + "type": "object", + "properties": { + "qaScorecardRevisions": { + "description": "List of QaScorecardRevisions.", + "type": "array", + "items": { + "type": "string" + } + }, + "predefinedQaScorecards": { + "description": "List of predefined scorecards.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PredefinedQaScorecardType" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse": { + "description": "The response for a bulk analyze conversations operation.", + "type": "object", + "properties": { + "successfulAnalysisCount": { + "description": "Count of successful analyses.", + "type": "integer", + "format": "int32" + }, + "failedAnalysisCount": { + "description": "Count of failed analyses.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata": { + "description": "The metadata for a bulk delete conversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for bulk delete.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during bulk delete conversations operation that might cause\nthe operation output to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest": { + "description": "The request to delete conversations in bulk.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource to delete conversations from.\nFormat:\nprojects/{project}/locations/{location}", + "type": "string" + }, + "filter": { + "description": "Filter used to select the subset of conversations to delete.", + "type": "string" + }, + "maxDeleteCount": { + "description": "Maximum number of conversations to delete.", + "type": "integer", + "format": "int32" + }, + "force": { + "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", + "type": "boolean" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse": { + "description": "The response for a bulk delete conversations operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata": { + "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", + "type": "object", + "properties": { + "request": { + "description": "Output only. The original request for delete.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during deletion operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest": { + "description": "Request for the BulkDeleteFeedbackLabels endpoint.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "type": "string" + }, + "filter": { + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "type": "string" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse": { + "description": "Response for the BulkDeleteFeedbackLabels endpoint.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkUpdateQaQuestionsMetadata": { + "description": "The metadata for bulk updating QaQuestions.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkUpdateQaQuestionsRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkUpdateQaQuestionsRequest": { + "description": "The request for bulk updating QaQuestions.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource for the bulk update job instance.", + "type": "string" + }, + "qaQuestions": { + "description": "Required. All the questions to be updated", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestion" + } + }, + "updateMask": { + "description": "Optional. All questions will be updated with the same mask.\nAn empty mask will means updating all updatable fields.", + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + }, + "required": [ + "parent", + "qaQuestions" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1QaQuestion": { + "description": "A single question to be scored by the Insights QA feature.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The resource name of the question.\nFormat:\nprojects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", + "x-google-identifier": true, + "type": "string" + }, + "abbreviation": { + "description": "Short, descriptive string, used in the UI where it's not practical\nto display the full question body. E.g., \"Greeting\".", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this question was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the question was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "questionType": { + "description": "The type of question.", + "type": "string", + "x-google-enum-descriptions": [ + "The type of the question is unspecified.", + "The default question type. The question is fully customizable by the\nuser.", + "The question type is using a predefined model provided by CCAI\nteams. Users are not allowed to edit the question_body, answer_choices,\nupload feedback labels for the question nor fine-tune the question.\nHowever, users may edit other fields like question tags, question order,\netc." + ], + "enum": [ + "QA_QUESTION_TYPE_UNSPECIFIED", + "CUSTOMIZABLE", + "PREDEFINED" + ] + }, + "questionMedium": { + "description": "The medium of the question.", + "type": "string", + "x-google-enum-descriptions": [ + "The medium of the question is unspecified.", + "The question is for chat conversations and will expect a chat transcript\nto be present before scoring.", + "The question is for voice conversations and does NOT expect any chat\ntranscripts to be present before scoring." + ], + "enum": [ + "QA_QUESTION_MEDIUM_UNSPECIFIED", + "CHAT", + "VOICE" + ] + }, + "qaQuestionDataOptions": { + "description": "Options for configuring the data used to generate the QA question.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions" + }] + }, + "predefinedQuestionConfig": { + "description": "The configuration of the predefined question. This field will only be set\nif the Question Type is predefined.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig" + }] + }, + "questionBody": { + "description": "Question text. E.g., \"Did the agent greet the customer?\"", + "type": "string" + }, + "answerInstructions": { + "description": "Instructions describing how to determine the answer.", + "type": "string" + }, + "answerChoices": { + "description": "A list of valid answers to the question, which the LLM must choose from.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice" + } + }, + "tags": { + "description": "Questions are tagged for categorization and scoring. Tags can either be:\n- Default Tags: These are predefined categories. They are identified by\ntheir string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\").\n- Custom Tags: These are user-defined categories. They are identified by\ntheir full resource name (e.g.,\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}).\nBoth default and custom tags are used to group questions and to influence\nthe scoring of each question.", + "type": "array", + "items": { + "type": "string" + } + }, + "order": { + "description": "Defines the order of the question within its parent scorecard revision.", + "type": "integer", + "format": "int32" + }, + "metrics": { + "description": "Metrics of the underlying tuned LLM over a holdout/test set while fine\ntuning the underlying LLM for the given question. This field will only be\npopulated if and only if the question is part of a scorecard revision that\nhas been tuned.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics" + }] + }, + "tuningMetadata": { + "description": "Metadata about the tuning operation for the question.This field will only\nbe populated if and only if the question is part of a scorecard revision\nthat has been tuned.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions": { + "description": "Options for configuring the data used to generate the QA question.", + "type": "object", + "properties": { + "conversationDataOptions": { + "description": "Options for configuring the conversation data used to generate the QA\nquestion.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions": { + "description": "Options for configuring what metadata is included in the conversation data\nused in QAI and Discovery Engine.", + "type": "object", + "properties": { + "includeDialogflowInteractionData": { + "description": "Whether to include the per turn Dialogflow interaction data in conversation\ntranscript.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig": { + "description": "Configuration for a predefined question. This field will only be set if the\nQuestion Type is predefined.", + "type": "object", + "properties": { + "type": { + "description": "The type of the predefined question.", + "type": "string", + "x-google-enum-descriptions": [ + "The type of the predefined question is unspecified.", + "A prebuilt classifier classfying the outcome of the conversation.\nFor example, if the customer issue mentioned in a conversation has\nbeen resolved or not.", + "A prebuilt classifier classfying the initiator of the conversation\nescalation. For example, if it was initiated by the customer or the\nagent." + ], + "enum": [ + "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", + "CONVERSATION_OUTCOME", + "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice": { + "description": "Message representing a possible answer to the question.", + "type": "object", + "properties": { + "strValue": { + "description": "String value.", + "type": "string" + }, + "numValue": { + "description": "Numerical value.", + "type": "number", + "format": "double" + }, + "boolValue": { + "description": "Boolean value.", + "type": "boolean" + }, + "naValue": { + "description": "A value of \"Not Applicable (N/A)\". If provided, this field may only\nbe set to `true`. If a question receives this answer, it will be\nexcluded from any score calculations.", + "type": "boolean" + }, + "key": { + "description": "A short string used as an identifier.", + "type": "string" + }, + "score": { + "description": "Numerical score of the answer, used for generating the overall score of\na QaScorecardResult. If the answer uses na_value, this field is unused.", + "type": "number", + "format": "double" + }, + "nextActionConfig": { + "description": "Configuration for the next action to take if this answerChoice is\nselected for this question.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfig": { + "description": "The configuration for the next action. This is used to configure the next\naction to take if an answer choice is selected.", + "type": "object", + "properties": { + "runChildQaQuestionsAction": { + "description": "The list of questions to evaluate next, i.e., child questions.\nRequirements for this action are the following:\n1. The current question and child questions must be in the same\n scorecard and present in the same scorecard revision.\n2. The current question and child questions must not introduce a\n cycle, i.e., Q1 -> [Q2, Q3], then Q2 -> [Q1] should not be\n allowed, where Q1, Q2, and Q3 are questions.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction" + }] + }, + "terminateChildQaQuestionsAction": { + "description": "Terminate any further evaluation of child questions.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction": { + "description": "The configuration for evaluating child questions.", + "type": "object", + "properties": { + "childQaQuestionNames": { + "description": "A list of resource names representing the child questions to evaluate\nnext. The format for each question resource name is:\nprojects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions": { + "description": "Indicates termination.", + "type": "object", + "properties": { + "terminationType": { + "description": "The type of termination to perform.", + "type": "string", + "x-google-enum-descriptions": [ + "The termination type is unspecified.", + "A failed scorecard would mean the overall scorecard score will be\nzeroed out, i.e., the scorecard score will be 0.", + "The overall scorecard score will be calculated based on the\nscores of the questions answered in the chain up until the last\nscored question that was answered. This is the default behavior." + ], + "enum": [ + "TERMINATION_TYPE_UNSPECIFIED", + "TERMINATE_WITH_SCORECARD_FAILURE", + "TERMINATE_WITH_CALCULATED_SCORE" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics": { + "description": "A wrapper representing metrics calculated against a test-set on a LLM that\nwas fine tuned for this question.", + "type": "object", + "properties": { + "accuracy": { + "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the\nmodel gave on the test set.", + "readOnly": true, + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata": { + "description": "Metadata about the tuning operation for the question. Will only be set if a\nscorecard containing this question has been tuned.", + "type": "object", + "properties": { + "totalValidLabelCount": { + "description": "Total number of valid labels provided for the question at the time of\ntuining.", + "type": "string", + "format": "int64" + }, + "datasetValidationWarnings": { + "description": "A list of any applicable data validation warnings about the question's\nfeedback labels.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DatasetValidationWarning" + } + }, + "tuningError": { + "description": "Error status of the tuning operation for the question. Will only be set\nif the tuning operation failed.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkUpdateQaQuestionsResponse": { + "description": "The response for bulk updating QaQuestions.", + "type": "object", + "properties": { + "qaQuestions": { + "description": "The QaQuestions that were updated.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestion" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata": { + "description": "Metadata for a create analysis operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "conversation": { + "description": "Output only. The Conversation that this Analysis Operation belongs to.", + "readOnly": true, + "type": "string" + }, + "annotatorSelector": { + "description": "Output only. The annotator selector used for the analysis (if any).", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1CreateDiscoveryRevisionMetadata": { + "description": "Metadata for a discovery revision creation operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The request to create the discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateDiscoveryRevisionRequest" + }] + }, + "progress": { + "description": "The progress of the discovery creation operation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryProgress" + }] + }, + "resultRevision": { + "description": "Output only. The newly created discovery revision resource name.", + "readOnly": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1CreateDiscoveryRevisionRequest": { + "description": "The request to create a discovery revision.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the discovery.", + "type": "string" + }, + "discoveryRevision": { + "description": "Required. The discovery revision to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevision" + }] + }, + "discoveryRevisionId": { + "description": "Optional. The ID of the discovery revision to create.", + "type": "string" + } + }, + "required": [ + "parent", + "discoveryRevision" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevision": { + "description": "The discovery result revision resource. A revision is created when client\nspecifically requests via calling CreateDiscoveryRevision API. This\nusually happens when client is finalizing the feedbacks to previous revision.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Resource name of the DiscoveryRevision.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", + "x-google-identifier": true, + "type": "string" + }, + "snapshot": { + "description": "Output only. The snapshot of the discovery result at this revision.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Discovery" + }] + }, + "createTime": { + "description": "Output only. The time at which this discovery result revision was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the discovery result revision was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "feedback": { + "description": "The feedback for the discovery result under source_revision.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevisionFeedback" + }] + }, + "inputData": { + "description": "The input data to be used to create this revision.\nWhen not provided, the input data from the source revision will be used.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryInputDataConfig" + }] + }, + "sourceRevision": { + "description": "Immutable. The source of this discovery revision. i.e. this discovery revision is\nthe result of applying changes on top of source_revision. Format:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", + "x-google-immutable": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the discovery.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "This value is unused.", + "The discovery is running. There may be discovery results generated but\nthe final list or distributions are not finalized.", + "The discovery is completed. The final list or distributions are\nfinalized." + ], + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "COMPLETED" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1Discovery": { + "description": "The discovery resource.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Resource name of the discovery.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "User provided display name of the discovery. Modifying this will not change\nthe discovery result or behaviour.", + "type": "string" + }, + "languageCode": { + "description": "Immutable. The language code of the discovery results. When drill_down_parent is\nspecified, this field is inherited from the parent discovery.\nWhen neither language_code nor drill_down_parent is specified, defaults to\nen.", + "x-google-immutable": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this discovery was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the discovery was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "drillDownParent": { + "description": "Name of the discovery discovery result this discovery is a drill down of.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}\nIf empty, this discovery is a top level discovery.\nServer enforces at discovery resource creation time that this resource\nreference creates a tree structure and there's no cycle in the resource\nhierarchy. This field should not be updated once the discovery is created.", + "type": "string" + }, + "discoveryGoal": { + "description": "Required. Immutable. User specified goal for the discovery. This field is immutable once the\ndiscovery is created.", + "x-google-immutable": true, + "type": "string" + }, + "inputData": { + "description": "Specs for the input data used for this discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryInputDataConfig" + }] + }, + "customTaxonomy": { + "description": "User provided taxonomy to guide the discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryCustomTaxonomy" + }] + }, + "advancedOptions": { + "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryDiscoveryAdvancedOptions" + }] + } + }, + "required": [ + "discoveryGoal" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1DiscoveryInputDataConfig": { + "description": "Configuration for the input data used for discovery.", + "type": "object", + "properties": { + "conversationFilter": { + "description": "Optional. The filter for querying conversations.", + "type": "string" + }, + "maxSampleSize": { + "description": "Optional. Maximum number of conversations to sample.", + "type": "string", + "format": "int64" + }, + "dataset": { + "description": "Optional. The resource name of the Dataset to scope the discovery to.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}\nIf provided, discovery will only run on conversations within this dataset.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DiscoveryCustomTaxonomy": { + "description": "User provided taxonomy to guide the discovery.", + "type": "object", + "properties": { + "taxonomyEntries": { + "description": "Entries in the custom taxonomy.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryCustomTaxonomyTaxonomyEntry" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DiscoveryCustomTaxonomyTaxonomyEntry": { + "description": "A single entry in the custom taxonomy.", + "type": "object", + "properties": { + "displayName": { + "description": "Name of the taxonomy entry.", + "type": "string" + }, + "description": { + "description": "Description of the taxonomy entry.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DiscoveryDiscoveryAdvancedOptions": { + "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", + "type": "object", + "properties": { + "conversationDataOptions": { + "description": "Options for configuring what metadata goes into conversation\ntranscript.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevisionFeedback": { + "description": "Feedback for the discovery results under previous_revision.", + "type": "object", + "properties": { + "resultFeedback": { + "description": "DiscoveryResult level feedback.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevisionFeedbackResultFeedback" + } + }, + "revisionFeedback": { + "description": "DiscoveryRevision level feedback.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevisionFeedbackResultFeedback": { + "description": "Content of a DiscoveryResult level feedback. i.e. Feedback applied\nspecifically to a DiscoveryResult.", + "type": "object", + "properties": { + "result": { + "description": "Resource name of the discovery result this feedback is for.\nThe parent discovery revision of the result must be the same as what's\nspecified in the source_revision field.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}", + "type": "string" + }, + "feedback": { + "description": "The feedback for the discovery result.", + "type": "string" + }, + "userAction": { + "description": "The user action for the entry feedback.", + "type": "string", + "x-google-enum-descriptions": [ + "Default value.", + "The user wants to remove the discovery result.", + "The user provides an exact replacement for the display name.", + "The user provides an exact replacement for the description.", + "The user provides comments/instructions on how to modify the display\nname.", + "The user provides comments/instructions on how to modify the\ndescription." + ], + "enum": [ + "USER_ACTION_UNSPECIFIED", + "REMOVE", + "SET_DISPLAY_NAME", + "SET_DESCRIPTION", + "SUGGEST_DISPLAY_NAME_EDIT", + "SUGGEST_DESCRIPTION_EDIT" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DiscoveryProgress": { + "description": "Progress information for a discovery.", + "type": "object", + "properties": { + "progressState": { + "description": "Output only. The state of the discovery creation or refinement.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "Default value. This value is unused.", + "The input data is being preprocessed.", + "Summarizing the conversations to extract features.", + "Generating the results based on the features.", + "Calculating the distributions for the results.", + "The discovery is being finalized.", + "The GenerateDiscovery operation has completed successfully." + ], + "enum": [ + "PROGRESS_STATE_UNSPECIFIED", + "PREPROCESSING", + "SUMMARIZING", + "GENERATING_RESULTS", + "COMPUTING_DISTRIBUTIONS", + "FINALIZING", + "SUCCEEDED" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1CreateFaqModelMetadata": { + "description": "Metadata for creating an FAQ model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for creation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateFaqModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1CreateFaqModelRequest": { + "description": "The request to create an FAQ model.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the FAQ model.", + "type": "string" + }, + "faqModel": { + "description": "Required. The FAQ model to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqModel" + }] + }, + "faqModelId": { + "description": "Optional. The ID to use for the FAQ model, which will become the final\ncomponent of the FAQ model's resource name.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", + "type": "string" + } + }, + "required": [ + "parent", + "faqModel" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1FaqModel": { + "description": "The FAQ model resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the FAQ model.\nFormat:\nprojects/{project}/locations/{location}/faqModels/{faq_model}", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The representative name for the FAQ model.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this FAQ model was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the FAQ model was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "faqEntryCount": { + "description": "Output only. Number of FAQ entries in this FAQ model.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "state": { + "description": "Output only. State of the FAQ model.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Model is not deployed but is ready to deploy.", + "Model is being deleted." + ], + "enum": [ + "STATE_UNSPECIFIED", + "UNDEPLOYED", + "DELETING" + ] + }, + "inputDataConfig": { + "description": "Configs for the input data used to create the FAQ model.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqModelInputDataConfig" + }] + }, + "modelTrainingStats": { + "description": "Output only. Immutable. The model statistics on its training data.", + "readOnly": true, + "x-google-immutable": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqModelModelStats" + }] + }, + "infobotAgent": { + "description": "Immutable. The resource name of the infobot agent to be used to create generative\nanswers. Format: projects/{project}/locations/{location}/agents/{agent}", + "x-google-immutable": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1FaqModelInputDataConfig": { + "description": "Configs for the input data used to create the FAQ model.", + "type": "object", + "properties": { + "trainingConversationsCount": { + "description": "Output only. Number of conversations used in training. Output only.", + "readOnly": true, + "type": "string", + "format": "int64" + }, + "filter": { + "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1FaqModelModelStats": { + "description": "Train/inference statistics for the model.", + "type": "object", + "properties": { + "totalConversationsCount": { + "description": "Total number of conversations analyzed at this point in time.", + "type": "integer", + "format": "int32" + }, + "skippedConversationsCount": { + "description": "Number of analyzed conversations which were skipped e.g. customer\ndisconnected from the call.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata": { + "description": "Metadata for creating an issue.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for creation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest": { + "description": "The request to create an issue.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the issue.", + "type": "string" + }, + "issue": { + "description": "Required. The values for the new issue.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Issue" + }] + } + }, + "required": [ + "parent", + "issue" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1Issue": { + "description": "The issue resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the issue.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The representative name for the issue.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this issue was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time that this issue was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "representativeConversationNames": { + "description": "Output only. Resource names of the most representative conversations matched.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "sampleUtterances": { + "description": "Output only. Resource names of the sample representative utterances that match to this\nissue.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "source": { + "description": "Source of the topic", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Generated based on the customers data - i.e. topic discovered by model.", + "Taxonomy provided by the customer (topic come from custom taxonomy)." + ], + "enum": [ + "ISSUE_SOURCE_UNSPECIFIED", + "GENERATED", + "CUSTOMER_PROVIDED" + ] + }, + "parentIssues": { + "description": "Unique identifiers of the parent topics for hierarchical representation.\nFormat is\n`projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}`", + "type": "array", + "items": { + "type": "string" + } + }, + "alternatives": { + "description": "Additional topic descriptions.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAlternative" + } + }, + "displayDescription": { + "description": "Representative description of the issue.", + "type": "string" + }, + "matchTarget": { + "description": "Target used for semantic similarity comparisons.\nPopulated on V2 models if the display name was renamed.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IssueAlternative": { + "description": "Alternative topic names or descriptions to improve inference.", + "type": "object", + "properties": { + "alternative": { + "description": "An alternative topic name.", + "type": "string" + }, + "description": { + "description": "An alternative topic description.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata": { + "description": "Metadata for creating an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for creation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest": { + "description": "The request to create an issue model.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the issue model.", + "type": "string" + }, + "issueModel": { + "description": "Required. The issue model to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel" + }] + } + }, + "required": [ + "parent", + "issueModel" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1IssueModel": { + "description": "The issue model resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the issue model.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The representative name for the issue model.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this issue model was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the issue model was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "issueCount": { + "description": "Output only. Number of issues in this issue model.", + "readOnly": true, + "type": "string", + "format": "int64" + }, + "state": { + "description": "Output only. State of the model.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Model is not deployed but is ready to deploy.", + "Model is being deployed.", + "Model is deployed and is ready to be used. A model can only be used in\nanalysis if it's in this state.", + "Model is being undeployed.", + "Model is being deleted." + ], + "enum": [ + "STATE_UNSPECIFIED", + "UNDEPLOYED", + "DEPLOYING", + "DEPLOYED", + "UNDEPLOYING", + "DELETING" + ] + }, + "inputDataConfig": { + "description": "Configs for the input data that used to create the issue model.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig" + }] + }, + "trainingStats": { + "description": "Output only. Immutable. The issue model's label statistics on its training data.", + "readOnly": true, + "x-google-immutable": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats" + }] + }, + "modelType": { + "description": "Type of the model.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified model type.", + "Type V1.", + "Type V2." + ], + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "TYPE_V1", + "TYPE_V2" + ] + }, + "languageCode": { + "description": "Language of the model.", + "type": "string" + }, + "multiLingualMatch": { + "description": "Whether the model can be used for analysis with conversations in multiple\nlanguages. The topic names and descriptions will be in the `language_code`\nspecified, but the matching will be performed against conversations in any\nlanguage.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig": { + "description": "Configs for the input data used to create the issue model.", + "type": "object", + "properties": { + "medium": { + "description": "Medium of conversations used in training data. This field is being\ndeprecated. To specify the medium to be used in training a new issue\nmodel, set the `medium` field on `filter`.", + "deprecated": true, + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "The format for conversations that took place over the phone.", + "The format for conversations that took place over chat." + ], + "enum": [ + "MEDIUM_UNSPECIFIED", + "PHONE_CALL", + "CHAT" + ] + }, + "trainingConversationsCount": { + "description": "Output only. Number of conversations used in training. Output only.", + "readOnly": true, + "type": "string", + "format": "int64" + }, + "filter": { + "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", + "type": "string" + }, + "customTaxonomy": { + "description": "Custom supplied taxonomy.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelCustomTaxonomy" + }] + }, + "issueGranularity": { + "description": "Issue granularity preference for model training.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Granularity much coarser than default.", + "Granularity coarser than default.", + "Default granularity.", + "Granularity finer than default.", + "Granularity much finer than default." + ], + "enum": [ + "ISSUE_GRANULARITY_UNSPECIFIED", + "MORE_COARSE", + "COARSE", + "STANDARD", + "FINE", + "MORE_FINE" + ] + }, + "industry": { + "description": "Customer industry, used to improve specificity of the topic model.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IssueModelCustomTaxonomy": { + "description": "Structure for custom supplied taxonomy. A custom taxonomy consists of\nmultiple taxonomy entries organized in a hierarchical way.", + "type": "object", + "properties": { + "taxonomyEntries": { + "description": "List of taxonomy entries.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelCustomTaxonomyTaxonomyEntry" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IssueModelCustomTaxonomyTaxonomyEntry": { + "description": "Structure for a taxonomy entry.", + "type": "object", + "properties": { + "id": { + "description": "Immutable. The Id of the taxonomy entry", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The content of the taxonomy entry.", + "type": "string" + }, + "parents": { + "description": "Ids of parent taxonomy entries.", + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "The description of the taxonomy entry.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats": { + "description": "Aggregated statistics about an issue model.", + "type": "object", + "properties": { + "analyzedConversationsCount": { + "description": "Number of conversations the issue model has analyzed at this point in time.", + "type": "string", + "format": "int64" + }, + "unclassifiedConversationsCount": { + "description": "Number of analyzed conversations for which no issue was applicable at this\npoint in time.", + "type": "string", + "format": "int64" + }, + "issueStats": { + "description": "Statistics on each issue. Key is the issue's resource name.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats": { + "description": "Aggregated statistics about an issue.", + "type": "object", + "properties": { + "issue": { + "description": "Issue resource.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", + "type": "string" + }, + "labeledConversationsCount": { + "description": "Number of conversations attached to the issue at this point in time.", + "type": "string", + "format": "int64" + }, + "displayName": { + "description": "Display name of the issue.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DeleteFaqModelMetadata": { + "description": "Metadata for deleting an FAQ model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for deletion.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteFaqModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DeleteFaqModelRequest": { + "description": "The request to delete an FAQ model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The name of the FAQ model to delete.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata": { + "description": "Metadata for deleting an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for deletion.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest": { + "description": "The request to delete an issue model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The name of the issue model to delete.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata": { + "description": "The metadata for deleting a QaQuestionTag Resource.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest": { + "description": "The request for deleting a QaQuestionTag.", + "type": "object", + "properties": { + "name": { + "description": "Required. The name of the QaQuestionTag to delete.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata": { + "description": "Metadata for deploying an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for deployment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest": { + "description": "The request to deploy an issue model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The issue model to deploy.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse": { + "description": "The response to deploy an issue model.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata": { + "description": "Metadata for an export insights operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for export.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during export operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "completedExportCount": { + "description": "The number of conversations that were exported successfully.", + "type": "integer", + "format": "int32" + }, + "failedExportCount": { + "description": "The number of conversations that failed to be exported.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest": { + "description": "The request to export insights.", + "type": "object", + "properties": { + "bigQueryDestination": { + "description": "Specified if sink is a BigQuery table.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination" + }] + }, + "parent": { + "description": "Required. The parent resource to export data from.", + "type": "string" + }, + "filter": { + "description": "A filter to reduce results to a specific subset. Useful for exporting\nconversations with specific properties.", + "type": "string" + }, + "kmsKey": { + "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK.\nFormat:\nprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", + "type": "string" + }, + "writeDisposition": { + "description": "Options for what to do if the destination table already exists.", + "type": "string", + "x-google-enum-descriptions": [ + "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", + "If the table already exists, BigQuery will overwrite the table data and\nuse the schema from the load.", + "If the table already exists, BigQuery will append data to the table." + ], + "enum": [ + "WRITE_DISPOSITION_UNSPECIFIED", + "WRITE_TRUNCATE", + "WRITE_APPEND" + ] + }, + "exportSchemaVersion": { + "description": "Optional. Version of the export schema.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified. Defaults to EXPORT_V3.", + "Export schema version 1.", + "Export schema version 2.", + "Export schema version 3.", + "Export schema version 4.", + "Export schema version 5.", + "Export schema version 6.", + "Export schema version 7.", + "Export schema version 8.", + "Export schema version 9.", + "Export schema version 10.", + "Export schema version 11.", + "Export schema version 12.", + "Export schema version 13.", + "Export schema version 14.", + "Export schema version 15.", + "Export schema version 16.", + "Export schema version 17.", + "Export schema version latest available." + ], + "enum": [ + "EXPORT_SCHEMA_VERSION_UNSPECIFIED", + "EXPORT_V1", + "EXPORT_V2", + "EXPORT_V3", + "EXPORT_V4", + "EXPORT_V5", + "EXPORT_V6", + "EXPORT_V7", + "EXPORT_V8", + "EXPORT_V9", + "EXPORT_V10", + "EXPORT_V11", + "EXPORT_V12", + "EXPORT_V13", + "EXPORT_V14", + "EXPORT_V15", + "EXPORT_V16", + "EXPORT_V17", + "EXPORT_VERSION_LATEST_AVAILABLE" + ] + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination": { + "description": "A BigQuery Table Reference.", + "type": "object", + "properties": { + "projectId": { + "description": "A project ID or number. If specified, then export will attempt to\nwrite data to this project instead of the resource project. Otherwise,\nthe resource project will be used.", + "type": "string" + }, + "dataset": { + "description": "Required. The name of the BigQuery dataset that the snapshot result should be\nexported to. If this dataset does not exist, the export call returns an\nINVALID_ARGUMENT error.", + "type": "string" + }, + "table": { + "description": "The BigQuery table name to which the insights data should be written.\nIf this table does not exist, the export call returns an INVALID_ARGUMENT\nerror.", + "type": "string" + } + }, + "required": [ + "dataset" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse": { + "description": "Response for an export insights operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata": { + "description": "Metadata used for export issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original export request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest": { + "description": "Request to export an issue model.", + "type": "object", + "properties": { + "gcsDestination": { + "description": "Google Cloud Storage URI to export the issue model to.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination" + }] + }, + "name": { + "description": "Required. The issue model to export.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination": { + "description": "Google Cloud Storage Object URI to save the issue model to.", + "type": "object", + "properties": { + "objectUri": { + "description": "Required. Format: `gs:///`", + "type": "string" + } + }, + "required": [ + "objectUri" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse": { + "description": "Response from export issue model", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerateDiscoveryMetadata": { + "description": "Metadata for GenerateDiscovery operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The request to create the discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerateDiscoveryRequest" + }] + }, + "progress": { + "description": "The progress of the discovery creation operation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryProgress" + }] + }, + "resultRevision": { + "description": "Output only. The DiscoveryRevision resource name that contains the result entries\ngenerated in this discovery.", + "readOnly": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerateDiscoveryRequest": { + "description": "The request to generate a discovery.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent of generated discovery request.\nWhen it's a Location resource, this operation creates a root discovery and\nits discovery workspace will be automatically created.\nWhen it's a discovery workspace resource, this operation creates a drill\ndown discovery. discovery.drill_down_parent should have the same discovery\nworkspace as the parent.", + "type": "string" + }, + "discovery": { + "description": "Required. Specifies the discovery to generate. The name field of the discovery will\nbe ignored.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Discovery" + }] + } + }, + "required": [ + "parent", + "discovery" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerateDiscoveryResponse": { + "description": "The response of generating a discovery.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata": { + "description": "The metadata for generative insights.", + "type": "object", + "properties": { + "errorMessages": { + "description": "The error message when the generative insights request fails.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse": { + "description": "The response for generative insights.", + "type": "object", + "properties": { + "generativeResponses": { + "description": "The full list of generative responses.\nEach response is ordered by time.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse" + } + }, + "transcript": { + "description": "The transcript of the generative insights conversation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse": { + "description": "Wrapper for storing the generative response for a chart.", + "type": "object", + "properties": { + "textOutput": { + "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", + "deprecated": true, + "type": "string" + }, + "generatedSqlQuery": { + "description": "The generated SQL query from the LLM. Will be populated during the\nchart building phase. The generated SQL will be cached in the\ncorresponding chart resource.", + "type": "string" + }, + "chartSpec": { + "description": "The chart spec for the data.\nThis will be specified in the vega-lite or vega format.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "textMessage": { + "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput": { + "description": "Wrapper for text output.", + "type": "object", + "properties": { + "text": { + "description": "The text output from the LLM.", + "type": "array", + "items": { + "type": "string" + } + }, + "textType": { + "description": "The type of text output.", + "type": "string", + "x-google-enum-descriptions": [ + "The type is unspecified.", + "The text is part of LLM reasoning.", + "The text is the final answer from LLM.", + "The text is an informational message about the agent's progress, such\nas a tool being invoked. This is distinct from the agent's internal\nthought process (`THOUGHT`) and the final answer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the agent's\nactions." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "THOUGHT", + "FINAL_RESPONSE", + "PROGRESS" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript": { + "description": "The conversation transcript for the chart.", + "type": "object", + "properties": { + "conversationId": { + "description": "The conversation id of the chart.", + "type": "string" + }, + "createTime": { + "description": "Output only. The create time of the conversation.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The update time of the conversation.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "messages": { + "description": "Ordered list of messages, including user inputs and system responses.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage": { + "description": "The message in the conversation.", + "type": "object", + "properties": { + "userMessage": { + "description": "A message from the user that is interacting with the system.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage" + }] + }, + "systemMessageWrapper": { + "description": "A wrapper for system messages per turn.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages" + }] + }, + "messageId": { + "description": "The message id of the message.", + "type": "string" + }, + "createTime": { + "description": "Output only. For user messages, this is the time at which the system received the\nmessage. For system messages, this is the time at which the system\ngenerated the message.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage": { + "description": "The user message.", + "type": "object", + "properties": { + "text": { + "description": "A message from the user that is interacting with the system.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages": { + "description": "A wrapper for system messages per turn.", + "type": "object", + "properties": { + "systemMessages": { + "description": "A message from the system in response to the user.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage": { + "description": "A message from the system in response to the user. This message can\nalso be a message from the user as historical context for multiturn\nconversations with the system.", + "type": "object", + "properties": { + "textMessage": { + "description": "A direct natural language response to the user message.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" + }] + }, + "generatedSqlQuery": { + "description": "Raw SQL from LLM, before templatization", + "type": "string" + }, + "chartSpec": { + "description": "Chart spec from LLM", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "userProvidedSqlQuery": { + "description": "Optional. User provided SQL query", + "type": "string" + }, + "userProvidedChartSpec": { + "description": "Optional. User provided chart spec", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { + "description": "A text output message from the system.", + "type": "object", + "properties": { + "text": { + "description": "The parts of the message.", + "type": "array", + "items": { + "type": "string" + } + }, + "textType": { + "description": "The type of the text message.", + "type": "string", + "x-google-enum-descriptions": [ + "The default text type.", + "The text is a thinking plan generated by the thinking tool.", + "The text is a final response to the user question.", + "The text is an informational message about the agent's\nprogress, such as a tool being invoked. This is distinct from\nthe agent's internal thought process (`THOUGHT`) and the final\nanswer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the\nagent's actions." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "THOUGHT", + "FINAL_RESPONSE", + "PROGRESS" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata": { + "description": "Metadata used for import issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original import request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest": { + "description": "Request to import an issue model.", + "type": "object", + "properties": { + "gcsSource": { + "description": "Google Cloud Storage source message.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource" + }] + }, + "parent": { + "description": "Required. The parent resource of the issue model.", + "type": "string" + }, + "createNewModel": { + "description": "Optional. If set to true, will create an issue model from the imported file with\nrandomly generated IDs for the issue model and corresponding issues.\nOtherwise, replaces an existing model with the same ID as the file.", + "type": "boolean" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource": { + "description": "Google Cloud Storage Object URI to get the issue model file from.", + "type": "object", + "properties": { + "objectUri": { + "description": "Required. Format: `gs:///`", + "type": "string" + } + }, + "required": [ + "objectUri" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse": { + "description": "Response from import issue model", + "type": "object", + "properties": { + "issueModel": { + "description": "The issue model that was imported.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata": { + "description": "The metadata for an IngestConversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for ingest.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" + }] + }, + "partialErrors": { + "description": "Output only. Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "ingestConversationsStats": { + "description": "Output only. Statistics for IngestConversations operation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats" + }] + }, + "sampledConversations": { + "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest": { + "description": "The request to ingest conversations.", + "type": "object", + "properties": { + "gcsSource": { + "description": "A cloud storage bucket source. Note that any previously ingested objects\nfrom the source will be skipped to avoid duplication.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource" + }] + }, + "transcriptObjectConfig": { + "description": "Configuration for when `source` contains conversation transcripts.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig" + }] + }, + "parent": { + "description": "Required. The parent resource for new conversations.", + "type": "string" + }, + "conversationConfig": { + "description": "Configuration that applies to all conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig" + }] + }, + "redactionConfig": { + "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config\nspecified in Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" + }] + }, + "speechConfig": { + "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config\nspecified in Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" + }] + }, + "sampleSize": { + "description": "Optional. If set, this fields indicates the number of objects to ingest from the\nCloud Storage bucket. If empty, the entire bucket will be ingested.\nUnless they are first deleted, conversations produced through sampling\nwon't be ingested by subsequent ingest requests.", + "type": "integer", + "format": "int32" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource": { + "description": "Configuration for Cloud Storage bucket sources.", + "type": "object", + "properties": { + "bucketUri": { + "description": "Optional. The Cloud Storage bucket containing source objects.\nAvoid passing this. Pass this through one of `transcript_bucket_uri` or\n`audio_bucket_uri`.", + "type": "string" + }, + "bucketObjectType": { + "description": "Optional. Specifies the type of the objects in `bucket_uri`.\nAvoid passing this. This is inferred from the `transcript_bucket_uri`,\n`audio_bucket_uri`.", + "type": "string", + "x-google-enum-descriptions": [ + "The object type is unspecified and will default to `TRANSCRIPT`.", + "The object is a transcript.", + "The object is an audio file." + ], + "enum": [ + "BUCKET_OBJECT_TYPE_UNSPECIFIED", + "TRANSCRIPT", + "AUDIO" + ] + }, + "transcriptBucketUri": { + "description": "Optional. The Cloud Storage path to the conversation transcripts. Note\nthat: [1] Transcript files are expected to be in JSON format. [2]\nTranscript, audio, metadata files must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", + "type": "string" + }, + "audioBucketUri": { + "description": "Optional. The Cloud Storage path to the conversation audio file.\nNote that: [1] Audio files will be transcribed if not already.\n[2] Audio files and transcript files must be in separate\nbuckets / folders.\n[3] A source file and its corresponding audio file\nmust share the same name to\n be properly ingested, E.g.\n `gs://bucket/transcript/conversation1.json` and\n `gs://bucket/audio/conversation1.mp3`.", + "type": "string" + }, + "metadataBucketUri": { + "description": "Optional. The Cloud Storage path to the conversation metadata. Note that:\n[1] Metadata files are expected to be in JSON format.\n[2] Metadata and source files (transcripts or audio) must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", + "type": "string" + }, + "customMetadataKeys": { + "description": "Optional. Custom keys to extract as conversation labels from metadata files in\n`metadata_bucket_uri`. Keys not included in this field will be ignored.\nNote that there is a limit of 100 labels per conversation.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig": { + "description": "Configuration for processing transcript objects.", + "type": "object", + "properties": { + "medium": { + "description": "Required. The medium transcript objects represent.", + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "The format for conversations that took place over the phone.", + "The format for conversations that took place over chat." + ], + "enum": [ + "MEDIUM_UNSPECIFIED", + "PHONE_CALL", + "CHAT" + ] + } + }, + "required": [ + "medium" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig": { + "description": "Configuration that applies to all conversations.", + "type": "object", + "properties": { + "agentId": { + "description": "Optional. An opaque, user-specified string representing a human agent who handled\nall conversations in the import. Note that this will be overridden if\nper-conversation metadata is provided through the `metadata_bucket_uri`.", + "type": "string" + }, + "agentChannel": { + "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", + "type": "integer", + "format": "int32" + }, + "customerChannel": { + "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig": { + "description": "DLP resources used for redaction while ingesting conversations.\nDLP settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint or the Dialogflow / Agent\nAssist runtime integrations. When using Dialogflow / Agent Assist runtime\nintegrations, redaction should be performed in Dialogflow / Agent Assist.", + "type": "object", + "properties": { + "deidentifyTemplate": { + "description": "The fully-qualified DLP deidentify template resource name.\nFormat:\n`projects/{project}/deidentifyTemplates/{template}`", + "type": "string" + }, + "inspectTemplate": { + "description": "The fully-qualified DLP inspect template resource name.\nFormat:\n`projects/{project}/locations/{location}/inspectTemplates/{template}`", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig": { + "description": "Speech-to-Text configuration.\nSpeech-to-Text settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint.", + "type": "object", + "properties": { + "speechRecognizer": { + "description": "The fully-qualified Speech Recognizer resource name.\nFormat:\n`projects/{project_id}/locations/{location}/recognizer/{recognizer}`", + "type": "string" + }, + "disableWordTimeOffsets": { + "description": "Whether to disable word time offsets.\nIf true, the `enable_word_time_offsets` field in the recognition config\nwill be set to false.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats": { + "description": "Statistics for IngestConversations operation.", + "type": "object", + "properties": { + "processedObjectCount": { + "description": "Output only. The number of objects processed during the ingest operation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "duplicatesSkippedCount": { + "description": "Output only. The number of objects skipped because another conversation with the same\ntranscript uri had already been ingested.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "successfulIngestCount": { + "description": "Output only. The number of new conversations added during this ingest operation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "failedIngestCount": { + "description": "Output only. The number of objects which were unable to be ingested due to errors.\nThe errors are populated in the partial_errors field.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse": { + "description": "The response to an IngestConversations operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for initialization.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during initializing operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "type": "object", + "properties": { + "encryptionSpec": { + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms\nkey is in the same region as the endpoint. The same key will be used for\nall provisioned resources, if encryption is available. If the\n`kms_key_name` field is left empty, no encryption will be enforced.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" + }] + } + }, + "required": [ + "encryptionSpec" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all\ncreated resources (e.g. `Conversation`).", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the encryption key specification resource.\nFormat:\nprojects/{project}/locations/{location}/encryptionSpec", + "x-google-immutable": true, + "type": "string" + }, + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to\nsecure a resource and its sub-resources. If empty, the resource is secured\nby our default encryption key. Only the key in the same location as this\nresource is allowed to be used for encryption. Format:\n`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + } + }, + "required": [ + "kmsKey" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse": { + "description": "The response to initialize a location-level encryption specification.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse": { + "description": "The response for listing all feedback labels.", + "type": "object", + "properties": { + "feedbackLabels": { + "description": "The feedback labels that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel": { + "description": "Represents a conversation, resource, and label provided by the user.\nCan take the form of a string label or a QaAnswer label.\nQaAnswer labels are used for Quality AI example conversations.\nString labels are used for Topic Modeling.\nAgentAssistSummary labels are used for Agent Assist Summarization.", + "type": "object", + "properties": { + "label": { + "description": "String label used for Topic Modeling.", + "type": "string" + }, + "qaAnswerLabel": { + "description": "QaAnswer label used for Quality AI example conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" + }] + }, + "name": { + "description": "Immutable. Resource name of the FeedbackLabel.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", + "x-google-immutable": true, + "type": "string" + }, + "labeledResource": { + "description": "Name of the resource to be labeled.\nSupported resources are:\n\n* `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}`\n* `projects/{project}/locations/{location}/issueModels/{issue_model}`\n* `projects/{project}/locations/{location}/generators/{generator_id}`", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the label.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. Update time of the label.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue": { + "description": "Message for holding the value of a QaAnswer.\nQaQuestion.AnswerChoice defines the possible answer values for a\nquestion.", + "type": "object", + "properties": { + "strValue": { + "description": "String value.", + "type": "string" + }, + "numValue": { + "description": "Numerical value.", + "type": "number", + "format": "double" + }, + "boolValue": { + "description": "Boolean value.", + "type": "boolean" + }, + "naValue": { + "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", + "type": "boolean" + }, + "skipValue": { + "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`.\nIf a question receives this answer, it will be excluded from any score\ncalculations. This would mean that the question was not evaluated.", + "readOnly": true, + "type": "boolean" + }, + "key": { + "description": "A short string used as an identifier. Matches the value used in\nQaQuestion.AnswerChoice.key.", + "type": "string" + }, + "score": { + "description": "Output only. Numerical score of the answer.", + "readOnly": true, + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "Output only. The maximum potential score of the question.", + "readOnly": true, + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", + "readOnly": true, + "type": "number", + "format": "double" + }, + "rationale": { + "description": "Output only. The rationale for the answer. This field is only populated for answers\nthat are generated by the LLM. Manual edits currently do not have\nrationales.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale": { + "description": "Wrapper for the rationale for the answer.", + "type": "object", + "properties": { + "rationale": { + "description": "The rationale string for the answer.", + "type": "string" + }, + "rationaleSource": { + "description": "The source of the rationale. A manual edit AnswerValue could still\ncontain a system generated rationale if user didn't provide one. Manual\nedit would override the system generated rationale.", + "type": "string", + "x-google-enum-descriptions": [ + "The rationale source is unspecified. This value should generally not\nbe used.", + "The rationale is system generated.", + "The rationale is manually added by the user." + ], + "enum": [ + "RATIONALE_SOURCE_UNSPECIFIED", + "RATIONALE_SOURCE_SYSTEM_GENERATED", + "RATIONALE_SOURCE_MANUAL_EDIT" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse": { + "description": "The response for listing feedback labels.", + "type": "object", + "properties": { + "feedbackLabels": { + "description": "The feedback labels that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" + } + }, + "nextPageToken": { + "description": "The next page token.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1MergeIssuesMetadata": { + "description": "Metadata for creating an issue.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata": { + "description": "The metadata from querying metrics.", + "type": "object", + "properties": { + "resultIsTruncated": { + "description": "Whether the result rows were truncated because the result row size is too\nlarge to materialize.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse": { + "description": "The response for querying metrics.", + "type": "object", + "properties": { + "location": { + "description": "Required. The location of the data.\n\"projects/{project}/locations/{location}\"", + "type": "string" + }, + "updateTime": { + "description": "The metrics last update time.", + "type": "string", + "format": "date-time" + }, + "slices": { + "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" + } + }, + "macroAverageSlice": { + "description": "The macro average slice contains aggregated averages across all selected\ndimensions. i.e. if group_by agent and scorecard_id is specified, this\nfield will contain the average across all agents and all scorecards. This\nfield is only populated if the request specifies a Dimension.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" + }] + } + }, + "required": [ + "location" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice": { + "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.\n\nFor example, if the request specifies a single ISSUE dimension and it has a\ncardinality of 2 (i.e. the data used to compute the metrics has 2 issues in\ntotal), the response will have 2 slices:\n\n* Slice 1 -> dimensions=[Issue 1]\n* Slice 2 -> dimensions=[Issue 2]", + "type": "object", + "properties": { + "dimensions": { + "description": "A unique combination of dimensions that this slice represents.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Dimension" + } + }, + "total": { + "description": "The total metric value. The interval of this data point is\n[starting create time, ending create time) from the request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" + }] + }, + "timeSeries": { + "description": "A time series of metric values. This is only populated if the request\nspecifies a time granularity other than NONE.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1Dimension": { + "description": "A dimension determines the grouping key for the query. In SQL terms, these\nwould be part of both the \"SELECT\" and \"GROUP BY\" clauses.", + "type": "object", + "properties": { + "issueDimensionMetadata": { + "description": "Output only. Metadata about the issue dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata" + }] + }, + "agentDimensionMetadata": { + "description": "Output only. Metadata about the agent dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata" + }] + }, + "qaQuestionDimensionMetadata": { + "description": "Output only. Metadata about the QA question dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata" + }] + }, + "qaQuestionAnswerDimensionMetadata": { + "description": "Output only. Metadata about the QA question-answer dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata" + }] + }, + "qaScorecardDimensionMetadata": { + "description": "Output only. Metadata about the QA scorecard dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata" + }] + }, + "conversationProfileDimensionMetadata": { + "description": "Output only. Metadata about the conversation profile dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata" + }] + }, + "mediumDimensionMetadata": { + "description": "Output only. Metadata about the conversation medium dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata" + }] + }, + "conversationalAgentsPlaybookDimensionMetadata": { + "description": "Output only. Metadata about the Conversational Agents playbook dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata" + }] + }, + "conversationalAgentsToolDimensionMetadata": { + "description": "Output only. Metadata about the Conversational Agents tool dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata" + }] + }, + "clientSentimentCategoryDimensionMetadata": { + "description": "Output only. Metadata about the client sentiment category dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata" + }] + }, + "agentAssistSupervisorDimensionMetadata": { + "description": "Output only. Metadata about the supervisor for virtual agents dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionAgentAssistSupervisorDimensionMetadata" + }] + }, + "labelDimensionMetadata": { + "description": "Output only. Metadata about conversation labels.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata" + }] + }, + "dimensionKey": { + "description": "The key of the dimension.", + "type": "string", + "x-google-enum-descriptions": [ + "The key of the dimension is unspecified.", + "The dimension is keyed by issues.", + "The dimension is keyed by issue names.", + "The dimension is keyed by agents.", + "The dimension is keyed by agent teams.", + "The dimension is keyed by QaQuestionIds.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing stats for\nthe same question across different scorecard revisions.", + "The dimension is keyed by QaQuestionIds-Answer value pairs.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing\ndistribution of answers per question across different scorecard\nrevisions.", + "The dimension is keyed by QaScorecardIds.\nNote that: We only group by the ScorecardId and not the revision-id of\nthe scorecard. This allows for showing stats for the same scorecard\nacross different revisions.\nThis metric is mostly only useful if querying the average normalized\nscore per scorecard.", + "The dimension is keyed by the conversation profile ID.", + "The dimension is keyed by the conversation medium.", + "The dimension is keyed by the Conversational Agents playbook ID.", + "The dimension is keyed by the Conversational Agents playbook display\nname.", + "The dimension is keyed by the Conversational Agents tool ID.", + "The dimension is keyed by the Conversational Agents tool display name.", + "The dimension is keyed by the client sentiment category.", + "The dimension is keyed by the agent version ID.", + "The dimension is keyed by the agent deployment ID.", + "The dimension is keyed by the supervisor ID of the assigned human\nsupervisor for virtual agents.", + "The dimension is keyed by label keys.", + "The dimension is keyed by label values.", + "The dimension is keyed by label key-value pairs." + ], + "enum": [ + "DIMENSION_KEY_UNSPECIFIED", + "ISSUE", + "ISSUE_NAME", + "AGENT", + "AGENT_TEAM", + "QA_QUESTION_ID", + "QA_QUESTION_ANSWER_VALUE", + "QA_SCORECARD_ID", + "CONVERSATION_PROFILE_ID", + "MEDIUM", + "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", + "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", + "CONVERSATIONAL_AGENTS_TOOL_ID", + "CONVERSATIONAL_AGENTS_TOOL_NAME", + "CLIENT_SENTIMENT_CATEGORY", + "AGENT_VERSION_ID", + "AGENT_DEPLOYMENT_ID", + "AGENT_ASSIST_SUPERVISOR_ID", + "LABEL_KEY", + "LABEL_VALUE", + "LABEL_KEY_AND_VALUE" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata": { + "description": "Metadata about the issue dimension.", + "type": "object", + "properties": { + "issueId": { + "description": "The issue ID.", + "type": "string" + }, + "issueDisplayName": { + "description": "The issue display name.", + "type": "string" + }, + "issueModelId": { + "description": "The parent issue model ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata": { + "description": "Metadata about the agent dimension.", + "type": "object", + "properties": { + "agentId": { + "description": "Optional. A user-specified string representing the agent.\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentDisplayName": { + "description": "Optional. The agent's name\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentTeam": { + "description": "Optional. A user-specified string representing the agent's team.", + "type": "string" + }, + "agentVersionDisplayName": { + "description": "Optional. The agent's version display name. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentVersionId": { + "description": "Optional. The agent's version ID. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentDeploymentDisplayName": { + "description": "Optional. The agent's deployment display name. Only applicable to automated agents.\nThis will be populated for AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentDeploymentId": { + "description": "Optional. The agent's deployment ID. Only applicable to automated agents.\nThis will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata": { + "description": "Metadata about the QA question dimension.", + "type": "object", + "properties": { + "qaScorecardId": { + "description": "Optional. The QA scorecard ID.", + "type": "string" + }, + "qaQuestionId": { + "description": "Optional. The QA question ID.", + "type": "string" + }, + "questionBody": { + "description": "Optional. The full body of the question.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata": { + "description": "Metadata about the QA question-answer dimension.\nThis is useful for showing the answer distribution for questions for a\ngiven scorecard.", + "type": "object", + "properties": { + "qaScorecardId": { + "description": "Optional. The QA scorecard ID.", + "type": "string" + }, + "qaQuestionId": { + "description": "Optional. The QA question ID.", + "type": "string" + }, + "questionBody": { + "description": "Optional. The full body of the question.", + "type": "string" + }, + "answerValue": { + "description": "Optional. The full body of the question.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata": { + "description": "Metadata about the QA scorecard dimension.", + "type": "object", + "properties": { + "qaScorecardId": { + "description": "Optional. The QA scorecard ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata": { + "description": "Metadata about the conversation profile dimension.", + "type": "object", + "properties": { + "conversationProfileId": { + "description": "Optional. The conversation profile ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata": { + "description": "Metadata about the conversation medium dimension.", + "type": "object", + "properties": { + "medium": { + "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata": { + "description": "Metadata about the Conversational Agents playbook dimension.", + "type": "object", + "properties": { + "playbookId": { + "description": "Optional. The dialogflow playbook ID.", + "type": "string" + }, + "playbookDisplayName": { + "description": "Optional. The dialogflow playbook display name.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata": { + "description": "Metadata about the Conversational Agents tool dimension.", + "type": "object", + "properties": { + "toolId": { + "description": "Optional. The dialogflow tool ID.", + "type": "string" + }, + "toolDisplayName": { + "description": "Optional. The dialogflow tool display name.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata": { + "description": "Metadata about the client sentiment category dimension.", + "type": "object", + "properties": { + "sentimentCategory": { + "description": "Optional. The client sentiment category.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentAssistSupervisorDimensionMetadata": { + "description": "Metadata about AA's human supervisor dimension.", + "type": "object", + "properties": { + "supervisorId": { + "description": "Optional. ID of the assigned supervisor.", + "type": "string" + }, + "supervisorUsername": { + "description": "Optional. User name of the assigned supervisor.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata": { + "description": "Metadata about conversation labels.", + "type": "object", + "properties": { + "labelKey": { + "description": "Optional. The label key.", + "type": "string" + }, + "labelValue": { + "description": "Optional. The label value.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint": { + "description": "A data point contains the metric values mapped to an interval.", + "type": "object", + "properties": { + "conversationMeasure": { + "description": "The measure related to conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure" + }] + }, + "dialogflowInteractionMeasure": { + "description": "The measure related to dialogflow interactions.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" + }] + }, + "interval": { + "description": "The interval that this data point represents.\n\n* If this is the total data point, the interval is\n[starting create time, ending create time) from the request.\n* If this a data point from the time series, the interval is\n[time, time + time granularity from the request).", + "allOf": [{ + "$ref": "#/components/schemas/GoogleTypeInterval" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure": { + "description": "The measure related to conversations.", + "type": "object", + "properties": { + "conversationCount": { + "description": "The conversation count.", + "type": "integer", + "format": "int32" + }, + "averageSilencePercentage": { + "description": "The average silence percentage.", + "type": "number", + "format": "float" + }, + "averageDuration": { + "description": "The average duration.", + "type": "string", + "format": "google-duration" + }, + "averageTurnCount": { + "description": "The average turn count.", + "type": "number", + "format": "float" + }, + "averageAgentSentimentScore": { + "description": "The average agent's sentiment score.", + "type": "number", + "format": "float" + }, + "averageClientSentimentScore": { + "description": "The average client's sentiment score.", + "type": "number", + "format": "float" + }, + "averageCustomerSatisfactionRating": { + "description": "The average customer satisfaction rating.", + "type": "number", + "format": "double" + }, + "averageQaNormalizedScore": { + "description": "The average normalized QA score for a scorecard. When computing the\naverage across a set of conversations, if a conversation has been\nevaluated with multiple revisions of a scorecard, only the latest\nrevision results will be used. Will exclude 0's in average\ncalculation. Will be only populated if the request specifies a\ndimension of QA_SCORECARD_ID.", + "type": "number", + "format": "double" + }, + "qaTagScores": { + "description": "Average QA normalized score for all the tags.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" + } + }, + "averageQaQuestionNormalizedScore": { + "description": "Average QA normalized score averaged for questions averaged across\nall revisions of the parent scorecard.\nWill be only populated if the request specifies a dimension of\nQA_QUESTION_ID.", + "type": "number", + "format": "double" + }, + "knowledgeSearchResultCount": { + "description": "Count of knowledge search results (Generative Knowledge\nAssist) shown to the user.", + "type": "integer", + "format": "int32" + }, + "knowledgeSearchAgentQuerySourceRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nmade by the agent compared to the total number of knowledge search\nqueries made.", + "type": "number", + "format": "double" + }, + "knowledgeSearchSuggestedQuerySourceRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nsuggested compared to the total number of knowledge search\nqueries made.", + "type": "number", + "format": "double" + }, + "knowledgeAssistResultCount": { + "description": "Count of knowledge assist results (Proactive Generative Knowledge\nAssist) shown to the user.", + "type": "integer", + "format": "int32" + }, + "knowledgeSearchUriClickRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had a URL clicked.", + "type": "number", + "format": "double" + }, + "knowledgeAssistUriClickRatio": { + "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had a URL clicked.", + "type": "number", + "format": "double" + }, + "knowledgeSearchPositiveFeedbackRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had positive feedback.", + "type": "number", + "format": "double" + }, + "knowledgeSearchNegativeFeedbackRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had negative feedback.", + "type": "number", + "format": "double" + }, + "knowledgeAssistPositiveFeedbackRatio": { + "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had positive feedback.", + "type": "number", + "format": "double" + }, + "knowledgeAssistNegativeFeedbackRatio": { + "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had negative feedback.", + "type": "number", + "format": "double" + }, + "summarizationSuggestionEditRatio": { + "description": "Proportion of summarization suggestions that were manually edited.", + "type": "number", + "format": "double" + }, + "averageSummarizationSuggestionEditDistance": { + "description": "Average edit distance of the summarization suggestions. Edit\ndistance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion.", + "type": "number", + "format": "double" + }, + "averageSummarizationSuggestionNormalizedEditDistance": { + "description": "Normalized Average edit distance of the summarization suggestions.\nEdit distance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion. Normalized edit distance is the average of (edit distance\n/ summary length).", + "type": "number", + "format": "double" + }, + "conversationSuggestedSummaryRatio": { + "description": "Proportion of conversations that had a suggested summary.", + "type": "number", + "format": "double" + }, + "summarizationSuggestionResultCount": { + "description": "Count of summarization suggestions results.", + "type": "integer", + "format": "int32" + }, + "dialogflowInteractionsNoMatchRatio": { + "description": "Proportion of dialogflow interactions that has no intent match for\nthe input.", + "type": "number", + "format": "double" + }, + "dialogflowInteractionsNoInputRatio": { + "description": "Proportion of dialogflow interactions that has empty input.", + "type": "number", + "format": "double" + }, + "dialogflowWebhookFailureRatio": { + "description": "Proportion of dialogflow webhook calls that failed.", + "type": "number", + "format": "double" + }, + "dialogflowWebhookTimeoutRatio": { + "description": "Proportion of dialogflow webhook calls that timed out.", + "type": "number", + "format": "double" + }, + "dialogflowAverageWebhookLatency": { + "description": "Average latency of dialogflow webhook calls.", + "type": "number", + "format": "double" + }, + "dialogflowConversationsEscalationRatio": { + "description": "Proportion of conversations that was handed off from virtual agent to\nhuman agent.", + "type": "number", + "format": "double" + }, + "dialogflowConversationsEscalationCount": { + "description": "count of conversations that was handed off from virtual agent to\nhuman agent.", + "type": "number", + "format": "double" + }, + "conversationalAgentsToolCallSuccessRatio": { + "description": "Proportion of conversational agents' tool calls that were successful.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageToolCallLatency": { + "description": "Average latency of conversational agents' tool calls.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageTtsLatency": { + "description": "The macro average latency of conversational agents' TTS latency\nper interaction.\nThis is computed as the average of the all the interactions' TTS\nlatencies in a conversation and averaged across conversations.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageLlmCallLatency": { + "description": "The average latency of conversational agents' LLM call latency\nper interaction. This is computed as the average of the all the\ninteractions LLM call latencies in a conversation and averaged across\nconversations.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageAudioInAudioOutLatency": { + "description": "The average latency of conversational agents' audio in audio\nout latency per interaction.\nThis is computed as the average of the all the interactions' audio in\naudio out latencies in a conversation and averaged across\nconversations.", + "type": "number", + "format": "double" + }, + "conversationAiCoachSuggestionRatio": { + "description": "Proportion of conversations that has Ai Coach Suggestions.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionAgentUsageRatio": { + "description": "Proportion of Ai Coach Suggestion that has been used by agents.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionCustomerMessageTriggerRatio": { + "description": "Proportion of customer messages that triggered an Ai Coach\nSuggestion.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageEndToEndLatency": { + "description": "The average latency of conversational agents' latency per\ninteraction. This is computed as the average of the all the\niteractions' end to end latencies in a conversation and averaged\nacross conversations. The e2e latency is the time between the end of\nthe user utterance and the start of the agent utterance on the\ninteraction level.", + "type": "number", + "format": "double" + }, + "conversationAiCoachSuggestionCount": { + "description": "Count of conversations that has Ai Coach Suggestions.", + "type": "integer", + "format": "int32" + }, + "aiCoachSuggestionAgentUsageCount": { + "description": "Count of Ai Coach Suggestion that has been used by agents.", + "type": "integer", + "format": "int32" + }, + "aiCoachSuggestionCustomerMessageTriggerCount": { + "description": "Count of customer messages that triggered an Ai Coach\nSuggestion.", + "type": "integer", + "format": "int32" + }, + "aiCoachSuggestionAgentMessageTriggerCount": { + "description": "Count of agent messages that triggered an Ai Coach Suggestion.", + "type": "integer", + "format": "int32" + }, + "conversationTotalCustomerMessageCount": { + "description": "The customer message count.", + "type": "integer", + "format": "int32" + }, + "conversationTotalAgentMessageCount": { + "description": "The agent message count.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorMonitoredConversationsCount": { + "description": "The number of conversations scanned by the AA human supervisor.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorEscalatedConversationsCount": { + "description": "The number of conversations that were escalated to an AA human\nsupervisor for intervention.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorAssignedConversationsCount": { + "description": "The number of conversations that were assigned to an AA human\nsupervisor.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorDroppedConversationsCount": { + "description": "The number of conversations that were dropped, i.e. escalated but not\nassigned to an AA human supervisor.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorTransferredToHumanAgentConvCount": { + "description": "The number of conversations transferred to a human agent.", + "type": "integer", + "format": "int32" + }, + "avgConversationClientTurnSentimentEma": { + "description": "The exponential moving average of the sentiment score of client turns\nin the conversation.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionMessageTriggerRatio": { + "description": "Proportion of end_of_utterance trigger event messages that triggered\nan Ai Coach Suggestion.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionMessageTriggerCount": { + "description": "Count of end_of_utterance trigger event messages that triggered an Ai\nCoach Suggestion.", + "type": "integer", + "format": "int32" + }, + "containedConversationCount": { + "description": "The number of conversations that were contained.", + "type": "integer", + "format": "int32" + }, + "containedConversationRatio": { + "description": "The percentage of conversations that were contained.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { + "description": "Average QA normalized score for the tag.", + "type": "object", + "properties": { + "tag": { + "description": "Tag name.", + "type": "string" + }, + "averageTagNormalizedScore": { + "description": "Average tag normalized score per tag.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { + "description": "The measure related to dialogflow interactions.", + "type": "object", + "properties": { + "percentileAudioInAudioOutLatency": { + "description": "The percentile result for audio in audio out latency in milliseconds\nper dialogflow interaction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileLlmCallLatency": { + "description": "The percentile result for LLM latency in milliseconds per dialogflow\ninteraction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileTtsLatency": { + "description": "The percentile result for TTS latency in milliseconds per dialogflow\ninteraction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileToolUseLatency": { + "description": "The percentile result for tool use latency in milliseconds per\ndialogflow interaction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileEndToEndLatency": { + "description": "The percentile result for end to end chat latency in milliseconds per\ndialogflow interaction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult": { + "description": "The percentile result. Currently supported percentiles are 50th, 90th,\nand 99th.", + "type": "object", + "properties": { + "p50": { + "description": "The 50th percentile value.", + "type": "number", + "format": "double" + }, + "p90": { + "description": "The 90th percentile value.", + "type": "number", + "format": "double" + }, + "p99": { + "description": "The 99th percentile value.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries": { + "description": "A time series of metric values.", + "type": "object", + "properties": { + "dataPoints": { + "description": "The data points that make up the time series .", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata": { + "description": "The metadata for querying performance overview.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse": { + "description": "The response for querying performance overview.", + "type": "object", + "properties": { + "summaryText": { + "description": "The summary text of the performance.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata": { + "description": "The metadata for an SampleConversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for sample conversations to dataset.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" + }] + }, + "partialErrors": { + "description": "Output only. Partial errors during sample conversations operation that might\ncause the operation output to be incomplete.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "sampleConversationsStats": { + "description": "Output only. Statistics for SampleConversations operation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest": { + "description": "The request to sample conversations to a dataset.", + "type": "object", + "properties": { + "destinationDataset": { + "description": "The dataset resource to copy the sampled conversations to.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Dataset" + }] + }, + "parent": { + "description": "Required. The parent resource of the dataset.", + "type": "string" + }, + "sampleRule": { + "description": "Optional. The sample rule used for sampling conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SampleRule" + }] + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1Dataset": { + "description": "Dataset resource represents a collection of conversations\nthat may be bounded (Static Dataset, e.g. golden dataset for training),\nor unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", + "type": "object", + "properties": { + "name": { + "description": "Immutable. Identifier. Resource name of the dataset.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}", + "x-google-immutable": true, + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "Display name for the dataaset", + "type": "string" + }, + "description": { + "description": "Dataset description.", + "type": "string" + }, + "type": { + "description": "Dataset usage type.", + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "For evals only.", + "Dataset with new conversations coming in regularly (Insights legacy\nconversations and AI trainer)" + ], + "enum": [ + "TYPE_UNSPECIFIED", + "EVAL", + "LIVE" + ] + }, + "ttl": { + "description": "Optional. Option TTL for the dataset.", + "type": "string", + "format": "google-duration" + }, + "createTime": { + "description": "Output only. Dataset create time.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. Dataset update time.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1SampleRule": { + "description": "Message for sampling conversations.", + "type": "object", + "properties": { + "samplePercentage": { + "description": "Percentage of conversations that we should sample based on the dimension\nbetween [0, 100].", + "type": "number", + "format": "double" + }, + "sampleRow": { + "description": "Number of the conversations that we should sample based on the dimension.", + "type": "string", + "format": "int64" + }, + "dimension": { + "description": "Optional. Group by dimension to sample the conversation. If no dimension is\nprovided, the sampling will be applied to the project level.\nCurrent supported dimensions is 'quality_metadata.agent_info.agent_id'.", + "type": "string" + }, + "conversationFilter": { + "description": "To specify the filter for the conversions that should apply this sample\nrule. An empty filter means this sample rule applies to all conversations.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats": { + "description": "Statistics for SampleConversations operation.", + "type": "object", + "properties": { + "successfulSampleCount": { + "description": "Output only. The number of new conversations added during this sample operation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "failedSampleCount": { + "description": "Output only. The number of objects which were unable to be sampled due to errors.\nThe errors are populated in the partial_errors field.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse": { + "description": "The response to an SampleConversations operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata": { + "description": "Metadata for testing correlation config.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "dataset": { + "description": "The dataset used for sampling conversations.", + "type": "string" + }, + "stats": { + "description": "The statistics for the operation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats": { + "description": "Statistics for TestCorrelationConfig operation.", + "type": "object", + "properties": { + "sampledConversationsCount": { + "description": "The number of conversations sampled.", + "type": "integer", + "format": "int32" + }, + "correlatedConversationsCount": { + "description": "The number of conversations correlated.", + "type": "integer", + "format": "int32" + }, + "failedConversationsCount": { + "description": "The number of conversations that failed correlation.", + "type": "integer", + "format": "int32" + }, + "partialErrors": { + "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "conversationCorrelationErrors": { + "description": "A list of errors that occurred during correlation, one for each\nconversation that failed.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { + "description": "An error that occurred during correlation for a specific conversation.", + "type": "object", + "properties": { + "conversation": { + "description": "The conversation resource name that had an error during correlation.", + "type": "string" + }, + "status": { + "description": "The error status.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleRpcStatus" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse": { + "description": "The response of testing correlation config.", + "type": "object", + "properties": { + "detailedResults": { + "description": "Results for the DETAILED_SYNC execution mode.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults" + }] + }, + "partialErrors": { + "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults": { + "description": "Wrapper for detailed, step-by-step results.", + "type": "object", + "properties": { + "joinKeyResults": { + "description": "A list of join key correlation results for each conversation tested.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult" + } + }, + "constraintResults": { + "description": "A list of constraint evaluation results for each pair of conversations.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult": { + "description": "The result of testing correlation config on a single conversation.", + "type": "object", + "properties": { + "conversation": { + "description": "The conversation resource name.", + "type": "string" + }, + "ruleResults": { + "description": "The results for each correlation rule.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult": { + "description": "The result of a single correlation rule.", + "type": "object", + "properties": { + "correlationId": { + "description": "The correlation ID generated by the join key expression.", + "type": "string" + }, + "error": { + "description": "The error status if the join key expression failed to evaluate.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleRpcStatus" + }] + }, + "ruleId": { + "description": "The rule ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult": { + "description": "The result of testing a constraint expression on a pair of conversations.", + "type": "object", + "properties": { + "conversationA": { + "description": "The first conversation resource name.", + "type": "string" + }, + "conversationB": { + "description": "The second conversation resource name.", + "type": "string" + }, + "ruleConstraintResults": { + "description": "The results for each applicable constraint rule.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult": { + "description": "The result of a single constraint rule on the pair of conversations.", + "type": "object", + "properties": { + "constraintMet": { + "description": "Whether the constraint expression evaluated to true for (A, B) or (B,\nA).", + "type": "boolean" + }, + "error": { + "description": "The error status if the constraint expression failed to evaluate.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleRpcStatus" + }] + }, + "ruleId": { + "description": "The rule ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata": { + "description": "Metadata for undeploying an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for undeployment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest": { + "description": "The request to undeploy an issue model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The issue model to undeploy.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse": { + "description": "The response to undeploy an issue model.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata": { + "description": "The metadata for updating a QaQuestionTag Resource.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest": { + "description": "The request for updating a QaQuestionTag.", + "type": "object", + "properties": { + "qaQuestionTag": { + "description": "Required. The QaQuestionTag to update.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" + }] + }, + "updateMask": { + "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `qa_question_tag_name` - the name of the tag\n* `qa_question_ids` - the list of questions the tag applies to", + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + }, + "required": [ + "qaQuestionTag" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag": { + "description": "A tag is a resource which aims to categorize a set of questions across\nmultiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Resource name for the QaQuestionTag\nFormat\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}\nIn the above format, the last segment, i.e., qa_question_tag, is a\nserver-generated ID corresponding to the tag resource.", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "Required. A user-specified display name for the tag.", + "type": "string" + }, + "qaQuestionIds": { + "description": "Optional. The list of Scorecard Question IDs that the tag applies to.\nEach QaQuestionId is represented as a full resource name containing the\nQuestion ID. Lastly, Since a tag may not necessarily be referenced by any\nScorecard Questions, we treat this field as optional.", + "type": "array", + "items": { + "type": "string" + } + }, + "createTime": { + "description": "Output only. The time at which the question tag was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the question tag was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + }, + "required": [ + "displayName" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata": { + "description": "The metadata for an `UploadConversation` operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest" + }] + }, + "analysisOperation": { + "description": "Output only. The operation name for a successfully created analysis operation, if any.", + "readOnly": true, + "type": "string" + }, + "appliedRedactionConfig": { + "description": "Output only. The redaction config applied to the uploaded conversation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest": { + "description": "Request to upload a conversation.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the conversation.", + "type": "string" + }, + "conversation": { + "description": "Required. The conversation resource to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation" + }] + }, + "conversationId": { + "description": "Optional. A unique ID for the new conversation. This ID will become the final\ncomponent of the conversation's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", + "type": "string" + }, + "redactionConfig": { + "description": "Optional. DLP settings for transcript redaction. Will default to the config specified\nin Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" + }] + }, + "speechConfig": { + "description": "Optional. Speech-to-Text configuration. Will default to the config specified\nin Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" + }] + } + }, + "required": [ + "parent", + "conversation" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1Conversation": { + "description": "The conversation resource.", + "type": "object", + "properties": { + "callMetadata": { + "description": "Call-specific metadata.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata" + }] + }, + "expireTime": { + "description": "The time at which this conversation should expire. After this time, the\nconversation data and any associated analyses will be deleted.", + "type": "string", + "format": "date-time" + }, + "ttl": { + "description": "Input only. The TTL for this resource. If specified, then this TTL will\nbe used to calculate the expire time.", + "writeOnly": true, + "type": "string", + "format": "google-duration" + }, + "name": { + "description": "Immutable. The resource name of the conversation.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}", + "x-google-immutable": true, + "type": "string" + }, + "dataSource": { + "description": "The source of the audio and transcription for the conversation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource" + }] + }, + "createTime": { + "description": "Output only. The time at which the conversation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the conversation was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "startTime": { + "description": "The time at which the conversation started.", + "type": "string", + "format": "date-time" + }, + "languageCode": { + "description": "A user-specified language code for the conversation.", + "type": "string" + }, + "agentId": { + "description": "An opaque, user-specified string representing the human agent who handled\nthe conversation.", + "type": "string" + }, + "customerId": { + "description": "An opaque, user-specified string representing the customer identifier.", + "type": "string" + }, + "labels": { + "description": "A map for the user to specify any custom fields. A maximum of 100 labels\nper conversation is allowed, with a maximum of 256 characters per entry.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "qualityMetadata": { + "description": "Conversation metadata related to quality management.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata" + }] + }, + "metadataJson": { + "description": "Input only. JSON metadata encoded as a string.\nThis field is primarily used by Insights integrations with various\ntelephony systems and must be in one of Insight's supported formats.", + "writeOnly": true, + "type": "string" + }, + "transcript": { + "description": "Output only. The conversation transcript.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript" + }] + }, + "medium": { + "description": "Immutable. The conversation medium.", + "x-google-immutable": true, + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "The format for conversations that took place over the phone.", + "The format for conversations that took place over chat." + ], + "enum": [ + "MEDIUM_UNSPECIFIED", + "PHONE_CALL", + "CHAT" + ] + }, + "duration": { + "description": "Output only. The duration of the conversation.", + "readOnly": true, + "type": "string", + "format": "google-duration" + }, + "turnCount": { + "description": "Output only. The number of turns in the conversation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "latestAnalysis": { + "description": "Output only. The conversation's latest analysis, if one exists.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis" + }] + }, + "latestSummary": { + "description": "Output only. Latest summary of the conversation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" + }] + }, + "runtimeAnnotations": { + "description": "Output only. The annotations that were generated during the customer and agent\ninteraction.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" + } + }, + "dialogflowIntents": { + "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a\nDialogflow intent, format:\nprojects/{project}/agent/{agent}/intents/{intent}", + "readOnly": true, + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent" + } + }, + "obfuscatedUserId": { + "description": "Obfuscated user ID which the customer sent to us.", + "type": "string" + }, + "dialogflowCxConversationData": { + "description": "The Dialogflow conversation raw data. It will only be populated when\nConversationView is DF_CONVERSATION_BASIC or DF_CONVERSATION_FULL.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationData" + }] + }, + "aaSupervisorMonitoringStatus": { + "description": "Output only. Data from the monitoring status of a conversation by a human supervisor in\nAA. A human supervisor is a human agent that is monitoring virtual agent\nconversations.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationAgentAssistSupervisorMonitoringStatus" + }] + }, + "correlationInfo": { + "description": "Output only. Info for correlating across conversations.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata": { + "description": "Call-specific metadata.", + "type": "object", + "properties": { + "customerChannel": { + "description": "The audio channel that contains the customer.", + "type": "integer", + "format": "int32" + }, + "agentChannel": { + "description": "The audio channel that contains the agent.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource": { + "description": "The conversation source, which is a combination of transcript and audio.", + "type": "object", + "properties": { + "gcsSource": { + "description": "A Cloud Storage location specification for the audio and transcript.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource" + }] + }, + "dialogflowSource": { + "description": "The source when the conversation comes from Dialogflow.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource" + }] + }, + "metadataUri": { + "description": "Cloud Storage URI that points to a file that contains the conversation\nmetadata.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1GcsSource": { + "description": "A Cloud Storage source of conversation data.", + "type": "object", + "properties": { + "audioUri": { + "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", + "type": "string" + }, + "transcriptUri": { + "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation\ntranscript.", + "x-google-immutable": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource": { + "description": "A Dialogflow source of conversation data.", + "type": "object", + "properties": { + "dialogflowConversation": { + "description": "Output only. The name of the Dialogflow conversation that this conversation\nresource is derived from. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}", + "readOnly": true, + "type": "string" + }, + "audioUri": { + "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata": { + "description": "Conversation metadata related to quality management.", + "type": "object", + "properties": { + "customerSatisfactionRating": { + "description": "An arbitrary integer value indicating the customer's satisfaction rating.", + "type": "integer", + "format": "int32" + }, + "waitDuration": { + "description": "The amount of time the customer waited to connect with an agent.", + "type": "string", + "format": "google-duration" + }, + "menuPath": { + "description": "An arbitrary string value specifying the menu path the customer took.", + "type": "string" + }, + "agentInfo": { + "description": "Information about agents involved in the call.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" + } + }, + "feedbackLabels": { + "description": "Input only. The feedback labels associated with the conversation.", + "writeOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo": { + "description": "Information about an agent involved in the conversation.", + "type": "object", + "properties": { + "agentId": { + "description": "A user-specified string representing the agent.", + "type": "string" + }, + "displayName": { + "description": "The agent's name.", + "type": "string" + }, + "team": { + "description": "A user-specified string representing the agent's team. Deprecated in\nfavor of the `teams` field.", + "deprecated": true, + "type": "string" + }, + "teams": { + "description": "User-specified strings representing the agent's teams.", + "type": "array", + "items": { + "type": "string" + } + }, + "dispositionCode": { + "description": "A user-provided string indicating the outcome of the agent's segment of\nthe call.", + "type": "string" + }, + "agentType": { + "description": "The agent type, e.g. HUMAN_AGENT.", + "type": "string", + "x-google-enum-descriptions": [ + "Participant's role is not set.", + "Participant is a human agent.", + "Participant is an automated agent.", + "Participant is an end user who conversed with the contact center.", + "Participant is either a human or automated agent." + ], + "enum": [ + "ROLE_UNSPECIFIED", + "HUMAN_AGENT", + "AUTOMATED_AGENT", + "END_USER", + "ANY_AGENT" + ] + }, + "location": { + "description": "The agent's location.", + "type": "string" + }, + "deploymentId": { + "description": "The agent's deployment ID. Only applicable to automated agents.", + "type": "string" + }, + "deploymentDisplayName": { + "description": "The agent's deployment display name. Only applicable to automated\nagents.", + "type": "string" + }, + "versionId": { + "description": "The agent's version ID. Only applicable to automated agents.", + "type": "string" + }, + "versionDisplayName": { + "description": "The agent's version display name. Only applicable to automated agents.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript": { + "description": "A message representing the transcript of a conversation.", + "type": "object", + "properties": { + "transcriptSegments": { + "description": "A list of sequential transcript segments that comprise the conversation.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment": { + "description": "A segment of a full transcript.", + "type": "object", + "properties": { + "messageTime": { + "description": "The time that the message occurred, if provided.", + "type": "string", + "format": "date-time" + }, + "text": { + "description": "The text of this segment.", + "type": "string" + }, + "confidence": { + "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nsegment. A default value of 0.0 indicates that the value is unset.", + "type": "number", + "format": "float" + }, + "words": { + "description": "A list of the word-specific information for each word in the segment.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo" + } + }, + "languageCode": { + "description": "The language code of this segment as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".", + "type": "string" + }, + "channelTag": { + "description": "For conversations derived from multi-channel audio, this is the channel\nnumber corresponding to the audio from that channel. For\naudioChannelCount = N, its output values can range from '1' to 'N'. A\nchannel tag of 0 indicates that the audio is mono.", + "type": "integer", + "format": "int32" + }, + "segmentParticipant": { + "description": "The participant of this segment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant" + }] + }, + "dialogflowSegmentMetadata": { + "description": "CCAI metadata relating to the current transcript segment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" + }] + }, + "sentiment": { + "description": "The sentiment for this transcript segment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo": { + "description": "Word-level info for words in a transcript.", + "type": "object", + "properties": { + "startOffset": { + "description": "Time offset of the start of this word relative to the beginning of\nthe total conversation.", + "type": "string", + "format": "google-duration" + }, + "endOffset": { + "description": "Time offset of the end of this word relative to the beginning of the\ntotal conversation.", + "type": "string", + "format": "google-duration" + }, + "word": { + "description": "The word itself. Includes punctuation marks that surround the word.", + "type": "string" + }, + "confidence": { + "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nword. A default value of 0.0 indicates that the value is unset.", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant": { + "description": "The call participant speaking for a given utterance.", + "type": "object", + "properties": { + "dialogflowParticipantName": { + "description": "The name of the participant provided by Dialogflow. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", + "type": "string" + }, + "userId": { + "description": "A user-specified ID representing the participant.", + "type": "string" + }, + "dialogflowParticipant": { + "description": "Deprecated. Use `dialogflow_participant_name` instead.\nThe name of the Dialogflow participant. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", + "deprecated": true, + "type": "string" + }, + "obfuscatedExternalUserId": { + "description": "Obfuscated user ID from Dialogflow.", + "type": "string" + }, + "role": { + "description": "The role of the participant.", + "type": "string", + "x-google-enum-descriptions": [ + "Participant's role is not set.", + "Participant is a human agent.", + "Participant is an automated agent.", + "Participant is an end user who conversed with the contact center.", + "Participant is either a human or automated agent." + ], + "enum": [ + "ROLE_UNSPECIFIED", + "HUMAN_AGENT", + "AUTOMATED_AGENT", + "END_USER", + "ANY_AGENT" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { + "description": "Metadata from Dialogflow relating to the current transcript segment.", + "type": "object", + "properties": { + "smartReplyAllowlistCovered": { + "description": "Whether the transcript segment was covered under the configured smart\nreply allowlist in Agent Assist.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1SentimentData": { + "description": "The data for a sentiment annotation.", + "type": "object", + "properties": { + "magnitude": { + "description": "A non-negative number from 0 to infinity which represents the absolute\nmagnitude of sentiment regardless of score.", + "type": "number", + "format": "float" + }, + "score": { + "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", + "type": "number", + "format": "float" + }, + "rationale": { + "description": "The rationale for the sentiment result.", + "type": "string" + }, + "modelType": { + "description": "The sentiment model used to produce the sentiment result.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified model type.", + "V1 model.", + "V2 LLM model." + ], + "enum": [ + "SENTIMENT_MODEL_TYPE_UNSPECIFIED", + "SENTIMENT_MODEL_TYPE_V1", + "SENTIMENT_MODEL_TYPE_V2" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1Analysis": { + "description": "The analysis resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the analysis.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", + "x-google-immutable": true, + "type": "string" + }, + "requestTime": { + "description": "Output only. The time at which the analysis was requested.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "createTime": { + "description": "Output only. The time at which the analysis was created, which occurs when the\nlong-running operation completes.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "analysisResult": { + "description": "Output only. The result of the analysis, which is populated when the analysis\nfinishes.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult" + }] + }, + "annotatorSelector": { + "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult": { + "description": "The result of an analysis.", + "type": "object", + "properties": { + "callAnalysisMetadata": { + "description": "Call-specific metadata created by the analysis.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata" + }] + }, + "endTime": { + "description": "The time at which the analysis ended.", + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata": { + "description": "Call-specific metadata created during analysis.", + "type": "object", + "properties": { + "annotations": { + "description": "A list of call annotations that apply to this call.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation" + } + }, + "entities": { + "description": "All the entities in the call.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity" + } + }, + "sentiments": { + "description": "Overall conversation-level sentiment for each channel of the call.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment" + } + }, + "silence": { + "description": "Overall conversation-level silence during the call.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence" + }] + }, + "intents": { + "description": "All the matched intents in the call.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent" + } + }, + "phraseMatchers": { + "description": "All the matched phrase matchers in the call.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" + } + }, + "issueModelResult": { + "description": "Overall conversation-level issue modeling result.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult" + }] + }, + "semanticMatchMetadata": { + "description": "Metadata used in the semantic match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SemanticMatchMetadata" + }] + }, + "qaScorecardResults": { + "description": "Results of scoring QaScorecards.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation": { + "description": "A piece of metadata that applies to a window of a call.", + "type": "object", + "properties": { + "interruptionData": { + "description": "Data specifying an interruption.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData" + }] + }, + "sentimentData": { + "description": "Data specifying sentiment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData" + }] + }, + "silenceData": { + "description": "Data specifying silence.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData" + }] + }, + "holdData": { + "description": "Data specifying a hold.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1HoldData" + }] + }, + "entityMentionData": { + "description": "Data specifying an entity mention.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData" + }] + }, + "intentMatchData": { + "description": "Data specifying an intent match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IntentMatchData" + }] + }, + "phraseMatchData": { + "description": "Data specifying a phrase match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" + }] + }, + "issueMatchData": { + "description": "Data specifying an issue match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData" + }] + }, + "channelTag": { + "description": "The channel of the audio where the annotation occurs. For single-channel\naudio, this field is not populated.", + "type": "integer", + "format": "int32" + }, + "annotationStartBoundary": { + "description": "The boundary in the conversation where the annotation starts, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" + }] + }, + "annotationEndBoundary": { + "description": "The boundary in the conversation where the annotation ends, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1InterruptionData": { + "description": "The data for an interruption annotation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1SilenceData": { + "description": "The data for a silence annotation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1HoldData": { + "description": "The data for a hold annotation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData": { + "description": "The data for an entity mention annotation.\nThis represents a mention of an `Entity` in the conversation.", + "type": "object", + "properties": { + "entityUniqueId": { + "description": "The key of this entity in conversation entities.\nCan be used to retrieve the exact `Entity` this mention is attached to.", + "type": "string" + }, + "type": { + "description": "The type of the entity mention.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Proper noun.", + "Common noun (or noun compound)." + ], + "enum": [ + "MENTION_TYPE_UNSPECIFIED", + "PROPER", + "COMMON" + ] + }, + "sentiment": { + "description": "Sentiment expressed for this mention of the entity.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData": { + "description": "The data for an intent match.\nRepresents an intent match for a text segment in the conversation. A text\nsegment can be part of a sentence, a complete sentence, or an utterance\nwith multiple sentences.", + "type": "object", + "properties": { + "intentUniqueId": { + "description": "The id of the matched intent.\nCan be used to retrieve the corresponding intent information.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData": { + "description": "The data for a matched phrase matcher.\nRepresents information identifying a phrase matcher for a given match.", + "type": "object", + "properties": { + "phraseMatcher": { + "description": "The unique identifier (the resource name) of the phrase matcher.", + "type": "string" + }, + "displayName": { + "description": "The human-readable name of the phrase matcher.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData": { + "description": "The data for an issue match annotation.", + "type": "object", + "properties": { + "issueAssignment": { + "description": "Information about the issue's assignment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment": { + "description": "Information about the issue.", + "type": "object", + "properties": { + "issue": { + "description": "Resource name of the assigned issue.", + "type": "string" + }, + "score": { + "description": "Score indicating the likelihood of the issue assignment.\ncurrently bounded on [0,1].", + "type": "number", + "format": "double" + }, + "displayName": { + "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis\nand immutable since then.", + "x-google-immutable": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary": { + "description": "A point in a conversation that marks the start or the end of an annotation.", + "type": "object", + "properties": { + "wordIndex": { + "description": "The word index of this boundary with respect to the first word in the\ntranscript piece. This index starts at zero.", + "type": "integer", + "format": "int32" + }, + "transcriptIndex": { + "description": "The index in the sequence of transcribed pieces of the conversation where\nthe boundary is located. This index starts at zero.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1Entity": { + "description": "The data for an entity annotation.\nRepresents a phrase in the conversation that is a known entity, such\nas a person, an organization, or location.", + "type": "object", + "properties": { + "displayName": { + "description": "The representative name for the entity.", + "type": "string" + }, + "type": { + "description": "The entity type.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Person.", + "Location.", + "Organization.", + "Event.", + "Artwork.", + "Consumer product.", + "Other types of entities.", + "Phone number.\n\nThe metadata lists the phone number (formatted according to local\nconvention), plus whichever additional elements appear in the text:\n\n* `number` - The actual number, broken down into sections according to\nlocal convention.\n* `national_prefix` - Country code, if detected.\n* `area_code` - Region or area code, if detected.\n* `extension` - Phone extension (to be dialed after connection), if\ndetected.", + "Address.\n\nThe metadata identifies the street number and locality plus whichever\nadditional elements appear in the text:\n\n* `street_number` - Street number.\n* `locality` - City or town.\n* `street_name` - Street/route name, if detected.\n* `postal_code` - Postal code, if detected.\n* `country` - Country, if detected.\n* `broad_region` - Administrative area, such as the state, if detected.\n* `narrow_region` - Smaller administrative area, such as county, if\ndetected.\n* `sublocality` - Used in Asian addresses to demark a district within a\ncity, if detected.", + "Date.\n\nThe metadata identifies the components of the date:\n\n* `year` - Four digit year, if detected.\n* `month` - Two digit month number, if detected.\n* `day` - Two digit day number, if detected.", + "Number.\n\nThe metadata is the number itself.", + "Price.\n\nThe metadata identifies the `value` and `currency`." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "PERSON", + "LOCATION", + "ORGANIZATION", + "EVENT", + "WORK_OF_ART", + "CONSUMER_GOOD", + "OTHER", + "PHONE_NUMBER", + "ADDRESS", + "DATE", + "NUMBER", + "PRICE" + ] + }, + "metadata": { + "description": "Metadata associated with the entity.\n\nFor most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)\nand Knowledge Graph MID (`mid`), if they are available. For the metadata\nassociated with other entity types, see the Type table below.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "salience": { + "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.", + "type": "number", + "format": "float" + }, + "sentiment": { + "description": "The aggregate sentiment expressed for this entity in the conversation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment": { + "description": "One channel of conversation-level sentiment data.", + "type": "object", + "properties": { + "channelTag": { + "description": "The channel of the audio that the data applies to.", + "type": "integer", + "format": "int32" + }, + "sentimentData": { + "description": "Data specifying sentiment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence": { + "description": "Conversation-level silence data.", + "type": "object", + "properties": { + "silenceDuration": { + "description": "Amount of time calculated to be in silence.", + "type": "string", + "format": "google-duration" + }, + "silencePercentage": { + "description": "Percentage of the total conversation spent in silence.", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1Intent": { + "description": "The data for an intent.\nRepresents a detected intent in the conversation, for example MAKES_PROMISE.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the intent.", + "type": "string" + }, + "displayName": { + "description": "The human-readable name of the intent.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult": { + "description": "Issue Modeling result on a conversation.", + "type": "object", + "properties": { + "issueModel": { + "description": "Issue model that generates the result.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", + "type": "string" + }, + "issues": { + "description": "All the matched issues.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1SemanticMatchMetadata": { + "description": "Semantic match metadata used in an analysis.", + "type": "object", + "properties": { + "issueModel": { + "description": "Issue model that's used in the semantic match.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult": { + "description": "The results of scoring a single conversation against a QaScorecard. Contains\na collection of QaAnswers and aggregate score.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The name of the scorecard result.\nFormat:\nprojects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", + "x-google-identifier": true, + "type": "string" + }, + "qaScorecardRevision": { + "description": "The QaScorecardRevision scored by this result.", + "type": "string" + }, + "conversation": { + "description": "The conversation scored by this result.", + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp that the revision was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "agentId": { + "description": "ID of the agent that handled the conversation.", + "type": "string" + }, + "qaAnswers": { + "description": "Set of QaAnswers represented in the result.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswer" + } + }, + "score": { + "description": "The overall numerical score of the result, incorporating any manual edits\nif they exist.", + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "The normalized score, which is the score divided by the potential score.\nAny manual edits are included if they exist.", + "type": "number", + "format": "double" + }, + "qaTagResults": { + "description": "Collection of tags and their scores.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" + } + }, + "scoreSources": { + "description": "List of all individual score sets.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaAnswer": { + "description": "An answer to a QaQuestion.", + "type": "object", + "properties": { + "qaQuestion": { + "description": "The QaQuestion answered by this answer.", + "type": "string" + }, + "conversation": { + "description": "The conversation the answer applies to.", + "type": "string" + }, + "questionBody": { + "description": "Question text. E.g., \"Did the agent greet the customer?\"", + "type": "string" + }, + "answerValue": { + "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" + }] + }, + "tags": { + "description": "User-defined list of arbitrary tags. Matches the value from\nQaScorecard.ScorecardQuestion.tags. Used for grouping/organization and\nfor weighting the score of each answer.", + "type": "array", + "items": { + "type": "string" + } + }, + "answerSources": { + "description": "Lists all answer sources containing one or more answer values of a\nspecific source type, e.g., all system-generated answer sources, or all\nmanual edit answer sources.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource": { + "description": "A question may have multiple answers from varying sources, one of which\nbecomes the \"main\" answer above. AnswerSource represents each individual\nanswer.", + "type": "object", + "properties": { + "sourceType": { + "description": "What created the answer.", + "type": "string", + "x-google-enum-descriptions": [ + "Source type is unspecified.", + "Answer was system-generated; created during an Insights analysis.", + "Answer was created by a human via manual edit." + ], + "enum": [ + "SOURCE_TYPE_UNSPECIFIED", + "SYSTEM_GENERATED", + "MANUAL_EDIT" + ] + }, + "answerValue": { + "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult": { + "description": "Tags and their corresponding results.", + "type": "object", + "properties": { + "tag": { + "description": "The tag the score applies to.", + "type": "string" + }, + "score": { + "description": "The score the tag applies to.", + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "The potential score the tag applies to.", + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "The normalized score the tag applies to.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource": { + "description": "A scorecard result may have multiple sets of scores from varying sources,\none of which becomes the \"main\" answer above. A ScoreSource represents\neach individual set of scores.", + "type": "object", + "properties": { + "sourceType": { + "description": "What created the score.", + "type": "string", + "x-google-enum-descriptions": [ + "Source type is unspecified.", + "Score is derived only from system-generated answers.", + "Score is derived from both system-generated answers, and includes\nany manual edits if they exist." + ], + "enum": [ + "SOURCE_TYPE_UNSPECIFIED", + "SYSTEM_GENERATED_ONLY", + "INCLUDES_MANUAL_EDITS" + ] + }, + "score": { + "description": "The overall numerical score of the result.", + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "The normalized score, which is the score divided by the potential score.", + "type": "number", + "format": "double" + }, + "qaTagResults": { + "description": "Collection of tags and their scores.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData": { + "description": "Conversation summarization suggestion data.", + "type": "object", + "properties": { + "text": { + "description": "The summarization content that is concatenated into one string.", + "type": "string" + }, + "textSections": { + "description": "The summarization content that is divided into sections. The key is the\nsection's name and the value is the section's content. There is no\nspecific format for the key or value.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "confidence": { + "description": "The confidence score of the summarization.", + "type": "number", + "format": "float" + }, + "metadata": { + "description": "A map that contains metadata about the summarization and the document\nfrom which it originates.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "answerRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + }, + "conversationModel": { + "description": "The name of the model that generates this summary.\nFormat:\nprojects/{project}/locations/{location}/conversationModels/{conversation_model}", + "type": "string" + }, + "generatorId": { + "description": "Agent Assist generator ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation": { + "description": "An annotation that was generated during the customer and agent interaction.", + "type": "object", + "properties": { + "articleSuggestion": { + "description": "Agent Assist Article Suggestion data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData" + }] + }, + "faqAnswer": { + "description": "Agent Assist FAQ answer data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData" + }] + }, + "smartReply": { + "description": "Agent Assist Smart Reply data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData" + }] + }, + "smartComposeSuggestion": { + "description": "Agent Assist Smart Compose suggestion data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData" + }] + }, + "dialogflowInteraction": { + "description": "Dialogflow interaction data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData" + }] + }, + "conversationSummarizationSuggestion": { + "description": "Conversation summarization suggestion data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" + }] + }, + "annotationId": { + "description": "The unique identifier of the annotation.\nFormat:\nprojects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", + "type": "string" + }, + "createTime": { + "description": "The time at which this annotation was created.", + "type": "string", + "format": "date-time" + }, + "startBoundary": { + "description": "The boundary in the conversation where the annotation starts, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" + }] + }, + "endBoundary": { + "description": "The boundary in the conversation where the annotation ends, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" + }] + }, + "answerFeedback": { + "description": "The feedback that the customer has about the answer in `data`.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback" + }] + }, + "userInput": { + "description": "Explicit input used for generating the answer", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData": { + "description": "Agent Assist Article Suggestion data.", + "type": "object", + "properties": { + "title": { + "description": "Article title.", + "type": "string" + }, + "uri": { + "description": "Article URI.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this article is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "float" + }, + "metadata": { + "description": "Map that contains metadata about the Article Suggestion and the document\nthat it originates from.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + }, + "source": { + "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData": { + "description": "Agent Assist frequently-asked-question answer data.", + "type": "object", + "properties": { + "answer": { + "description": "The piece of text from the `source` knowledge base document.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this answer is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "float" + }, + "question": { + "description": "The corresponding FAQ question.", + "type": "string" + }, + "metadata": { + "description": "Map that contains metadata about the FAQ answer and the document that\nit originates from.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + }, + "source": { + "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData": { + "description": "Agent Assist Smart Reply data.", + "type": "object", + "properties": { + "reply": { + "description": "The content of the reply.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this reply is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "double" + }, + "metadata": { + "description": "Map that contains metadata about the Smart Reply and the document from\nwhich it originates.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData": { + "description": "Agent Assist Smart Compose suggestion data.", + "type": "object", + "properties": { + "suggestion": { + "description": "The content of the suggestion.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this suggestion is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "double" + }, + "metadata": { + "description": "Map that contains metadata about the Smart Compose suggestion and the\ndocument from which it originates.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData": { + "description": "Dialogflow interaction data.", + "type": "object", + "properties": { + "dialogflowIntentId": { + "description": "The Dialogflow intent resource path. Format:\nprojects/{project}/agent/{agent}/intents/{intent}", + "type": "string" + }, + "confidence": { + "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0\n(completely certain).", + "type": "number", + "format": "float" + }, + "detectIntentRequest": { + "description": "The Dialogflow conversation DetectIntentRequest raw data of this turn. This\nfield will only be populated in the GetConversation response and its data\nformat should be same as Dialogflow [DetectIntentRequest] of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL." + } + }, + "detectIntentResponse": { + "description": "The Dialogflow conversation DetectIntentResponse raw data of this turn.\nThis field will only be populated in the GetConversation response and its\ndata format should be same as Dialogflow DetectIntentResponse of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL." + } + }, + "flowId": { + "description": "The Dialogflow flow id.", + "type": "string" + }, + "flowDisplayName": { + "description": "The Dialogflow flow display name.\nThe Dialogflow environment display name.", + "type": "string" + }, + "pageId": { + "description": "The Dialogflow page ID.", + "type": "string" + }, + "pageDisplayName": { + "description": "The Dialogflow page display name.\nThe Dialogflow environment display name.", + "type": "string" + }, + "intentId": { + "description": "The Dialogflow intent ID.", + "type": "string" + }, + "intentDisplayName": { + "description": "The Dialogflow intent display name.\nThe Dialogflow environment display name.", + "type": "string" + }, + "endFlowOrSession": { + "description": "The turn reaches END_FLOW or END_SESSION.", + "type": "boolean" + }, + "liveAgentHandoff": { + "description": "Whether the turn was handed off to a human agent.", + "type": "boolean" + }, + "inputType": { + "description": "The input type in this turn.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified. Should never be used.", + "Text input.", + "Intent input.", + "Audio input.", + "Event input.", + "DTMF input." + ], + "enum": [ + "INPUT_TYPE_UNSPECIFIED", + "INPUT_TYPE_TEXT", + "INPUT_TYPE_INTENT", + "INPUT_TYPE_AUDIO", + "INPUT_TYPE_EVENT", + "INPUT_TYPE_DTMF" + ] + }, + "matchType": { + "description": "The match type in this turn.", + "type": "string", + "x-google-enum-descriptions": [ + "Not specified. Should never be used.", + "An intent is matched.", + "The input is an intent.", + "The input is for parameter filling.", + "No intent match for the input.", + "Indicates an empty input.", + "The input is an event." + ], + "enum": [ + "MATCH_TYPE_UNSPECIFIED", + "MATCH_TYPE_INTENT", + "MATCH_TYPE_DIRECT_INTENT", + "MATCH_TYPE_PARAMETER_FILLING", + "MATCH_TYPE_NO_MATCH", + "MATCH_TYPE_NO_INPUT", + "MATCH_TYPE_EVENT" + ] + }, + "detectIntentResponseV3": { + "description": "The Dialogflow v3 DetectIntentResponse raw data of this turn.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DetectIntentResponse" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback": { + "description": "The feedback that the customer has about a certain answer in the\nconversation.", + "type": "object", + "properties": { + "correctnessLevel": { + "description": "The correctness level of an answer.", + "type": "string", + "x-google-enum-descriptions": [ + "Correctness level unspecified.", + "Answer is totally wrong.", + "Answer is partially correct.", + "Answer is fully correct." + ], + "enum": [ + "CORRECTNESS_LEVEL_UNSPECIFIED", + "NOT_CORRECT", + "PARTIALLY_CORRECT", + "FULLY_CORRECT" + ] + }, + "clicked": { + "description": "Indicates whether an answer or item was clicked by the human agent.", + "type": "boolean" + }, + "displayed": { + "description": "Indicates whether an answer or item was displayed to the human agent in the\nagent desktop UI.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput": { + "description": "Explicit input used for generating the answer", + "type": "object", + "properties": { + "query": { + "description": "Query text. Article Search uses this to store the input query used\nto generate the search results.", + "type": "string" + }, + "generatorName": { + "description": "The resource name of associated generator. Format:\n`projects//locations//generators/`", + "type": "string" + }, + "querySource": { + "description": "Query source for the answer.", + "type": "string", + "x-google-enum-descriptions": [ + "Unknown query source.", + "The query is from agents.", + "The query is a query from previous suggestions, e.g. from a preceding\nSuggestKnowledgeAssist response.", + "The query is from the end user." + ], + "enum": [ + "QUERY_SOURCE_UNSPECIFIED", + "AGENT_QUERY", + "SUGGESTED_QUERY", + "END_USER_QUERY" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent": { + "description": "The data for a Dialogflow intent.\nRepresents a detected intent in the conversation, e.g. MAKES_PROMISE.", + "type": "object", + "properties": { + "displayName": { + "description": "The human-readable name of the intent.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationData": { + "description": "The metadata for a Dialogflow CX conversation.", + "type": "object", + "properties": { + "virtualAgentId": { + "description": "The virtual agent id of this conversation.", + "type": "string" + }, + "flowIds": { + "description": "The deduped flow UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "flowDisplayNames": { + "description": "The deduped flow display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "pageIds": { + "description": "The deduped page UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "pageDisplayNames": { + "description": "The deduped page display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "intentIds": { + "description": "The deduped intent UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "intentDisplayNames": { + "description": "The deduped intent display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "experimentIds": { + "description": "The deduped experiment UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "experimentDisplayNames": { + "description": "The deduped experiment display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "inputAudioDuration": { + "description": "The total duration of the user input audio in this conversation.", + "type": "string", + "format": "google-duration" + }, + "outputAudioDuration": { + "description": "The total duration of the agent output audio in this conversation.", + "type": "string", + "format": "google-duration" + }, + "queryInputStats": { + "description": "Query input stats", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationDataQueryInputStats" + }] + }, + "matchTypeStats": { + "description": "Match type stats.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationDataMatchTypeStats" + }] + }, + "averageMatchConfidence": { + "description": "Average match confidence for all the initent matches in this conversation.", + "type": "number", + "format": "float" + }, + "endSessionExit": { + "description": "Whether the conversation reaches END_FLOW or END_SESSION.", + "type": "boolean" + }, + "maxWebhookLatency": { + "description": "The maximum webhook latency for an individual webhook call in this\nconversation.", + "type": "string", + "format": "google-duration" + }, + "liveAgentHandoff": { + "description": "Whether the conversation was handed off to a human agent.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationDataQueryInputStats": { + "description": "Count by input types in this conversation", + "type": "object", + "properties": { + "textCount": { + "description": "The number of requests with text input.", + "type": "integer", + "format": "int32" + }, + "intentCount": { + "description": "The number of requests with intent input.", + "type": "integer", + "format": "int32" + }, + "audioCount": { + "description": "The number of requests with audio input.", + "type": "integer", + "format": "int32" + }, + "eventCount": { + "description": "The number of requests with event input.", + "type": "integer", + "format": "int32" + }, + "dtmfCount": { + "description": "The number of requests with DTMF input.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationDataMatchTypeStats": { + "description": "Count by match types in this conversation .", + "type": "object", + "properties": { + "intentCount": { + "description": "The number of responses with match type INTENT.", + "type": "integer", + "format": "int32" + }, + "directIntentCount": { + "description": "The number of responses with match type DIRECT_INTENT.", + "type": "integer", + "format": "int32" + }, + "parameterFillingCount": { + "description": "The number of responses with match type PARAMETER_FILLING.", + "type": "integer", + "format": "int32" + }, + "noMatchCount": { + "description": "The number of responses with match type NO_MATCH.", + "type": "integer", + "format": "int32" + }, + "noInputCount": { + "description": "The number of responses with match type NO_INPUT.", + "type": "integer", + "format": "int32" + }, + "eventCount": { + "description": "The number of responses with match type EVENT.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationAgentAssistSupervisorMonitoringStatus": { + "description": "Tracks the status of an AA supervisor monitoring a conversation.", + "type": "object", + "properties": { + "monitored": { + "description": "The conversation was monitored by an AA supervisor.", + "type": "boolean" + }, + "escalatedToSupervisor": { + "description": "The conversation was escalated to an AA supervisor for intervention.", + "type": "boolean" + }, + "assignedSupervisor": { + "description": "The ID of the assigned AA supervisor.", + "type": "string" + }, + "transferredToHumanAgent": { + "description": "The conversation was transferred to a human agent by the AA supervisor.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo": { + "description": "Info for correlating across conversations.", + "type": "object", + "properties": { + "fullConversationCorrelationId": { + "description": "Output only. The full conversation correlation id this conversation is a segment of.", + "readOnly": true, + "type": "string" + }, + "mergedFullConversationCorrelationId": { + "description": "Output only. The full conversation correlation id this conversation is a merged\nconversation of.", + "readOnly": true, + "type": "string" + }, + "correlationTypes": { + "description": "Output only. The correlation types of this conversation. A single conversation can\nhave multiple correlation types. For example a conversation that only has\na single segment is both a SEGMENT and a FULL_CONVERSATION.", + "readOnly": true, + "type": "array", + "items": { + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "This conversation represents a segment of a full conversation. The\nlowest level of granularity.", + "This conversation represents a partial conversation of potentially\nmultiple segments but is not a full conversation.", + "This conversation represents a full conversation of potentially\nmultiple segments.", + "This conversation represents a synthetic conversation." + ], + "enum": [ + "CORRELATION_TYPE_UNSPECIFIED", + "SEGMENT", + "PARTIAL", + "FULL", + "SYNTHETIC" + ] + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata": { + "description": "The metadata for a bulk analyze conversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for bulk analyze.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest" + }] + }, + "completedAnalysesCount": { + "description": "The number of requested analyses that have completed successfully so far.", + "type": "integer", + "format": "int32" + }, + "failedAnalysesCount": { + "description": "The number of requested analyses that have failed so far.", + "type": "integer", + "format": "int32" + }, + "totalRequestedAnalysesCount": { + "description": "Total number of analyses requested. Computed by the number of conversations\nreturned by `filter` multiplied by `analysis_percentage` in the request.", + "type": "integer", + "format": "int32" + }, + "partialErrors": { + "description": "Output only. Partial errors during bulk analyze operation that might cause the operation\noutput to be incomplete.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest": { + "description": "The request to analyze conversations in bulk.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource to create analyses in.", + "type": "string" + }, + "filter": { + "description": "Required. Filter used to select the subset of conversations to analyze.", + "type": "string" + }, + "analysisPercentage": { + "description": "Required. Percentage of selected conversation to analyze, between\n[0, 100].", + "type": "number", + "format": "float" + }, + "annotatorSelector": { + "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" + }] + } + }, + "required": [ + "parent", + "filter", + "analysisPercentage" + ] + }, + "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector": { + "description": "Selector of all available annotators and phrase matchers to run.", + "type": "object", + "properties": { + "runInterruptionAnnotator": { + "description": "Whether to run the interruption annotator.", + "type": "boolean" + }, + "runSilenceAnnotator": { + "description": "Whether to run the silence annotator.", + "type": "boolean" + }, + "runPhraseMatcherAnnotator": { + "description": "Whether to run the active phrase matcher annotator(s).", + "type": "boolean" + }, + "phraseMatchers": { + "description": "The list of phrase matchers to run. If not provided, all active phrase\nmatchers will be used. If inactive phrase matchers are provided, they will\nnot be used. Phrase matchers will be run only if\nrun_phrase_matcher_annotator is set to true. Format:\nprojects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", + "type": "array", + "items": { + "type": "string" + } + }, + "runSentimentAnnotator": { + "description": "Whether to run the sentiment annotator.", + "type": "boolean" + }, + "runEntityAnnotator": { + "description": "Whether to run the entity annotator.", + "type": "boolean" + }, + "runIntentAnnotator": { + "description": "Whether to run the intent annotator.", + "type": "boolean" + }, + "runIssueModelAnnotator": { + "description": "Whether to run the issue model annotator. A model should have already been\ndeployed for this to take effect.", + "type": "boolean" + }, + "issueModels": { + "description": "The issue model to run. If not provided, the most recently deployed topic\nmodel will be used. The provided issue model will only be used for\ninference if the issue model is deployed and if run_issue_model_annotator\nis set to true. If more than one issue model is provided, only the first\nprovided issue model will be used for inference.", + "type": "array", + "items": { + "type": "string" + } + }, + "runSummarizationAnnotator": { + "description": "Whether to run the summarization annotator.", + "type": "boolean" + }, + "summarizationConfig": { + "description": "Configuration for the summarization annotator.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig" + }] + }, + "runQaAnnotator": { + "description": "Whether to run the QA annotator.", + "type": "boolean" + }, + "qaConfig": { + "description": "Configuration for the QA annotator.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig": { + "description": "Configuration for summarization.", + "type": "object", + "properties": { + "conversationProfile": { + "description": "Resource name of the Dialogflow conversation profile.\nFormat:\nprojects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", + "type": "string" + }, + "summarizationModel": { + "description": "Default summarization model to be used.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified summarization model.", + "The CCAI baseline model. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead.", + "The CCAI baseline model, V2.0. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead." + ], + "x-google-enum-deprecated": [ + false, + true, + true + ], + "enum": [ + "SUMMARIZATION_MODEL_UNSPECIFIED", + "BASELINE_MODEL", + "BASELINE_MODEL_V2_0" + ] + }, + "generator": { + "description": "The resource name of the existing created generator. Format:\nprojects//locations//generators/", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig": { + "description": "Configuration for the QA feature.", + "type": "object", + "properties": { + "scorecardList": { + "description": "A manual list of scorecards to score.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList": { + "description": "Container for a list of scorecards.", + "type": "object", + "properties": { + "qaScorecardRevisions": { + "description": "List of QaScorecardRevisions.", + "type": "array", + "items": { + "type": "string" + } + }, + "predefinedQaScorecards": { + "description": "List of predefined scorecards.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainPredefinedQaScorecardType" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse": { + "description": "The response for a bulk analyze conversations operation.", + "type": "object", + "properties": { + "successfulAnalysisCount": { + "description": "Count of successful analyses.", + "type": "integer", + "format": "int32" + }, + "failedAnalysisCount": { + "description": "Count of failed analyses.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata": { + "description": "The metadata for a bulk delete conversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for bulk delete.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during bulk delete conversations operation that might cause\nthe operation output to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest": { + "description": "The request to delete conversations in bulk.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource to delete conversations from.\nFormat:\nprojects/{project}/locations/{location}", + "type": "string" + }, + "filter": { + "description": "Filter used to select the subset of conversations to delete.", + "type": "string" + }, + "maxDeleteCount": { + "description": "Maximum number of conversations to delete.", + "type": "integer", + "format": "int32" + }, + "force": { + "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", + "type": "boolean" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse": { + "description": "The response for a bulk delete conversations operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata": { + "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", + "type": "object", + "properties": { + "request": { + "description": "Output only. The original request for delete.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during deletion operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest": { + "description": "Request for the BulkDeleteFeedbackLabels endpoint.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "type": "string" + }, + "filter": { + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "type": "string" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse": { + "description": "Response for the BulkDeleteFeedbackLabels endpoint.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata": { + "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for download.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "downloadStats": { + "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest": { + "description": "Request for the BulkDownloadFeedbackLabel endpoint.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "type": "string" + }, + "filter": { + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "type": "string" + }, + "gcsDestination": { + "description": "A cloud storage bucket destination.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination" + }] + }, + "sheetsDestination": { + "description": "A sheets document destination.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination" + }] + }, + "maxDownloadCount": { + "description": "Optional. Limits the maximum number of feedback labels that will be downloaded.\nThe first `N` feedback labels will be downloaded.", + "type": "integer", + "format": "int32" + }, + "feedbackLabelType": { + "description": "Optional. The type of feedback labels that will be downloaded.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified format", + "Downloaded file will contain all Quality AI labels from the latest\nscorecard revision.", + "Downloaded file will contain only Topic Modeling labels.", + "Agent Assist Summarization labels." + ], + "enum": [ + "FEEDBACK_LABEL_TYPE_UNSPECIFIED", + "QUALITY_AI", + "TOPIC_MODELING", + "AGENT_ASSIST_SUMMARY" + ] + }, + "conversationFilter": { + "description": "Optional. Filter parent conversations to download feedback labels for.\nWhen specified, the feedback labels will be downloaded for the\nconversations that match the filter.\nIf `template_qa_scorecard_id` is set, all the conversations that match the\nfilter will be paired with the questions under the scorecard for labeling.", + "type": "string" + }, + "templateQaScorecardId": { + "description": "Optional. If set, a template for labeling conversations and scorecard questions will\nbe created from the conversation_filter and the questions under the\nscorecard(s). The feedback label `filter` will be ignored.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination": { + "description": "Google Cloud Storage Object details to write the feedback labels to.", + "type": "object", + "properties": { + "format": { + "description": "Required. File format in which the labels will be exported.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified format.", + "CSV format.\n1,000 labels are stored per CSV file by default.", + "JSON format.\n1 label stored per JSON file by default." + ], + "enum": [ + "FORMAT_UNSPECIFIED", + "CSV", + "JSON" + ] + }, + "objectUri": { + "description": "Required. The Google Cloud Storage URI to write the feedback labels to.\nThe file name will be used as a prefix for the files written to the\nbucket if the output needs to be split across multiple files, otherwise\nit will be used as is. The file extension will be appended to the file\nname based on the format selected.\n E.g. `gs://bucket_name/object_uri_prefix`", + "type": "string" + }, + "addWhitespace": { + "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases\nfile size. Only applicable for JSON format.", + "type": "boolean" + }, + "alwaysPrintEmptyFields": { + "description": "Optional. Always print fields with no presence.\nThis is useful for printing fields that are not set, like implicit 0\nvalue or empty lists/maps. Only applicable for JSON format.", + "type": "boolean" + }, + "recordsPerFileCount": { + "description": "Optional. The number of records per file. Applicable for either format.", + "type": "string", + "format": "int64" + } + }, + "required": [ + "format", + "objectUri" + ] + }, + "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination": { + "description": "Google Sheets document details to write the feedback labels to.", + "type": "object", + "properties": { + "spreadsheetUri": { + "description": "Required. The Google Sheets document to write the feedback labels to.\nRetrieved from Google Sheets URI.\nE.g. `https://docs.google.com/spreadsheets/d/1234567890`\nThe spreadsheet must be shared with the Insights P4SA.\nThe spreadsheet ID written to will be returned as `file_names` in the\nBulkDownloadFeedbackLabelsMetadata.", + "type": "string" + }, + "sheetTitle": { + "description": "Optional. The title of the new sheet to write the feedback labels to.", + "type": "string" + } + }, + "required": [ + "spreadsheetUri" + ] + }, + "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats": { + "description": "Statistics for BulkDownloadFeedbackLabels operation.", + "type": "object", + "properties": { + "processedObjectCount": { + "description": "The number of objects processed during the download operation.", + "type": "integer", + "format": "int32" + }, + "successfulDownloadCount": { + "description": "The number of new feedback labels downloaded during this operation.\nDifferent from \"processed\" because some labels might not be downloaded\nbecause an error.", + "type": "integer", + "format": "int32" + }, + "totalFilesWritten": { + "description": "Total number of files written to the provided Cloud Storage bucket.", + "type": "integer", + "format": "int32" + }, + "fileNames": { + "description": "Output only. Full name of the files written to Cloud storage.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse": { + "description": "Response for the BulkDownloadFeedbackLabel endpoint.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainBulkUpdateQaQuestionsMetadata": { + "description": "The metadata for bulk updating QaQuestions.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkUpdateQaQuestionsRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainBulkUpdateQaQuestionsRequest": { + "description": "The request for bulk updating QaQuestions.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource for the bulk update job instance.", + "type": "string" + }, + "qaQuestions": { + "description": "Required. All the questions to be updated", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestion" + } + }, + "updateMask": { + "description": "Optional. All questions will be updated with the same mask.\nAn empty mask will means updating all updatable fields.", + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + }, + "required": [ + "parent", + "qaQuestions" + ] + }, + "GoogleCloudContactcenterinsightsV1mainQaQuestion": { + "description": "A single question to be scored by the Insights QA feature.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The resource name of the question.\nFormat:\nprojects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", + "x-google-identifier": true, + "type": "string" + }, + "abbreviation": { + "description": "Short, descriptive string, used in the UI where it's not practical\nto display the full question body. E.g., \"Greeting\".", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this question was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the question was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "questionType": { + "description": "The type of question.", + "type": "string", + "x-google-enum-descriptions": [ + "The type of the question is unspecified.", + "The default question type. The question is fully customizable by the\nuser.", + "The question type is using a predefined model provided by CCAI\nteams. Users are not allowed to edit the question_body, answer_choices,\nupload feedback labels for the question nor fine-tune the question.\nHowever, users may edit other fields like question tags, question order,\netc." + ], + "enum": [ + "QA_QUESTION_TYPE_UNSPECIFIED", + "CUSTOMIZABLE", + "PREDEFINED" + ] + }, + "questionMedium": { + "description": "The medium of the question.", + "type": "string", + "x-google-enum-descriptions": [ + "The medium of the question is unspecified.", + "The question is for chat conversations and will expect a chat transcript\nto be present before scoring.", + "The question is for voice conversations and does NOT expect any chat\ntranscripts to be present before scoring." + ], + "enum": [ + "QA_QUESTION_MEDIUM_UNSPECIFIED", + "CHAT", + "VOICE" + ] + }, + "qaQuestionDataOptions": { + "description": "Options for configuring the data used to generate the QA question.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionQaQuestionDataOptions" + }] + }, + "predefinedQuestionConfig": { + "description": "The configuration of the predefined question. This field will only be set\nif the Question Type is predefined.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionPredefinedQuestionConfig" + }] + }, + "questionBody": { + "description": "Question text. E.g., \"Did the agent greet the customer?\"", + "type": "string" + }, + "answerInstructions": { + "description": "Instructions describing how to determine the answer.", + "type": "string" + }, + "answerChoices": { + "description": "A list of valid answers to the question, which the LLM must choose from.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoice" + } + }, + "tags": { + "description": "Questions are tagged for categorization and scoring. Tags can either be:\n- Default Tags: These are predefined categories. They are identified by\ntheir string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\").\n- Custom Tags: These are user-defined categories. They are identified by\ntheir full resource name (e.g.,\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}).\nBoth default and custom tags are used to group questions and to influence\nthe scoring of each question.", + "type": "array", + "items": { + "type": "string" + } + }, + "order": { + "description": "Defines the order of the question within its parent scorecard revision.", + "type": "integer", + "format": "int32" + }, + "metrics": { + "description": "Metrics of the underlying tuned LLM over a holdout/test set while fine\ntuning the underlying LLM for the given question. This field will only be\npopulated if and only if the question is part of a scorecard revision that\nhas been tuned.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionMetrics" + }] + }, + "tuningMetadata": { + "description": "Metadata about the tuning operation for the question.This field will only\nbe populated if and only if the question is part of a scorecard revision\nthat has been tuned.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionTuningMetadata" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaQuestionQaQuestionDataOptions": { + "description": "Options for configuring the data used to generate the QA question.", + "type": "object", + "properties": { + "conversationDataOptions": { + "description": "Options for configuring the conversation data used to generate the QA\nquestion.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationDataOptions" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationDataOptions": { + "description": "Options for configuring what metadata is included in the conversation data\nused in QAI and Discovery Engine.", + "type": "object", + "properties": { + "includeDialogflowInteractionData": { + "description": "Whether to include the per turn Dialogflow interaction data in conversation\ntranscript.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaQuestionPredefinedQuestionConfig": { + "description": "Configuration for a predefined question. This field will only be set if the\nQuestion Type is predefined.", + "type": "object", + "properties": { + "type": { + "description": "The type of the predefined question.", + "type": "string", + "x-google-enum-descriptions": [ + "The type of the predefined question is unspecified.", + "A prebuilt classifier classfying the outcome of the conversation.\nFor example, if the customer issue mentioned in a conversation has\nbeen resolved or not.", + "A prebuilt classifier classfying the initiator of the conversation\nescalation. For example, if it was initiated by the customer or the\nagent." + ], + "enum": [ + "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", + "CONVERSATION_OUTCOME", + "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoice": { + "description": "Message representing a possible answer to the question.", + "type": "object", + "properties": { + "key": { + "description": "A short string used as an identifier.", + "type": "string" + }, + "strValue": { + "description": "String value.", + "type": "string" + }, + "numValue": { + "description": "Numerical value.", + "type": "number", + "format": "double" + }, + "boolValue": { + "description": "Boolean value.", + "type": "boolean" + }, + "naValue": { + "description": "A value of \"Not Applicable (N/A)\". If provided, this field may only\nbe set to `true`. If a question receives this answer, it will be\nexcluded from any score calculations.", + "type": "boolean" + }, + "score": { + "description": "Numerical score of the answer, used for generating the overall score of\na QaScorecardResult. If the answer uses na_value, this field is unused.", + "type": "number", + "format": "double" + }, + "nextActionConfig": { + "description": "Configuration for the next action to take if this answerChoice is\nselected for this question.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfig": { + "description": "The configuration for the next action. This is used to configure the next\naction to take if an answer choice is selected.", + "type": "object", + "properties": { + "runChildQaQuestionsAction": { + "description": "The list of questions to evaluate next, i.e., child questions.\nRequirements for this action are the following:\n1. The current question and child questions must be in the same\n scorecard and present in the same scorecard revision.\n2. The current question and child questions must not introduce a\n cycle, i.e., Q1 -> [Q2, Q3], then Q2 -> [Q1] should not be\n allowed, where Q1, Q2, and Q3 are questions.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction" + }] + }, + "terminateChildQaQuestionsAction": { + "description": "Terminate any further evaluation of child questions.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction": { + "description": "The configuration for evaluating child questions.", + "type": "object", + "properties": { + "childQaQuestionNames": { + "description": "A list of resource names representing the child questions to evaluate\nnext. The format for each question resource name is:\nprojects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions": { + "description": "Indicates termination.", + "type": "object", + "properties": { + "terminationType": { + "description": "The type of termination to perform.", + "type": "string", + "x-google-enum-descriptions": [ + "The termination type is unspecified.", + "A failed scorecard would mean the overall scorecard score will be\nzeroed out, i.e., the scorecard score will be 0.", + "The overall scorecard score will be calculated based on the\nscores of the questions answered in the chain up until the last\nscored question that was answered. This is the default behavior." + ], + "enum": [ + "TERMINATION_TYPE_UNSPECIFIED", + "TERMINATE_WITH_SCORECARD_FAILURE", + "TERMINATE_WITH_CALCULATED_SCORE" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaQuestionMetrics": { + "description": "A wrapper representing metrics calculated against a test-set on a LLM that\nwas fine tuned for this question.", + "type": "object", + "properties": { + "accuracy": { + "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the\nmodel gave on the test set.", + "readOnly": true, + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaQuestionTuningMetadata": { + "description": "Metadata about the tuning operation for the question. Will only be set if a\nscorecard containing this question has been tuned.", + "type": "object", + "properties": { + "totalValidLabelCount": { + "description": "Total number of valid labels provided for the question at the time of\ntuining.", + "type": "string", + "format": "int64" + }, + "datasetValidationWarnings": { + "description": "A list of any applicable data validation warnings about the question's\nfeedback labels.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDatasetValidationWarning" + } + }, + "tuningError": { + "description": "Error status of the tuning operation for the question. Will only be set\nif the tuning operation failed.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainBulkUpdateQaQuestionsResponse": { + "description": "The response for bulk updating QaQuestions.", + "type": "object", + "properties": { + "qaQuestions": { + "description": "The QaQuestions that were updated.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestion" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata": { + "description": "Metadata for a create analysis operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "conversation": { + "description": "Output only. The Conversation that this Analysis Operation belongs to.", + "readOnly": true, + "type": "string" + }, + "annotatorSelector": { + "description": "Output only. The annotator selector used for the analysis (if any).", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainCreateDiscoveryRevisionMetadata": { + "description": "Metadata for a discovery revision creation operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The request to create the discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainCreateDiscoveryRevisionRequest" + }] + }, + "progress": { + "description": "The progress of the discovery creation operation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryProgress" + }] + }, + "resultRevision": { + "description": "Output only. The newly created discovery revision resource name.", + "readOnly": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainCreateDiscoveryRevisionRequest": { + "description": "The request to create a discovery revision.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the discovery.", + "type": "string" + }, + "discoveryRevision": { + "description": "Required. The discovery revision to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryRevision" + }] + }, + "discoveryRevisionId": { + "description": "Optional. The ID of the discovery revision to create.", + "type": "string" + } + }, + "required": [ + "parent", + "discoveryRevision" + ] + }, + "GoogleCloudContactcenterinsightsV1mainDiscoveryRevision": { + "description": "The discovery result revision resource. A revision is created when client\nspecifically requests via calling CreateDiscoveryRevision API. This\nusually happens when client is finalizing the feedbacks to previous revision.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Resource name of the DiscoveryRevision.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", + "x-google-identifier": true, + "type": "string" + }, + "snapshot": { + "description": "Output only. The snapshot of the discovery result at this revision.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscovery" + }] + }, + "createTime": { + "description": "Output only. The time at which this discovery result revision was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the discovery result revision was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "feedback": { + "description": "The feedback for the discovery result under source_revision.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryRevisionFeedback" + }] + }, + "inputData": { + "description": "The input data to be used to create this revision.\nWhen not provided, the input data from the source revision will be used.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryInputDataConfig" + }] + }, + "sourceRevision": { + "description": "Immutable. The source of this discovery revision. i.e. this discovery revision is\nthe result of applying changes on top of source_revision. Format:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", + "x-google-immutable": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the discovery.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "This value is unused.", + "The discovery is running. There may be discovery results generated but\nthe final list or distributions are not finalized.", + "The discovery is completed. The final list or distributions are\nfinalized." + ], + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "COMPLETED" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDiscovery": { + "description": "The discovery resource.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Resource name of the discovery.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "User provided display name of the discovery. Modifying this will not change\nthe discovery result or behaviour.", + "type": "string" + }, + "languageCode": { + "description": "Immutable. The language code of the discovery results. When drill_down_parent is\nspecified, this field is inherited from the parent discovery.\nWhen neither language_code nor drill_down_parent is specified, defaults to\nen.", + "x-google-immutable": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this discovery was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the discovery was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "drillDownParent": { + "description": "Name of the discovery discovery result this discovery is a drill down of.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}\nIf empty, this discovery is a top level discovery.\nServer enforces at discovery resource creation time that this resource\nreference creates a tree structure and there's no cycle in the resource\nhierarchy. This field should not be updated once the discovery is created.", + "type": "string" + }, + "discoveryGoal": { + "description": "Required. Immutable. User specified goal for the discovery. This field is immutable once the\ndiscovery is created.", + "x-google-immutable": true, + "type": "string" + }, + "inputData": { + "description": "Specs for the input data used for this discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryInputDataConfig" + }] + }, + "customTaxonomy": { + "description": "User provided taxonomy to guide the discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryCustomTaxonomy" + }] + }, + "advancedOptions": { + "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryDiscoveryAdvancedOptions" + }] + } + }, + "required": [ + "discoveryGoal" + ] + }, + "GoogleCloudContactcenterinsightsV1mainDiscoveryInputDataConfig": { + "description": "Configuration for the input data used for discovery.", + "type": "object", + "properties": { + "conversationFilter": { + "description": "Optional. The filter for querying conversations.", + "type": "string" + }, + "maxSampleSize": { + "description": "Optional. Maximum number of conversations to sample.", + "type": "string", + "format": "int64" + }, + "dataset": { + "description": "Optional. The resource name of the Dataset to scope the discovery to.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}\nIf provided, discovery will only run on conversations within this dataset.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDiscoveryCustomTaxonomy": { + "description": "User provided taxonomy to guide the discovery.", + "type": "object", + "properties": { + "taxonomyEntries": { + "description": "Entries in the custom taxonomy.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryCustomTaxonomyTaxonomyEntry" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDiscoveryCustomTaxonomyTaxonomyEntry": { + "description": "A single entry in the custom taxonomy.", + "type": "object", + "properties": { + "displayName": { + "description": "Name of the taxonomy entry.", + "type": "string" + }, + "description": { + "description": "Description of the taxonomy entry.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDiscoveryDiscoveryAdvancedOptions": { + "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", + "type": "object", + "properties": { + "conversationDataOptions": { + "description": "Options for configuring what metadata goes into conversation\ntranscript.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationDataOptions" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDiscoveryRevisionFeedback": { + "description": "Feedback for the discovery results under previous_revision.", + "type": "object", + "properties": { + "resultFeedback": { + "description": "DiscoveryResult level feedback.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryRevisionFeedbackResultFeedback" + } + }, + "revisionFeedback": { + "description": "DiscoveryRevision level feedback.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDiscoveryRevisionFeedbackResultFeedback": { + "description": "Content of a DiscoveryResult level feedback. i.e. Feedback applied\nspecifically to a DiscoveryResult.", + "type": "object", + "properties": { + "result": { + "description": "Resource name of the discovery result this feedback is for.\nThe parent discovery revision of the result must be the same as what's\nspecified in the source_revision field.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}", + "type": "string" + }, + "feedback": { + "description": "The feedback for the discovery result.", + "type": "string" + }, + "userAction": { + "description": "The user action for the entry feedback.", + "type": "string", + "x-google-enum-descriptions": [ + "Default value.", + "The user wants to remove the discovery result.", + "The user provides an exact replacement for the display name.", + "The user provides an exact replacement for the description.", + "The user provides comments/instructions on how to modify the display\nname.", + "The user provides comments/instructions on how to modify the\ndescription." + ], + "enum": [ + "USER_ACTION_UNSPECIFIED", + "REMOVE", + "SET_DISPLAY_NAME", + "SET_DESCRIPTION", + "SUGGEST_DISPLAY_NAME_EDIT", + "SUGGEST_DESCRIPTION_EDIT" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDiscoveryProgress": { + "description": "Progress information for a discovery.", + "type": "object", + "properties": { + "progressState": { + "description": "Output only. The state of the discovery creation or refinement.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "Default value. This value is unused.", + "The input data is being preprocessed.", + "Summarizing the conversations to extract features.", + "Generating the results based on the features.", + "Calculating the distributions for the results.", + "The discovery is being finalized.", + "The GenerateDiscovery operation has completed successfully." + ], + "enum": [ + "PROGRESS_STATE_UNSPECIFIED", + "PREPROCESSING", + "SUMMARIZING", + "GENERATING_RESULTS", + "COMPUTING_DISTRIBUTIONS", + "FINALIZING", + "SUCCEEDED" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainCreateFaqModelMetadata": { + "description": "Metadata for creating an FAQ model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for creation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainCreateFaqModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainCreateFaqModelRequest": { + "description": "The request to create an FAQ model.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the FAQ model.", + "type": "string" + }, + "faqModel": { + "description": "Required. The FAQ model to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFaqModel" + }] + }, + "faqModelId": { + "description": "Optional. The ID to use for the FAQ model, which will become the final\ncomponent of the FAQ model's resource name.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", + "type": "string" + } + }, + "required": [ + "parent", + "faqModel" + ] + }, + "GoogleCloudContactcenterinsightsV1mainFaqModel": { + "description": "The FAQ model resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the FAQ model.\nFormat:\nprojects/{project}/locations/{location}/faqModels/{faq_model}", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The representative name for the FAQ model.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this FAQ model was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the FAQ model was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "faqEntryCount": { + "description": "Output only. Number of FAQ entries in this FAQ model.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "state": { + "description": "Output only. State of the FAQ model.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Model is not deployed but is ready to deploy.", + "Model is being deleted." + ], + "enum": [ + "STATE_UNSPECIFIED", + "UNDEPLOYED", + "DELETING" + ] + }, + "inputDataConfig": { + "description": "Configs for the input data used to create the FAQ model.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFaqModelInputDataConfig" + }] + }, + "modelTrainingStats": { + "description": "Output only. Immutable. The model statistics on its training data.", + "readOnly": true, + "x-google-immutable": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFaqModelModelStats" + }] + }, + "infobotAgent": { + "description": "Immutable. The resource name of the infobot agent to be used to create generative\nanswers. Format: projects/{project}/locations/{location}/agents/{agent}", + "x-google-immutable": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainFaqModelInputDataConfig": { + "description": "Configs for the input data used to create the FAQ model.", + "type": "object", + "properties": { + "trainingConversationsCount": { + "description": "Output only. Number of conversations used in training. Output only.", + "readOnly": true, + "type": "string", + "format": "int64" + }, + "filter": { + "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainFaqModelModelStats": { + "description": "Train/inference statistics for the model.", + "type": "object", + "properties": { + "totalConversationsCount": { + "description": "Total number of conversations analyzed at this point in time.", + "type": "integer", + "format": "int32" + }, + "skippedConversationsCount": { + "description": "Number of analyzed conversations which were skipped e.g. customer\ndisconnected from the call.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata": { + "description": "Metadata for creating an issue.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for creation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainCreateIssueRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest": { + "description": "The request to create an issue.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the issue.", + "type": "string" + }, + "issue": { + "description": "Required. The values for the new issue.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssue" + }] + } + }, + "required": [ + "parent", + "issue" + ] + }, + "GoogleCloudContactcenterinsightsV1mainIssue": { + "description": "The issue resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the issue.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The representative name for the issue.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this issue was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time that this issue was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "representativeConversationNames": { + "description": "Output only. Resource names of the most representative conversations matched.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "sampleUtterances": { + "description": "Output only. Resource names of the sample representative utterances that match to this\nissue.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "source": { + "description": "Source of the topic", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Generated based on the customers data - i.e. topic discovered by model.", + "Taxonomy provided by the customer (topic come from custom taxonomy)." + ], + "enum": [ + "ISSUE_SOURCE_UNSPECIFIED", + "GENERATED", + "CUSTOMER_PROVIDED" + ] + }, + "parentIssues": { + "description": "Unique identifiers of the parent topics for hierarchical representation.\nFormat is\n`projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}`", + "type": "array", + "items": { + "type": "string" + } + }, + "alternatives": { + "description": "Additional topic descriptions.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueAlternative" + } + }, + "displayDescription": { + "description": "Representative description of the issue.", + "type": "string" + }, + "matchTarget": { + "description": "Target used for semantic similarity comparisons.\nPopulated on V2 models if the display name was renamed.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIssueAlternative": { + "description": "Alternative topic names or descriptions to improve inference.", + "type": "object", + "properties": { + "alternative": { + "description": "An alternative topic name.", + "type": "string" + }, + "description": { + "description": "An alternative topic description.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata": { + "description": "Metadata for creating an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for creation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest": { + "description": "The request to create an issue model.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the issue model.", + "type": "string" + }, + "issueModel": { + "description": "Required. The issue model to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModel" + }] + } + }, + "required": [ + "parent", + "issueModel" + ] + }, + "GoogleCloudContactcenterinsightsV1mainIssueModel": { + "description": "The issue model resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the issue model.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The representative name for the issue model.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this issue model was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the issue model was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "issueCount": { + "description": "Output only. Number of issues in this issue model.", + "readOnly": true, + "type": "string", + "format": "int64" + }, + "state": { + "description": "Output only. State of the model.", + "readOnly": true, + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Model is not deployed but is ready to deploy.", + "Model is being deployed.", + "Model is deployed and is ready to be used. A model can only be used in\nanalysis if it's in this state.", + "Model is being undeployed.", + "Model is being deleted." + ], + "enum": [ + "STATE_UNSPECIFIED", + "UNDEPLOYED", + "DEPLOYING", + "DEPLOYED", + "UNDEPLOYING", + "DELETING" + ] + }, + "inputDataConfig": { + "description": "Configs for the input data that used to create the issue model.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig" + }] + }, + "trainingStats": { + "description": "Output only. Immutable. The issue model's label statistics on its training data.", + "readOnly": true, + "x-google-immutable": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats" + }] + }, + "modelType": { + "description": "Type of the model.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified model type.", + "Type V1.", + "Type V2." + ], + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "TYPE_V1", + "TYPE_V2" + ] + }, + "languageCode": { + "description": "Language of the model.", + "type": "string" + }, + "multiLingualMatch": { + "description": "Whether the model can be used for analysis with conversations in multiple\nlanguages. The topic names and descriptions will be in the `language_code`\nspecified, but the matching will be performed against conversations in any\nlanguage.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig": { + "description": "Configs for the input data used to create the issue model.", + "type": "object", + "properties": { + "medium": { + "description": "Medium of conversations used in training data. This field is being\ndeprecated. To specify the medium to be used in training a new issue\nmodel, set the `medium` field on `filter`.", + "deprecated": true, + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "The format for conversations that took place over the phone.", + "The format for conversations that took place over chat." + ], + "enum": [ + "MEDIUM_UNSPECIFIED", + "PHONE_CALL", + "CHAT" + ] + }, + "trainingConversationsCount": { + "description": "Output only. Number of conversations used in training. Output only.", + "readOnly": true, + "type": "string", + "format": "int64" + }, + "filter": { + "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", + "type": "string" + }, + "customTaxonomy": { + "description": "Custom supplied taxonomy.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelCustomTaxonomy" + }] + }, + "issueGranularity": { + "description": "Issue granularity preference for model training.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Granularity much coarser than default.", + "Granularity coarser than default.", + "Default granularity.", + "Granularity finer than default.", + "Granularity much finer than default." + ], + "enum": [ + "ISSUE_GRANULARITY_UNSPECIFIED", + "MORE_COARSE", + "COARSE", + "STANDARD", + "FINE", + "MORE_FINE" + ] + }, + "industry": { + "description": "Customer industry, used to improve specificity of the topic model.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIssueModelCustomTaxonomy": { + "description": "Structure for custom supplied taxonomy. A custom taxonomy consists of\nmultiple taxonomy entries organized in a hierarchical way.", + "type": "object", + "properties": { + "taxonomyEntries": { + "description": "List of taxonomy entries.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelCustomTaxonomyTaxonomyEntry" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIssueModelCustomTaxonomyTaxonomyEntry": { + "description": "Structure for a taxonomy entry.", + "type": "object", + "properties": { + "id": { + "description": "Immutable. The Id of the taxonomy entry", + "x-google-immutable": true, + "type": "string" + }, + "displayName": { + "description": "The content of the taxonomy entry.", + "type": "string" + }, + "parents": { + "description": "Ids of parent taxonomy entries.", + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "The description of the taxonomy entry.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats": { + "description": "Aggregated statistics about an issue model.", + "type": "object", + "properties": { + "analyzedConversationsCount": { + "description": "Number of conversations the issue model has analyzed at this point in time.", + "type": "string", + "format": "int64" + }, + "unclassifiedConversationsCount": { + "description": "Number of analyzed conversations for which no issue was applicable at this\npoint in time.", + "type": "string", + "format": "int64" + }, + "issueStats": { + "description": "Statistics on each issue. Key is the issue's resource name.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats": { + "description": "Aggregated statistics about an issue.", + "type": "object", + "properties": { + "issue": { + "description": "Issue resource.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", + "type": "string" + }, + "labeledConversationsCount": { + "description": "Number of conversations attached to the issue at this point in time.", + "type": "string", + "format": "int64" + }, + "displayName": { + "description": "Display name of the issue.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDeleteFaqModelMetadata": { + "description": "Metadata for deleting an FAQ model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for deletion.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDeleteFaqModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDeleteFaqModelRequest": { + "description": "The request to delete an FAQ model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The name of the FAQ model to delete.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata": { + "description": "Metadata for deleting an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for deletion.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest": { + "description": "The request to delete an issue model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The name of the issue model to delete.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata": { + "description": "The metadata for deleting a QaQuestionTag Resource.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest": { + "description": "The request for deleting a QaQuestionTag.", + "type": "object", + "properties": { + "name": { + "description": "Required. The name of the QaQuestionTag to delete.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata": { + "description": "Metadata for deploying an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for deployment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest": { + "description": "The request to deploy an issue model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The issue model to deploy.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse": { + "description": "The response to deploy an issue model.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata": { + "description": "Metadata for an export insights operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for export.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during export operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "completedExportCount": { + "description": "The number of conversations that were exported successfully.", + "type": "integer", + "format": "int32" + }, + "failedExportCount": { + "description": "The number of conversations that failed to be exported.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest": { + "description": "The request to export insights.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource to export data from.", + "type": "string" + }, + "bigQueryDestination": { + "description": "Specified if sink is a BigQuery table.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination" + }] + }, + "filter": { + "description": "A filter to reduce results to a specific subset. Useful for exporting\nconversations with specific properties.", + "type": "string" + }, + "kmsKey": { + "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK.\nFormat:\nprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", + "type": "string" + }, + "writeDisposition": { + "description": "Options for what to do if the destination table already exists.", + "type": "string", + "x-google-enum-descriptions": [ + "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", + "If the table already exists, BigQuery will overwrite the table data and\nuse the schema from the load.", + "If the table already exists, BigQuery will append data to the table." + ], + "enum": [ + "WRITE_DISPOSITION_UNSPECIFIED", + "WRITE_TRUNCATE", + "WRITE_APPEND" + ] + }, + "exportSchemaVersion": { + "description": "Optional. Version of the export schema.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified. Defaults to EXPORT_V3.", + "Export schema version 1.", + "Export schema version 2.", + "Export schema version 3.", + "Export schema version 4.", + "Export schema version 5.", + "Export schema version 6.", + "Export schema version 7.", + "Export schema version 8.", + "Export schema version 9.", + "Export schema version 10.", + "Export schema version 11.", + "Export schema version 12.", + "Export schema version 13.", + "Export schema version 14.", + "Export schema version 15.", + "Export schema version 16.", + "Export schema version 17.", + "Export schema version latest available." + ], + "enum": [ + "EXPORT_SCHEMA_VERSION_UNSPECIFIED", + "EXPORT_V1", + "EXPORT_V2", + "EXPORT_V3", + "EXPORT_V4", + "EXPORT_V5", + "EXPORT_V6", + "EXPORT_V7", + "EXPORT_V8", + "EXPORT_V9", + "EXPORT_V10", + "EXPORT_V11", + "EXPORT_V12", + "EXPORT_V13", + "EXPORT_V14", + "EXPORT_V15", + "EXPORT_V16", + "EXPORT_V17", + "EXPORT_VERSION_LATEST_AVAILABLE" + ] + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination": { + "description": "A BigQuery Table Reference.", + "type": "object", + "properties": { + "projectId": { + "description": "A project ID or number. If specified, then export will attempt to\nwrite data to this project instead of the resource project. Otherwise,\nthe resource project will be used.", + "type": "string" + }, + "dataset": { + "description": "Required. The name of the BigQuery dataset that the snapshot result should be\nexported to. If this dataset does not exist, the export call returns an\nINVALID_ARGUMENT error.", + "type": "string" + }, + "table": { + "description": "The BigQuery table name to which the insights data should be written.\nIf this table does not exist, the export call returns an INVALID_ARGUMENT\nerror.", + "type": "string" + } + }, + "required": [ + "dataset" + ] + }, + "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse": { + "description": "Response for an export insights operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata": { + "description": "Metadata used for export issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original export request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest": { + "description": "Request to export an issue model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The issue model to export.", + "type": "string" + }, + "gcsDestination": { + "description": "Google Cloud Storage URI to export the issue model to.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination" + }] + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination": { + "description": "Google Cloud Storage Object URI to save the issue model to.", + "type": "object", + "properties": { + "objectUri": { + "description": "Required. Format: `gs:///`", + "type": "string" + } + }, + "required": [ + "objectUri" + ] + }, + "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse": { + "description": "Response from export issue model", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainGenerateDiscoveryMetadata": { + "description": "Metadata for GenerateDiscovery operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The request to create the discovery.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerateDiscoveryRequest" + }] + }, + "progress": { + "description": "The progress of the discovery creation operation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryProgress" + }] + }, + "resultRevision": { + "description": "Output only. The DiscoveryRevision resource name that contains the result entries\ngenerated in this discovery.", + "readOnly": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainGenerateDiscoveryRequest": { + "description": "The request to generate a discovery.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent of generated discovery request.\nWhen it's a Location resource, this operation creates a root discovery and\nits discovery workspace will be automatically created.\nWhen it's a discovery workspace resource, this operation creates a drill\ndown discovery. discovery.drill_down_parent should have the same discovery\nworkspace as the parent.", + "type": "string" + }, + "discovery": { + "description": "Required. Specifies the discovery to generate. The name field of the discovery will\nbe ignored.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscovery" + }] + } + }, + "required": [ + "parent", + "discovery" + ] + }, + "GoogleCloudContactcenterinsightsV1mainGenerateDiscoveryResponse": { + "description": "The response of generating a discovery.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata": { + "description": "The metadata for generative insights.", + "type": "object", + "properties": { + "errorMessages": { + "description": "The error message when the generative insights request fails.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse": { + "description": "The response for generative insights.", + "type": "object", + "properties": { + "generativeResponses": { + "description": "The full list of generative responses.\nEach response is ordered by time.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse" + } + }, + "transcript": { + "description": "The transcript of the generative insights conversation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse": { + "description": "Wrapper for storing the generative response for a chart.", + "type": "object", + "properties": { + "textOutput": { + "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", + "deprecated": true, + "type": "string" + }, + "generatedSqlQuery": { + "description": "The generated SQL query from the LLM. Will be populated during the\nchart building phase. The generated SQL will be cached in the\ncorresponding chart resource.", + "type": "string" + }, + "chartSpec": { + "description": "The chart spec for the data.\nThis will be specified in the vega-lite or vega format.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "textMessage": { + "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput": { + "description": "Wrapper for text output.", + "type": "object", + "properties": { + "text": { + "description": "The text output from the LLM.", + "type": "array", + "items": { + "type": "string" + } + }, + "textType": { + "description": "The type of text output.", + "type": "string", + "x-google-enum-descriptions": [ + "The type is unspecified.", + "The text is part of LLM reasoning.", + "The text is the final answer from LLM.", + "The text is an informational message about the agent's progress, such\nas a tool being invoked. This is distinct from the agent's internal\nthought process (`THOUGHT`) and the final answer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the agent's\nactions." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "THOUGHT", + "FINAL_RESPONSE", + "PROGRESS" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript": { + "description": "The conversation transcript for the chart.", + "type": "object", + "properties": { + "conversationId": { + "description": "The conversation id of the chart.", + "type": "string" + }, + "createTime": { + "description": "Output only. The create time of the conversation.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The update time of the conversation.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "messages": { + "description": "Ordered list of messages, including user inputs and system responses.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage": { + "description": "The message in the conversation.", + "type": "object", + "properties": { + "messageId": { + "description": "The message id of the message.", + "type": "string" + }, + "createTime": { + "description": "Output only. For user messages, this is the time at which the system received the\nmessage. For system messages, this is the time at which the system\ngenerated the message.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "userMessage": { + "description": "A message from the user that is interacting with the system.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage" + }] + }, + "systemMessageWrapper": { + "description": "A wrapper for system messages per turn.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage": { + "description": "The user message.", + "type": "object", + "properties": { + "text": { + "description": "A message from the user that is interacting with the system.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages": { + "description": "A wrapper for system messages per turn.", + "type": "object", + "properties": { + "systemMessages": { + "description": "A message from the system in response to the user.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage": { + "description": "A message from the system in response to the user. This message can\nalso be a message from the user as historical context for multiturn\nconversations with the system.", + "type": "object", + "properties": { + "textMessage": { + "description": "A direct natural language response to the user message.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" + }] + }, + "generatedSqlQuery": { + "description": "Raw SQL from LLM, before templatization", + "type": "string" + }, + "chartSpec": { + "description": "Chart spec from LLM", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + }, + "userProvidedSqlQuery": { + "description": "Optional. User provided SQL query", + "type": "string" + }, + "userProvidedChartSpec": { + "description": "Optional. User provided chart spec", + "type": "object", + "additionalProperties": { + "description": "Properties of the object." + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { + "description": "A text output message from the system.", + "type": "object", + "properties": { + "text": { + "description": "The parts of the message.", + "type": "array", + "items": { + "type": "string" + } + }, + "textType": { + "description": "The type of the text message.", + "type": "string", + "x-google-enum-descriptions": [ + "The default text type.", + "The text is a thinking plan generated by the thinking tool.", + "The text is a final response to the user question.", + "The text is an informational message about the agent's\nprogress, such as a tool being invoked. This is distinct from\nthe agent's internal thought process (`THOUGHT`) and the final\nanswer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the\nagent's actions." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "THOUGHT", + "FINAL_RESPONSE", + "PROGRESS" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata": { + "description": "Metadata used for import issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was created.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished running.", + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original import request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest": { + "description": "Request to import an issue model.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the issue model.", + "type": "string" + }, + "gcsSource": { + "description": "Google Cloud Storage source message.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource" + }] + }, + "createNewModel": { + "description": "Optional. If set to true, will create an issue model from the imported file with\nrandomly generated IDs for the issue model and corresponding issues.\nOtherwise, replaces an existing model with the same ID as the file.", + "type": "boolean" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource": { + "description": "Google Cloud Storage Object URI to get the issue model file from.", + "type": "object", + "properties": { + "objectUri": { + "description": "Required. Format: `gs:///`", + "type": "string" + } + }, + "required": [ + "objectUri" + ] + }, + "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse": { + "description": "Response from import issue model", + "type": "object", + "properties": { + "issueModel": { + "description": "The issue model that was imported.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModel" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata": { + "description": "The metadata for an IngestConversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for ingest.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest" + }] + }, + "partialErrors": { + "description": "Output only. Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "ingestConversationsStats": { + "description": "Output only. Statistics for IngestConversations operation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats" + }] + }, + "sampledConversations": { + "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest": { + "description": "The request to ingest conversations.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource for new conversations.", + "type": "string" + }, + "gcsSource": { + "description": "A cloud storage bucket source. Note that any previously ingested objects\nfrom the source will be skipped to avoid duplication.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource" + }] + }, + "transcriptObjectConfig": { + "description": "Configuration for when `source` contains conversation transcripts.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig" + }] + }, + "conversationConfig": { + "description": "Configuration that applies to all conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig" + }] + }, + "redactionConfig": { + "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config\nspecified in Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainRedactionConfig" + }] + }, + "speechConfig": { + "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config\nspecified in Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSpeechConfig" + }] + }, + "sampleSize": { + "description": "Optional. If set, this fields indicates the number of objects to ingest from the\nCloud Storage bucket. If empty, the entire bucket will be ingested.\nUnless they are first deleted, conversations produced through sampling\nwon't be ingested by subsequent ingest requests.", + "type": "integer", + "format": "int32" + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource": { + "description": "Configuration for Cloud Storage bucket sources.", + "type": "object", + "properties": { + "bucketUri": { + "description": "Optional. The Cloud Storage bucket containing source objects.\nAvoid passing this. Pass this through one of `transcript_bucket_uri` or\n`audio_bucket_uri`.", + "type": "string" + }, + "bucketObjectType": { + "description": "Optional. Specifies the type of the objects in `bucket_uri`.\nAvoid passing this. This is inferred from the `transcript_bucket_uri`,\n`audio_bucket_uri`.", + "type": "string", + "x-google-enum-descriptions": [ + "The object type is unspecified and will default to `TRANSCRIPT`.", + "The object is a transcript.", + "The object is an audio file." + ], + "enum": [ + "BUCKET_OBJECT_TYPE_UNSPECIFIED", + "TRANSCRIPT", + "AUDIO" + ] + }, + "transcriptBucketUri": { + "description": "Optional. The Cloud Storage path to the conversation transcripts. Note\nthat: [1] Transcript files are expected to be in JSON format. [2]\nTranscript, audio, metadata files must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", + "type": "string" + }, + "audioBucketUri": { + "description": "Optional. The Cloud Storage path to the conversation audio file.\nNote that: [1] Audio files will be transcribed if not already.\n[2] Audio files and transcript files must be in separate\nbuckets / folders.\n[3] A source file and its corresponding audio file\nmust share the same name to\n be properly ingested, E.g.\n `gs://bucket/transcript/conversation1.json` and\n `gs://bucket/audio/conversation1.mp3`.", + "type": "string" + }, + "metadataBucketUri": { + "description": "Optional. The Cloud Storage path to the conversation metadata. Note that:\n[1] Metadata files are expected to be in JSON format.\n[2] Metadata and source files (transcripts or audio) must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", + "type": "string" + }, + "customMetadataKeys": { + "description": "Optional. Custom keys to extract as conversation labels from metadata files in\n`metadata_bucket_uri`. Keys not included in this field will be ignored.\nNote that there is a limit of 100 labels per conversation.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig": { + "description": "Configuration for processing transcript objects.", + "type": "object", + "properties": { + "medium": { + "description": "Required. The medium transcript objects represent.", + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "The format for conversations that took place over the phone.", + "The format for conversations that took place over chat." + ], + "enum": [ + "MEDIUM_UNSPECIFIED", + "PHONE_CALL", + "CHAT" + ] + } + }, + "required": [ + "medium" + ] + }, + "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig": { + "description": "Configuration that applies to all conversations.", + "type": "object", + "properties": { + "agentId": { + "description": "Optional. An opaque, user-specified string representing a human agent who handled\nall conversations in the import. Note that this will be overridden if\nper-conversation metadata is provided through the `metadata_bucket_uri`.", + "type": "string" + }, + "agentChannel": { + "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", + "type": "integer", + "format": "int32" + }, + "customerChannel": { + "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainRedactionConfig": { + "description": "DLP resources used for redaction while ingesting conversations.\nDLP settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint or the Dialogflow / Agent\nAssist runtime integrations. When using Dialogflow / Agent Assist runtime\nintegrations, redaction should be performed in Dialogflow / Agent Assist.", + "type": "object", + "properties": { + "deidentifyTemplate": { + "description": "The fully-qualified DLP deidentify template resource name.\nFormat:\n`projects/{project}/deidentifyTemplates/{template}`", + "type": "string" + }, + "inspectTemplate": { + "description": "The fully-qualified DLP inspect template resource name.\nFormat:\n`projects/{project}/locations/{location}/inspectTemplates/{template}`", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainSpeechConfig": { + "description": "Speech-to-Text configuration.\nSpeech-to-Text settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint.", + "type": "object", + "properties": { + "speechRecognizer": { + "description": "The fully-qualified Speech Recognizer resource name.\nFormat:\n`projects/{project_id}/locations/{location}/recognizer/{recognizer}`", + "type": "string" + }, + "disableWordTimeOffsets": { + "description": "Whether to disable word time offsets.\nIf true, the `enable_word_time_offsets` field in the recognition config\nwill be set to false.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats": { + "description": "Statistics for IngestConversations operation.", + "type": "object", + "properties": { + "processedObjectCount": { + "description": "Output only. The number of objects processed during the ingest operation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "duplicatesSkippedCount": { + "description": "Output only. The number of objects skipped because another conversation with the same\ntranscript uri had already been ingested.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "successfulIngestCount": { + "description": "Output only. The number of new conversations added during this ingest operation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "failedIngestCount": { + "description": "Output only. The number of objects which were unable to be ingested due to errors.\nThe errors are populated in the partial_errors field.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse": { + "description": "The response to an IngestConversations operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for initialization.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest" + }] + }, + "partialErrors": { + "description": "Partial errors during initializing operation that might cause the operation\noutput to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "type": "object", + "properties": { + "encryptionSpec": { + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms\nkey is in the same region as the endpoint. The same key will be used for\nall provisioned resources, if encryption is available. If the\n`kms_key_name` field is left empty, no encryption will be enforced.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainEncryptionSpec" + }] + } + }, + "required": [ + "encryptionSpec" + ] + }, + "GoogleCloudContactcenterinsightsV1mainEncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all\ncreated resources (e.g. `Conversation`).", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the encryption key specification resource.\nFormat:\nprojects/{project}/locations/{location}/encryptionSpec", + "x-google-immutable": true, + "type": "string" + }, + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to\nsecure a resource and its sub-resources. If empty, the resource is secured\nby our default encryption key. Only the key in the same location as this\nresource is allowed to be used for encryption. Format:\n`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + } + }, + "required": [ + "kmsKey" + ] + }, + "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse": { + "description": "The response to initialize a location-level encryption specification.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse": { + "description": "The response for listing all feedback labels.", + "type": "object", + "properties": { + "feedbackLabels": { + "description": "The feedback labels that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFeedbackLabel" + } + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainFeedbackLabel": { + "description": "Represents a conversation, resource, and label provided by the user.\nCan take the form of a string label or a QaAnswer label.\nQaAnswer labels are used for Quality AI example conversations.\nString labels are used for Topic Modeling.\nAgentAssistSummary labels are used for Agent Assist Summarization.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. Resource name of the FeedbackLabel.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", + "x-google-immutable": true, + "type": "string" + }, + "labeledResource": { + "description": "Name of the resource to be labeled.\nSupported resources are:\n\n* `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}`\n* `projects/{project}/locations/{location}/issueModels/{issue_model}`\n* `projects/{project}/locations/{location}/generators/{generator_id}`", + "type": "string" + }, + "label": { + "description": "String label used for Topic Modeling.", + "type": "string" + }, + "qaAnswerLabel": { + "description": "QaAnswer label used for Quality AI example conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" + }] + }, + "createTime": { + "description": "Output only. Create time of the label.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. Update time of the label.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue": { + "description": "Message for holding the value of a QaAnswer.\nQaQuestion.AnswerChoice defines the possible answer values for a\nquestion.", + "type": "object", + "properties": { + "key": { + "description": "A short string used as an identifier. Matches the value used in\nQaQuestion.AnswerChoice.key.", + "type": "string" + }, + "strValue": { + "description": "String value.", + "type": "string" + }, + "numValue": { + "description": "Numerical value.", + "type": "number", + "format": "double" + }, + "boolValue": { + "description": "Boolean value.", + "type": "boolean" + }, + "naValue": { + "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", + "type": "boolean" + }, + "skipValue": { + "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`.\nIf a question receives this answer, it will be excluded from any score\ncalculations. This would mean that the question was not evaluated.", + "readOnly": true, + "type": "boolean" + }, + "score": { + "description": "Output only. Numerical score of the answer.", + "readOnly": true, + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "Output only. The maximum potential score of the question.", + "readOnly": true, + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", + "readOnly": true, + "type": "number", + "format": "double" + }, + "rationale": { + "description": "Output only. The rationale for the answer. This field is only populated for answers\nthat are generated by the LLM. Manual edits currently do not have\nrationales.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValueQaAnswerRationale" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValueQaAnswerRationale": { + "description": "Wrapper for the rationale for the answer.", + "type": "object", + "properties": { + "rationale": { + "description": "The rationale string for the answer.", + "type": "string" + }, + "rationaleSource": { + "description": "The source of the rationale. A manual edit AnswerValue could still\ncontain a system generated rationale if user didn't provide one. Manual\nedit would override the system generated rationale.", + "type": "string", + "x-google-enum-descriptions": [ + "The rationale source is unspecified. This value should generally not\nbe used.", + "The rationale is system generated.", + "The rationale is manually added by the user." + ], + "enum": [ + "RATIONALE_SOURCE_UNSPECIFIED", + "RATIONALE_SOURCE_SYSTEM_GENERATED", + "RATIONALE_SOURCE_MANUAL_EDIT" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse": { + "description": "The response for listing feedback labels.", + "type": "object", + "properties": { + "feedbackLabels": { + "description": "The feedback labels that match the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFeedbackLabel" + } + }, + "nextPageToken": { + "description": "The next page token.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainMergeIssuesMetadata": { + "description": "Metadata for creating an issue.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata": { + "description": "The metadata from querying metrics.", + "type": "object", + "properties": { + "resultIsTruncated": { + "description": "Whether the result rows were truncated because the result row size is too\nlarge to materialize.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse": { + "description": "The response for querying metrics.", + "type": "object", + "properties": { + "location": { + "description": "Required. The location of the data.\n\"projects/{project}/locations/{location}\"", + "type": "string" + }, + "updateTime": { + "description": "The metrics last update time.", + "type": "string", + "format": "date-time" + }, + "slices": { + "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" + } + }, + "macroAverageSlice": { + "description": "The macro average slice contains aggregated averages across all selected\ndimensions. i.e. if group_by agent and scorecard_id is specified, this\nfield will contain the average across all agents and all scorecards. This\nfield is only populated if the request specifies a Dimension.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" + }] + } + }, + "required": [ + "location" + ] + }, + "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice": { + "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.\n\nFor example, if the request specifies a single ISSUE dimension and it has a\ncardinality of 2 (i.e. the data used to compute the metrics has 2 issues in\ntotal), the response will have 2 slices:\n\n* Slice 1 -> dimensions=[Issue 1]\n* Slice 2 -> dimensions=[Issue 2]", + "type": "object", + "properties": { + "dimensions": { + "description": "A unique combination of dimensions that this slice represents.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimension" + } + }, + "total": { + "description": "The total metric value. The interval of this data point is\n[starting create time, ending create time) from the request.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" + }] + }, + "timeSeries": { + "description": "A time series of metric values. This is only populated if the request\nspecifies a time granularity other than NONE.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimension": { + "description": "A dimension determines the grouping key for the query. In SQL terms, these\nwould be part of both the \"SELECT\" and \"GROUP BY\" clauses.", + "type": "object", + "properties": { + "dimensionKey": { + "description": "The key of the dimension.", + "type": "string", + "x-google-enum-descriptions": [ + "The key of the dimension is unspecified.", + "The dimension is keyed by issues.", + "The dimension is keyed by issue names.", + "The dimension is keyed by agents.", + "The dimension is keyed by agent teams.", + "The dimension is keyed by QaQuestionIds.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing stats for\nthe same question across different scorecard revisions.", + "The dimension is keyed by QaQuestionIds-Answer value pairs.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing\ndistribution of answers per question across different scorecard\nrevisions.", + "The dimension is keyed by QaScorecardIds.\nNote that: We only group by the ScorecardId and not the revision-id of\nthe scorecard. This allows for showing stats for the same scorecard\nacross different revisions.\nThis metric is mostly only useful if querying the average normalized\nscore per scorecard.", + "The dimension is keyed by the conversation profile ID.", + "The dimension is keyed by the conversation medium.", + "The dimension is keyed by the Conversational Agents playbook ID.", + "The dimension is keyed by the Conversational Agents playbook display\nname.", + "The dimension is keyed by the Conversational Agents tool ID.", + "The dimension is keyed by the Conversational Agents tool display name.", + "The dimension is keyed by the client sentiment category.", + "The dimension is keyed by the agent version ID.", + "The dimension is keyed by the agent deployment ID.", + "The dimension is keyed by the supervisor ID of the assigned human\nsupervisor for virtual agents.", + "The dimension is keyed by label keys.", + "The dimension is keyed by label values.", + "The dimension is keyed by label key-value pairs." + ], + "enum": [ + "DIMENSION_KEY_UNSPECIFIED", + "ISSUE", + "ISSUE_NAME", + "AGENT", + "AGENT_TEAM", + "QA_QUESTION_ID", + "QA_QUESTION_ANSWER_VALUE", + "QA_SCORECARD_ID", + "CONVERSATION_PROFILE_ID", + "MEDIUM", + "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", + "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", + "CONVERSATIONAL_AGENTS_TOOL_ID", + "CONVERSATIONAL_AGENTS_TOOL_NAME", + "CLIENT_SENTIMENT_CATEGORY", + "AGENT_VERSION_ID", + "AGENT_DEPLOYMENT_ID", + "AGENT_ASSIST_SUPERVISOR_ID", + "LABEL_KEY", + "LABEL_VALUE", + "LABEL_KEY_AND_VALUE" + ] + }, + "issueDimensionMetadata": { + "description": "Output only. Metadata about the issue dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata" + }] + }, + "agentDimensionMetadata": { + "description": "Output only. Metadata about the agent dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata" + }] + }, + "qaQuestionDimensionMetadata": { + "description": "Output only. Metadata about the QA question dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata" + }] + }, + "qaQuestionAnswerDimensionMetadata": { + "description": "Output only. Metadata about the QA question-answer dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata" + }] + }, + "qaScorecardDimensionMetadata": { + "description": "Output only. Metadata about the QA scorecard dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata" + }] + }, + "conversationProfileDimensionMetadata": { + "description": "Output only. Metadata about the conversation profile dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata" + }] + }, + "mediumDimensionMetadata": { + "description": "Output only. Metadata about the conversation medium dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata" + }] + }, + "conversationalAgentsPlaybookDimensionMetadata": { + "description": "Output only. Metadata about the Conversational Agents playbook dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata" + }] + }, + "conversationalAgentsToolDimensionMetadata": { + "description": "Output only. Metadata about the Conversational Agents tool dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata" + }] + }, + "clientSentimentCategoryDimensionMetadata": { + "description": "Output only. Metadata about the client sentiment category dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata" + }] + }, + "agentAssistSupervisorDimensionMetadata": { + "description": "Output only. Metadata about the supervisor for virtual agents dimension.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionAgentAssistSupervisorDimensionMetadata" + }] + }, + "labelDimensionMetadata": { + "description": "Output only. Metadata about conversation labels.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata": { + "description": "Metadata about the issue dimension.", + "type": "object", + "properties": { + "issueId": { + "description": "The issue ID.", + "type": "string" + }, + "issueDisplayName": { + "description": "The issue display name.", + "type": "string" + }, + "issueModelId": { + "description": "The parent issue model ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata": { + "description": "Metadata about the agent dimension.", + "type": "object", + "properties": { + "agentId": { + "description": "Optional. A user-specified string representing the agent.\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentDisplayName": { + "description": "Optional. The agent's name\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentTeam": { + "description": "Optional. A user-specified string representing the agent's team.", + "type": "string" + }, + "agentVersionDisplayName": { + "description": "Optional. The agent's version display name. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentVersionId": { + "description": "Optional. The agent's version ID. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentDeploymentDisplayName": { + "description": "Optional. The agent's deployment display name. Only applicable to automated agents.\nThis will be populated for AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + }, + "agentDeploymentId": { + "description": "Optional. The agent's deployment ID. Only applicable to automated agents.\nThis will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata": { + "description": "Metadata about the QA question dimension.", + "type": "object", + "properties": { + "qaScorecardId": { + "description": "Optional. The QA scorecard ID.", + "type": "string" + }, + "qaQuestionId": { + "description": "Optional. The QA question ID.", + "type": "string" + }, + "questionBody": { + "description": "Optional. The full body of the question.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata": { + "description": "Metadata about the QA question-answer dimension.\nThis is useful for showing the answer distribution for questions for a\ngiven scorecard.", + "type": "object", + "properties": { + "qaScorecardId": { + "description": "Optional. The QA scorecard ID.", + "type": "string" + }, + "qaQuestionId": { + "description": "Optional. The QA question ID.", + "type": "string" + }, + "questionBody": { + "description": "Optional. The full body of the question.", + "type": "string" + }, + "answerValue": { + "description": "Optional. The full body of the question.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata": { + "description": "Metadata about the QA scorecard dimension.", + "type": "object", + "properties": { + "qaScorecardId": { + "description": "Optional. The QA scorecard ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata": { + "description": "Metadata about the conversation profile dimension.", + "type": "object", + "properties": { + "conversationProfileId": { + "description": "Optional. The conversation profile ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata": { + "description": "Metadata about the conversation medium dimension.", + "type": "object", + "properties": { + "medium": { + "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata": { + "description": "Metadata about the Conversational Agents playbook dimension.", + "type": "object", + "properties": { + "playbookId": { + "description": "Optional. The dialogflow playbook ID.", + "type": "string" + }, + "playbookDisplayName": { + "description": "Optional. The dialogflow playbook display name.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata": { + "description": "Metadata about the Conversational Agents tool dimension.", + "type": "object", + "properties": { + "toolId": { + "description": "Optional. The dialogflow tool ID.", + "type": "string" + }, + "toolDisplayName": { + "description": "Optional. The dialogflow tool display name.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata": { + "description": "Metadata about the client sentiment category dimension.", + "type": "object", + "properties": { + "sentimentCategory": { + "description": "Optional. The client sentiment category.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionAgentAssistSupervisorDimensionMetadata": { + "description": "Metadata about AA's human supervisor dimension.", + "type": "object", + "properties": { + "supervisorId": { + "description": "Optional. ID of the assigned supervisor.", + "type": "string" + }, + "supervisorUsername": { + "description": "Optional. User name of the assigned supervisor.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata": { + "description": "Metadata about conversation labels.", + "type": "object", + "properties": { + "labelKey": { + "description": "Optional. The label key.", + "type": "string" + }, + "labelValue": { + "description": "Optional. The label value.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint": { + "description": "A data point contains the metric values mapped to an interval.", + "type": "object", + "properties": { + "interval": { + "description": "The interval that this data point represents.\n\n* If this is the total data point, the interval is\n[starting create time, ending create time) from the request.\n* If this a data point from the time series, the interval is\n[time, time + time granularity from the request).", + "allOf": [{ + "$ref": "#/components/schemas/GoogleTypeInterval" + }] + }, + "conversationMeasure": { + "description": "The measure related to conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure" + }] + }, + "dialogflowInteractionMeasure": { + "description": "The measure related to dialogflow interactions.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure": { + "description": "The measure related to conversations.", + "type": "object", + "properties": { + "conversationCount": { + "description": "The conversation count.", + "type": "integer", + "format": "int32" + }, + "averageSilencePercentage": { + "description": "The average silence percentage.", + "type": "number", + "format": "float" + }, + "averageDuration": { + "description": "The average duration.", + "type": "string", + "format": "google-duration" + }, + "averageTurnCount": { + "description": "The average turn count.", + "type": "number", + "format": "float" + }, + "averageAgentSentimentScore": { + "description": "The average agent's sentiment score.", + "type": "number", + "format": "float" + }, + "averageClientSentimentScore": { + "description": "The average client's sentiment score.", + "type": "number", + "format": "float" + }, + "averageCustomerSatisfactionRating": { + "description": "The average customer satisfaction rating.", + "type": "number", + "format": "double" + }, + "averageQaNormalizedScore": { + "description": "The average normalized QA score for a scorecard. When computing the\naverage across a set of conversations, if a conversation has been\nevaluated with multiple revisions of a scorecard, only the latest\nrevision results will be used. Will exclude 0's in average\ncalculation. Will be only populated if the request specifies a\ndimension of QA_SCORECARD_ID.", + "type": "number", + "format": "double" + }, + "qaTagScores": { + "description": "Average QA normalized score for all the tags.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" + } + }, + "averageQaQuestionNormalizedScore": { + "description": "Average QA normalized score averaged for questions averaged across\nall revisions of the parent scorecard.\nWill be only populated if the request specifies a dimension of\nQA_QUESTION_ID.", + "type": "number", + "format": "double" + }, + "knowledgeSearchResultCount": { + "description": "Count of knowledge search results (Generative Knowledge\nAssist) shown to the user.", + "type": "integer", + "format": "int32" + }, + "knowledgeSearchAgentQuerySourceRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nmade by the agent compared to the total number of knowledge search\nqueries made.", + "type": "number", + "format": "double" + }, + "knowledgeSearchSuggestedQuerySourceRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nsuggested compared to the total number of knowledge search\nqueries made.", + "type": "number", + "format": "double" + }, + "knowledgeAssistResultCount": { + "description": "Count of knowledge assist results (Proactive Generative Knowledge\nAssist) shown to the user.", + "type": "integer", + "format": "int32" + }, + "knowledgeSearchUriClickRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had a URL clicked.", + "type": "number", + "format": "double" + }, + "knowledgeAssistUriClickRatio": { + "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had a URL clicked.", + "type": "number", + "format": "double" + }, + "knowledgeSearchPositiveFeedbackRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had positive feedback.", + "type": "number", + "format": "double" + }, + "knowledgeSearchNegativeFeedbackRatio": { + "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had negative feedback.", + "type": "number", + "format": "double" + }, + "knowledgeAssistPositiveFeedbackRatio": { + "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had positive feedback.", + "type": "number", + "format": "double" + }, + "knowledgeAssistNegativeFeedbackRatio": { + "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had negative feedback.", + "type": "number", + "format": "double" + }, + "summarizationSuggestionEditRatio": { + "description": "Proportion of summarization suggestions that were manually edited.", + "type": "number", + "format": "double" + }, + "averageSummarizationSuggestionEditDistance": { + "description": "Average edit distance of the summarization suggestions. Edit\ndistance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion.", + "type": "number", + "format": "double" + }, + "averageSummarizationSuggestionNormalizedEditDistance": { + "description": "Normalized Average edit distance of the summarization suggestions.\nEdit distance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion. Normalized edit distance is the average of (edit distance\n/ summary length).", + "type": "number", + "format": "double" + }, + "conversationSuggestedSummaryRatio": { + "description": "Proportion of conversations that had a suggested summary.", + "type": "number", + "format": "double" + }, + "summarizationSuggestionResultCount": { + "description": "Count of summarization suggestions results.", + "type": "integer", + "format": "int32" + }, + "dialogflowInteractionsNoMatchRatio": { + "description": "Proportion of dialogflow interactions that has no intent match for\nthe input.", + "type": "number", + "format": "double" + }, + "dialogflowInteractionsNoInputRatio": { + "description": "Proportion of dialogflow interactions that has empty input.", + "type": "number", + "format": "double" + }, + "dialogflowWebhookFailureRatio": { + "description": "Proportion of dialogflow webhook calls that failed.", + "type": "number", + "format": "double" + }, + "dialogflowWebhookTimeoutRatio": { + "description": "Proportion of dialogflow webhook calls that timed out.", + "type": "number", + "format": "double" + }, + "dialogflowAverageWebhookLatency": { + "description": "Average latency of dialogflow webhook calls.", + "type": "number", + "format": "double" + }, + "dialogflowConversationsEscalationRatio": { + "description": "Proportion of conversations that was handed off from virtual agent to\nhuman agent.", + "type": "number", + "format": "double" + }, + "dialogflowConversationsEscalationCount": { + "description": "count of conversations that was handed off from virtual agent to\nhuman agent.", + "type": "number", + "format": "double" + }, + "conversationalAgentsToolCallSuccessRatio": { + "description": "Proportion of conversational agents' tool calls that were successful.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageToolCallLatency": { + "description": "Average latency of conversational agents' tool calls.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageTtsLatency": { + "description": "The macro average latency of conversational agents' TTS latency\nper interaction.\nThis is computed as the average of the all the interactions' TTS\nlatencies in a conversation and averaged across conversations.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageLlmCallLatency": { + "description": "The average latency of conversational agents' LLM call latency\nper interaction. This is computed as the average of the all the\ninteractions LLM call latencies in a conversation and averaged across\nconversations.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageAudioInAudioOutLatency": { + "description": "The average latency of conversational agents' audio in audio\nout latency per interaction.\nThis is computed as the average of the all the interactions' audio in\naudio out latencies in a conversation and averaged across\nconversations.", + "type": "number", + "format": "double" + }, + "conversationAiCoachSuggestionRatio": { + "description": "Proportion of conversations that has Ai Coach Suggestions.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionAgentUsageRatio": { + "description": "Proportion of Ai Coach Suggestion that has been used by agents.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionCustomerMessageTriggerRatio": { + "description": "Proportion of customer messages that triggered an Ai Coach\nSuggestion.", + "type": "number", + "format": "double" + }, + "conversationalAgentsAverageEndToEndLatency": { + "description": "The average latency of conversational agents' latency per\ninteraction. This is computed as the average of the all the\niteractions' end to end latencies in a conversation and averaged\nacross conversations. The e2e latency is the time between the end of\nthe user utterance and the start of the agent utterance on the\ninteraction level.", + "type": "number", + "format": "double" + }, + "conversationAiCoachSuggestionCount": { + "description": "Count of conversations that has Ai Coach Suggestions.", + "type": "integer", + "format": "int32" + }, + "aiCoachSuggestionAgentUsageCount": { + "description": "Count of Ai Coach Suggestion that has been used by agents.", + "type": "integer", + "format": "int32" + }, + "aiCoachSuggestionCustomerMessageTriggerCount": { + "description": "Count of customer messages that triggered an Ai Coach\nSuggestion.", + "type": "integer", + "format": "int32" + }, + "aiCoachSuggestionAgentMessageTriggerCount": { + "description": "Count of agent messages that triggered an Ai Coach Suggestion.", + "type": "integer", + "format": "int32" + }, + "conversationTotalCustomerMessageCount": { + "description": "The customer message count.", + "type": "integer", + "format": "int32" + }, + "conversationTotalAgentMessageCount": { + "description": "The agent message count.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorMonitoredConversationsCount": { + "description": "The number of conversations scanned by the AA human supervisor.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorEscalatedConversationsCount": { + "description": "The number of conversations that were escalated to an AA human\nsupervisor for intervention.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorAssignedConversationsCount": { + "description": "The number of conversations that were assigned to an AA human\nsupervisor.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorDroppedConversationsCount": { + "description": "The number of conversations that were dropped, i.e. escalated but not\nassigned to an AA human supervisor.", + "type": "integer", + "format": "int32" + }, + "aaSupervisorTransferredToHumanAgentConvCount": { + "description": "The number of conversations transferred to a human agent.", + "type": "integer", + "format": "int32" + }, + "avgConversationClientTurnSentimentEma": { + "description": "The exponential moving average of the sentiment score of client turns\nin the conversation.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionMessageTriggerRatio": { + "description": "Proportion of end_of_utterance trigger event messages that triggered\nan Ai Coach Suggestion.", + "type": "number", + "format": "double" + }, + "aiCoachSuggestionMessageTriggerCount": { + "description": "Count of end_of_utterance trigger event messages that triggered an Ai\nCoach Suggestion.", + "type": "integer", + "format": "int32" + }, + "containedConversationCount": { + "description": "The number of conversations that were contained.", + "type": "integer", + "format": "int32" + }, + "containedConversationRatio": { + "description": "The percentage of conversations that were contained.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { + "description": "Average QA normalized score for the tag.", + "type": "object", + "properties": { + "tag": { + "description": "Tag name.", + "type": "string" + }, + "averageTagNormalizedScore": { + "description": "Average tag normalized score per tag.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { + "description": "The measure related to dialogflow interactions.", + "type": "object", + "properties": { + "percentileAudioInAudioOutLatency": { + "description": "The percentile result for audio in audio out latency in milliseconds\nper dialogflow interaction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileLlmCallLatency": { + "description": "The percentile result for LLM latency in milliseconds per dialogflow\ninteraction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileTtsLatency": { + "description": "The percentile result for TTS latency in milliseconds per dialogflow\ninteraction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileToolUseLatency": { + "description": "The percentile result for tool use latency in milliseconds per\ndialogflow interaction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" + }] + }, + "percentileEndToEndLatency": { + "description": "The percentile result for end to end chat latency in milliseconds per\ndialogflow interaction level.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult": { + "description": "The percentile result. Currently supported percentiles are 50th, 90th,\nand 99th.", + "type": "object", + "properties": { + "p50": { + "description": "The 50th percentile value.", + "type": "number", + "format": "double" + }, + "p90": { + "description": "The 90th percentile value.", + "type": "number", + "format": "double" + }, + "p99": { + "description": "The 99th percentile value.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries": { + "description": "A time series of metric values.", + "type": "object", + "properties": { + "dataPoints": { + "description": "The data points that make up the time series .", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata": { + "description": "The metadata for querying performance overview.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse": { + "description": "The response for querying performance overview.", + "type": "object", + "properties": { + "summaryText": { + "description": "The summary text of the performance.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata": { + "description": "The metadata for an SampleConversations operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request for sample conversations to dataset.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest" + }] + }, + "partialErrors": { + "description": "Output only. Partial errors during sample conversations operation that might\ncause the operation output to be incomplete.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "sampleConversationsStats": { + "description": "Output only. Statistics for SampleConversations operation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest": { + "description": "The request to sample conversations to a dataset.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the dataset.", + "type": "string" + }, + "sampleRule": { + "description": "Optional. The sample rule used for sampling conversations.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSampleRule" + }] + }, + "destinationDataset": { + "description": "The dataset resource to copy the sampled conversations to.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDataset" + }] + } + }, + "required": [ + "parent" + ] + }, + "GoogleCloudContactcenterinsightsV1mainSampleRule": { + "description": "Message for sampling conversations.", + "type": "object", + "properties": { + "samplePercentage": { + "description": "Percentage of conversations that we should sample based on the dimension\nbetween [0, 100].", + "type": "number", + "format": "double" + }, + "sampleRow": { + "description": "Number of the conversations that we should sample based on the dimension.", + "type": "string", + "format": "int64" + }, + "dimension": { + "description": "Optional. Group by dimension to sample the conversation. If no dimension is\nprovided, the sampling will be applied to the project level.\nCurrent supported dimensions is 'quality_metadata.agent_info.agent_id'.", + "type": "string" + }, + "conversationFilter": { + "description": "To specify the filter for the conversions that should apply this sample\nrule. An empty filter means this sample rule applies to all conversations.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDataset": { + "description": "Dataset resource represents a collection of conversations\nthat may be bounded (Static Dataset, e.g. golden dataset for training),\nor unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", + "type": "object", + "properties": { + "name": { + "description": "Immutable. Identifier. Resource name of the dataset.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}", + "x-google-immutable": true, + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "Display name for the dataaset", + "type": "string" + }, + "description": { + "description": "Dataset description.", + "type": "string" + }, + "type": { + "description": "Dataset usage type.", + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "For evals only.", + "Dataset with new conversations coming in regularly (Insights legacy\nconversations and AI trainer)" + ], + "enum": [ + "TYPE_UNSPECIFIED", + "EVAL", + "LIVE" + ] + }, + "ttl": { + "description": "Optional. Option TTL for the dataset.", + "type": "string", + "format": "google-duration" + }, + "createTime": { + "description": "Output only. Dataset create time.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. Dataset update time.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats": { + "description": "Statistics for SampleConversations operation.", + "type": "object", + "properties": { + "successfulSampleCount": { + "description": "Output only. The number of new conversations added during this sample operation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "failedSampleCount": { + "description": "Output only. The number of objects which were unable to be sampled due to errors.\nThe errors are populated in the partial_errors field.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse": { + "description": "The response to an SampleConversations operation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata": { + "description": "Metadata for testing correlation config.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "dataset": { + "description": "The dataset used for sampling conversations.", + "type": "string" + }, + "stats": { + "description": "The statistics for the operation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats": { + "description": "Statistics for TestCorrelationConfig operation.", + "type": "object", + "properties": { + "sampledConversationsCount": { + "description": "The number of conversations sampled.", + "type": "integer", + "format": "int32" + }, + "correlatedConversationsCount": { + "description": "The number of conversations correlated.", + "type": "integer", + "format": "int32" + }, + "failedConversationsCount": { + "description": "The number of conversations that failed correlation.", + "type": "integer", + "format": "int32" + }, + "partialErrors": { + "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + }, + "conversationCorrelationErrors": { + "description": "A list of errors that occurred during correlation, one for each\nconversation that failed.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { + "description": "An error that occurred during correlation for a specific conversation.", + "type": "object", + "properties": { + "conversation": { + "description": "The conversation resource name that had an error during correlation.", + "type": "string" + }, + "status": { + "description": "The error status.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleRpcStatus" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse": { + "description": "The response of testing correlation config.", + "type": "object", + "properties": { + "detailedResults": { + "description": "Results for the DETAILED_SYNC execution mode.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults" + }] + }, + "partialErrors": { + "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleRpcStatus" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults": { + "description": "Wrapper for detailed, step-by-step results.", + "type": "object", + "properties": { + "joinKeyResults": { + "description": "A list of join key correlation results for each conversation tested.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult" + } + }, + "constraintResults": { + "description": "A list of constraint evaluation results for each pair of conversations.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult": { + "description": "The result of testing correlation config on a single conversation.", + "type": "object", + "properties": { + "conversation": { + "description": "The conversation resource name.", + "type": "string" + }, + "ruleResults": { + "description": "The results for each correlation rule.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult": { + "description": "The result of a single correlation rule.", + "type": "object", + "properties": { + "ruleId": { + "description": "The rule ID.", + "type": "string" + }, + "correlationId": { + "description": "The correlation ID generated by the join key expression.", + "type": "string" + }, + "error": { + "description": "The error status if the join key expression failed to evaluate.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleRpcStatus" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult": { + "description": "The result of testing a constraint expression on a pair of conversations.", + "type": "object", + "properties": { + "conversationA": { + "description": "The first conversation resource name.", + "type": "string" + }, + "conversationB": { + "description": "The second conversation resource name.", + "type": "string" + }, + "ruleConstraintResults": { + "description": "The results for each applicable constraint rule.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult": { + "description": "The result of a single constraint rule on the pair of conversations.", + "type": "object", + "properties": { + "ruleId": { + "description": "The rule ID.", + "type": "string" + }, + "constraintMet": { + "description": "Whether the constraint expression evaluated to true for (A, B) or (B,\nA).", + "type": "boolean" + }, + "error": { + "description": "The error status if the constraint expression failed to evaluate.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleRpcStatus" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata": { + "description": "Metadata for undeploying an issue model.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "The original request for undeployment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest": { + "description": "The request to undeploy an issue model.", + "type": "object", + "properties": { + "name": { + "description": "Required. The issue model to undeploy.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse": { + "description": "The response to undeploy an issue model.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata": { + "description": "The metadata for updating a QaQuestionTag Resource.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest": { + "description": "The request for updating a QaQuestionTag.", + "type": "object", + "properties": { + "qaQuestionTag": { + "description": "Required. The QaQuestionTag to update.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionTag" + }] + }, + "updateMask": { + "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `qa_question_tag_name` - the name of the tag\n* `qa_question_ids` - the list of questions the tag applies to", + "type": "string", + "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", + "format": "google-fieldmask" + } + }, + "required": [ + "qaQuestionTag" + ] + }, + "GoogleCloudContactcenterinsightsV1mainQaQuestionTag": { + "description": "A tag is a resource which aims to categorize a set of questions across\nmultiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. Resource name for the QaQuestionTag\nFormat\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}\nIn the above format, the last segment, i.e., qa_question_tag, is a\nserver-generated ID corresponding to the tag resource.", + "x-google-identifier": true, + "type": "string" + }, + "displayName": { + "description": "Required. A user-specified display name for the tag.", + "type": "string" + }, + "qaQuestionIds": { + "description": "Optional. The list of Scorecard Question IDs that the tag applies to.\nEach QaQuestionId is represented as a full resource name containing the\nQuestion ID. Lastly, Since a tag may not necessarily be referenced by any\nScorecard Questions, we treat this field as optional.", + "type": "array", + "items": { + "type": "string" + } + }, + "createTime": { + "description": "Output only. The time at which the question tag was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the question tag was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + } + }, + "required": [ + "displayName" + ] + }, + "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata": { + "description": "The metadata for an `UploadConversation` operation.", + "type": "object", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "request": { + "description": "Output only. The original request.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainUploadConversationRequest" + }] + }, + "analysisOperation": { + "description": "Output only. The operation name for a successfully created analysis operation, if any.", + "readOnly": true, + "type": "string" + }, + "appliedRedactionConfig": { + "description": "Output only. The redaction config applied to the uploaded conversation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainRedactionConfig" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest": { + "description": "Request to upload a conversation.", + "type": "object", + "properties": { + "parent": { + "description": "Required. The parent resource of the conversation.", + "type": "string" + }, + "conversation": { + "description": "Required. The conversation resource to create.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversation" + }] + }, + "conversationId": { + "description": "Optional. A unique ID for the new conversation. This ID will become the final\ncomponent of the conversation's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", + "type": "string" + }, + "redactionConfig": { + "description": "Optional. DLP settings for transcript redaction. Will default to the config specified\nin Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainRedactionConfig" + }] + }, + "speechConfig": { + "description": "Optional. Speech-to-Text configuration. Will default to the config specified\nin Settings.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSpeechConfig" + }] + } + }, + "required": [ + "parent", + "conversation" + ] + }, + "GoogleCloudContactcenterinsightsV1mainConversation": { + "description": "The conversation resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the conversation.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}", + "x-google-immutable": true, + "type": "string" + }, + "dataSource": { + "description": "The source of the audio and transcription for the conversation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationDataSource" + }] + }, + "createTime": { + "description": "Output only. The time at which the conversation was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "updateTime": { + "description": "Output only. The most recent time at which the conversation was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "startTime": { + "description": "The time at which the conversation started.", + "type": "string", + "format": "date-time" + }, + "languageCode": { + "description": "A user-specified language code for the conversation.", + "type": "string" + }, + "agentId": { + "description": "An opaque, user-specified string representing the human agent who handled\nthe conversation.", + "type": "string" + }, + "customerId": { + "description": "An opaque, user-specified string representing the customer identifier.", + "type": "string" + }, + "labels": { + "description": "A map for the user to specify any custom fields. A maximum of 100 labels\nper conversation is allowed, with a maximum of 256 characters per entry.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "callMetadata": { + "description": "Call-specific metadata.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationCallMetadata" + }] + }, + "qualityMetadata": { + "description": "Conversation metadata related to quality management.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata" + }] + }, + "metadataJson": { + "description": "Input only. JSON metadata encoded as a string.\nThis field is primarily used by Insights integrations with various\ntelephony systems and must be in one of Insight's supported formats.", + "writeOnly": true, + "type": "string" + }, + "transcript": { + "description": "Output only. The conversation transcript.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationTranscript" + }] + }, + "medium": { + "description": "Immutable. The conversation medium.", + "x-google-immutable": true, + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "The format for conversations that took place over the phone.", + "The format for conversations that took place over chat." + ], + "enum": [ + "MEDIUM_UNSPECIFIED", + "PHONE_CALL", + "CHAT" + ] + }, + "duration": { + "description": "Output only. The duration of the conversation.", + "readOnly": true, + "type": "string", + "format": "google-duration" + }, + "turnCount": { + "description": "Output only. The number of turns in the conversation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "latestAnalysis": { + "description": "Output only. The conversation's latest analysis, if one exists.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnalysis" + }] + }, + "latestSummary": { + "description": "Output only. Latest summary of the conversation.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" + }] + }, + "runtimeAnnotations": { + "description": "Output only. The annotations that were generated during the customer and agent\ninteraction.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation" + } + }, + "expireTime": { + "description": "The time at which this conversation should expire. After this time, the\nconversation data and any associated analyses will be deleted.", + "type": "string", + "format": "date-time" + }, + "ttl": { + "description": "Input only. The TTL for this resource. If specified, then this TTL will\nbe used to calculate the expire time.", + "writeOnly": true, + "type": "string", + "format": "google-duration" + }, + "dialogflowIntents": { + "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a\nDialogflow intent, format:\nprojects/{project}/agent/{agent}/intents/{intent}", + "readOnly": true, + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowIntent" + } + }, + "obfuscatedUserId": { + "description": "Obfuscated user ID which the customer sent to us.", + "type": "string" + }, + "dialogflowCxConversationData": { + "description": "The Dialogflow conversation raw data. It will only be populated when\nConversationView is DF_CONVERSATION_BASIC or DF_CONVERSATION_FULL.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationData" + }] + }, + "aaSupervisorMonitoringStatus": { + "description": "Output only. Data from the monitoring status of a conversation by a human supervisor in\nAA. A human supervisor is a human agent that is monitoring virtual agent\nconversations.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationAgentAssistSupervisorMonitoringStatus" + }] + }, + "correlationInfo": { + "description": "Output only. Info for correlating across conversations.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationDataSource": { + "description": "The conversation source, which is a combination of transcript and audio.", + "type": "object", + "properties": { + "gcsSource": { + "description": "A Cloud Storage location specification for the audio and transcript.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGcsSource" + }] + }, + "dialogflowSource": { + "description": "The source when the conversation comes from Dialogflow.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowSource" + }] + }, + "metadataUri": { + "description": "Cloud Storage URI that points to a file that contains the conversation\nmetadata.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainGcsSource": { + "description": "A Cloud Storage source of conversation data.", + "type": "object", + "properties": { + "audioUri": { + "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", + "type": "string" + }, + "transcriptUri": { + "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation\ntranscript.", + "x-google-immutable": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDialogflowSource": { + "description": "A Dialogflow source of conversation data.", + "type": "object", + "properties": { + "dialogflowConversation": { + "description": "Output only. The name of the Dialogflow conversation that this conversation\nresource is derived from. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}", + "readOnly": true, + "type": "string" + }, + "audioUri": { + "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata": { + "description": "Call-specific metadata.", + "type": "object", + "properties": { + "customerChannel": { + "description": "The audio channel that contains the customer.", + "type": "integer", + "format": "int32" + }, + "agentChannel": { + "description": "The audio channel that contains the agent.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata": { + "description": "Conversation metadata related to quality management.", + "type": "object", + "properties": { + "customerSatisfactionRating": { + "description": "An arbitrary integer value indicating the customer's satisfaction rating.", + "type": "integer", + "format": "int32" + }, + "waitDuration": { + "description": "The amount of time the customer waited to connect with an agent.", + "type": "string", + "format": "google-duration" + }, + "menuPath": { + "description": "An arbitrary string value specifying the menu path the customer took.", + "type": "string" + }, + "agentInfo": { + "description": "Information about agents involved in the call.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo" + } + }, + "feedbackLabels": { + "description": "Input only. The feedback labels associated with the conversation.", + "writeOnly": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFeedbackLabel" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo": { + "description": "Information about an agent involved in the conversation.", + "type": "object", + "properties": { + "agentId": { + "description": "A user-specified string representing the agent.", + "type": "string" + }, + "displayName": { + "description": "The agent's name.", + "type": "string" + }, + "team": { + "description": "A user-specified string representing the agent's team. Deprecated in\nfavor of the `teams` field.", + "deprecated": true, + "type": "string" + }, + "teams": { + "description": "User-specified strings representing the agent's teams.", + "type": "array", + "items": { + "type": "string" + } + }, + "dispositionCode": { + "description": "A user-provided string indicating the outcome of the agent's segment of\nthe call.", + "type": "string" + }, + "agentType": { + "description": "The agent type, e.g. HUMAN_AGENT.", + "type": "string", + "x-google-enum-descriptions": [ + "Participant's role is not set.", + "Participant is a human agent.", + "Participant is an automated agent.", + "Participant is an end user who conversed with the contact center.", + "Participant is either a human or automated agent." + ], + "enum": [ + "ROLE_UNSPECIFIED", + "HUMAN_AGENT", + "AUTOMATED_AGENT", + "END_USER", + "ANY_AGENT" + ] + }, + "location": { + "description": "The agent's location.", + "type": "string" + }, + "deploymentId": { + "description": "The agent's deployment ID. Only applicable to automated agents.", + "type": "string" + }, + "deploymentDisplayName": { + "description": "The agent's deployment display name. Only applicable to automated\nagents.", + "type": "string" + }, + "versionId": { + "description": "The agent's version ID. Only applicable to automated agents.", + "type": "string" + }, + "versionDisplayName": { + "description": "The agent's version display name. Only applicable to automated agents.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationTranscript": { + "description": "A message representing the transcript of a conversation.", + "type": "object", + "properties": { + "transcriptSegments": { + "description": "A list of sequential transcript segments that comprise the conversation.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment": { + "description": "A segment of a full transcript.", + "type": "object", + "properties": { + "messageTime": { + "description": "The time that the message occurred, if provided.", + "type": "string", + "format": "date-time" + }, + "text": { + "description": "The text of this segment.", + "type": "string" + }, + "confidence": { + "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nsegment. A default value of 0.0 indicates that the value is unset.", + "type": "number", + "format": "float" + }, + "words": { + "description": "A list of the word-specific information for each word in the segment.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo" + } + }, + "languageCode": { + "description": "The language code of this segment as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".", + "type": "string" + }, + "channelTag": { + "description": "For conversations derived from multi-channel audio, this is the channel\nnumber corresponding to the audio from that channel. For\naudioChannelCount = N, its output values can range from '1' to 'N'. A\nchannel tag of 0 indicates that the audio is mono.", + "type": "integer", + "format": "int32" + }, + "segmentParticipant": { + "description": "The participant of this segment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationParticipant" + }] + }, + "dialogflowSegmentMetadata": { + "description": "CCAI metadata relating to the current transcript segment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" + }] + }, + "sentiment": { + "description": "The sentiment for this transcript segment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo": { + "description": "Word-level info for words in a transcript.", + "type": "object", + "properties": { + "startOffset": { + "description": "Time offset of the start of this word relative to the beginning of\nthe total conversation.", + "type": "string", + "format": "google-duration" + }, + "endOffset": { + "description": "Time offset of the end of this word relative to the beginning of the\ntotal conversation.", + "type": "string", + "format": "google-duration" + }, + "word": { + "description": "The word itself. Includes punctuation marks that surround the word.", + "type": "string" + }, + "confidence": { + "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nword. A default value of 0.0 indicates that the value is unset.", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationParticipant": { + "description": "The call participant speaking for a given utterance.", + "type": "object", + "properties": { + "dialogflowParticipant": { + "description": "Deprecated. Use `dialogflow_participant_name` instead.\nThe name of the Dialogflow participant. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", + "deprecated": true, + "type": "string" + }, + "dialogflowParticipantName": { + "description": "The name of the participant provided by Dialogflow. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", + "type": "string" + }, + "userId": { + "description": "A user-specified ID representing the participant.", + "type": "string" + }, + "obfuscatedExternalUserId": { + "description": "Obfuscated user ID from Dialogflow.", + "type": "string" + }, + "role": { + "description": "The role of the participant.", + "type": "string", + "x-google-enum-descriptions": [ + "Participant's role is not set.", + "Participant is a human agent.", + "Participant is an automated agent.", + "Participant is an end user who conversed with the contact center.", + "Participant is either a human or automated agent." + ], + "enum": [ + "ROLE_UNSPECIFIED", + "HUMAN_AGENT", + "AUTOMATED_AGENT", + "END_USER", + "ANY_AGENT" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { + "description": "Metadata from Dialogflow relating to the current transcript segment.", + "type": "object", + "properties": { + "smartReplyAllowlistCovered": { + "description": "Whether the transcript segment was covered under the configured smart\nreply allowlist in Agent Assist.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainSentimentData": { + "description": "The data for a sentiment annotation.", + "type": "object", + "properties": { + "magnitude": { + "description": "A non-negative number from 0 to infinity which represents the absolute\nmagnitude of sentiment regardless of score.", + "type": "number", + "format": "float" + }, + "score": { + "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", + "type": "number", + "format": "float" + }, + "rationale": { + "description": "The rationale for the sentiment result.", + "type": "string" + }, + "modelType": { + "description": "The sentiment model used to produce the sentiment result.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified model type.", + "V1 model.", + "V2 LLM model." + ], + "enum": [ + "SENTIMENT_MODEL_TYPE_UNSPECIFIED", + "SENTIMENT_MODEL_TYPE_V1", + "SENTIMENT_MODEL_TYPE_V2" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainAnalysis": { + "description": "The analysis resource.", + "type": "object", + "properties": { + "name": { + "description": "Immutable. The resource name of the analysis.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", + "x-google-immutable": true, + "type": "string" + }, + "requestTime": { + "description": "Output only. The time at which the analysis was requested.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "createTime": { + "description": "Output only. The time at which the analysis was created, which occurs when the\nlong-running operation completes.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "analysisResult": { + "description": "Output only. The result of the analysis, which is populated when the analysis\nfinishes.", + "readOnly": true, + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnalysisResult" + }] + }, + "annotatorSelector": { + "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainAnalysisResult": { + "description": "The result of an analysis.", + "type": "object", + "properties": { + "endTime": { + "description": "The time at which the analysis ended.", + "type": "string", + "format": "date-time" + }, + "callAnalysisMetadata": { + "description": "Call-specific metadata created by the analysis.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata": { + "description": "Call-specific metadata created during analysis.", + "type": "object", + "properties": { + "annotations": { + "description": "A list of call annotations that apply to this call.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainCallAnnotation" + } + }, + "entities": { + "description": "All the entities in the call.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainEntity" + } + }, + "sentiments": { + "description": "Overall conversation-level sentiment for each channel of the call.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment" + } + }, + "silence": { + "description": "Overall conversation-level silence during the call.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationLevelSilence" + }] + }, + "intents": { + "description": "All the matched intents in the call.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIntent" + } + }, + "phraseMatchers": { + "description": "All the matched phrase matchers in the call.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainPhraseMatchData" + } + }, + "issueModelResult": { + "description": "Overall conversation-level issue modeling result.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelResult" + }] + }, + "semanticMatchMetadata": { + "description": "Metadata used in the semantic match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSemanticMatchMetadata" + }] + }, + "qaScorecardResults": { + "description": "Results of scoring QaScorecards.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaScorecardResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainCallAnnotation": { + "description": "A piece of metadata that applies to a window of a call.", + "type": "object", + "properties": { + "channelTag": { + "description": "The channel of the audio where the annotation occurs. For single-channel\naudio, this field is not populated.", + "type": "integer", + "format": "int32" + }, + "annotationStartBoundary": { + "description": "The boundary in the conversation where the annotation starts, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" + }] + }, + "annotationEndBoundary": { + "description": "The boundary in the conversation where the annotation ends, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" + }] + }, + "interruptionData": { + "description": "Data specifying an interruption.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainInterruptionData" + }] + }, + "sentimentData": { + "description": "Data specifying sentiment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSentimentData" + }] + }, + "silenceData": { + "description": "Data specifying silence.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSilenceData" + }] + }, + "holdData": { + "description": "Data specifying a hold.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainHoldData" + }] + }, + "entityMentionData": { + "description": "Data specifying an entity mention.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainEntityMentionData" + }] + }, + "intentMatchData": { + "description": "Data specifying an intent match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIntentMatchData" + }] + }, + "phraseMatchData": { + "description": "Data specifying a phrase match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainPhraseMatchData" + }] + }, + "issueMatchData": { + "description": "Data specifying an issue match.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueMatchData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary": { + "description": "A point in a conversation that marks the start or the end of an annotation.", + "type": "object", + "properties": { + "transcriptIndex": { + "description": "The index in the sequence of transcribed pieces of the conversation where\nthe boundary is located. This index starts at zero.", + "type": "integer", + "format": "int32" + }, + "wordIndex": { + "description": "The word index of this boundary with respect to the first word in the\ntranscript piece. This index starts at zero.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainInterruptionData": { + "description": "The data for an interruption annotation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainSilenceData": { + "description": "The data for a silence annotation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainHoldData": { + "description": "The data for a hold annotation.", + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainEntityMentionData": { + "description": "The data for an entity mention annotation.\nThis represents a mention of an `Entity` in the conversation.", + "type": "object", + "properties": { + "entityUniqueId": { + "description": "The key of this entity in conversation entities.\nCan be used to retrieve the exact `Entity` this mention is attached to.", + "type": "string" + }, + "type": { + "description": "The type of the entity mention.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Proper noun.", + "Common noun (or noun compound)." + ], + "enum": [ + "MENTION_TYPE_UNSPECIFIED", + "PROPER", + "COMMON" + ] + }, + "sentiment": { + "description": "Sentiment expressed for this mention of the entity.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIntentMatchData": { + "description": "The data for an intent match.\nRepresents an intent match for a text segment in the conversation. A text\nsegment can be part of a sentence, a complete sentence, or an utterance\nwith multiple sentences.", + "type": "object", + "properties": { + "intentUniqueId": { + "description": "The id of the matched intent.\nCan be used to retrieve the corresponding intent information.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainPhraseMatchData": { + "description": "The data for a matched phrase matcher.\nRepresents information identifying a phrase matcher for a given match.", + "type": "object", + "properties": { + "phraseMatcher": { + "description": "The unique identifier (the resource name) of the phrase matcher.", + "type": "string" + }, + "displayName": { + "description": "The human-readable name of the phrase matcher.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIssueMatchData": { + "description": "The data for an issue match annotation.", + "type": "object", + "properties": { + "issueAssignment": { + "description": "Information about the issue's assignment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueAssignment" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIssueAssignment": { + "description": "Information about the issue.", + "type": "object", + "properties": { + "issue": { + "description": "Resource name of the assigned issue.", + "type": "string" + }, + "score": { + "description": "Score indicating the likelihood of the issue assignment.\ncurrently bounded on [0,1].", + "type": "number", + "format": "double" + }, + "displayName": { + "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis\nand immutable since then.", + "x-google-immutable": true, + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainEntity": { + "description": "The data for an entity annotation.\nRepresents a phrase in the conversation that is a known entity, such\nas a person, an organization, or location.", + "type": "object", + "properties": { + "displayName": { + "description": "The representative name for the entity.", + "type": "string" + }, + "type": { + "description": "The entity type.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified.", + "Person.", + "Location.", + "Organization.", + "Event.", + "Artwork.", + "Consumer product.", + "Other types of entities.", + "Phone number.\n\nThe metadata lists the phone number (formatted according to local\nconvention), plus whichever additional elements appear in the text:\n\n* `number` - The actual number, broken down into sections according to\nlocal convention.\n* `national_prefix` - Country code, if detected.\n* `area_code` - Region or area code, if detected.\n* `extension` - Phone extension (to be dialed after connection), if\ndetected.", + "Address.\n\nThe metadata identifies the street number and locality plus whichever\nadditional elements appear in the text:\n\n* `street_number` - Street number.\n* `locality` - City or town.\n* `street_name` - Street/route name, if detected.\n* `postal_code` - Postal code, if detected.\n* `country` - Country, if detected.\n* `broad_region` - Administrative area, such as the state, if detected.\n* `narrow_region` - Smaller administrative area, such as county, if\ndetected.\n* `sublocality` - Used in Asian addresses to demark a district within a\ncity, if detected.", + "Date.\n\nThe metadata identifies the components of the date:\n\n* `year` - Four digit year, if detected.\n* `month` - Two digit month number, if detected.\n* `day` - Two digit day number, if detected.", + "Number.\n\nThe metadata is the number itself.", + "Price.\n\nThe metadata identifies the `value` and `currency`." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "PERSON", + "LOCATION", + "ORGANIZATION", + "EVENT", + "WORK_OF_ART", + "CONSUMER_GOOD", + "OTHER", + "PHONE_NUMBER", + "ADDRESS", + "DATE", + "NUMBER", + "PRICE" + ] + }, + "metadata": { + "description": "Metadata associated with the entity.\n\nFor most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)\nand Knowledge Graph MID (`mid`), if they are available. For the metadata\nassociated with other entity types, see the Type table below.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "salience": { + "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.", + "type": "number", + "format": "float" + }, + "sentiment": { + "description": "The aggregate sentiment expressed for this entity in the conversation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment": { + "description": "One channel of conversation-level sentiment data.", + "type": "object", + "properties": { + "channelTag": { + "description": "The channel of the audio that the data applies to.", + "type": "integer", + "format": "int32" + }, + "sentimentData": { + "description": "Data specifying sentiment.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSentimentData" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence": { + "description": "Conversation-level silence data.", + "type": "object", + "properties": { + "silenceDuration": { + "description": "Amount of time calculated to be in silence.", + "type": "string", + "format": "google-duration" + }, + "silencePercentage": { + "description": "Percentage of the total conversation spent in silence.", + "type": "number", + "format": "float" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIntent": { + "description": "The data for an intent.\nRepresents a detected intent in the conversation, for example MAKES_PROMISE.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the intent.", + "type": "string" + }, + "displayName": { + "description": "The human-readable name of the intent.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainIssueModelResult": { + "description": "Issue Modeling result on a conversation.", + "type": "object", + "properties": { + "issueModel": { + "description": "Issue model that generates the result.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", + "type": "string" + }, + "issues": { + "description": "All the matched issues.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueAssignment" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainSemanticMatchMetadata": { + "description": "Semantic match metadata used in an analysis.", + "type": "object", + "properties": { + "issueModel": { + "description": "Issue model that's used in the semantic match.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaScorecardResult": { + "description": "The results of scoring a single conversation against a QaScorecard. Contains\na collection of QaAnswers and aggregate score.", + "type": "object", + "properties": { + "name": { + "description": "Identifier. The name of the scorecard result.\nFormat:\nprojects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", + "x-google-identifier": true, + "type": "string" + }, + "qaScorecardRevision": { + "description": "The QaScorecardRevision scored by this result.", + "type": "string" + }, + "conversation": { + "description": "The conversation scored by this result.", + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp that the revision was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "agentId": { + "description": "ID of the agent that handled the conversation.", + "type": "string" + }, + "qaAnswers": { + "description": "Set of QaAnswers represented in the result.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswer" + } + }, + "score": { + "description": "The overall numerical score of the result, incorporating any manual edits\nif they exist.", + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "The normalized score, which is the score divided by the potential score.\nAny manual edits are included if they exist.", + "type": "number", + "format": "double" + }, + "qaTagResults": { + "description": "Collection of tags and their scores.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" + } + }, + "scoreSources": { + "description": "List of all individual score sets.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaAnswer": { + "description": "An answer to a QaQuestion.", + "type": "object", + "properties": { + "qaQuestion": { + "description": "The QaQuestion answered by this answer.", + "type": "string" + }, + "conversation": { + "description": "The conversation the answer applies to.", + "type": "string" + }, + "questionBody": { + "description": "Question text. E.g., \"Did the agent greet the customer?\"", + "type": "string" + }, + "answerValue": { + "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" + }] + }, + "tags": { + "description": "User-defined list of arbitrary tags. Matches the value from\nQaScorecard.ScorecardQuestion.tags. Used for grouping/organization and\nfor weighting the score of each answer.", + "type": "array", + "items": { + "type": "string" + } + }, + "answerSources": { + "description": "Lists all answer sources containing one or more answer values of a\nspecific source type, e.g., all system-generated answer sources, or all\nmanual edit answer sources.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource": { + "description": "A question may have multiple answers from varying sources, one of which\nbecomes the \"main\" answer above. AnswerSource represents each individual\nanswer.", + "type": "object", + "properties": { + "sourceType": { + "description": "What created the answer.", + "type": "string", + "x-google-enum-descriptions": [ + "Source type is unspecified.", + "Answer was system-generated; created during an Insights analysis.", + "Answer was created by a human via manual edit." + ], + "enum": [ + "SOURCE_TYPE_UNSPECIFIED", + "SYSTEM_GENERATED", + "MANUAL_EDIT" + ] + }, + "answerValue": { + "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult": { + "description": "Tags and their corresponding results.", + "type": "object", + "properties": { + "tag": { + "description": "The tag the score applies to.", + "type": "string" + }, + "score": { + "description": "The score the tag applies to.", + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "The potential score the tag applies to.", + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "The normalized score the tag applies to.", + "type": "number", + "format": "double" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource": { + "description": "A scorecard result may have multiple sets of scores from varying sources,\none of which becomes the \"main\" answer above. A ScoreSource represents\neach individual set of scores.", + "type": "object", + "properties": { + "sourceType": { + "description": "What created the score.", + "type": "string", + "x-google-enum-descriptions": [ + "Source type is unspecified.", + "Score is derived only from system-generated answers.", + "Score is derived from both system-generated answers, and includes\nany manual edits if they exist." + ], + "enum": [ + "SOURCE_TYPE_UNSPECIFIED", + "SYSTEM_GENERATED_ONLY", + "INCLUDES_MANUAL_EDITS" + ] + }, + "score": { + "description": "The overall numerical score of the result.", + "type": "number", + "format": "double" + }, + "potentialScore": { + "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", + "type": "number", + "format": "double" + }, + "normalizedScore": { + "description": "The normalized score, which is the score divided by the potential score.", + "type": "number", + "format": "double" + }, + "qaTagResults": { + "description": "Collection of tags and their scores.", + "type": "array", + "items": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" + } + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData": { + "description": "Conversation summarization suggestion data.", + "type": "object", + "properties": { + "text": { + "description": "The summarization content that is concatenated into one string.", + "type": "string" + }, + "textSections": { + "description": "The summarization content that is divided into sections. The key is the\nsection's name and the value is the section's content. There is no\nspecific format for the key or value.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "confidence": { + "description": "The confidence score of the summarization.", + "type": "number", + "format": "float" + }, + "metadata": { + "description": "A map that contains metadata about the summarization and the document\nfrom which it originates.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "answerRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + }, + "conversationModel": { + "description": "The name of the model that generates this summary.\nFormat:\nprojects/{project}/locations/{location}/conversationModels/{conversation_model}", + "type": "string" + }, + "generatorId": { + "description": "Agent Assist generator ID.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation": { + "description": "An annotation that was generated during the customer and agent interaction.", + "type": "object", + "properties": { + "annotationId": { + "description": "The unique identifier of the annotation.\nFormat:\nprojects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", + "type": "string" + }, + "createTime": { + "description": "The time at which this annotation was created.", + "type": "string", + "format": "date-time" + }, + "startBoundary": { + "description": "The boundary in the conversation where the annotation starts, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" + }] + }, + "endBoundary": { + "description": "The boundary in the conversation where the annotation ends, inclusive.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" + }] + }, + "answerFeedback": { + "description": "The feedback that the customer has about the answer in `data`.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnswerFeedback" + }] + }, + "articleSuggestion": { + "description": "Agent Assist Article Suggestion data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainArticleSuggestionData" + }] + }, + "faqAnswer": { + "description": "Agent Assist FAQ answer data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFaqAnswerData" + }] + }, + "smartReply": { + "description": "Agent Assist Smart Reply data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSmartReplyData" + }] + }, + "smartComposeSuggestion": { + "description": "Agent Assist Smart Compose suggestion data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData" + }] + }, + "dialogflowInteraction": { + "description": "Dialogflow interaction data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData" + }] + }, + "conversationSummarizationSuggestion": { + "description": "Conversation summarization suggestion data.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" + }] + }, + "userInput": { + "description": "Explicit input used for generating the answer", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainAnswerFeedback": { + "description": "The feedback that the customer has about a certain answer in the\nconversation.", + "type": "object", + "properties": { + "correctnessLevel": { + "description": "The correctness level of an answer.", + "type": "string", + "x-google-enum-descriptions": [ + "Correctness level unspecified.", + "Answer is totally wrong.", + "Answer is partially correct.", + "Answer is fully correct." + ], + "enum": [ + "CORRECTNESS_LEVEL_UNSPECIFIED", + "NOT_CORRECT", + "PARTIALLY_CORRECT", + "FULLY_CORRECT" + ] + }, + "clicked": { + "description": "Indicates whether an answer or item was clicked by the human agent.", + "type": "boolean" + }, + "displayed": { + "description": "Indicates whether an answer or item was displayed to the human agent in the\nagent desktop UI.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData": { + "description": "Agent Assist Article Suggestion data.", + "type": "object", + "properties": { + "title": { + "description": "Article title.", + "type": "string" + }, + "uri": { + "description": "Article URI.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this article is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "float" + }, + "metadata": { + "description": "Map that contains metadata about the Article Suggestion and the document\nthat it originates from.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + }, + "source": { + "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainFaqAnswerData": { + "description": "Agent Assist frequently-asked-question answer data.", + "type": "object", + "properties": { + "answer": { + "description": "The piece of text from the `source` knowledge base document.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this answer is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "float" + }, + "question": { + "description": "The corresponding FAQ question.", + "type": "string" + }, + "metadata": { + "description": "Map that contains metadata about the FAQ answer and the document that\nit originates from.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + }, + "source": { + "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainSmartReplyData": { + "description": "Agent Assist Smart Reply data.", + "type": "object", + "properties": { + "reply": { + "description": "The content of the reply.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this reply is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "double" + }, + "metadata": { + "description": "Map that contains metadata about the Smart Reply and the document from\nwhich it originates.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData": { + "description": "Agent Assist Smart Compose suggestion data.", + "type": "object", + "properties": { + "suggestion": { + "description": "The content of the suggestion.", + "type": "string" + }, + "confidenceScore": { + "description": "The system's confidence score that this suggestion is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", + "type": "number", + "format": "double" + }, + "metadata": { + "description": "Map that contains metadata about the Smart Compose suggestion and the\ndocument from which it originates.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryRecord": { + "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData": { + "description": "Dialogflow interaction data.", + "type": "object", + "properties": { + "dialogflowIntentId": { + "description": "The Dialogflow intent resource path. Format:\nprojects/{project}/agent/{agent}/intents/{intent}", + "type": "string" + }, + "confidence": { + "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0\n(completely certain).", + "type": "number", + "format": "float" + }, + "detectIntentRequest": { + "description": "The Dialogflow conversation DetectIntentRequest raw data of this turn. This\nfield will only be populated in the GetConversation response and its data\nformat should be same as Dialogflow [DetectIntentRequest] of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL." + } + }, + "detectIntentResponse": { + "description": "The Dialogflow conversation DetectIntentResponse raw data of this turn.\nThis field will only be populated in the GetConversation response and its\ndata format should be same as Dialogflow DetectIntentResponse of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL." + } + }, + "flowId": { + "description": "The Dialogflow flow id.", + "type": "string" + }, + "flowDisplayName": { + "description": "The Dialogflow flow display name.\nThe Dialogflow environment display name.", + "type": "string" + }, + "pageId": { + "description": "The Dialogflow page ID.", + "type": "string" + }, + "pageDisplayName": { + "description": "The Dialogflow page display name.\nThe Dialogflow environment display name.", + "type": "string" + }, + "intentId": { + "description": "The Dialogflow intent ID.", + "type": "string" + }, + "intentDisplayName": { + "description": "The Dialogflow intent display name.\nThe Dialogflow environment display name.", + "type": "string" + }, + "endFlowOrSession": { + "description": "The turn reaches END_FLOW or END_SESSION.", + "type": "boolean" + }, + "liveAgentHandoff": { + "description": "Whether the turn was handed off to a human agent.", + "type": "boolean" + }, + "inputType": { + "description": "The input type in this turn.", + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified. Should never be used.", + "Text input.", + "Intent input.", + "Audio input.", + "Event input.", + "DTMF input." + ], + "enum": [ + "INPUT_TYPE_UNSPECIFIED", + "INPUT_TYPE_TEXT", + "INPUT_TYPE_INTENT", + "INPUT_TYPE_AUDIO", + "INPUT_TYPE_EVENT", + "INPUT_TYPE_DTMF" + ] + }, + "matchType": { + "description": "The match type in this turn.", + "type": "string", + "x-google-enum-descriptions": [ + "Not specified. Should never be used.", + "An intent is matched.", + "The input is an intent.", + "The input is for parameter filling.", + "No intent match for the input.", + "Indicates an empty input.", + "The input is an event." + ], + "enum": [ + "MATCH_TYPE_UNSPECIFIED", + "MATCH_TYPE_INTENT", + "MATCH_TYPE_DIRECT_INTENT", + "MATCH_TYPE_PARAMETER_FILLING", + "MATCH_TYPE_NO_MATCH", + "MATCH_TYPE_NO_INPUT", + "MATCH_TYPE_EVENT" + ] + }, + "detectIntentResponseV3": { + "description": "The Dialogflow v3 DetectIntentResponse raw data of this turn.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DetectIntentResponse" + }] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput": { + "description": "Explicit input used for generating the answer", + "type": "object", + "properties": { + "query": { + "description": "Query text. Article Search uses this to store the input query used\nto generate the search results.", + "type": "string" + }, + "generatorName": { + "description": "The resource name of associated generator. Format:\n`projects//locations//generators/`", + "type": "string" + }, + "querySource": { + "description": "Query source for the answer.", + "type": "string", + "x-google-enum-descriptions": [ + "Unknown query source.", + "The query is from agents.", + "The query is a query from previous suggestions, e.g. from a preceding\nSuggestKnowledgeAssist response.", + "The query is from the end user." + ], + "enum": [ + "QUERY_SOURCE_UNSPECIFIED", + "AGENT_QUERY", + "SUGGESTED_QUERY", + "END_USER_QUERY" + ] + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDialogflowIntent": { + "description": "The data for a Dialogflow intent.\nRepresents a detected intent in the conversation, e.g. MAKES_PROMISE.", + "type": "object", + "properties": { + "displayName": { + "description": "The human-readable name of the intent.", + "type": "string" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationData": { + "description": "The metadata for a Dialogflow CX conversation.", + "type": "object", + "properties": { + "virtualAgentId": { + "description": "The virtual agent id of this conversation.", + "type": "string" + }, + "flowIds": { + "description": "The deduped flow UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "flowDisplayNames": { + "description": "The deduped flow display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "pageIds": { + "description": "The deduped page UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "pageDisplayNames": { + "description": "The deduped page display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "intentIds": { + "description": "The deduped intent UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "intentDisplayNames": { + "description": "The deduped intent display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "experimentIds": { + "description": "The deduped experiment UUIDs set.", + "type": "array", + "items": { + "type": "string" + } + }, + "experimentDisplayNames": { + "description": "The deduped experiment display names set.", + "type": "array", + "items": { + "type": "string" + } + }, + "inputAudioDuration": { + "description": "The total duration of the user input audio in this conversation.", + "type": "string", + "format": "google-duration" + }, + "outputAudioDuration": { + "description": "The total duration of the agent output audio in this conversation.", + "type": "string", + "format": "google-duration" + }, + "queryInputStats": { + "description": "Query input stats", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationDataQueryInputStats" + }] + }, + "matchTypeStats": { + "description": "Match type stats.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationDataMatchTypeStats" + }] + }, + "averageMatchConfidence": { + "description": "Average match confidence for all the initent matches in this conversation.", + "type": "number", + "format": "float" + }, + "endSessionExit": { + "description": "Whether the conversation reaches END_FLOW or END_SESSION.", + "type": "boolean" + }, + "maxWebhookLatency": { + "description": "The maximum webhook latency for an individual webhook call in this\nconversation.", + "type": "string", + "format": "google-duration" + }, + "liveAgentHandoff": { + "description": "Whether the conversation was handed off to a human agent.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationDataQueryInputStats": { + "description": "Count by input types in this conversation", + "type": "object", + "properties": { + "textCount": { + "description": "The number of requests with text input.", + "type": "integer", + "format": "int32" + }, + "intentCount": { + "description": "The number of requests with intent input.", + "type": "integer", + "format": "int32" + }, + "audioCount": { + "description": "The number of requests with audio input.", + "type": "integer", + "format": "int32" + }, + "eventCount": { + "description": "The number of requests with event input.", + "type": "integer", + "format": "int32" + }, + "dtmfCount": { + "description": "The number of requests with DTMF input.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationDataMatchTypeStats": { + "description": "Count by match types in this conversation .", + "type": "object", + "properties": { + "intentCount": { + "description": "The number of responses with match type INTENT.", + "type": "integer", + "format": "int32" + }, + "directIntentCount": { + "description": "The number of responses with match type DIRECT_INTENT.", + "type": "integer", + "format": "int32" + }, + "parameterFillingCount": { + "description": "The number of responses with match type PARAMETER_FILLING.", + "type": "integer", + "format": "int32" + }, + "noMatchCount": { + "description": "The number of responses with match type NO_MATCH.", + "type": "integer", + "format": "int32" + }, + "noInputCount": { + "description": "The number of responses with match type NO_INPUT.", + "type": "integer", + "format": "int32" + }, + "eventCount": { + "description": "The number of responses with match type EVENT.", + "type": "integer", + "format": "int32" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationAgentAssistSupervisorMonitoringStatus": { + "description": "Tracks the status of an AA supervisor monitoring a conversation.", + "type": "object", + "properties": { + "monitored": { + "description": "The conversation was monitored by an AA supervisor.", + "type": "boolean" + }, + "escalatedToSupervisor": { + "description": "The conversation was escalated to an AA supervisor for intervention.", + "type": "boolean" + }, + "assignedSupervisor": { + "description": "The ID of the assigned AA supervisor.", + "type": "string" + }, + "transferredToHumanAgent": { + "description": "The conversation was transferred to a human agent by the AA supervisor.", + "type": "boolean" + } + } + }, + "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo": { + "description": "Info for correlating across conversations.", + "type": "object", + "properties": { + "fullConversationCorrelationId": { + "description": "Output only. The full conversation correlation id this conversation is a segment of.", + "readOnly": true, + "type": "string" + }, + "mergedFullConversationCorrelationId": { + "description": "Output only. The full conversation correlation id this conversation is a merged\nconversation of.", + "readOnly": true, + "type": "string" + }, + "correlationTypes": { + "description": "Output only. The correlation types of this conversation. A single conversation can\nhave multiple correlation types. For example a conversation that only has\na single segment is both a SEGMENT and a FULL_CONVERSATION.", + "readOnly": true, + "type": "array", + "items": { + "type": "string", + "x-google-enum-descriptions": [ + "Default value for unspecified.", + "This conversation represents a segment of a full conversation. The\nlowest level of granularity.", + "This conversation represents a partial conversation of potentially\nmultiple segments but is not a full conversation.", + "This conversation represents a full conversation of potentially\nmultiple segments.", + "This conversation represents a synthetic conversation." + ], + "enum": [ + "CORRELATION_TYPE_UNSPECIFIED", + "SEGMENT", + "PARTIAL", + "FULL", + "SYNTHETIC" + ] + } + } + } + }, + "BaseOperation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "properties": { + "name": { + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "done": { + "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "type": "boolean" + }, + "error": { + "description": "The error result of the operation in case of failure or cancellation.", + "allOf": [{ + "$ref": "#/components/schemas/GoogleRpcStatus" + }] + } + } + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL." + } + }, + "response": { + "description": "The normal, successful response of the operation. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL." + } + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1UploadConversationOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1DeleteDatasetOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteDatasetMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1SampleConversationsOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1CreateAnalysisOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1IngestConversationsOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1ExportInsightsDataOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1CreateIssueModelOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1DeleteIssueModelOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1DeployIssueModelOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1UndeployIssueModelOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1ExportIssueModelOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1ImportIssueModelOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1CreateIssueOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1MergeIssuesOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1MergeIssuesMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1CreateFaqModelOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateFaqModelMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1DeleteFaqModelOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteFaqModelMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1TestCorrelationConfigOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1QueryMetricsOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1GenerativeInsightsOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleProtobufEmpty" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1GenerateDiscoveryOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryResponse" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionOperation": { + "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseOperation" + }, + { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionMetadata" + }, + "response": { + "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" + } + } + } + ] + }, + "GoogleCloudContactcenterinsightsV1PredefinedQaScorecardType": { + "type": "string", + "x-google-enum-descriptions": [ + "The type of the predefined scorecard is unspecified.", + "The scorecard for conversation classification, which includes\nquestions like conversation_outcome_classification,\nagent_helpful_classification, user_unsatisfied_classification, and\nwho_escalated_classification." + ], + "enum": [ + "PREDEFINED_QA_SCORECARD_TYPE_UNSPECIFIED", + "CONVERSATION_CLASSIFICATION" + ] + }, + "GoogleCloudDialogflowV3alpha1DataStoreType": { + "type": "string", + "x-google-enum-descriptions": [ + "Not specified. This value indicates that the data store type is not\nspecified, so it will not be used during search.", + "A data store that contains public web content.", + "A data store that contains unstructured private data.", + "A data store that contains structured data used as FAQ.", + "A data store that contains structured data used as Connector." + ], + "enum": [ + "DATA_STORE_TYPE_UNSPECIFIED", + "PUBLIC_WEB", + "UNSTRUCTURED", + "STRUCTURED", + "CONNECTOR" + ] + }, + "GoogleCloudDialogflowV3alpha1DocumentProcessingMode": { + "type": "string", + "x-google-enum-descriptions": [ + "Not specified. This should be set for STRUCTURED type data stores. Due to\nlegacy reasons this is considered as DOCUMENTS for STRUCTURED and\nPUBLIC_WEB data stores.", + "Documents are processed as documents.", + "Documents are converted to chunks." + ], + "enum": [ + "DOCUMENT_PROCESSING_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" + ] + }, + "GoogleCloudDialogflowV3alpha1EngineType": { + "type": "string", + "x-google-enum-descriptions": [ + "Not specified. Will default to CHAT_ENGINE.", + "Agent builder chat app.", + "Agent builder search app." + ], + "enum": [ + "ENGINE_TYPE_UNSPECIFIED", + "CHAT_ENGINE", + "SEARCH_ENGINE" + ] + }, + "GoogleCloudDialogflowV3alpha1DataType": { + "type": "string", + "x-google-enum-descriptions": [ + "Not specified.", + "Represents any string value.", + "Represents any number value.", + "Represents a boolean value.", + "Represents a repeated value." + ], + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "STRING", + "NUMBER", + "BOOLEAN", + "ARRAY" + ] + }, + "GoogleCloudDialogflowV3alpha1RetrievalStrategy": { + "type": "string", + "x-google-enum-descriptions": [ + "Not specified. `DEFAULT` will be used.", + "Default retrieval strategy.", + "Static example will always be inserted to the prompt.", + "Example will never be inserted into the prompt." + ], + "enum": [ + "RETRIEVAL_STRATEGY_UNSPECIFIED", + "DEFAULT", + "STATIC", + "NEVER" + ] + }, + "GoogleCloudDialogflowV3alpha1OutputState": { + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified output.", + "Succeeded.", + "Cancelled.", + "Failed.", + "Escalated.", + "Pending." + ], + "enum": [ + "OUTPUT_STATE_UNSPECIFIED", + "OUTPUT_STATE_OK", + "OUTPUT_STATE_CANCELLED", + "OUTPUT_STATE_FAILED", + "OUTPUT_STATE_ESCALATED", + "OUTPUT_STATE_PENDING" + ] + }, + "GoogleCloudDialogflowV3alpha1OutputAudioEncoding": { + "type": "string", + "x-google-enum-descriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).\nAudio content returned as LINEAR16 also contains a WAV header.", + "MP3 audio at 32kbps.", + "MP3 audio at 64kbps.", + "Opus encoded audio wrapped in an ogg container. The result will be a\nfile which can be played natively on Android, and in browsers (at least\nChrome and Firefox). The quality of the encoding is considerably higher\nthan MP3 while using approximately the same bitrate.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." + ], + "enum": [ + "OUTPUT_AUDIO_ENCODING_UNSPECIFIED", + "OUTPUT_AUDIO_ENCODING_LINEAR_16", + "OUTPUT_AUDIO_ENCODING_MP3", + "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", + "OUTPUT_AUDIO_ENCODING_OGG_OPUS", + "OUTPUT_AUDIO_ENCODING_MULAW", + "OUTPUT_AUDIO_ENCODING_ALAW" + ] + }, + "GoogleCloudDialogflowV3alpha1SsmlVoiceGender": { + "type": "string", + "x-google-enum-descriptions": [ + "An unspecified gender, which means that the client doesn't care which\ngender the selected voice will have.", + "A male voice.", + "A female voice.", + "A gender-neutral voice." + ], + "enum": [ + "SSML_VOICE_GENDER_UNSPECIFIED", + "SSML_VOICE_GENDER_MALE", + "SSML_VOICE_GENDER_FEMALE", + "SSML_VOICE_GENDER_NEUTRAL" + ] + }, + "GoogleCloudContactcenterinsightsV1DatasetValidationWarning": { + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified data validation warning.", + "A non-trivial percentage of the feedback labels are invalid.", + "The quantity of valid feedback labels provided is less than the\nrecommended minimum.", + "One or more of the answers have less than the recommended minimum of\nfeedback labels.", + "All the labels in the dataset come from a single answer choice." + ], + "enum": [ + "DATASET_VALIDATION_WARNING_UNSPECIFIED", + "TOO_MANY_INVALID_FEEDBACK_LABELS", + "INSUFFICIENT_FEEDBACK_LABELS", + "INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER", + "ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER" + ] + }, + "GoogleCloudContactcenterinsightsV1QaScorecardSource": { + "type": "string", + "x-google-enum-descriptions": [ + "The source of the scorecard is unspecified. Default to\nQA_SCORECARD_SOURCE_CUSTOMER_DEFINED.", + "The scorecard is a custom scorecard created by the user.", + "The scorecard is a scorecard created through discovery engine deployment.", + "The scorecard is a predefined scorecard and is defined via a configuration." + ], + "enum": [ + "QA_SCORECARD_SOURCE_UNSPECIFIED", + "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", + "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE", + "QA_SCORECARD_SOURCE_PREDEFINED" + ] + }, + "GoogleCloudContactcenterinsightsV1ChartVisualizationType": { + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified chart visualization type.", + "Bar chart.", + "Line chart.", + "Area chart.", + "Pie chart.", + "Scatter chart.", + "Table chart.", + "Score card chart.", + "Sunburst chart.", + "Gauge chart.", + "Sankey chart." + ], + "enum": [ + "CHART_VISUALIZATION_TYPE_UNSPECIFIED", + "BAR", + "LINE", + "AREA", + "PIE", + "SCATTER", + "TABLE", + "SCORE_CARD", + "SUNBURST", + "GAUGE", + "SANKEY" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1PredefinedQaScorecardType": { + "type": "string", + "x-google-enum-descriptions": [ + "The type of the predefined scorecard is unspecified.", + "The scorecard for conversation classification, which includes\nquestions like conversation_outcome_classification,\nagent_helpful_classification, user_unsatisfied_classification, and\nwho_escalated_classification." + ], + "enum": [ + "PREDEFINED_QA_SCORECARD_TYPE_UNSPECIFIED", + "CONVERSATION_CLASSIFICATION" + ] + }, + "GoogleCloudContactcenterinsightsV1alpha1DatasetValidationWarning": { + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified data validation warning.", + "A non-trivial percentage of the feedback labels are invalid.", + "The quantity of valid feedback labels provided is less than the\nrecommended minimum.", + "One or more of the answers have less than the recommended minimum of\nfeedback labels.", + "All the labels in the dataset come from a single answer choice." + ], + "enum": [ + "DATASET_VALIDATION_WARNING_UNSPECIFIED", + "TOO_MANY_INVALID_FEEDBACK_LABELS", + "INSUFFICIENT_FEEDBACK_LABELS", + "INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER", + "ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER" + ] + }, + "GoogleCloudContactcenterinsightsV1mainPredefinedQaScorecardType": { + "type": "string", + "x-google-enum-descriptions": [ + "The type of the predefined scorecard is unspecified.", + "The scorecard for conversation classification, which includes\nquestions like conversation_outcome_classification,\nagent_helpful_classification, user_unsatisfied_classification, and\nwho_escalated_classification." + ], + "enum": [ + "PREDEFINED_QA_SCORECARD_TYPE_UNSPECIFIED", + "CONVERSATION_CLASSIFICATION" + ] + }, + "GoogleCloudContactcenterinsightsV1mainDatasetValidationWarning": { + "type": "string", + "x-google-enum-descriptions": [ + "Unspecified data validation warning.", + "A non-trivial percentage of the feedback labels are invalid.", + "The quantity of valid feedback labels provided is less than the\nrecommended minimum.", + "One or more of the answers have less than the recommended minimum of\nfeedback labels.", + "All the labels in the dataset come from a single answer choice." + ], + "enum": [ + "DATASET_VALIDATION_WARNING_UNSPECIFIED", + "TOO_MANY_INVALID_FEEDBACK_LABELS", + "INSUFFICIENT_FEEDBACK_LABELS", + "INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER", + "ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER" + ] + } + } + } + , + "externalDocs": { + "description": "Find more info here.", + "url": "https://cloud.google.com/contact-center/insights/docs" + } +} \ No newline at end of file From 64b047e5e727e068c1f62cbd6fe96acc11550312 Mon Sep 17 00:00:00 2001 From: scawful Date: Fri, 6 Feb 2026 20:47:17 +0000 Subject: [PATCH 03/25] ContactCenterInsights: Simplify location description in AutoLabelingRule --- mmv1/products/contactcenterinsights/AutoLabelingRule.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml index 98e45464cd35..440972e4ac87 100644 --- a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml +++ b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml @@ -48,7 +48,7 @@ parameters: - name: location type: String required: true - description: Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. + description: Location of the resource. immutable: true url_param_only: true - name: autoLabelingRuleId From 4b1e786ee6c2982e90b2e0c9f29079fa6f81ed07 Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 24 Feb 2026 19:55:34 +0000 Subject: [PATCH 04/25] Remove openapi json file as per review feedback --- .../openapi/contactcenterinsights.v1.json | 42995 ---------------- 1 file changed, 42995 deletions(-) delete mode 100755 mmv1/openapi_generate/openapi/contactcenterinsights.v1.json diff --git a/mmv1/openapi_generate/openapi/contactcenterinsights.v1.json b/mmv1/openapi_generate/openapi/contactcenterinsights.v1.json deleted file mode 100755 index f14dcfb7d405..000000000000 --- a/mmv1/openapi_generate/openapi/contactcenterinsights.v1.json +++ /dev/null @@ -1,42995 +0,0 @@ -{ - "openapi": "3.0.3", - "info": { - "title": "Contact Center AI Insights API", - "description": "", - "version": "v1", - "x-google-revision": "0" - }, - "servers": [ - { - "url": "https://contactcenterinsights.googleapis.com", - "description": "Global Endpoint" - } - ], - "paths": { - "/v1/projects/{project}/locations/{location}/operations": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListOperations", - "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "The standard list filter.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The standard list page size.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The standard list page token.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "returnPartialSuccess", - "description": "When set to `true`, operations that are reachable are returned as normal,\nand those that are unreachable are returned in the\nListOperationsResponse.unreachable\nfield.\n\nThis can only be `true` when reading across collections. For example, when\n`parent` is set to `\"projects/example/locations/-\"`.\n\nThis field is not supported by default and will result in an\n`UNIMPLEMENTED` error if set unless explicitly documented otherwise in\nservice or product specific documentation.", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleLongrunningListOperationsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/operations": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListOperationsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", - "x-google-operation-name" : "ListOperations", - "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "The standard list filter.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The standard list page size.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The standard list page token.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "returnPartialSuccess", - "description": "When set to `true`, operations that are reachable are returned as normal,\nand those that are unreachable are returned in the\nListOperationsResponse.unreachable\nfield.\n\nThis can only be `true` when reading across collections. For example, when\n`parent` is set to `\"projects/example/locations/-\"`.\n\nThis field is not supported by default and will result in an\n`UNIMPLEMENTED` error if set unless explicitly documented otherwise in\nservice or product specific documentation.", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleLongrunningListOperationsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/operations/{operation}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetOperation", - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "operation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleLongrunningOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/operations/{operation}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetOperationByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndOperation", - "x-google-operation-name" : "GetOperation", - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "operation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleLongrunningOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/operations/{operation}:cancel": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CancelOperation", - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of `1`,\ncorresponding to `Code.CANCELLED`.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "operation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/operations/{operation}:cancel": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CancelOperationByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndOperation", - "x-google-operation-name" : "CancelOperation", - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of `1`,\ncorresponding to `Code.CANCELLED`.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "operation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateConversation", - "description": "Creates a conversation.\nNote that this method does not support audio transcription or redaction.\nUse `conversations.upload` instead.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversationId", - "description": "A unique ID for the new conversation. This ID will become the final\ncomponent of the conversation's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The conversation resource to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListConversations", - "description": "Lists conversations.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "virtualAgentId", - "description": "The agent id of the Dialogflow conversation. It is specified to only list\nthe conversations under this agent.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of conversations to return in the response. A valid page\nsize ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The value returned by the last `ListConversationsResponse`. This value\nindicates that this is a continuation of a prior `ListConversations` call\nand that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "A filter to reduce results to a specific subset. Useful for querying\nconversations with specific properties.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "orderBy", - "description": "Optional. The attribute by which to order conversations in the response.\nIf empty, conversations will be ordered by descending creation time.\nSupported values are one of the following:\n\n* create_time\n* customer_satisfaction_rating\n* duration\n* latest_analysis\n* start_time\n* turn_count\n\nThe default sort order is ascending. To specify order, append `asc` or\n`desc` (`create_time desc`).\nFor more details, see [Google AIPs\nOrdering](https://google.aip.dev/132#ordering).", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "view", - "description": "The level of details of the conversation. Default is `BASIC`.", - "in": "query", - "schema": { - "type": "string", - "x-google-enum-descriptions": [ - "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", - "Populates all fields in the conversation.", - "Populates all fields in the conversation except the transcript.", - "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." - ], - "enum": [ - "CONVERSATION_VIEW_UNSPECIFIED", - "FULL", - "BASIC", - "DF_CONVERSATION" - ] - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations:upload": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "UploadConversation", - "description": "Create a long-running conversation upload operation. This method differs\nfrom `CreateConversation` by allowing audio transcription and optional DLP\nredaction.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateConversation", - "description": "Updates a conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `agent_id`\n* `language_code`\n* `labels`\n* `metadata`\n* `quality_metadata`\n* `call_metadata`\n* `start_time`\n* `expire_time` or `ttl`\n* `data_source.gcs_source.audio_uri` or\n* `data_source.dialogflow_source.audio_uri`\n* `data_source.screen_recordings`", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - }, - { - "name": "allowMissing", - "description": "Optional. Defaults to false. If set to true, and the conversation is not found, a new\nconversation will be created. In this situation, `update_mask` is ignored.", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "conversationAutoLabelingUpdateConfig.allowAutoLabelingUpdate", - "description": "Optional. If set to true, the conversation will be updated with auto labeling\nresults.", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "description": "Required. The new values for the conversation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetConversation", - "description": "Gets a conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "view", - "description": "The level of details of the conversation. Default is `FULL`.", - "in": "query", - "schema": { - "type": "string", - "x-google-enum-descriptions": [ - "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", - "Populates all fields in the conversation.", - "Populates all fields in the conversation except the transcript.", - "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." - ], - "enum": [ - "CONVERSATION_VIEW_UNSPECIFIED", - "FULL", - "BASIC", - "DF_CONVERSATION" - ] - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteConversation", - "description": "Deletes a conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "force", - "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetConversationByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", - "x-google-operation-name" : "GetConversation", - "description": "Gets a conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "view", - "description": "The level of details of the conversation. Default is `FULL`.", - "in": "query", - "schema": { - "type": "string", - "x-google-enum-descriptions": [ - "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", - "Populates all fields in the conversation.", - "Populates all fields in the conversation except the transcript.", - "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." - ], - "enum": [ - "CONVERSATION_VIEW_UNSPECIFIED", - "FULL", - "BASIC", - "DF_CONVERSATION" - ] - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteConversationByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", - "x-google-operation-name" : "DeleteConversation", - "description": "Deletes a conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "force", - "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations/{conversation}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetConversationByProjectAndLocationAndDatasetAndConversation", - "x-google-operation-name" : "GetConversation", - "description": "Gets a conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "view", - "description": "The level of details of the conversation. Default is `FULL`.", - "in": "query", - "schema": { - "type": "string", - "x-google-enum-descriptions": [ - "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", - "Populates all fields in the conversation.", - "Populates all fields in the conversation except the transcript.", - "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." - ], - "enum": [ - "CONVERSATION_VIEW_UNSPECIFIED", - "FULL", - "BASIC", - "DF_CONVERSATION" - ] - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteConversationByProjectAndLocationAndDatasetAndConversation", - "x-google-operation-name" : "DeleteConversation", - "description": "Deletes a conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "force", - "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListConversationsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", - "x-google-operation-name" : "ListConversations", - "description": "Lists conversations.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "virtualAgentId", - "description": "The agent id of the Dialogflow conversation. It is specified to only list\nthe conversations under this agent.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of conversations to return in the response. A valid page\nsize ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The value returned by the last `ListConversationsResponse`. This value\nindicates that this is a continuation of a prior `ListConversations` call\nand that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "A filter to reduce results to a specific subset. Useful for querying\nconversations with specific properties.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "orderBy", - "description": "Optional. The attribute by which to order conversations in the response.\nIf empty, conversations will be ordered by descending creation time.\nSupported values are one of the following:\n\n* create_time\n* customer_satisfaction_rating\n* duration\n* latest_analysis\n* start_time\n* turn_count\n\nThe default sort order is ascending. To specify order, append `asc` or\n`desc` (`create_time desc`).\nFor more details, see [Google AIPs\nOrdering](https://google.aip.dev/132#ordering).", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "view", - "description": "The level of details of the conversation. Default is `BASIC`.", - "in": "query", - "schema": { - "type": "string", - "x-google-enum-descriptions": [ - "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", - "Populates all fields in the conversation.", - "Populates all fields in the conversation except the transcript.", - "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." - ], - "enum": [ - "CONVERSATION_VIEW_UNSPECIFIED", - "FULL", - "BASIC", - "DF_CONVERSATION" - ] - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListConversationsByProjectAndLocationAndDataset", - "x-google-operation-name" : "ListConversations", - "description": "Lists conversations.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "virtualAgentId", - "description": "The agent id of the Dialogflow conversation. It is specified to only list\nthe conversations under this agent.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of conversations to return in the response. A valid page\nsize ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The value returned by the last `ListConversationsResponse`. This value\nindicates that this is a continuation of a prior `ListConversations` call\nand that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "A filter to reduce results to a specific subset. Useful for querying\nconversations with specific properties.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "orderBy", - "description": "Optional. The attribute by which to order conversations in the response.\nIf empty, conversations will be ordered by descending creation time.\nSupported values are one of the following:\n\n* create_time\n* customer_satisfaction_rating\n* duration\n* latest_analysis\n* start_time\n* turn_count\n\nThe default sort order is ascending. To specify order, append `asc` or\n`desc` (`create_time desc`).\nFor more details, see [Google AIPs\nOrdering](https://google.aip.dev/132#ordering).", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "view", - "description": "The level of details of the conversation. Default is `BASIC`.", - "in": "query", - "schema": { - "type": "string", - "x-google-enum-descriptions": [ - "The conversation view is not specified.\n\n* Defaults to `FULL` in `GetConversationRequest`.\n* Defaults to `BASIC` in `ListConversationsRequest`.", - "Populates all fields in the conversation.", - "Populates all fields in the conversation except the transcript.", - "Populates all fields in the conversation plus\n`DialogflowCxConversationData`. This option only applies to conversations\nthat came to Insights via [Dialogflow runtime integration]\n(https://cloud.google.com/contact-center/insights/docs/dialogflow-runtime-integration).\n\n* This option will show the raw Dialogflow request and response data when\n it is used in `GetConversationRequest`.\n* This option will **not** show the raw Dialogflow request and response\n data when it is used in `ListConversationsRequest`." - ], - "enum": [ - "CONVERSATION_VIEW_UNSPECIFIED", - "FULL", - "BASIC", - "DF_CONVERSATION" - ] - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}:generateSignedAudio": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GenerateConversationSignedAudio", - "description": "Gets the signed URI for the audio for the given conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}:generateSignedAudio": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GenerateConversationSignedAudioByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", - "x-google-operation-name" : "GenerateConversationSignedAudio", - "description": "Gets the signed URI for the audio for the given conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations/{conversation}:generateSignedAudio": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GenerateConversationSignedAudioByProjectAndLocationAndDatasetAndConversation", - "x-google-operation-name" : "GenerateConversationSignedAudio", - "description": "Gets the signed URI for the audio for the given conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateDataset", - "description": "Creates a dataset.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "datasetId", - "description": "Optional. The ID to use for the dataset.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The dataset to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListDatasets", - "description": "List datasets matching the input.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of datasets to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListDatasetsResponse`; indicates\nthat this is a continuation of a prior `ListDatasets` call and\nthe system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. A filter to reduce results to a specific subset. Useful for querying\ndatasets with specific properties.\nSupported fields include, for Q2 though we only support list by project:\n- `type`\n- `description`\n- `project_number`", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDatasetsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetDataset", - "description": "Gets a dataset.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateDataset", - "description": "Updates a dataset.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to update.", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The dataset to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteDataset", - "description": "Delete a dataset.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteDatasetOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations:sample": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "SampleConversations", - "description": "Samples conversations based on user configuration and handles\nthe sampled conversations for different use cases.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations:sample": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "SampleConversationsByProjectAndLocationAndDataset", - "x-google-operation-name" : "SampleConversations", - "description": "Samples conversations based on user configuration and handles\nthe sampled conversations for different use cases.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/analyses": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateAnalysis", - "description": "Creates an analysis. The long running operation is done when the analysis\nhas completed.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The analysis to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateAnalysisOperation" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListAnalyses", - "description": "Lists analyses.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of analyses to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The value returned by the last `ListAnalysesResponse`; indicates\nthat this is a continuation of a prior `ListAnalyses` call and\nthe system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "A filter to reduce results to a specific subset. Useful for querying\nconversations with specific properties.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetAnalysis", - "description": "Gets an analysis.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "analysis", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteAnalysis", - "description": "Deletes an analysis.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "analysis", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations:bulkAnalyze": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "BulkAnalyzeConversations", - "description": "Analyzes multiple conversations in a single request.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/segments:bulkAnalyze": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "BulkAnalyzeConversationsByProjectAndLocationAndConversation", - "x-google-operation-name" : "BulkAnalyzeConversations", - "description": "Analyzes multiple conversations in a single request.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations:bulkDelete": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "BulkDeleteConversations", - "description": "Deletes multiple conversations in a single request.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations:bulkDelete": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "BulkDeleteConversationsByProjectAndLocationAndDataset", - "x-google-operation-name" : "BulkDeleteConversations", - "description": "Deletes multiple conversations in a single request.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations:ingest": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "IngestConversations", - "description": "Imports conversations and processes them according to the user's\nconfiguration.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations:ingest": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "IngestConversationsByProjectAndLocationAndDataset", - "x-google-operation-name" : "IngestConversations", - "description": "Imports conversations and processes them according to the user's\nconfiguration.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "ExportInsightsData", - "description": "Export insights data to a destination defined in the request body.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "projectsId", - "description": "Part of `parent`. Required. The parent resource to export data from.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "locationsId", - "description": "Part of `parent`. See documentation of `projectsId`.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataOperation" - } - } - } - } - } - } - }, - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/insightsdata:export": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "ExportInsightsDataByProjectsIdAndLocationsIdAndDatasetsId", - "x-google-operation-name" : "ExportInsightsData", - "description": "Export insights data to a destination defined in the request body.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "projectsId", - "description": "Part of `parent`. Required. The parent resource to export data from.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "locationsId", - "description": "Part of `parent`. See documentation of `projectsId`.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "datasetsId", - "description": "Part of `parent`. See documentation of `projectsId`.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/issueModels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateIssueModel", - "description": "Creates an issue model.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The issue model to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelOperation" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListIssueModels", - "description": "Lists issue models.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of issue models to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The value returned by the last `ListIssueModelsResponse`. This value\nindicates that this is a continuation of a prior `ListIssueModels` call and\nthat the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "A filter to reduce results to a specific subset. Useful for querying\nissue models with specific properties.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListIssueModelsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateIssueModel", - "description": "Updates an issue model.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "The list of fields to be updated.", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The new values for the issue model.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetIssueModel", - "description": "Gets an issue model.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteIssueModel", - "description": "Deletes an issue model.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}:deploy": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "DeployIssueModel", - "description": "Deploys an issue model. Returns an error if a model is already deployed.\nAn issue model can only be used in analysis after it has been deployed.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}:undeploy": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "UndeployIssueModel", - "description": "Undeploys an issue model.\nAn issue model can not be used in analysis after it has been undeployed.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}:export": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "ExportIssueModel", - "description": "Exports an issue model to the provided destination.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/issueModels:import": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "ImportIssueModel", - "description": "Imports an issue model from a Cloud Storage bucket.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}/issues/{issue}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetIssue", - "description": "Gets an issue.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateIssue", - "description": "Updates an issue.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "The list of fields to be updated.", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The new values for the issue.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteIssue", - "description": "Deletes an issue.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}/issues": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListIssues", - "description": "Lists issues.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of issues to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The value returned by the last `ListIssuesResponse`. This value indicates\nthat this is a continuation of a prior `ListIssues` call and\nthat the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse" - } - } - } - } - } - }, - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateIssue", - "description": "Creates an issue.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The values for the new issue.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}:mergeIssues": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "MergeIssues", - "description": "Merges a group of issues into a new issue.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1MergeIssuesRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1MergeIssuesOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/issueModels/{issuemodel}:calculateIssueModelStats": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "CalculateIssueModelStats", - "description": "Gets an issue model's statistics.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issuemodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/faqModels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateFaqModel", - "description": "Creates an FAQ model.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "faqModelId", - "description": "Optional. The ID to use for the FAQ model, which will become the final\ncomponent of the FAQ model's resource name.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The FAQ model to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateFaqModelOperation" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListFaqModels", - "description": "Lists FAQ models.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of FAQ models to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The value returned by the last `ListFaqModelsResponse`. This value\nindicates that this is a continuation of a prior `ListFaqModels` call and\nthat the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "A filter to reduce results to a specific subset. Useful for querying\nFAQ models with specific properties.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListFaqModelsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/faqModels/{faqmodel}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateFaqModel", - "description": "Updates an FAQ model.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "faqmodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to be updated.", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The new values for the FAQ model.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetFaqModel", - "description": "Gets an FAQ model.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "faqmodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteFaqModel", - "description": "Deletes an FAQ model.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "faqmodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteFaqModelOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/faqModels/{faqmodel}/faqEntries/{faqentry}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetFaqEntry", - "description": "Gets an FAQ entry.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "faqmodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "faqentry", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntry" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateFaqEntry", - "description": "Updates an FAQ entry.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "faqmodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "faqentry", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to be updated.", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The new values for the FAQ entry.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntry" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntry" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteFaqEntry", - "description": "Deletes an FAQ entry.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "faqmodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "faqentry", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/faqModels/{faqmodel}/faqEntries": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListFaqEntries", - "description": "Lists FAQ entries.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "faqmodel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of FAQ entries to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The value returned by the last `ListFaqsResponse`. This value indicates\nthat this is a continuation of a prior `ListFaqEntries` call and\nthat the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListFaqEntriesResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/phraseMatchers": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreatePhraseMatcher", - "description": "Creates a phrase matcher.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The phrase matcher resource to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListPhraseMatchers", - "description": "Lists phrase matchers.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of phrase matchers to return in the response. If this\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The value returned by the last `ListPhraseMatchersResponse`. This value\nindicates that this is a continuation of a prior `ListPhraseMatchers` call\nand that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "A filter to reduce results to a specific subset. Useful for querying\nphrase matchers with specific properties.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/phraseMatchers/{phrasematcher}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetPhraseMatcher", - "description": "Gets a phrase matcher.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "phrasematcher", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeletePhraseMatcher", - "description": "Deletes a phrase matcher.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "phrasematcher", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdatePhraseMatcher", - "description": "Updates a phrase matcher.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "phrasematcher", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "The list of fields to be updated.", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The new values for the phrase matcher.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations:calculateStats": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "CalculateStats", - "description": "Gets conversation statistics.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "A filter to reduce results to a specific subset. This field is useful for\ngetting statistics about conversations with specific properties.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations:calculateStats": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "CalculateStatsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", - "x-google-operation-name" : "CalculateStats", - "description": "Gets conversation statistics.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "A filter to reduce results to a specific subset. This field is useful for\ngetting statistics about conversations with specific properties.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations:calculateStats": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CalculateStatsByProjectAndLocationAndDataset", - "x-google-operation-name" : "CalculateStats", - "description": "Gets conversation statistics.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/correlationConfig": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetCorrelationConfig", - "description": "Gets correlation config.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationConfig" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateCorrelationConfig", - "description": "Updates correlation config.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to be updated.", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The new correlation config values.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationConfig" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationConfig" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}:testCorrelationConfig": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "TestCorrelationConfig", - "description": "Tests correlation config on a conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/settings": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetSettings", - "description": "Gets project-level settings.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Settings" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateSettings", - "description": "Updates project-level settings.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Required. The list of fields to be updated.", - "in": "query", - "required": true, - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The new settings values.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Settings" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Settings" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/analysisRules": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateAnalysisRule", - "description": "Creates a analysis rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The analysis rule resource to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListAnalysisRules", - "description": "Lists analysis rules.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of analysis rule to return in the response. If this\nvalue is zero, the service will select a default size. A call may return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListAnalysisRulesResponse`; indicates\nthat this is a continuation of a prior `ListAnalysisRules` call and\nthe system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/analysisRules/{analysisrule}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetAnalysisRule", - "description": "Get a analysis rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "analysisrule", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateAnalysisRule", - "description": "Updates a analysis rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "analysisrule", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to be updated.\nIf the update_mask is not provided, the update will be applied to all\nfields.", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The new analysis rule.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteAnalysisRule", - "description": "Deletes a analysis rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "analysisrule", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/autoLabelingRules": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListAutoLabelingRules", - "description": "Lists auto labeling rules.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of auto labeling rules to return in a single response.\nIf unspecified, at most 100 rules will be returned. The maximum value is\n1000; values above 1000 will be coerced to 1000.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The next_page_token value returned from a previous List request, if any.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAutoLabelingRulesResponse" - } - } - } - } - } - }, - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateAutoLabelingRule", - "description": "Creates an auto labeling rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "autoLabelingRuleId", - "description": "Required. The ID to use for the auto labeling rule, which will become the final\ncomponent of the auto labeling rule's resource name.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The auto labeling rule to create.\nThe `name` field of this rule must be empty. The `label_key` field\nwill be used to form the resource name.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/autoLabelingRules/{autolabelingrule}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetAutoLabelingRule", - "description": "Gets an auto labeling rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "autolabelingrule", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateAutoLabelingRule", - "description": "Updates an auto labeling rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "autolabelingrule", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to be updated.", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The auto labeling rule to update.\nThe rule's `name` field is used to identify the rule to update.\nFormat:\nprojects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteAutoLabelingRule", - "description": "Deletes an auto labeling rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "autolabelingrule", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/autoLabelingRules:test": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "TestAutoLabelingRule", - "description": "Tests auto labeling rules against a conversation.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/assessmentRules": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "description": "Creates an assessment rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessmentRuleId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The assessment rule resource to create.", - "content": { - "application/json": { - "schema": { - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "description": "Lists assessment rules.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of assessment rule to return in the response. If this\nvalue is zero, the service will select a default size. A call may return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/assessmentRules/{assessmentrule}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "description": "Get an assessment rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessmentrule", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "description": "Updates an assessment rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessmentrule", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to be updated.\nIf the update_mask is not provided, the update will be applied to all\nfields.", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The new assessment rule.", - "content": { - "application/json": { - "schema": { - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "description": "Deletes an assessment rule.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessmentrule", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/encryptionSpec": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetEncryptionSpec", - "description": "Gets location-level encryption key specification.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/encryptionSpec:initialize": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "InitializeEncryptionSpec", - "description": "Initializes a location-level encryption key specification. An error will\nresult if the location has resources already created before the\ninitialization. After the encryption specification is initialized at a\nlocation, it is immutable and all newly created resources under the\nlocation will be encrypted with the existing specification.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/views": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateView", - "description": "Creates a view.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The view resource to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListViews", - "description": "Lists views.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of views to return in the response. If this\nvalue is zero, the service will select a default size. A call may return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "The value returned by the last `ListViewsResponse`; indicates\nthat this is a continuation of a prior `ListViews` call and\nthe system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/views/{view}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetView", - "description": "Gets a view.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "view", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateView", - "description": "Updates a view.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "view", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "The list of fields to be updated.", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The new view.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteView", - "description": "Deletes a view.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "view", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}:queryMetrics": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "QueryMetrics", - "description": "Query metrics.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:queryMetrics": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "QueryMetricsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", - "x-google-operation-name" : "QueryMetrics", - "description": "Query metrics.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}:generativeInsights": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "GenerativeInsights", - "description": "Natural language based Insights which powers the next generation of\ndashboards in Insights.\nNext generation of QueryMetrics.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:generativeInsights": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "GenerativeInsightsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", - "x-google-operation-name" : "GenerativeInsights", - "description": "Natural language based Insights which powers the next generation of\ndashboards in Insights.\nNext generation of QueryMetrics.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}:queryPerformanceOverview": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "QueryPerformanceOverview", - "description": "Generates a summary of predefined performance metrics for a set of\nconversations. Conversations can be specified by specifying a time window\nand an agent id, for now. The summary includes a comparison of metrics\ncomputed for conversations in the previous time period, and also a\ncomparison with peers in the same time period.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:queryPerformanceOverview": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "QueryPerformanceOverviewByProjectAndLocationAndAuthorizedviewsetAndAuthorizedview", - "x-google-operation-name" : "QueryPerformanceOverview", - "description": "Generates a summary of predefined performance metrics for a set of\nconversations. Conversations can be specified by specifying a time window\nand an agent id, for now. The summary includes a comparison of metrics\ncomputed for conversations in the previous time period, and also a\ncomparison with peers in the same time period.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}/qaQuestions": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateQaQuestion", - "description": "Create a QaQuestion.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qaQuestionId", - "description": "Optional. A unique ID for the new question. This ID will become the final\ncomponent of the question's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The QaQuestion to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListQaQuestions", - "description": "Lists QaQuestions.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of questions to return in the response. If the value is\nzero, the service will select a default size. A call might return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListQaQuestionsResponse`. This value\nindicates that this is a continuation of a prior `ListQaQuestions` call\nand that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}/qaQuestions/{qaquestion}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetQaQuestion", - "description": "Gets a QaQuestion.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qaquestion", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateQaQuestion", - "description": "Updates a QaQuestion.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qaquestion", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Required. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `abbreviation`\n* `answer_choices`\n* `answer_instructions`\n* `order`\n* `question_body`\n* `tags`", - "in": "query", - "required": true, - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The QaQuestion to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteQaQuestion", - "description": "Deletes a QaQuestion.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qaquestion", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaQuestionTags": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateQaQuestionTag", - "description": "Creates a QaQuestionTag.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qaQuestionTagId", - "description": "Optional. A unique ID for the new QaQuestionTag. This ID will become the final\ncomponent of the QaQuestionTag's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The QaQuestionTag to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListQaQuestionTags", - "description": "Lists the question tags.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. A filter to reduce results to a specific subset. Supports conjunctions\n(ie. AND operators). Supported fields include the following:\n\n* `project_id` - id of the project to list tags for\n* `qa_scorecard_id` - id of the scorecard to list tags for\n* `revision_id` - id of the scorecard revision to list tags for`\n* `qa_question_id - id of the question to list tags for`", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaQuestionTags/{qaquestiontag}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetQaQuestionTag", - "description": "Gets a QaQuestionTag.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qaquestiontag", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateQaQuestionTag", - "description": "Updates a QaQuestionTag.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qaquestiontag", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `qa_question_tag_name` - the name of the tag\n* `qa_question_ids` - the list of questions the tag applies to", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The QaQuestionTag to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagOperation" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteQaQuestionTag", - "description": "Deletes a QaQuestionTag.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qaquestiontag", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaScorecards": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateQaScorecard", - "description": "Create a QaScorecard.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qaScorecardId", - "description": "Optional. A unique ID for the new QaScorecard. This ID will become the final\ncomponent of the QaScorecard's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The QaScorecard to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListQaScorecards", - "description": "Lists QaScorecards.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of scorecards to return in the response. If the value is\nzero, the service will select a default size. A call might return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListQaScorecardsResponse`. This value\nindicates that this is a continuation of a prior `ListQaScorecards` call\nand that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "qaScorecardSources", - "description": "Optional. The source of scorecards are based on how those Scorecards were created,\ne.g., a customer-defined scorecard, a predefined scorecard, etc.\nThis field is used to retrieve Scorecards of one or more sources.", - "in": "query", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardSource" - } - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetQaScorecard", - "description": "Gets a QaScorecard.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateQaScorecard", - "description": "Updates a QaScorecard.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Required. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `description`\n* `display_name`", - "in": "query", - "required": true, - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The QaScorecard to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteQaScorecard", - "description": "Deletes a QaScorecard.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "force", - "description": "Optional. If set to true, all of this QaScorecard's child resources will also be\ndeleted. Otherwise, the request will only succeed if it has none.", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateQaScorecardRevision", - "description": "Creates a QaScorecardRevision.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qaScorecardRevisionId", - "description": "Optional. A unique ID for the new QaScorecardRevision. This ID will become the final\ncomponent of the QaScorecardRevision's resource name. If no ID is\nspecified, a server-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The QaScorecardRevision to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListQaScorecardRevisions", - "description": "Lists all revisions under the parent QaScorecard.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of scorecard revisions to return in the response. If the\nvalue is zero, the service will select a default size. A call might return\nfewer objects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListQaScorecardRevisionsResponse`. This\nvalue indicates that this is a continuation of a prior\n`ListQaScorecardRevisions` call and that the system should return the next\npage of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. A filter to reduce results to a specific subset. Useful for querying\nscorecard revisions with specific properties.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "qaScorecardSources", - "description": "Optional. The source of scorecards are based on how those Scorecards were created,\ne.g., a customer-defined scorecard, a predefined scorecard, etc.\nThis field is used to retrieve Scorecards Revisions from Scorecards of one\nor more sources.", - "in": "query", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardSource" - } - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetQaScorecardRevision", - "description": "Gets a QaScorecardRevision.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteQaScorecardRevision", - "description": "Deletes a QaScorecardRevision.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "force", - "description": "Optional. If set to true, all of this QaScorecardRevision's child resources will also\nbe deleted. Otherwise, the request will only succeed if it has none.", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}:tuneQaScorecardRevision": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "TuneQaScorecardRevision", - "description": "Fine tune one or more QaModels.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}:bulkUpdateQaQuestions": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "BulkUpdateQaQuestions", - "description": "Bulk updates QaQuestions that are in the same revision.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}:deploy": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "DeployQaScorecardRevision", - "description": "Deploy a QaScorecardRevision.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/qaScorecards/{qascorecard}/revisions/{revision}:undeploy": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "UndeployQaScorecardRevision", - "description": "Undeploy a QaScorecardRevision.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "qascorecard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateFeedbackLabel", - "description": "Create feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbackLabelId", - "description": "Optional. The ID of the feedback label to create.\nIf one is not specified it will be generated by the server.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The feedback label to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListFeedbackLabels", - "description": "List feedback labels.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND). Automatically sorts by conversation ID. To sort by\nall feedback labels in a project see ListAllFeedbackLabels.\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of feedback labels to return in the response. A valid\npage size ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value\nindicates that this is a continuation of a prior `ListFeedbackLabels` call\nand that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/feedbackLabels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateFeedbackLabelByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", - "x-google-operation-name" : "CreateFeedbackLabel", - "description": "Create feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbackLabelId", - "description": "Optional. The ID of the feedback label to create.\nIf one is not specified it will be generated by the server.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The feedback label to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListFeedbackLabelsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", - "x-google-operation-name" : "ListFeedbackLabels", - "description": "List feedback labels.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND). Automatically sorts by conversation ID. To sort by\nall feedback labels in a project see ListAllFeedbackLabels.\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of feedback labels to return in the response. A valid\npage size ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value\nindicates that this is a continuation of a prior `ListFeedbackLabels` call\nand that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations/{conversation}/feedbackLabels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateFeedbackLabelByProjectAndLocationAndDatasetAndConversation", - "x-google-operation-name" : "CreateFeedbackLabel", - "description": "Create feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbackLabelId", - "description": "Optional. The ID of the feedback label to create.\nIf one is not specified it will be generated by the server.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The feedback label to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListFeedbackLabelsByProjectAndLocationAndDatasetAndConversation", - "x-google-operation-name" : "ListFeedbackLabels", - "description": "List feedback labels.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND). Automatically sorts by conversation ID. To sort by\nall feedback labels in a project see ListAllFeedbackLabels.\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of feedback labels to return in the response. A valid\npage size ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value\nindicates that this is a continuation of a prior `ListFeedbackLabels` call\nand that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedbacklabel}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetFeedbackLabel", - "description": "Get feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbacklabel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateFeedbackLabel", - "description": "Update feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbacklabel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Required. The list of fields to be updated.", - "in": "query", - "required": true, - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The feedback label to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteFeedbackLabel", - "description": "Delete feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbacklabel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/feedbackLabels/{feedbacklabel}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetFeedbackLabelByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndFeedbacklabel", - "x-google-operation-name" : "GetFeedbackLabel", - "description": "Get feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbacklabel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateFeedbackLabelByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndFeedbacklabel", - "x-google-operation-name" : "UpdateFeedbackLabel", - "description": "Update feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbacklabel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Required. The list of fields to be updated.", - "in": "query", - "required": true, - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The feedback label to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteFeedbackLabelByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndFeedbacklabel", - "x-google-operation-name" : "DeleteFeedbackLabel", - "description": "Delete feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbacklabel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}/conversations/{conversation}/feedbackLabels/{feedbacklabel}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetFeedbackLabelByProjectAndLocationAndDatasetAndConversationAndFeedbacklabel", - "x-google-operation-name" : "GetFeedbackLabel", - "description": "Get feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbacklabel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateFeedbackLabelByProjectAndLocationAndDatasetAndConversationAndFeedbacklabel", - "x-google-operation-name" : "UpdateFeedbackLabel", - "description": "Update feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbacklabel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Required. The list of fields to be updated.", - "in": "query", - "required": true, - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The feedback label to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteFeedbackLabelByProjectAndLocationAndDatasetAndConversationAndFeedbacklabel", - "x-google-operation-name" : "DeleteFeedbackLabel", - "description": "Delete feedback label.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "feedbacklabel", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}:listAllFeedbackLabels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListAllFeedbackLabels", - "description": "List all feedback labels by project number.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of feedback labels to return in the response. A valid\npage size ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value\nindicates that this is a continuation of a prior `ListAllFeedbackLabels`\ncall and that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. A filter to reduce results to a specific subset in the entire project.\nSupports disjunctions (OR) and conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}:listAllFeedbackLabels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListAllFeedbackLabelsByProjectAndLocationAndDataset", - "x-google-operation-name" : "ListAllFeedbackLabels", - "description": "List all feedback labels by project number.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of feedback labels to return in the response. A valid\npage size ranges from 0 to 100,000 inclusive. If the page size is zero or\nunspecified, a default page size of 100 will be chosen. Note that a call\nmight return fewer results than the requested page size.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value\nindicates that this is a continuation of a prior `ListAllFeedbackLabels`\ncall and that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. A filter to reduce results to a specific subset in the entire project.\nSupports disjunctions (OR) and conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}:bulkUploadFeedbackLabels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "BulkUploadFeedbackLabels", - "description": "Upload feedback labels from an external source in bulk.\nCurrently supports labeling Quality AI example conversations.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}:bulkUploadFeedbackLabels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "BulkUploadFeedbackLabelsByProjectAndLocationAndDataset", - "x-google-operation-name" : "BulkUploadFeedbackLabels", - "description": "Upload feedback labels from an external source in bulk.\nCurrently supports labeling Quality AI example conversations.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}:bulkDownloadFeedbackLabels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "BulkDownloadFeedbackLabels", - "description": "Download feedback labels in bulk from an external source.\nCurrently supports exporting Quality AI example conversations with\ntranscripts and question bodies.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}:bulkDownloadFeedbackLabels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "BulkDownloadFeedbackLabelsByProjectAndLocationAndDataset", - "x-google-operation-name" : "BulkDownloadFeedbackLabels", - "description": "Download feedback labels in bulk from an external source.\nCurrently supports exporting Quality AI example conversations with\ntranscripts and question bodies.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}:bulkDeleteFeedbackLabels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "BulkDeleteFeedbackLabels", - "description": "Delete feedback labels in bulk using a filter.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/datasets/{dataset}:bulkDeleteFeedbackLabels": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "BulkDeleteFeedbackLabelsByProjectAndLocationAndDataset", - "x-google-operation-name" : "BulkDeleteFeedbackLabels", - "description": "Delete feedback labels in bulk using a filter.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateAuthorizedViewSet", - "description": "Create AuthorizedViewSet", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedViewSetId", - "description": "Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final\ncomponent of the AuthorizedViewSet's resource name. If no ID is specified,\na server-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See\nhttps://google.aip.dev/122#resource-id-segments", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The AuthorizedViewSet to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListAuthorizedViewSets", - "description": "List AuthorizedViewSets", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of view sets to return in the response. If the value is\nzero, the service will select a default size. A call might return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListAuthorizedViewSetsResponse`. This value\nindicates that this is a continuation of a prior `ListAuthorizedViewSets`\ncall and that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. The filter expression to filter authorized view sets listed in the\nresponse.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "orderBy", - "description": "Optional. The order by expression to order authorized view sets listed in the\nresponse.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetAuthorizedViewSet", - "description": "Get AuthorizedViewSet", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateAuthorizedViewSet", - "description": "Updates an AuthorizedViewSet.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `display_name`", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The AuthorizedViewSet to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteAuthorizedViewSet", - "description": "Deletes an AuthorizedViewSet.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "force", - "description": "Optional. If set to true, all of this AuthorizedViewSet's child resources will also\nbe deleted. Otherwise, the request will only succeed if it has none.", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateAuthorizedView", - "description": "Create AuthorizedView", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedViewId", - "description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final\ncomponent of the AuthorizedView's resource name. If no ID is specified,\na server-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See\nhttps://google.aip.dev/122#resource-id-segments", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The AuthorizedView to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListAuthorizedViews", - "description": "List AuthorizedViewSets", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of view to return in the response. If the value is\nzero, the service will select a default size. A call might return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value\nindicates that this is a continuation of a prior `ListAuthorizedViews`\ncall and that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. The filter expression to filter authorized views listed in the response.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "orderBy", - "description": "Optional. The order by expression to order authorized views listed in the response.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetAuthorizedView", - "description": "Get AuthorizedView", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateAuthorizedView", - "description": "Updates an AuthorizedView.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `conversation_filter`\n* `display_name`", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The AuthorizedView to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteAuthorizedView", - "description": "Deletes an AuthorizedView.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews:search": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "SearchAuthorizedViews", - "description": "SearchAuthorizedViewSets", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of view to return in the response. If the value is\nzero, the service will select a default size. A call might return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value\nindicates that this is a continuation of a prior `ListAuthorizedViews`\ncall and that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "query", - "description": "Optional. The query expression to search authorized views.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "orderBy", - "description": "Optional. The order by expression to order authorized views listed in the response.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateAssessment", - "description": "Create Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The assessment to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListAssessments", - "description": "List Assessments.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of assessments to list. If zero, the service will select\na default size. A call may return fewer objects than requested. A non-empty\n`next_page_token` in the response indicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. A filter to reduce results to a specific subset.\nSupported filters include:\n\n* `state` - The state of the assessment\n* `agent_info.agent_id` - The ID of the agent the assessment is for", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAssessmentsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", - "x-google-operation-name" : "CreateAssessment", - "description": "Create Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The assessment to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListAssessmentsByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversation", - "x-google-operation-name" : "ListAssessments", - "description": "List Assessments.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "The maximum number of assessments to list. If zero, the service will select\na default size. A call may return fewer objects than requested. A non-empty\n`next_page_token` in the response indicates that more data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. A filter to reduce results to a specific subset.\nSupported filters include:\n\n* `state` - The state of the assessment\n* `agent_info.agent_id` - The ID of the agent the assessment is for", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListAssessmentsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetAssessment", - "description": "Get Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteAssessment", - "description": "Delete an Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "force", - "description": "Optional. If set to true, all of this assessment's notes will also be deleted.\nOtherwise, the request will only succeed if it has no notes.", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", - "x-google-operation-name" : "GetAssessment", - "description": "Get Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", - "x-google-operation-name" : "DeleteAssessment", - "description": "Delete an Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "force", - "description": "Optional. If set to true, all of this assessment's notes will also be deleted.\nOtherwise, the request will only succeed if it has no notes.", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}:publish": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "PublishAssessment", - "description": "Publish an Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PublishAssessmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}:publish": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "PublishAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", - "x-google-operation-name" : "PublishAssessment", - "description": "Publish an Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PublishAssessmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}:appeal": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "AppealAssessment", - "description": "Appeal an Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AppealAssessmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}:appeal": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "AppealAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", - "x-google-operation-name" : "AppealAssessment", - "description": "Appeal an Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AppealAssessmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}:finalize": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "FinalizeAssessment", - "description": "Finalize an Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}:finalize": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "FinalizeAssessmentByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", - "x-google-operation-name" : "FinalizeAssessment", - "description": "Finalize an Assessment.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateNote", - "description": "Create Note.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The note resource to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListNotes", - "description": "List Notes.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of notes to return in the response. If zero the service\nwill select a default size. A call might return fewer objects than\nrequested. A non-empty `next_page_token` in the response indicates that\nmore data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListNotesResponse`. This value indicates\nthat this is a continuation of a prior `ListNotes` call and that the system\nshould return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListNotesResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}/notes": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateNoteByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", - "x-google-operation-name" : "CreateNote", - "description": "Create Note.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The note resource to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListNotesByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessment", - "x-google-operation-name" : "ListNotes", - "description": "List Notes.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of notes to return in the response. If zero the service\nwill select a default size. A call might return fewer objects than\nrequested. A non-empty `next_page_token` in the response indicates that\nmore data is available.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListNotesResponse`. This value indicates\nthat this is a continuation of a prior `ListNotes` call and that the system\nshould return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListNotesResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateNote", - "description": "Update Note.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "note", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to be updated. If the update_mask is empty, all\nupdateable fields will be updated. Acceptable fields include:\n* `content`", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The note to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteNote", - "description": "Deletes a Note.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "note", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}/conversations/{conversation}/assessments/{assessment}/notes/{note}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateNoteByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessmentAndNote", - "x-google-operation-name" : "UpdateNote", - "description": "Update Note.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "note", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. The list of fields to be updated. If the update_mask is empty, all\nupdateable fields will be updated. Acceptable fields include:\n* `content`", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The note to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteNoteByProjectAndLocationAndAuthorizedviewsetAndAuthorizedviewAndConversationAndAssessmentAndNote", - "x-google-operation-name" : "DeleteNote", - "description": "Deletes a Note.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "conversation", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "assessment", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "note", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/dashboards": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateDashboard", - "description": "Creates a Dashboard.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dashboardId", - "description": "Optional. A unique ID for the new Dashboard. This ID will become the final\ncomponent of the Dashboard's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The dashboard to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListDashboards", - "description": "Lists Dashboards.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of dashboards to return. The service may return fewer\nthan this value.\nThe default and maximum value is 100.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListDashboardsResponse`. This value\nindicates that this is a continuation of a prior `ListDashboards` call\nand that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. The filter expression to filter dashboards listed in the response.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "orderBy", - "description": "Optional. The order by expression to order dashboards listed in the response.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDashboardsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/dashboards/{dashboard}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetDashboard", - "description": "Gets a Dashboard.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dashboard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateDashboard", - "description": "Updates a Dashboard.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dashboard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. List of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `display_name`\n* `root_container`", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The dashboard to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteDashboard", - "description": "Deletes a Dashboard.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dashboard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/dashboards/{dashboard}/charts": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateChart", - "description": "Creates a Chart.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dashboard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "chartId", - "description": "Optional. A unique ID for the new Chart. This ID will become the final\ncomponent of the Chart's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The chart to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListCharts", - "description": "Lists Charts.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dashboard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListChartsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetChart", - "description": "Gets a Chart.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dashboard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "chart", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateChart", - "description": "Updates a Chart.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dashboard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "chart", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. List of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `display_name`", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The chart to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteChart", - "description": "Deletes a Chart.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "dashboard", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "chart", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListDiscoveryWorkspaces", - "description": "Lists DiscoveryWorkspaces.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of discovery workspaces to return. The service may\nreturn fewer than this value.\nThe default and maximum value is 100.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListDiscoveryWorkspacesResponse`. This\nvalue indicates that this is a continuation of a prior\n`ListDiscoveryWorkspaces` call and that the system should return the next\npage of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. The filter expression to filter discovery workspaces listed in the\nresponse. Filter should adhere to https://google.aip.dev/160. Supported\nfilter fields:\n- `display_name`: returns discovery workspaces with root discovery display\nname equal to value.\n- `language_code`: returns discovery workspaces with root discovery\nlanguage code equal to value.\n- `deployment_spec`: returns discovery workspaces with deployment spec\ndisplay name equal to value.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDiscoveryWorkspacesResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetDiscoveryWorkspace", - "description": "Gets a DiscoveryWorkspace.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspace" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteDiscoveryWorkspace", - "description": "Deletes a DiscoveryWorkspace. All resources associated with the\nDiscoveryWorkspace will also be deleted.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "force", - "description": "Optional. If set to true, any child resources of this discovery workspace will also\nbe deleted. (Otherwise, the request will only work if the discovery\nworkspace has no child resources.)", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}:fetchTree": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "FetchDiscoveryWorkspaceTree", - "description": "Retrieves a DiscoveryWorkspace tree. By default, this method will return\nthe latest revision of all Discoveries in the tree starting with the\noverall root Discovery. To retrieve the tree with specific non-latest\nrevisions, specify the revision name or names as filters.\nThe .snapshot.display_name field of all discovery revisions in the response\nwill be populated with the display name of parent discovery at its latest\nstate.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryRevisionFilter", - "description": "Optional. Optional filter to specify which revision(s) of the tree's Discoveries to\ninclude. If empty, the latest revision of each Discovery in the tree will\nbe used. Accepts the suffix \"/revisions/latest\".", - "in": "query", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FetchDiscoveryWorkspaceTreeResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}:deploy": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "DeployDiscoveryWorkspace", - "description": "Deploys a Discovery tree in a DiscoveryWorkspace for live inference. The\ndiscovery workspace will have the discoveryWorkspace.deployment_spec\npopulated with the deployed discovery revisions. An optional rediscovery\nschedule can be specified that will periodically regenerate the deployed\ndiscovery tree and use it to update the deployment spec.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployDiscoveryWorkspaceRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployDiscoveryWorkspaceResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}:undeploy": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "UndeployDiscoveryWorkspace", - "description": "Undeploys a Discovery tree in a DiscoveryWorkspace for live inference.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployDiscoveryWorkspaceRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployDiscoveryWorkspaceResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces:generate": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "GenerateDiscovery", - "description": "Generates a Discovery in a DiscoveryWorkspace. The discovery could be the\ninitial discovery or a drill down discovery.\nWhen this method is called to generate the initial discovery, client can\nspecify the parent discovery workspace name with a wildcard `-` (i.e.\nprojects/123/locations/global/discoveryWorkspaces/-/discoveries:generate)\nand the discovery workspace will be automatically created with a randomly\ngenerated id.\nWhen the discovery is a drill down discovery, discovery workspace resource\nfield in request.parent must be consistent with the workspace\nresource id section in discovery.drill_down_parent.\nWhen LRO finishes, the resulting discovery will contain the initial\ndiscoveryRevision that holds the initial discovery results. This method\nwill not run simultaneously with create discovery revision LROs as create\ndiscovery revision LRO will be blocked unless the latest revision under a\ndiscovery is finalized.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries:generate": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "GenerateDiscoveryByProjectAndLocationAndDiscoveryworkspace", - "x-google-operation-name" : "GenerateDiscovery", - "description": "Generates a Discovery in a DiscoveryWorkspace. The discovery could be the\ninitial discovery or a drill down discovery.\nWhen this method is called to generate the initial discovery, client can\nspecify the parent discovery workspace name with a wildcard `-` (i.e.\nprojects/123/locations/global/discoveryWorkspaces/-/discoveries:generate)\nand the discovery workspace will be automatically created with a randomly\ngenerated id.\nWhen the discovery is a drill down discovery, discovery workspace resource\nfield in request.parent must be consistent with the workspace\nresource id section in discovery.drill_down_parent.\nWhen LRO finishes, the resulting discovery will contain the initial\ndiscoveryRevision that holds the initial discovery results. This method\nwill not run simultaneously with create discovery revision LROs as create\ndiscovery revision LRO will be blocked unless the latest revision under a\ndiscovery is finalized.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryRequest" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryOperation" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListDiscoveries", - "description": "Lists Discoveries.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of discoveries to return. The service may return fewer\nthan this value.\nThe default and maximum value is 100.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListDiscoveriesResponse`. This value\nindicates that this is a continuation of a prior `ListDiscoveries` call\nand that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. The filter expression to filter discoveries listed in the response.\n## Supported filters:\n\n\u201Dcontains(\u2018project/../locations/../discoveryWorkspaces/../discoveries/../revisions/\u2026\u2019)\u201D\nreturns all discoveries in the discovery tree (linked by\nDiscovery.drill_down_parent and DiscoveryResult.drill_down_children\nfields) where the specified revision is a member of.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDiscoveriesResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries/{discovery}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetDiscovery", - "description": "Gets a Discovery.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discovery", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" - } - } - } - } - } - }, - "delete": { - "tags": ["contactcenterinsights"], - "operationId": "DeleteDiscovery", - "description": "Deletes a Discovery.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discovery", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "force", - "description": "Optional. If set to true, any child resources of this discovery will also be\ndeleted. (Otherwise, the request will only work if the discovery has no\nchild resources.)", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - } - } - }, - "patch": { - "tags": ["contactcenterinsights"], - "operationId": "UpdateDiscovery", - "description": "Updates a Discovery.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discovery", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "updateMask", - "description": "Optional. List of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `description`\n* `display_name`", - "in": "query", - "schema": { - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - ], - "requestBody": { - "description": "Required. The discovery to update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries/{discovery}/revisions": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights"], - "operationId": "CreateDiscoveryRevision", - "description": "Creates a DiscoveryRevision. This is used to refine the Discovery's head\nrevision with feedbacks. This method expect feedbacks passed into\ndiscovery_revision to be finalized.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discovery", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryRevisionId", - "description": "Optional. The ID of the discovery revision to create.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Required. The discovery revision to create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" - } - } - } - }, - "x-google-lro" : "true", - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionOperation" - } - } - } - } - } - }, - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListDiscoveryRevisions", - "description": "List discovery revisions.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discovery", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of discovery revisions to return. The service may\nreturn fewer than this value.\nThe default and maximum value is 100.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListDiscoveryRevisionsResponse`. This value\nindicates that this is a continuation of a prior `ListDiscoveryRevisions`\ncall and that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. The filter expression to filter discovery revisions listed in the response.\nSupported filters:\n* \u201Dcontains(\u2018project/../locations/../discoveryWorkspaces/../discoveries/../revisions/\u2026\u2019)\u201D\n returns all discovery revisions in the discovery tree (linked by\n Discovery.drill_down_parent and DiscoveryResult.drill_down_children\n fields) where the specified revision is a member.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDiscoveryRevisionsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries/{discovery}/revisions/{revision}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetDiscoveryRevision", - "description": "Get a discovery result revision.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discovery", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries/{discovery}/revisions/{revision}/results": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "ListDiscoveryResults", - "description": "List discovery result entries.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discovery", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "description": "Optional. The maximum number of discovery results to return. The service may return\nfewer than this value. The default and maximum value is 100.", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageToken", - "description": "Optional. The value returned by the last `ListDiscoveryResultsResponse`. This value\nindicates that this is a continuation of a prior `ListDiscoveryResults`\ncall and that the system should return the next page of data.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "description": "Optional. The filter expression to filter discovery results listed in the response.\nSupported filters:\n* \u201Dcontains(\u2018project/../locations/../discoveryWorkspaces/../discoveries/../revisions/../results/\u2026\u2019)\u201D\n returns all discovery results in the discovery tree (linked by\n Discovery.drill_down_parent and DiscoveryResult.drill_down_children\n fields) where the specified revision is a member.", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ListDiscoveryResultsResponse" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/discoveryWorkspaces/{discoveryworkspace}/discoveries/{discovery}/revisions/{revision}/results/{result}": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights"], - "operationId": "GetDiscoveryResult", - "description": "Get a discovery result.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discoveryworkspace", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discovery", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "revision", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "result", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryResult" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:setIamPolicy": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights", "SetIamPolicy"], - "operationId": "SetIamPolicy", - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleIamV1SetIamPolicyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleIamV1Policy" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:getIamPolicy": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "get": { - "tags": ["contactcenterinsights", "GetIamPolicy"], - "operationId": "GetIamPolicy", - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "options.requestedPolicyVersion", - "description": "Optional. The maximum policy version that will be used to format the\npolicy.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional role bindings must specify\nversion 3. Policies with no conditional role bindings may specify any valid\nvalue or leave the field unset.\n\nThe policy in the response might use the policy version that you specified,\nor it might use a lower policy version. For example, if you specify version\n3, but the policy has no conditional role bindings, the response uses\nversion 1.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleIamV1Policy" - } - } - } - } - } - } - }, - "/v1/projects/{project}/locations/{location}/authorizedViewSets/{authorizedviewset}/authorizedViews/{authorizedview}:testIamPermissions": { - "parameters": [ - { "$ref": "#/components/parameters/alt"}, - { "$ref": "#/components/parameters/callback"}, - { "$ref": "#/components/parameters/prettyPrint"}, - { "$ref": "#/components/parameters/_.xgafv"} - ], - "post": { - "tags": ["contactcenterinsights", "TestIamPermissions"], - "operationId": "TestIamPermissions", - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", - "security": [ - { - "google_oauth_implicit": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "google_oauth_code": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - { - "bearer_auth": [] - } - ], - "parameters": [ - { - "name": "project", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "location", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedviewset", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "authorizedview", - "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleIamV1TestIamPermissionsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GoogleIamV1TestIamPermissionsResponse" - } - } - } - } - } - } - } - }, - "components": { - "parameters": { - "alt": { - "name": "$alt", - "description": "Data format for response.", - "schema": { - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "x-google-enum-descriptions": [ - "Responses with Content-Type of application/json", - "Media download with context-dependent Content-Type", - "Responses with Content-Type of application/x-protobuf" - ], - "type": "string" - }, - "in": "query" - }, - "callback": { - "name": "$callback", - "description": "JSONP", - "schema": { - "type": "string" - }, - "in": "query" - }, - "prettyPrint": { - "name": "$prettyPrint", - "description": "Returns response with indentations and line breaks.", - "schema": { - "default": "true", - "type": "boolean" - }, - "in": "query" - }, - "_.xgafv": { - "name": "$.xgafv", - "description": "V1 error format.", - "schema": { - "enum": [ - "1", - "2" - ], - "x-google-enum-descriptions": [ - "v1 error format", - "v2 error format" - ], - "type": "string" - }, - "in": "query" - } - }, - "securitySchemes": { - "google_oauth_implicit": { - "type": "oauth2", - "description": "Google Oauth 2.0 implicit authentication flow.", - "flows": { - "implicit": { - "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." - } - } - } - }, - "google_oauth_code": { - "type": "oauth2", - "description": "Google Oauth 2.0 authorizationCode authentication flow.", - "flows": { - "authorizationCode": { - "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", - "tokenUrl": "https://oauth2.googleapis.com/token", - "refreshUrl": "https://oauth2.googleapis.com/token", - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." - } - } - } - }, - "bearer_auth": { - "type": "http", - "description": "Http bearer authentication.", - "scheme": "bearer" - } - }, - "schemas": { - "GoogleLongrunningListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", - "properties": { - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleLongrunningOperation" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - }, - "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets\n`ListOperationsRequest.return_partial_success` and reads across\ncollections. For example, when attempting to list all resources across all\nsupported locations.", - "x-google-unordered-list": true, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleRpcStatus": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", - "type": "object", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "type": "integer", - "format": "int32" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", - "type": "string" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL." - } - } - } - } - }, - "GoogleProtobufEmpty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1Conversation": { - "description": "The conversation resource.", - "type": "object", - "properties": { - "callMetadata": { - "description": "Call-specific metadata.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata" - }] - }, - "expireTime": { - "description": "The time at which this conversation should expire. After this time, the\nconversation data and any associated analyses will be deleted.", - "type": "string", - "format": "date-time" - }, - "ttl": { - "description": "Input only. The TTL for this resource. If specified, then this TTL will\nbe used to calculate the expire time.", - "writeOnly": true, - "type": "string", - "format": "google-duration" - }, - "name": { - "description": "Immutable. The resource name of the conversation.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}", - "x-google-immutable": true, - "type": "string" - }, - "dataSource": { - "description": "The source of the audio and transcription for the conversation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource" - }] - }, - "createTime": { - "description": "Output only. The time at which the conversation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the conversation was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "startTime": { - "description": "The time at which the conversation started.", - "type": "string", - "format": "date-time" - }, - "languageCode": { - "description": "A user-specified language code for the conversation.", - "type": "string" - }, - "agentId": { - "description": "An opaque, user-specified string representing the human agent who handled\nthe conversation.", - "type": "string" - }, - "customerId": { - "description": "An opaque, user-specified string representing the customer identifier.", - "type": "string" - }, - "labels": { - "description": "A map for the user to specify any custom fields. A maximum of 100 labels\nper conversation is allowed, with a maximum of 256 characters per entry.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "qualityMetadata": { - "description": "Conversation metadata related to quality management.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata" - }] - }, - "metadataJson": { - "description": "Input only. JSON metadata encoded as a string.\nThis field is primarily used by Insights integrations with various\ntelephony systems and must be in one of Insight's supported formats.", - "writeOnly": true, - "type": "string" - }, - "transcript": { - "description": "Output only. The conversation transcript.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript" - }] - }, - "medium": { - "description": "Immutable. The conversation medium.", - "x-google-immutable": true, - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "The format for conversations that took place over the phone.", - "The format for conversations that took place over chat." - ], - "enum": [ - "MEDIUM_UNSPECIFIED", - "PHONE_CALL", - "CHAT" - ] - }, - "duration": { - "description": "Output only. The duration of the conversation.", - "readOnly": true, - "type": "string", - "format": "google-duration" - }, - "turnCount": { - "description": "Output only. The number of turns in the conversation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "latestAnalysis": { - "description": "Output only. The conversation's latest analysis, if one exists.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis" - }] - }, - "latestSummary": { - "description": "Output only. Latest summary of the conversation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" - }] - }, - "runtimeAnnotations": { - "description": "Output only. The annotations that were generated during the customer and agent\ninteraction.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation" - } - }, - "dialogflowIntents": { - "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a\nDialogflow intent, format:\nprojects/{project}/agent/{agent}/intents/{intent}", - "readOnly": true, - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent" - } - }, - "obfuscatedUserId": { - "description": "Obfuscated user ID which the customer sent to us.", - "type": "string" - }, - "dialogflowCxConversationData": { - "description": "The Dialogflow conversation raw data. It will only be populated when\nConversationView is DF_CONVERSATION_BASIC or DF_CONVERSATION_FULL.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowCxConversationData" - }] - }, - "aaSupervisorMonitoringStatus": { - "description": "Output only. Data from the monitoring status of a conversation by a human supervisor in\nAA. A human supervisor is a human agent that is monitoring virtual agent\nconversations.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationAgentAssistSupervisorMonitoringStatus" - }] - }, - "correlationInfo": { - "description": "Output only. Info for correlating across conversations.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationCallMetadata": { - "description": "Call-specific metadata.", - "type": "object", - "properties": { - "customerChannel": { - "description": "The audio channel that contains the customer.", - "type": "integer", - "format": "int32" - }, - "agentChannel": { - "description": "The audio channel that contains the agent.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationDataSource": { - "description": "The conversation source, which is a combination of transcript and audio.", - "type": "object", - "properties": { - "gcsSource": { - "description": "A Cloud Storage location specification for the audio and transcript.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource" - }] - }, - "dialogflowSource": { - "description": "The source when the conversation comes from Dialogflow.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource" - }] - }, - "metadataUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation\nmetadata.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1GcsSource": { - "description": "A Cloud Storage source of conversation data.", - "type": "object", - "properties": { - "audioUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", - "type": "string" - }, - "transcriptUri": { - "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation\ntranscript.", - "x-google-immutable": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DialogflowSource": { - "description": "A Dialogflow source of conversation data.", - "type": "object", - "properties": { - "dialogflowConversation": { - "description": "Output only. The name of the Dialogflow conversation that this conversation\nresource is derived from. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}", - "readOnly": true, - "type": "string" - }, - "audioUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata": { - "description": "Conversation metadata related to quality management.", - "type": "object", - "properties": { - "customerSatisfactionRating": { - "description": "An arbitrary integer value indicating the customer's satisfaction rating.", - "type": "integer", - "format": "int32" - }, - "waitDuration": { - "description": "The amount of time the customer waited to connect with an agent.", - "type": "string", - "format": "google-duration" - }, - "menuPath": { - "description": "An arbitrary string value specifying the menu path the customer took.", - "type": "string" - }, - "agentInfo": { - "description": "Information about agents involved in the call.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" - } - }, - "feedbackLabels": { - "description": "Input only. The feedback labels associated with the conversation.", - "writeOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo": { - "description": "Information about an agent involved in the conversation.", - "type": "object", - "properties": { - "agentId": { - "description": "A user-specified string representing the agent.", - "type": "string" - }, - "displayName": { - "description": "The agent's name.", - "type": "string" - }, - "team": { - "description": "A user-specified string representing the agent's team. Deprecated in\nfavor of the `teams` field.", - "deprecated": true, - "type": "string" - }, - "teams": { - "description": "User-specified strings representing the agent's teams.", - "type": "array", - "items": { - "type": "string" - } - }, - "dispositionCode": { - "description": "A user-provided string indicating the outcome of the agent's segment of\nthe call.", - "type": "string" - }, - "agentType": { - "description": "The agent type, e.g. HUMAN_AGENT.", - "type": "string", - "x-google-enum-descriptions": [ - "Participant's role is not set.", - "Participant is a human agent.", - "Participant is an automated agent.", - "Participant is an end user who conversed with the contact center.", - "Participant is either a human or automated agent." - ], - "enum": [ - "ROLE_UNSPECIFIED", - "HUMAN_AGENT", - "AUTOMATED_AGENT", - "END_USER", - "ANY_AGENT" - ] - }, - "location": { - "description": "The agent's location.", - "type": "string" - }, - "deploymentId": { - "description": "The agent's deployment ID. Only applicable to automated agents.", - "type": "string" - }, - "deploymentDisplayName": { - "description": "The agent's deployment display name. Only applicable to automated\nagents.", - "type": "string" - }, - "versionId": { - "description": "The agent's version ID. Only applicable to automated agents.", - "type": "string" - }, - "versionDisplayName": { - "description": "The agent's version display name. Only applicable to automated agents.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1FeedbackLabel": { - "description": "Represents a conversation, resource, and label provided by the user.\nCan take the form of a string label or a QaAnswer label.\nQaAnswer labels are used for Quality AI example conversations.\nString labels are used for Topic Modeling.\nAgentAssistSummary labels are used for Agent Assist Summarization.", - "type": "object", - "properties": { - "label": { - "description": "String label used for Topic Modeling.", - "type": "string" - }, - "qaAnswerLabel": { - "description": "QaAnswer label used for Quality AI example conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" - }] - }, - "name": { - "description": "Immutable. Resource name of the FeedbackLabel.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", - "x-google-immutable": true, - "type": "string" - }, - "labeledResource": { - "description": "Name of the resource to be labeled.\nSupported resources are:\n\n* `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}`\n* `projects/{project}/locations/{location}/issueModels/{issue_model}`\n* `projects/{project}/locations/{location}/generators/{generator_id}`", - "type": "string" - }, - "createTime": { - "description": "Output only. Create time of the label.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. Update time of the label.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue": { - "description": "Message for holding the value of a QaAnswer.\nQaQuestion.AnswerChoice defines the possible answer values for a\nquestion.", - "type": "object", - "properties": { - "strValue": { - "description": "String value.", - "type": "string" - }, - "numValue": { - "description": "Numerical value.", - "type": "number", - "format": "double" - }, - "boolValue": { - "description": "Boolean value.", - "type": "boolean" - }, - "naValue": { - "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", - "type": "boolean" - }, - "skipValue": { - "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`.\nIf a question receives this answer, it will be excluded from any score\ncalculations. This would mean that the question was not evaluated.", - "readOnly": true, - "type": "boolean" - }, - "key": { - "description": "A short string used as an identifier. Matches the value used in\nQaQuestion.AnswerChoice.key.", - "type": "string" - }, - "score": { - "description": "Output only. Numerical score of the answer.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "Output only. The maximum potential score of the question.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "rationale": { - "description": "Output only. The rationale for the answer. This field is only populated for answers\nthat are generated by the LLM. Manual edits currently do not have\nrationales.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale": { - "description": "Wrapper for the rationale for the answer.", - "type": "object", - "properties": { - "rationale": { - "description": "The rationale string for the answer.", - "type": "string" - }, - "rationaleSource": { - "description": "The source of the rationale. A manual edit AnswerValue could still\ncontain a system generated rationale if user didn't provide one. Manual\nedit would override the system generated rationale.", - "type": "string", - "x-google-enum-descriptions": [ - "The rationale source is unspecified. This value should generally not\nbe used.", - "The rationale is system generated.", - "The rationale is manually added by the user." - ], - "enum": [ - "RATIONALE_SOURCE_UNSPECIFIED", - "RATIONALE_SOURCE_SYSTEM_GENERATED", - "RATIONALE_SOURCE_MANUAL_EDIT" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationTranscript": { - "description": "A message representing the transcript of a conversation.", - "type": "object", - "properties": { - "transcriptSegments": { - "description": "A list of sequential transcript segments that comprise the conversation.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment": { - "description": "A segment of a full transcript.", - "type": "object", - "properties": { - "messageTime": { - "description": "The time that the message occurred, if provided.", - "type": "string", - "format": "date-time" - }, - "text": { - "description": "The text of this segment.", - "type": "string" - }, - "confidence": { - "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nsegment. A default value of 0.0 indicates that the value is unset.", - "type": "number", - "format": "float" - }, - "words": { - "description": "A list of the word-specific information for each word in the segment.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" - } - }, - "languageCode": { - "description": "The language code of this segment as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".", - "type": "string" - }, - "channelTag": { - "description": "For conversations derived from multi-channel audio, this is the channel\nnumber corresponding to the audio from that channel. For\naudioChannelCount = N, its output values can range from '1' to 'N'. A\nchannel tag of 0 indicates that the audio is mono.", - "type": "integer", - "format": "int32" - }, - "segmentParticipant": { - "description": "The participant of this segment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant" - }] - }, - "dialogflowSegmentMetadata": { - "description": "CCAI metadata relating to the current transcript segment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" - }] - }, - "sentiment": { - "description": "The sentiment for this transcript segment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo": { - "description": "Word-level info for words in a transcript.", - "type": "object", - "properties": { - "startOffset": { - "description": "Time offset of the start of this word relative to the beginning of\nthe total conversation.", - "type": "string", - "format": "google-duration" - }, - "endOffset": { - "description": "Time offset of the end of this word relative to the beginning of the\ntotal conversation.", - "type": "string", - "format": "google-duration" - }, - "word": { - "description": "The word itself. Includes punctuation marks that surround the word.", - "type": "string" - }, - "confidence": { - "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nword. A default value of 0.0 indicates that the value is unset.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationParticipant": { - "description": "The call participant speaking for a given utterance.", - "type": "object", - "properties": { - "dialogflowParticipantName": { - "description": "The name of the participant provided by Dialogflow. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", - "type": "string" - }, - "userId": { - "description": "A user-specified ID representing the participant.", - "type": "string" - }, - "dialogflowParticipant": { - "description": "Deprecated. Use `dialogflow_participant_name` instead.\nThe name of the Dialogflow participant. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", - "deprecated": true, - "type": "string" - }, - "obfuscatedExternalUserId": { - "description": "Obfuscated user ID from Dialogflow.", - "type": "string" - }, - "role": { - "description": "The role of the participant.", - "type": "string", - "x-google-enum-descriptions": [ - "Participant's role is not set.", - "Participant is a human agent.", - "Participant is an automated agent.", - "Participant is an end user who conversed with the contact center.", - "Participant is either a human or automated agent." - ], - "enum": [ - "ROLE_UNSPECIFIED", - "HUMAN_AGENT", - "AUTOMATED_AGENT", - "END_USER", - "ANY_AGENT" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { - "description": "Metadata from Dialogflow relating to the current transcript segment.", - "type": "object", - "properties": { - "smartReplyAllowlistCovered": { - "description": "Whether the transcript segment was covered under the configured smart\nreply allowlist in Agent Assist.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1SentimentData": { - "description": "The data for a sentiment annotation.", - "type": "object", - "properties": { - "magnitude": { - "description": "A non-negative number from 0 to infinity which represents the absolute\nmagnitude of sentiment regardless of score.", - "type": "number", - "format": "float" - }, - "score": { - "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", - "type": "number", - "format": "float" - }, - "rationale": { - "description": "The rationale for the sentiment result.", - "type": "string" - }, - "modelType": { - "description": "The sentiment model used to produce the sentiment result.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified model type.", - "V1 model.", - "V2 LLM model." - ], - "enum": [ - "SENTIMENT_MODEL_TYPE_UNSPECIFIED", - "SENTIMENT_MODEL_TYPE_V1", - "SENTIMENT_MODEL_TYPE_V2" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1Analysis": { - "description": "The analysis resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the analysis.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", - "x-google-immutable": true, - "type": "string" - }, - "requestTime": { - "description": "Output only. The time at which the analysis was requested.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "createTime": { - "description": "Output only. The time at which the analysis was created, which occurs when the\nlong-running operation completes.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "analysisResult": { - "description": "Output only. The result of the analysis, which is populated when the analysis\nfinishes.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult" - }] - }, - "annotatorSelector": { - "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1AnalysisResult": { - "description": "The result of an analysis.", - "type": "object", - "properties": { - "callAnalysisMetadata": { - "description": "Call-specific metadata created by the analysis.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata" - }] - }, - "endTime": { - "description": "The time at which the analysis ended.", - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { - "description": "Call-specific metadata created during analysis.", - "type": "object", - "properties": { - "annotations": { - "description": "A list of call annotations that apply to this call.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation" - } - }, - "entities": { - "description": "All the entities in the call.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Entity" - } - }, - "sentiments": { - "description": "Overall conversation-level sentiment for each channel of the call.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" - } - }, - "silence": { - "description": "Overall conversation-level silence during the call.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence" - }] - }, - "intents": { - "description": "All the matched intents in the call.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Intent" - } - }, - "phraseMatchers": { - "description": "All the matched phrase matchers in the call.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData" - } - }, - "issueModelResult": { - "description": "Overall conversation-level issue modeling result.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelResult" - }] - }, - "semanticMatchMetadata": { - "description": "Metadata used in the semantic match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SemanticMatchMetadata" - }] - }, - "qaScorecardResults": { - "description": "Results of scoring QaScorecards.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1CallAnnotation": { - "description": "A piece of metadata that applies to a window of a call.", - "type": "object", - "properties": { - "interruptionData": { - "description": "Data specifying an interruption.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData" - }] - }, - "sentimentData": { - "description": "Data specifying sentiment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData" - }] - }, - "silenceData": { - "description": "Data specifying silence.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData" - }] - }, - "holdData": { - "description": "Data specifying a hold.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData" - }] - }, - "entityMentionData": { - "description": "Data specifying an entity mention.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData" - }] - }, - "intentMatchData": { - "description": "Data specifying an intent match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData" - }] - }, - "phraseMatchData": { - "description": "Data specifying a phrase match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData" - }] - }, - "issueMatchData": { - "description": "Data specifying an issue match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData" - }] - }, - "channelTag": { - "description": "The channel of the audio where the annotation occurs. For single-channel\naudio, this field is not populated.", - "type": "integer", - "format": "int32" - }, - "annotationStartBoundary": { - "description": "The boundary in the conversation where the annotation starts, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary" - }] - }, - "annotationEndBoundary": { - "description": "The boundary in the conversation where the annotation ends, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1InterruptionData": { - "description": "The data for an interruption annotation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1SilenceData": { - "description": "The data for a silence annotation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1HoldData": { - "description": "The data for a hold annotation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1EntityMentionData": { - "description": "The data for an entity mention annotation.\nThis represents a mention of an `Entity` in the conversation.", - "type": "object", - "properties": { - "entityUniqueId": { - "description": "The key of this entity in conversation entities.\nCan be used to retrieve the exact `Entity` this mention is attached to.", - "type": "string" - }, - "type": { - "description": "The type of the entity mention.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Proper noun.", - "Common noun (or noun compound)." - ], - "enum": [ - "MENTION_TYPE_UNSPECIFIED", - "PROPER", - "COMMON" - ] - }, - "sentiment": { - "description": "Sentiment expressed for this mention of the entity.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1IntentMatchData": { - "description": "The data for an intent match.\nRepresents an intent match for a text segment in the conversation. A text\nsegment can be part of a sentence, a complete sentence, or an utterance\nwith multiple sentences.", - "type": "object", - "properties": { - "intentUniqueId": { - "description": "The id of the matched intent.\nCan be used to retrieve the corresponding intent information.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1PhraseMatchData": { - "description": "The data for a matched phrase matcher.\nRepresents information identifying a phrase matcher for a given match.", - "type": "object", - "properties": { - "phraseMatcher": { - "description": "The unique identifier (the resource name) of the phrase matcher.", - "type": "string" - }, - "displayName": { - "description": "The human-readable name of the phrase matcher.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1IssueMatchData": { - "description": "The data for an issue match annotation.", - "type": "object", - "properties": { - "issueAssignment": { - "description": "Information about the issue's assignment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1IssueAssignment": { - "description": "Information about the issue.", - "type": "object", - "properties": { - "issue": { - "description": "Resource name of the assigned issue.", - "type": "string" - }, - "score": { - "description": "Score indicating the likelihood of the issue assignment.\ncurrently bounded on [0,1].", - "type": "number", - "format": "double" - }, - "displayName": { - "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis\nand immutable since then.", - "x-google-immutable": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1AnnotationBoundary": { - "description": "A point in a conversation that marks the start or the end of an annotation.", - "type": "object", - "properties": { - "wordIndex": { - "description": "The word index of this boundary with respect to the first word in the\ntranscript piece. This index starts at zero.", - "type": "integer", - "format": "int32" - }, - "transcriptIndex": { - "description": "The index in the sequence of transcribed pieces of the conversation where\nthe boundary is located. This index starts at zero.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1Entity": { - "description": "The data for an entity annotation.\nRepresents a phrase in the conversation that is a known entity, such\nas a person, an organization, or location.", - "type": "object", - "properties": { - "displayName": { - "description": "The representative name for the entity.", - "type": "string" - }, - "type": { - "description": "The entity type.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Person.", - "Location.", - "Organization.", - "Event.", - "Artwork.", - "Consumer product.", - "Other types of entities.", - "Phone number.\n\nThe metadata lists the phone number (formatted according to local\nconvention), plus whichever additional elements appear in the text:\n\n* `number` - The actual number, broken down into sections according to\nlocal convention.\n* `national_prefix` - Country code, if detected.\n* `area_code` - Region or area code, if detected.\n* `extension` - Phone extension (to be dialed after connection), if\ndetected.", - "Address.\n\nThe metadata identifies the street number and locality plus whichever\nadditional elements appear in the text:\n\n* `street_number` - Street number.\n* `locality` - City or town.\n* `street_name` - Street/route name, if detected.\n* `postal_code` - Postal code, if detected.\n* `country` - Country, if detected.\n* `broad_region` - Administrative area, such as the state, if detected.\n* `narrow_region` - Smaller administrative area, such as county, if\ndetected.\n* `sublocality` - Used in Asian addresses to demark a district within a\ncity, if detected.", - "Date.\n\nThe metadata identifies the components of the date:\n\n* `year` - Four digit year, if detected.\n* `month` - Two digit month number, if detected.\n* `day` - Two digit day number, if detected.", - "Number.\n\nThe metadata is the number itself.", - "Price.\n\nThe metadata identifies the `value` and `currency`." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "PERSON", - "LOCATION", - "ORGANIZATION", - "EVENT", - "WORK_OF_ART", - "CONSUMER_GOOD", - "OTHER", - "PHONE_NUMBER", - "ADDRESS", - "DATE", - "NUMBER", - "PRICE" - ] - }, - "metadata": { - "description": "Metadata associated with the entity.\n\nFor most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)\nand Knowledge Graph MID (`mid`), if they are available. For the metadata\nassociated with other entity types, see the Type table below.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "salience": { - "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.", - "type": "number", - "format": "float" - }, - "sentiment": { - "description": "The aggregate sentiment expressed for this entity in the conversation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment": { - "description": "One channel of conversation-level sentiment data.", - "type": "object", - "properties": { - "channelTag": { - "description": "The channel of the audio that the data applies to.", - "type": "integer", - "format": "int32" - }, - "sentimentData": { - "description": "Data specifying sentiment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationLevelSilence": { - "description": "Conversation-level silence data.", - "type": "object", - "properties": { - "silenceDuration": { - "description": "Amount of time calculated to be in silence.", - "type": "string", - "format": "google-duration" - }, - "silencePercentage": { - "description": "Percentage of the total conversation spent in silence.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudContactcenterinsightsV1Intent": { - "description": "The data for an intent.\nRepresents a detected intent in the conversation, for example MAKES_PROMISE.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the intent.", - "type": "string" - }, - "displayName": { - "description": "The human-readable name of the intent.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1IssueModelResult": { - "description": "Issue Modeling result on a conversation.", - "type": "object", - "properties": { - "issueModel": { - "description": "Issue model that generates the result.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", - "type": "string" - }, - "issues": { - "description": "All the matched issues.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1SemanticMatchMetadata": { - "description": "Semantic match metadata used in an analysis.", - "type": "object", - "properties": { - "issueModel": { - "description": "Issue model that's used in the semantic match.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1QaScorecardResult": { - "description": "The results of scoring a single conversation against a QaScorecard. Contains\na collection of QaAnswers and aggregate score.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The name of the scorecard result.\nFormat:\nprojects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", - "x-google-identifier": true, - "type": "string" - }, - "qaScorecardRevision": { - "description": "The QaScorecardRevision scored by this result.", - "type": "string" - }, - "conversation": { - "description": "The conversation scored by this result.", - "type": "string" - }, - "createTime": { - "description": "Output only. The timestamp that the revision was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "agentId": { - "description": "ID of the agent that handled the conversation.", - "type": "string" - }, - "qaAnswers": { - "description": "Set of QaAnswers represented in the result.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswer" - } - }, - "score": { - "description": "The overall numerical score of the result, incorporating any manual edits\nif they exist.", - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "The normalized score, which is the score divided by the potential score.\nAny manual edits are included if they exist.", - "type": "number", - "format": "double" - }, - "qaTagResults": { - "description": "Collection of tags and their scores.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" - } - }, - "scoreSources": { - "description": "List of all individual score sets.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1QaAnswer": { - "description": "An answer to a QaQuestion.", - "type": "object", - "properties": { - "qaQuestion": { - "description": "The QaQuestion answered by this answer.", - "type": "string" - }, - "conversation": { - "description": "The conversation the answer applies to.", - "type": "string" - }, - "questionBody": { - "description": "Question text. E.g., \"Did the agent greet the customer?\"", - "type": "string" - }, - "answerValue": { - "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" - }] - }, - "tags": { - "description": "User-defined list of arbitrary tags. Matches the value from\nQaScorecard.ScorecardQuestion.tags. Used for grouping/organization and\nfor weighting the score of each answer.", - "type": "array", - "items": { - "type": "string" - } - }, - "answerSources": { - "description": "Lists all answer sources containing one or more answer values of a\nspecific source type, e.g., all system-generated answer sources, or all\nmanual edit answer sources.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource": { - "description": "A question may have multiple answers from varying sources, one of which\nbecomes the \"main\" answer above. AnswerSource represents each individual\nanswer.", - "type": "object", - "properties": { - "sourceType": { - "description": "What created the answer.", - "type": "string", - "x-google-enum-descriptions": [ - "Source type is unspecified.", - "Answer was system-generated; created during an Insights analysis.", - "Answer was created by a human via manual edit." - ], - "enum": [ - "SOURCE_TYPE_UNSPECIFIED", - "SYSTEM_GENERATED", - "MANUAL_EDIT" - ] - }, - "answerValue": { - "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult": { - "description": "Tags and their corresponding results.", - "type": "object", - "properties": { - "tag": { - "description": "The tag the score applies to.", - "type": "string" - }, - "score": { - "description": "The score the tag applies to.", - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "The potential score the tag applies to.", - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "The normalized score the tag applies to.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource": { - "description": "A scorecard result may have multiple sets of scores from varying sources,\none of which becomes the \"main\" answer above. A ScoreSource represents\neach individual set of scores.", - "type": "object", - "properties": { - "sourceType": { - "description": "What created the score.", - "type": "string", - "x-google-enum-descriptions": [ - "Source type is unspecified.", - "Score is derived only from system-generated answers.", - "Score is derived from both system-generated answers, and includes\nany manual edits if they exist." - ], - "enum": [ - "SOURCE_TYPE_UNSPECIFIED", - "SYSTEM_GENERATED_ONLY", - "INCLUDES_MANUAL_EDITS" - ] - }, - "score": { - "description": "The overall numerical score of the result.", - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "The normalized score, which is the score divided by the potential score.", - "type": "number", - "format": "double" - }, - "qaTagResults": { - "description": "Collection of tags and their scores.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1AnnotatorSelector": { - "description": "Selector of all available annotators and phrase matchers to run.", - "type": "object", - "properties": { - "runInterruptionAnnotator": { - "description": "Whether to run the interruption annotator.", - "type": "boolean" - }, - "runSilenceAnnotator": { - "description": "Whether to run the silence annotator.", - "type": "boolean" - }, - "runPhraseMatcherAnnotator": { - "description": "Whether to run the active phrase matcher annotator(s).", - "type": "boolean" - }, - "phraseMatchers": { - "description": "The list of phrase matchers to run. If not provided, all active phrase\nmatchers will be used. If inactive phrase matchers are provided, they will\nnot be used. Phrase matchers will be run only if\nrun_phrase_matcher_annotator is set to true. Format:\nprojects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", - "type": "array", - "items": { - "type": "string" - } - }, - "runSentimentAnnotator": { - "description": "Whether to run the sentiment annotator.", - "type": "boolean" - }, - "runEntityAnnotator": { - "description": "Whether to run the entity annotator.", - "type": "boolean" - }, - "runIntentAnnotator": { - "description": "Whether to run the intent annotator.", - "type": "boolean" - }, - "runIssueModelAnnotator": { - "description": "Whether to run the issue model annotator. A model should have already been\ndeployed for this to take effect.", - "type": "boolean" - }, - "issueModels": { - "description": "The issue model to run. If not provided, the most recently deployed topic\nmodel will be used. The provided issue model will only be used for\ninference if the issue model is deployed and if run_issue_model_annotator\nis set to true. If more than one issue model is provided, only the first\nprovided issue model will be used for inference.", - "type": "array", - "items": { - "type": "string" - } - }, - "runSummarizationAnnotator": { - "description": "Whether to run the summarization annotator.", - "type": "boolean" - }, - "summarizationConfig": { - "description": "Configuration for the summarization annotator.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig" - }] - }, - "runQaAnnotator": { - "description": "Whether to run the QA annotator.", - "type": "boolean" - }, - "qaConfig": { - "description": "Configuration for the QA annotator.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig": { - "description": "Configuration for summarization.", - "type": "object", - "properties": { - "conversationProfile": { - "description": "Resource name of the Dialogflow conversation profile.\nFormat:\nprojects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", - "type": "string" - }, - "summarizationModel": { - "description": "Default summarization model to be used.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified summarization model.", - "The CCAI baseline model. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead.", - "The CCAI baseline model, V2.0. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead." - ], - "x-google-enum-deprecated": [ - false, - true, - true - ], - "enum": [ - "SUMMARIZATION_MODEL_UNSPECIFIED", - "BASELINE_MODEL", - "BASELINE_MODEL_V2_0" - ] - }, - "generator": { - "description": "The resource name of the existing created generator. Format:\nprojects//locations//generators/", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig": { - "description": "Configuration for the QA feature.", - "type": "object", - "properties": { - "scorecardList": { - "description": "A manual list of scorecards to score.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList": { - "description": "Container for a list of scorecards.", - "type": "object", - "properties": { - "qaScorecardRevisions": { - "description": "List of QaScorecardRevisions.", - "type": "array", - "items": { - "type": "string" - } - }, - "predefinedQaScorecards": { - "description": "List of predefined scorecards.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PredefinedQaScorecardType" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData": { - "description": "Conversation summarization suggestion data.", - "type": "object", - "properties": { - "text": { - "description": "The summarization content that is concatenated into one string.", - "type": "string" - }, - "textSections": { - "description": "The summarization content that is divided into sections. The key is the\nsection's name and the value is the section's content. There is no\nspecific format for the key or value.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "confidence": { - "description": "The confidence score of the summarization.", - "type": "number", - "format": "float" - }, - "metadata": { - "description": "A map that contains metadata about the summarization and the document\nfrom which it originates.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "answerRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - }, - "conversationModel": { - "description": "The name of the model that generates this summary.\nFormat:\nprojects/{project}/locations/{location}/conversationModels/{conversation_model}", - "type": "string" - }, - "generatorId": { - "description": "Agent Assist generator ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1RuntimeAnnotation": { - "description": "An annotation that was generated during the customer and agent interaction.", - "type": "object", - "properties": { - "articleSuggestion": { - "description": "Agent Assist Article Suggestion data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ArticleSuggestionData" - }] - }, - "faqAnswer": { - "description": "Agent Assist FAQ answer data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData" - }] - }, - "smartReply": { - "description": "Agent Assist Smart Reply data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData" - }] - }, - "smartComposeSuggestion": { - "description": "Agent Assist Smart Compose suggestion data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData" - }] - }, - "dialogflowInteraction": { - "description": "Dialogflow interaction data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData" - }] - }, - "conversationSummarizationSuggestion": { - "description": "Conversation summarization suggestion data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" - }] - }, - "annotationId": { - "description": "The unique identifier of the annotation.\nFormat:\nprojects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", - "type": "string" - }, - "createTime": { - "description": "The time at which this annotation was created.", - "type": "string", - "format": "date-time" - }, - "startBoundary": { - "description": "The boundary in the conversation where the annotation starts, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary" - }] - }, - "endBoundary": { - "description": "The boundary in the conversation where the annotation ends, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary" - }] - }, - "answerFeedback": { - "description": "The feedback that the customer has about the answer in `data`.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback" - }] - }, - "userInput": { - "description": "Explicit input used for generating the answer", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ArticleSuggestionData": { - "description": "Agent Assist Article Suggestion data.", - "type": "object", - "properties": { - "title": { - "description": "Article title.", - "type": "string" - }, - "uri": { - "description": "Article URI.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this article is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "float" - }, - "metadata": { - "description": "Map that contains metadata about the Article Suggestion and the document\nthat it originates from.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - }, - "source": { - "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1FaqAnswerData": { - "description": "Agent Assist frequently-asked-question answer data.", - "type": "object", - "properties": { - "answer": { - "description": "The piece of text from the `source` knowledge base document.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this answer is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "float" - }, - "question": { - "description": "The corresponding FAQ question.", - "type": "string" - }, - "metadata": { - "description": "Map that contains metadata about the FAQ answer and the document that\nit originates from.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - }, - "source": { - "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1SmartReplyData": { - "description": "Agent Assist Smart Reply data.", - "type": "object", - "properties": { - "reply": { - "description": "The content of the reply.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this reply is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "double" - }, - "metadata": { - "description": "Map that contains metadata about the Smart Reply and the document from\nwhich it originates.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData": { - "description": "Agent Assist Smart Compose suggestion data.", - "type": "object", - "properties": { - "suggestion": { - "description": "The content of the suggestion.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this suggestion is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "double" - }, - "metadata": { - "description": "Map that contains metadata about the Smart Compose suggestion and the\ndocument from which it originates.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { - "description": "Dialogflow interaction data.", - "type": "object", - "properties": { - "dialogflowIntentId": { - "description": "The Dialogflow intent resource path. Format:\nprojects/{project}/agent/{agent}/intents/{intent}", - "type": "string" - }, - "confidence": { - "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0\n(completely certain).", - "type": "number", - "format": "float" - }, - "detectIntentRequest": { - "description": "The Dialogflow conversation DetectIntentRequest raw data of this turn. This\nfield will only be populated in the GetConversation response and its data\nformat should be same as Dialogflow [DetectIntentRequest] of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL." - } - }, - "detectIntentResponse": { - "description": "The Dialogflow conversation DetectIntentResponse raw data of this turn.\nThis field will only be populated in the GetConversation response and its\ndata format should be same as Dialogflow DetectIntentResponse of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL." - } - }, - "flowId": { - "description": "The Dialogflow flow id.", - "type": "string" - }, - "flowDisplayName": { - "description": "The Dialogflow flow display name.\nThe Dialogflow environment display name.", - "type": "string" - }, - "pageId": { - "description": "The Dialogflow page ID.", - "type": "string" - }, - "pageDisplayName": { - "description": "The Dialogflow page display name.\nThe Dialogflow environment display name.", - "type": "string" - }, - "intentId": { - "description": "The Dialogflow intent ID.", - "type": "string" - }, - "intentDisplayName": { - "description": "The Dialogflow intent display name.\nThe Dialogflow environment display name.", - "type": "string" - }, - "endFlowOrSession": { - "description": "The turn reaches END_FLOW or END_SESSION.", - "type": "boolean" - }, - "liveAgentHandoff": { - "description": "Whether the turn was handed off to a human agent.", - "type": "boolean" - }, - "inputType": { - "description": "The input type in this turn.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified. Should never be used.", - "Text input.", - "Intent input.", - "Audio input.", - "Event input.", - "DTMF input." - ], - "enum": [ - "INPUT_TYPE_UNSPECIFIED", - "INPUT_TYPE_TEXT", - "INPUT_TYPE_INTENT", - "INPUT_TYPE_AUDIO", - "INPUT_TYPE_EVENT", - "INPUT_TYPE_DTMF" - ] - }, - "matchType": { - "description": "The match type in this turn.", - "type": "string", - "x-google-enum-descriptions": [ - "Not specified. Should never be used.", - "An intent is matched.", - "The input is an intent.", - "The input is for parameter filling.", - "No intent match for the input.", - "Indicates an empty input.", - "The input is an event." - ], - "enum": [ - "MATCH_TYPE_UNSPECIFIED", - "MATCH_TYPE_INTENT", - "MATCH_TYPE_DIRECT_INTENT", - "MATCH_TYPE_PARAMETER_FILLING", - "MATCH_TYPE_NO_MATCH", - "MATCH_TYPE_NO_INPUT", - "MATCH_TYPE_EVENT" - ] - }, - "detectIntentResponseV3": { - "description": "The Dialogflow v3 DetectIntentResponse raw data of this turn.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DetectIntentResponse" - }] - } - } - }, - "GoogleCloudDialogflowV3alpha1DetectIntentResponse": { - "description": "The message returned from the DetectIntent method.", - "type": "object", - "properties": { - "responseId": { - "description": "Output only. The unique identifier of the response. It can be used to\nlocate a response in the training example set or for reporting issues.", - "type": "string" - }, - "queryResult": { - "description": "The result of the conversational query.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1QueryResult" - }] - }, - "outputAudio": { - "description": "The audio data bytes encoded as specified in the request.\nNote: The output audio is generated based on the values of default platform\ntext responses found in the\n`query_result.response_messages` field. If\nmultiple default text responses exist, they will be concatenated when\ngenerating audio. If no default platform text responses exist, the\ngenerated audio content will be empty.\n\nIn some scenarios, multiple output audio fields may be present in the\nresponse structure. In these cases, only the top-most-level audio output\nhas content.", - "type": "string", - "format": "byte" - }, - "outputAudioConfig": { - "description": "The config used by the speech synthesizer to generate the output audio.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1OutputAudioConfig" - }] - }, - "responseType": { - "description": "Response type.", - "type": "string", - "x-google-enum-descriptions": [ - "Not specified. This should never happen.", - "Partial response. e.g. Aggregated responses in a Fulfillment that enables\n`return_partial_response` can be returned as partial response.\nWARNING: partial response is not eligible for barge-in.", - "Final response." - ], - "enum": [ - "RESPONSE_TYPE_UNSPECIFIED", - "PARTIAL", - "FINAL" - ] - }, - "allowCancellation": { - "description": "Indicates whether the partial response can be cancelled when a later\nresponse arrives. e.g. if the agent specified some music as partial\nresponse, it can be cancelled.", - "type": "boolean" - }, - "features": { - "description": "List of features used during the request processing.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DetectIntentResponseFeatureUsage" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1QueryResult": { - "description": "Represents the result of a conversational query.", - "type": "object", - "properties": { - "text": { - "description": "If natural language text was provided as input, this field\nwill contain a copy of the text.", - "type": "string" - }, - "triggerIntent": { - "description": "If an intent was provided as input, this field will\ncontain a copy of the intent identifier.\nFormat:\n`projects//locations//agents//intents/`.", - "type": "string" - }, - "transcript": { - "description": "If natural language speech audio was provided as input,\nthis field will contain the transcript for the audio.", - "type": "string" - }, - "triggerEvent": { - "description": "If an event was provided as input, this field will contain\nthe name of the event.", - "type": "string" - }, - "dtmf": { - "description": "If a DTMF was provided as input, this field will contain\na copy of the DtmfInput.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DtmfInput" - }] - }, - "languageCode": { - "description": "The language that was triggered during intent detection.\nSee [Language\nSupport](https://cloud.google.com/dialogflow/docs/reference/language)\nfor a list of the currently supported language codes.", - "type": "string" - }, - "parameters": { - "description": "The collected session parameters.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n* MapKey type: string\n* MapKey value: parameter name\n* MapValue type: If parameter's entity type is a composite entity then use\nmap, otherwise, depending on the parameter value type, it could be one of\nstring, number, boolean, null, list or map.\n* MapValue value: If parameter's entity type is a composite entity then use\nmap from composite entity property names to property values, otherwise,\nuse parameter value.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "responseMessages": { - "description": "The list of rich messages returned to the client. Responses vary from\nsimple text messages to more sophisticated, structured payloads used\nto drive complex logic.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessage" - } - }, - "webhookIds": { - "description": "The list of webhook ids in the order of call sequence.", - "type": "array", - "items": { - "type": "string" - } - }, - "webhookDisplayNames": { - "description": "The list of webhook display names in the order of call sequence.", - "type": "array", - "items": { - "type": "string" - } - }, - "webhookLatencies": { - "description": "The list of webhook latencies in the order of call sequence.", - "type": "array", - "items": { - "type": "string", - "format": "google-duration" - } - }, - "webhookTags": { - "description": "The list of webhook tags in the order of call sequence.", - "type": "array", - "items": { - "type": "string" - } - }, - "webhookStatuses": { - "description": "The list of webhook call status in the order of call sequence.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "webhookPayloads": { - "description": "The list of webhook payload in WebhookResponse.payload, in\nthe order of call sequence. If some webhook call fails or doesn't return\nany payload, an empty `Struct` would be used instead.", - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - }, - "currentPage": { - "description": "The current Page. Some, not all fields are filled in this message,\nincluding but not limited to `name` and `display_name`.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Page" - }] - }, - "currentFlow": { - "description": "The current Flow. Some, not all fields are filled in this message,\nincluding but not limited to `name` and `display_name`.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Flow" - }] - }, - "intent": { - "description": "The Intent that matched the conversational query. Some, not all fields\nare filled in this message, including but not limited to: `name` and\n`display_name`.\nThis field is deprecated, please use QueryResult.match instead.", - "deprecated": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Intent" - }] - }, - "intentDetectionConfidence": { - "description": "The intent detection confidence. Values range from 0.0 (completely\nuncertain) to 1.0 (completely certain).\nThis value is for informational purpose only and is only used to\nhelp match the best intent within the classification threshold.\nThis value may change for the same end-user expression at any time due to a\nmodel retraining or change in implementation.\nThis field is deprecated, please use QueryResult.match instead.", - "deprecated": true, - "type": "number", - "format": "float" - }, - "match": { - "description": "Intent match result, could be an intent or an event.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Match" - }] - }, - "diagnosticInfo": { - "description": "The free-form diagnostic info. For example, this field could contain\nwebhook call latency. The fields of this data can change without notice,\nso you should not write code that depends on its structure.\n\nOne of the fields is called \"Alternative Matched Intents\", which may\naid with debugging. The following describes these intent results:\n\n- The list is empty if no intent was matched to end-user input.\n- Only intents that are referenced in the currently active flow are\n included.\n- The matched intent is included.\n- Other intents that could have matched end-user input, but did not match\n because they are referenced by intent routes that are out of\n [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope),\n are included.\n- Other intents referenced by intent routes in scope that matched end-user\n input, but had a lower confidence score.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "generativeInfo": { - "description": "The information of a query if handled by generative agent resources.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1GenerativeInfo" - }] - }, - "sentimentAnalysisResult": { - "description": "The sentiment analysis result, which depends on\n`analyze_query_text_sentiment`, specified in the request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1SentimentAnalysisResult" - }] - }, - "advancedSettings": { - "description": "Returns the current advanced settings including IVR settings. Even though\nthe operations configured by these settings are performed by Dialogflow,\nthe client may need to perform special logic at the moment. For example, if\nDialogflow exports audio to Google Cloud Storage, then the client may need\nto wait for the resulting object to appear in the bucket before proceeding.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettings" - }] - }, - "allowAnswerFeedback": { - "description": "Indicates whether the Thumbs up/Thumbs down rating controls are need to be\nshown for the response in the Dialogflow Messenger widget.", - "type": "boolean" - }, - "callCompanionAuthCode": { - "description": "The auth code for accessing Call Companion UI.", - "type": "string", - "format": "byte" - }, - "dataStoreConnectionSignals": { - "description": "Optional. Data store connection feature output signals.\nFilled only when data stores are involved in serving the query.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignals" - }] - } - } - }, - "GoogleCloudDialogflowV3alpha1DtmfInput": { - "description": "Represents the input for dtmf event.", - "type": "object", - "properties": { - "digits": { - "description": "The dtmf digits.", - "type": "string" - }, - "finishDigit": { - "description": "The finish digit (if any).", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1ResponseMessage": { - "description": "Represents a response message that can be returned by a conversational agent.\n\nResponse messages are also used for output audio synthesis. The approach is\nas follows:\n\n* If at least one OutputAudioText response is present, then all\n OutputAudioText responses are linearly concatenated, and the result is used\n for output audio synthesis.\n* If the OutputAudioText responses are a mixture of text and SSML, then the\n concatenated result is treated as SSML; otherwise, the result is treated as\n either text or SSML as appropriate. The agent designer should ideally use\n either text or SSML consistently throughout the bot design.\n* Otherwise, all Text responses are linearly concatenated, and the result is\n used for output audio synthesis.\n\nThis approach allows for more sophisticated user experience scenarios, where\nthe text displayed to the user may differ from what is heard.", - "type": "object", - "properties": { - "text": { - "description": "Returns a text response.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageText" - }] - }, - "payload": { - "description": "Returns a response containing a custom, platform-specific payload.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "conversationSuccess": { - "description": "Indicates that the conversation succeeded.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageConversationSuccess" - }] - }, - "outputAudioText": { - "description": "A text or ssml response that is preferentially used for TTS output audio\nsynthesis, as described in the comment on the ResponseMessage message.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageOutputAudioText" - }] - }, - "liveAgentHandoff": { - "description": "Hands off conversation to a human agent.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageLiveAgentHandoff" - }] - }, - "endInteraction": { - "description": "Output only. A signal that indicates the interaction with the Dialogflow agent has\nended.\nThis message is generated by Dialogflow only when the conversation\nreaches `END_SESSION` page. It is not supposed to be defined by the user.\n\nIt's guaranteed that there is at most one such message in each response.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageEndInteraction" - }] - }, - "playAudio": { - "description": "Signal that the client should play an audio clip hosted at a\nclient-specific URI. Dialogflow uses this to construct\nmixed_audio. However, Dialogflow itself\ndoes not try to read or process the URI in any way.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessagePlayAudio" - }] - }, - "mixedAudio": { - "description": "Output only. An audio response message composed of both the synthesized Dialogflow\nagent responses and responses defined via\nplay_audio.\nThis message is generated by Dialogflow only and not supposed to be\ndefined by the user.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageMixedAudio" - }] - }, - "telephonyTransferCall": { - "description": "A signal that the client should transfer the phone call connected to\nthis agent to a third-party endpoint.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageTelephonyTransferCall" - }] - }, - "knowledgeInfoCard": { - "description": "Represents info card for knowledge answers, to be better rendered in\nDialogflow Messenger.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageKnowledgeInfoCard" - }] - }, - "toolCall": { - "description": "Returns the definition of a tool call that should be executed by the\nclient.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ToolCall" - }] - }, - "dataStoreTextResponse": { - "description": "Text response from data store.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageDataStoreTextResponse" - }] - }, - "responseType": { - "description": "Response type.", - "type": "string", - "x-google-enum-descriptions": [ - "Not specified.", - "The response is from an entry prompt in the\npage.", - "The response is from form-filling prompt\nin the page.", - "The response is from a transition route or an event\nhandler in the page or flow or transition route group." - ], - "enum": [ - "RESPONSE_TYPE_UNSPECIFIED", - "ENTRY_PROMPT", - "PARAMETER_PROMPT", - "HANDLER_PROMPT" - ] - }, - "channel": { - "description": "The channel which the response is associated with. Clients can specify the\nchannel via QueryParameters.channel, and only associated channel\nresponse will be returned.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1ResponseMessageText": { - "description": "The text response message.", - "type": "object", - "properties": { - "text": { - "description": "Required. A collection of text response variants. If multiple variants are\ndefined, only one text response variant is returned at runtime.", - "type": "array", - "items": { - "type": "string" - } - }, - "allowPlaybackInterruption": { - "description": "Output only. Whether the playback of this message can be interrupted by the end\nuser's speech and the client can then starts the next Dialogflow\nrequest.", - "readOnly": true, - "type": "boolean" - } - }, - "required": [ - "text" - ] - }, - "GoogleCloudDialogflowV3alpha1ResponseMessageConversationSuccess": { - "description": "Indicates that the conversation succeeded, i.e., the bot handled the issue\nthat the customer talked to it about.\n\nDialogflow only uses this to determine which conversations should be\ncounted as successful and doesn't process the metadata in this message in\nany way. Note that Dialogflow also considers conversations that get to the\nconversation end page as successful even if they don't return\nConversationSuccess.\n\nYou may set this, for example:\n* In the entry_fulfillment of a Page if\n entering the page indicates that the conversation succeeded.\n* In a webhook response when you determine that you handled the customer\n issue.", - "type": "object", - "properties": { - "metadata": { - "description": "Custom metadata. Dialogflow doesn't impose any structure on this.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudDialogflowV3alpha1ResponseMessageOutputAudioText": { - "description": "A text or ssml response that is preferentially used for TTS output audio\nsynthesis, as described in the comment on the ResponseMessage message.", - "type": "object", - "properties": { - "text": { - "description": "The raw text to be synthesized.", - "type": "string" - }, - "ssml": { - "description": "The SSML text to be synthesized. For more information, see\n[SSML](/speech/text-to-speech/docs/ssml).", - "type": "string" - }, - "allowPlaybackInterruption": { - "description": "Output only. Whether the playback of this message can be interrupted by the end\nuser's speech and the client can then starts the next Dialogflow\nrequest.", - "readOnly": true, - "type": "boolean" - } - } - }, - "GoogleCloudDialogflowV3alpha1ResponseMessageLiveAgentHandoff": { - "description": "Indicates that the conversation should be handed off to a live agent.\n\nDialogflow only uses this to determine which conversations were handed off\nto a human agent for measurement purposes. What else to do with this signal\nis up to you and your handoff procedures.\n\nYou may set this, for example:\n* In the entry_fulfillment of a Page if\n entering the page indicates something went extremely wrong in the\n conversation.\n* In a webhook response when you determine that the customer issue can only\n be handled by a human.", - "type": "object", - "properties": { - "metadata": { - "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose\nany structure on this.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudDialogflowV3alpha1ResponseMessageEndInteraction": { - "description": "Indicates that interaction with the Dialogflow agent has ended.\nThis message is generated by Dialogflow only and not supposed to be\ndefined by the user.", - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ResponseMessagePlayAudio": { - "description": "Specifies an audio clip to be played by the client as part of the response.", - "type": "object", - "properties": { - "audioUri": { - "description": "Required. URI of the audio clip. Dialogflow does not impose any validation on this\nvalue. It is specific to the client that reads it.", - "type": "string" - }, - "allowPlaybackInterruption": { - "description": "Output only. Whether the playback of this message can be interrupted by the end\nuser's speech and the client can then starts the next Dialogflow\nrequest.", - "readOnly": true, - "type": "boolean" - } - }, - "required": [ - "audioUri" - ] - }, - "GoogleCloudDialogflowV3alpha1ResponseMessageMixedAudio": { - "description": "Represents an audio message that is composed of both segments\nsynthesized from the Dialogflow agent prompts and ones hosted externally\nat the specified URIs.\nThe external URIs are specified via\nplay_audio.\nThis message is generated by Dialogflow only and not supposed to be\ndefined by the user.", - "type": "object", - "properties": { - "segments": { - "description": "Segments this audio response is composed of.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessageMixedAudioSegment" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1ResponseMessageMixedAudioSegment": { - "description": "Represents one segment of audio.", - "type": "object", - "properties": { - "audio": { - "description": "Raw audio synthesized from the Dialogflow agent's response using\nthe output config specified in the request.", - "type": "string", - "format": "byte" - }, - "uri": { - "description": "Client-specific URI that points to an audio clip accessible to the\nclient. Dialogflow does not impose any validation on it.", - "type": "string" - }, - "allowPlaybackInterruption": { - "description": "Output only. Whether the playback of this segment can be interrupted by the end\nuser's speech and the client should then start the next Dialogflow\nrequest.", - "readOnly": true, - "type": "boolean" - } - } - }, - "GoogleCloudDialogflowV3alpha1ResponseMessageTelephonyTransferCall": { - "description": "Represents the signal that telles the client to transfer the phone call\nconnected to the agent to a third-party endpoint.", - "type": "object", - "properties": { - "phoneNumber": { - "description": "Transfer the call to a phone number\nin [E.164 format](https://en.wikipedia.org/wiki/E.164).", - "type": "string" - }, - "useOriginatingTrunk": { - "description": "Whether to use the originating SIP trunk of the incoming call to make the\noutbound call for the transfer.", - "type": "boolean" - } - } - }, - "GoogleCloudDialogflowV3alpha1ResponseMessageKnowledgeInfoCard": { - "description": "Represents info card response. If the response contains generative\nknowledge prediction, Dialogflow will return a payload with Infobot\nMessenger compatible info card.\n\nOtherwise, the info card response is skipped.", - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ToolCall": { - "description": "Represents a call of a specific tool's action with the specified inputs.", - "type": "object", - "properties": { - "tool": { - "description": "Required. The tool associated with this call.\nFormat:\n`projects//locations//agents//tools/`.", - "type": "string" - }, - "action": { - "description": "Required. The name of the tool's action associated with this call.", - "type": "string" - }, - "inputParameters": { - "description": "Optional. The action's input parameters.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - }, - "required": [ - "tool", - "action" - ] - }, - "GoogleCloudDialogflowV3alpha1ResponseMessageDataStoreTextResponse": { - "description": "The data store text response message. Rendered as a text response to\nthe caller.", - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1Page": { - "description": "A Dialogflow CX conversation (session) can be described and visualized as a\nstate machine. The states of a CX session are represented by pages.\n\nFor each flow, you define many pages, where your combined pages can handle a\ncomplete conversation on the topics the flow is designed for. At any given\nmoment, exactly one page is the current page, the current page is considered\nactive, and the flow associated with that page is considered active. Every\nflow has a special start page. When a flow initially becomes active, the\nstart page page becomes the current page. For each conversational turn, the\ncurrent page will either stay the same or transition to another page.\n\nYou configure each page to collect information from the end-user that is\nrelevant for the conversational state represented by the page.\n\nFor more information, see the\n[Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).", - "type": "object", - "properties": { - "name": { - "description": "The unique identifier of the page.\nRequired for the Pages.UpdatePage method. Pages.CreatePage\npopulates the name automatically.\nFormat:\n`projects//locations//agents//flows//pages/`.", - "type": "string" - }, - "displayName": { - "description": "Required. The human-readable name of the page, unique within the flow.", - "type": "string" - }, - "description": { - "description": "The description of the page. The maximum length is 500 characters.", - "type": "string" - }, - "entryFulfillment": { - "description": "The fulfillment to call when the session is entering the page.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Fulfillment" - }] - }, - "form": { - "description": "The form associated with the page, used for collecting parameters\nrelevant to the page.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Form" - }] - }, - "transitionRouteGroups": { - "description": "Ordered list of `TransitionRouteGroups` added to\nthe page. Transition route groups must be unique within a page. If the page\nlinks both flow-level transition route groups and agent-level transition\nroute groups, the flow-level ones will have higher priority and will be put\nbefore the agent-level ones.\n\n* If multiple transition routes within a page scope refer to the same\n intent, then the precedence order is: page's transition route -> page's\n transition route group -> flow's transition routes.\n\n* If multiple transition route groups within a page contain the same\n intent, then the first group in the ordered list takes precedence.\n\nFormat:`projects//locations//agents//flows//transitionRouteGroups/`\nor\n`projects//locations//agents//transitionRouteGroups/`\nfor agent-level groups.", - "type": "array", - "items": { - "type": "string" - } - }, - "transitionRoutes": { - "description": "A list of transitions for the transition rules of this page.\nThey route the conversation to another page in the same flow, or another\nflow.\n\nWhen we are in a certain page, the TransitionRoutes are evaluated in the\nfollowing order:\n\n* TransitionRoutes defined in the page with intent specified.\n* TransitionRoutes defined in the\n transition route groups with intent\n specified.\n* TransitionRoutes defined in flow with intent specified.\n* TransitionRoutes defined in the\n transition route groups with intent\n specified.\n* TransitionRoutes defined in the page with only condition specified.\n* TransitionRoutes defined in the\n transition route groups with only\n condition specified.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1TransitionRoute" - } - }, - "eventHandlers": { - "description": "Handlers associated with the page to handle events such as webhook errors,\nno match or no input.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1EventHandler" - } - }, - "advancedSettings": { - "description": "Hierarchical advanced settings for this page. The settings exposed at the\nlower level overrides the settings exposed at the higher level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettings" - }] - }, - "knowledgeConnectorSettings": { - "description": "Optional. Knowledge connector configuration.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1KnowledgeConnectorSettings" - }] - } - }, - "required": [ - "displayName" - ] - }, - "GoogleCloudDialogflowV3alpha1Fulfillment": { - "description": "A fulfillment can do one or more of the following actions at the same time:\n * Generate rich message responses.\n * Set parameter values.\n * Call the webhook.\nFulfillments can be called at various stages in the Page or\nForm lifecycle. For example, when a DetectIntentRequest drives a\nsession to enter a new page, the page's entry fulfillment can add a static\nresponse to the QueryResult in the returning DetectIntentResponse,\ncall the webhook (e.g., to load user data from a database), or both.", - "type": "object", - "properties": { - "messages": { - "description": "The list of rich message responses to present to the user.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessage" - } - }, - "webhook": { - "description": "The webhook to call.\nFormat:\n`projects//locations//agents//webhooks/`.", - "type": "string" - }, - "returnPartialResponses": { - "description": "Whether Dialogflow should return currently queued fulfillment response\nmessages in streaming APIs. If a webhook is specified, it happens before\nDialogflow invokes webhook.\nWarning:\n1) This flag only affects streaming API. Responses are still queued\nand returned once in non-streaming API.\n2) The flag can be enabled in any fulfillment but only the first 3 partial\nresponses will be returned. You may only want to apply it to fulfillments\nthat have slow webhooks.", - "type": "boolean" - }, - "tag": { - "description": "The value of this field will be populated in the WebhookRequest\n`fulfillmentInfo.tag` field by Dialogflow when the associated webhook is\ncalled.\nThe tag is typically used by the webhook service to identify which\nfulfillment is being called, but it could be used for other purposes.\nThis field is required if `webhook` is specified.", - "type": "string" - }, - "setParameterActions": { - "description": "Set parameter values before executing the webhook.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentSetParameterAction" - } - }, - "conditionalCases": { - "description": "Conditional cases for this fulfillment.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentConditionalCases" - } - }, - "advancedSettings": { - "description": "Hierarchical advanced settings for this fulfillment. The settings exposed\nat the lower level overrides the settings exposed at the higher level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettings" - }] - }, - "enableGenerativeFallback": { - "description": "If the flag is true, the agent will utilize LLM to generate a text\nresponse. If LLM generation fails, the defined\nresponses in the fulfillment will be respected.\nThis flag is only useful for fulfillments associated with no-match event\nhandlers.", - "type": "boolean" - }, - "generators": { - "description": "A list of Generators to be called during this fulfillment.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentGeneratorSettings" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1FulfillmentSetParameterAction": { - "description": "Setting a parameter value.", - "type": "object", - "properties": { - "parameter": { - "description": "Display name of the parameter.", - "type": "string" - }, - "value": { - "description": "The new value of the parameter. A null value clears the parameter." - } - } - }, - "GoogleCloudDialogflowV3alpha1FulfillmentConditionalCases": { - "description": "A list of cascading if-else conditions. Cases are mutually exclusive.\nThe first one with a matching condition is selected, all the rest ignored.", - "type": "object", - "properties": { - "cases": { - "description": "A list of cascading if-else conditions.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentConditionalCasesCase" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1FulfillmentConditionalCasesCase": { - "description": "Each case has a Boolean condition. When it is evaluated to be True, the\ncorresponding messages will be selected and evaluated recursively.", - "type": "object", - "properties": { - "condition": { - "description": "The condition to activate and select this case. Empty means the\ncondition is always true. The condition is evaluated against form\nparameters or session\nparameters.\n\nSee the [conditions\nreference](https://cloud.google.com/dialogflow/priv/docs/v3/condition).", - "type": "string" - }, - "caseContent": { - "description": "A list of case content.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentConditionalCasesCaseCaseContent" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1FulfillmentConditionalCasesCaseCaseContent": { - "description": "The list of messages or conditional cases to activate for this case.", - "type": "object", - "properties": { - "message": { - "description": "Returned message.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ResponseMessage" - }] - }, - "additionalCases": { - "description": "Additional cases to be evaluated.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FulfillmentConditionalCases" - }] - } - } - }, - "GoogleCloudDialogflowV3alpha1AdvancedSettings": { - "description": "Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.\nSettings exposed at lower level overrides the settings exposed at higher\nlevel. Overriding occurs at the sub-setting level. For example, the\nplayback_interruption_settings at fulfillment level only overrides the\nplayback_interruption_settings at the agent level, leaving other settings\nat the agent level unchanged.\n\nDTMF settings does not override each other. DTMF settings set at different\nlevels define DTMF detections running in parallel.\n\nHierarchy: Agent->Flow->Page->Fulfillment/Parameter.", - "type": "object", - "properties": { - "audioExportGcsDestination": { - "description": "If present, incoming audio is exported by Dialogflow to the configured\nGoogle Cloud Storage destination.\nExposed at the following levels:\n- Agent level\n- Flow level", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1GcsDestination" - }] - }, - "dtmfSettings": { - "description": "Settings for DTMF.\nExposed at the following levels:\n- Agent level\n- Flow level\n- Page level\n- Parameter level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettingsDtmfSettings" - }] - }, - "loggingSettings": { - "description": "Settings for logging.\nSettings for Dialogflow History, Contact Center messages, StackDriver logs,\nand speech logging.\nExposed at the following levels:\n- Agent level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettingsLoggingSettings" - }] - }, - "dtmfSettingsList": { - "description": "Output only. List of DtmfSettings emitted from different levels of agent.\nEach DtmfSettings in the list has higher priority than the ones before it\nin the list, with the last one having the highest priority.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettingsDtmfSettings" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1GcsDestination": { - "description": "Google Cloud Storage location for a Dialogflow operation that writes or\nexports objects (e.g. exported agent or transcripts) outside of Dialogflow.", - "type": "object", - "properties": { - "uri": { - "description": "Required. The Google Cloud Storage URI for the exported objects. A URI is of the\nform:\n`gs://bucket/object-name-or-prefix`\nWhether a full object name, or just a prefix, its usage depends on the\nDialogflow operation.", - "type": "string" - } - }, - "required": [ - "uri" - ] - }, - "GoogleCloudDialogflowV3alpha1AdvancedSettingsDtmfSettings": { - "description": "Define behaviors for DTMF (dual tone multi frequency).", - "type": "object", - "properties": { - "enabled": { - "description": "If true, incoming audio is processed for DTMF (dual tone multi frequency)\nevents. For example, if the caller presses a button on their telephone\nkeypad and DTMF processing is enabled, Dialogflow will detect the\nevent (e.g. a \"3\" was pressed) in the incoming audio and pass the event\nto the bot to drive business logic (e.g. when 3 is pressed, return the\naccount balance).", - "type": "boolean" - }, - "maxDigits": { - "description": "Max length of DTMF digits.", - "type": "integer", - "format": "int32" - }, - "finishDigit": { - "description": "The digit that terminates a DTMF digit sequence.", - "type": "string" - }, - "disableSpeechDetection": { - "description": "If true, disable speech detection when DTMF detection is running.", - "type": "boolean" - } - } - }, - "GoogleCloudDialogflowV3alpha1AdvancedSettingsLoggingSettings": { - "description": "Define behaviors on logging.", - "type": "object", - "properties": { - "enableStackdriverLogging": { - "description": "Enables Google Cloud Logging.", - "type": "boolean" - }, - "enableInteractionLogging": { - "description": "Enables DF Interaction logging.", - "type": "boolean" - }, - "enableConsentBasedRedaction": { - "description": "Enables consent-based end-user input redaction, if true, a pre-defined\nsession parameter `$session.params.conversation-redaction` will be\nused to determine if the utterance should be redacted.", - "type": "boolean" - } - } - }, - "GoogleCloudDialogflowV3alpha1FulfillmentGeneratorSettings": { - "description": "Generator settings used by the LLM to generate a text response.", - "type": "object", - "properties": { - "generator": { - "description": "Required. The generator to call.\nFormat:\n`projects//locations//agents//generators/`.", - "type": "string" - }, - "inputParameters": { - "description": "Map from placeholder parameter in the\nGenerator to corresponding session parameters. By default,\nDialogflow uses the session parameter with the same name to fill in the\ngenerator template. e.g. If there is a placeholder parameter `city` in\nthe Generator, Dialogflow default to fill in the `$city` with\n`$session.params.city`. However, you may choose to fill `$city` with\n`$session.params.desination-city`.\n- Map key: parameter ID\n- Map value: session parameter name", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "outputParameter": { - "description": "Required. Output parameter which should contain the generator response.", - "type": "string" - } - }, - "required": [ - "generator", - "outputParameter" - ] - }, - "GoogleCloudDialogflowV3alpha1Form": { - "description": "A form is a data model that groups related parameters that can be collected\nfrom the user. The process in which the agent prompts the user and collects\nparameter values from the user is called form filling. A form can be added to\na page. When form filling is done, the filled parameters will be\nwritten to the session.", - "type": "object", - "properties": { - "parameters": { - "description": "Parameters to collect from the user.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FormParameter" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1FormParameter": { - "description": "Represents a form parameter.", - "type": "object", - "properties": { - "displayName": { - "description": "Required. The human-readable name of the parameter, unique within the\nform.", - "type": "string" - }, - "required": { - "description": "Indicates whether the parameter is required. Optional parameters will not\ntrigger prompts; however, they are filled if the user specifies them.\nRequired parameters must be filled before form filling concludes.", - "type": "boolean" - }, - "entityType": { - "description": "Required. The entity type of the parameter.\nFormat:\n`projects/-/locations/-/agents/-/entityTypes/` for\nsystem entity types (for example,\n`projects/-/locations/-/agents/-/entityTypes/sys.date`), or\n`projects//locations//agents//entityTypes/`\nfor developer entity types.", - "type": "string" - }, - "isList": { - "description": "Indicates whether the parameter represents a list of values.", - "type": "boolean" - }, - "fillBehavior": { - "description": "Required. Defines fill behavior for the parameter.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FormParameterFillBehavior" - }] - }, - "defaultValue": { - "description": "The default value of an optional parameter. If the parameter is required,\nthe default value will be ignored." - }, - "redact": { - "description": "Indicates whether the parameter content should be redacted in log. If\nredaction is enabled, the parameter content will be replaced by parameter\nname during logging.\nNote: the parameter content is subject to redaction if either parameter\nlevel redaction or entity type level redaction is\nenabled.", - "type": "boolean" - }, - "advancedSettings": { - "description": "Hierarchical advanced settings for this parameter. The settings exposed\nat the lower level overrides the settings exposed at the higher level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettings" - }] - } - }, - "required": [ - "displayName", - "entityType", - "fillBehavior" - ] - }, - "GoogleCloudDialogflowV3alpha1FormParameterFillBehavior": { - "description": "Configuration for how the filling of a parameter should be handled.", - "type": "object", - "properties": { - "initialPromptFulfillment": { - "description": "Required. The fulfillment to provide the initial prompt that the agent\ncan present to the user in order to fill the parameter.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Fulfillment" - }] - }, - "repromptEventHandlers": { - "description": "The handlers for parameter-level events, used to provide reprompt for\nthe parameter or transition to a different page/flow. The supported\nevents are:\n* `sys.no-match-`, where N can be from 1 to 6\n* `sys.no-match-default`\n* `sys.no-input-`, where N can be from 1 to 6\n* `sys.no-input-default`\n* `sys.invalid-parameter`\n\n`initial_prompt_fulfillment` provides the first prompt for the\nparameter.\n\nIf the user's response does not fill the parameter, a\nno-match/no-input event will be triggered, and the fulfillment\nassociated with the `sys.no-match-1`/`sys.no-input-1` handler (if\ndefined) will be called to provide a prompt. The\n`sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to\nthe next no-match/no-input event, and so on.\n\nA `sys.no-match-default` or `sys.no-input-default` handler will be used\nto handle all following no-match/no-input events after all numbered\nno-match/no-input handlers for the parameter are consumed.\n\nA `sys.invalid-parameter` handler can be defined to handle the case\nwhere the parameter values have been `invalidated` by webhook. For\nexample, if the user's response fill the parameter, however the\nparameter was invalidated by webhook, the fulfillment associated with\nthe `sys.invalid-parameter` handler (if defined) will be called to\nprovide a prompt.\n\nIf the event handler for the corresponding event can't be found on the\nparameter, `initial_prompt_fulfillment` will be re-prompted.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1EventHandler" - } - } - }, - "required": [ - "initialPromptFulfillment" - ] - }, - "GoogleCloudDialogflowV3alpha1EventHandler": { - "description": "An event handler specifies an event that can be handled\nduring a session. When the specified event happens, the following actions are\ntaken in order:\n\n* If there is a\n`trigger_fulfillment` associated with\nthe event, it will be called.\n* If there is a `target_page` associated\nwith the event, the session will transition into the specified page.\n* If there is a `target_flow` associated\nwith the event, the session will transition into the specified flow.", - "type": "object", - "properties": { - "name": { - "description": "Output only. The unique identifier of this event handler.", - "readOnly": true, - "type": "string" - }, - "event": { - "description": "Required. The name of the event to handle.", - "type": "string" - }, - "triggerFulfillment": { - "description": "The fulfillment to call when the event occurs.\nHandling webhook errors with a fulfillment enabled with webhook could\ncause infinite loop. It is invalid to specify such fulfillment for a\nhandler handling webhooks.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Fulfillment" - }] - }, - "targetPage": { - "description": "The target page to transition to.\nFormat:\n`projects//locations//agents//flows//pages/`.", - "type": "string" - }, - "targetFlow": { - "description": "The target flow to transition to.\nFormat:\n`projects//locations//agents//flows/`.", - "type": "string" - }, - "targetPlaybook": { - "description": "The target playbook to transition to.\nFormat:\n`projects//locations//agents//playbooks/`.", - "type": "string" - } - }, - "required": [ - "event" - ] - }, - "GoogleCloudDialogflowV3alpha1TransitionRoute": { - "description": "A transition route specifies a intent that can be matched and/or a\ndata condition that can be evaluated during a session. When a specified\ntransition is matched, the following actions are taken in order:\n\n* If there is a\n`trigger_fulfillment` associated with\nthe transition, it will be called.\n* If there is a `target_page` associated\nwith the transition, the session will transition into the specified page.\n* If there is a `target_flow` associated\nwith the transition, the session will transition into the specified flow.", - "type": "object", - "properties": { - "name": { - "description": "Output only. The unique identifier of this transition route.", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Optional. The description of the transition route. The maximum length is 500\ncharacters.", - "type": "string" - }, - "intent": { - "description": "The unique identifier of an Intent.\nFormat:\n`projects//locations//agents//intents/`.\nIndicates that the transition can only happen when the given intent is\nmatched.\nAt least one of `intent` or `condition` must be specified. When both\n`intent` and `condition` are specified, the transition can only happen\nwhen both are fulfilled.", - "type": "string" - }, - "condition": { - "description": "The condition to evaluate against form parameters or\nsession parameters.\n\nSee the [conditions\nreference](https://cloud.google.com/dialogflow/priv/docs/v3/condition).\nAt least one of `intent` or `condition` must be specified. When both\n`intent` and `condition` are specified, the transition can only happen\nwhen both are fulfilled.", - "type": "string" - }, - "triggerFulfillment": { - "description": "The fulfillment to call when the condition is satisfied. At least one of\n`trigger_fulfillment` and `target` must be specified. When both are\ndefined, `trigger_fulfillment` is executed first.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Fulfillment" - }] - }, - "targetPage": { - "description": "The target page to transition to.\nFormat:\n`projects//locations//agents//flows//pages/`.", - "type": "string" - }, - "targetFlow": { - "description": "The target flow to transition to.\nFormat:\n`projects//locations//agents//flows/`.", - "type": "string" - }, - "targetPlaybook": { - "description": "The target playbook to transition to.\nFormat:\n`projects//locations//agents//playbooks/`.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1KnowledgeConnectorSettings": { - "description": "The Knowledge Connector settings for this page or flow.\nThis includes information such as the attached Knowledge Bases, and the way\nto execute fulfillment.", - "type": "object", - "properties": { - "enabled": { - "description": "Whether Knowledge Connector is enabled or not.", - "type": "boolean" - }, - "triggerFulfillment": { - "description": "The fulfillment to be triggered.\n\nWhen the answers from the Knowledge Connector are selected by Dialogflow,\nyou can utitlize the request scoped parameter `$request.knowledge.answers`\n(contains up to the 5 highest confidence answers) and\n`$request.knowledge.questions` (contains the corresponding questions) to\nconstruct the fulfillment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Fulfillment" - }] - }, - "targetPage": { - "description": "The target page to transition to.\nFormat:\n`projects//locations//agents//flows//pages/`.", - "type": "string" - }, - "targetFlow": { - "description": "The target flow to transition to.\nFormat:\n`projects//locations//agents//flows/`.", - "type": "string" - }, - "dataStoreConnections": { - "description": "Optional. List of related data store connections.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnection" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnection": { - "description": "A data store connection. It represents a data store in Discovery Engine and\nthe type of the contents it contains.", - "type": "object", - "properties": { - "dataStoreType": { - "description": "The type of the connected data store.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreType" - }] - }, - "dataStore": { - "description": "The full name of the referenced data store.\nFormats:\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`\n`projects/{project}/locations/{location}/dataStores/{data_store}`", - "type": "string" - }, - "languageCode": { - "description": "The language for which the data store connection is applied.\n\nIn normal cases, we don't need to populate `language_code` as only\ndata store connections of the requested language are returned. However we\nneed to store the data store connections of all languages for changelog, so\nthat we can revert back the entire resource.", - "type": "string" - }, - "documentProcessingMode": { - "description": "The document processing mode for the data store connection. Should only be\nset for PUBLIC_WEB and UNSTRUCTURED data stores. If not set it is\nconsidered as DOCUMENTS, as this is the legacy mode.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DocumentProcessingMode" - }] - }, - "aclConfig": { - "description": "The ACL config for the data store connection. It is only used for data\nstore of type `STRUCTURED`.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AclConfig" - }] - }, - "engineType": { - "description": "The engine type for the data store connection. It will default to Agent\nbuilder chat.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1EngineType" - }] - }, - "connectorConfig": { - "description": "The connector config for the data store connection.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionConnectorConfig" - }] - }, - "createTime": { - "description": "Timestamp the data store was created at.", - "type": "string", - "format": "date-time" - }, - "displayName": { - "description": "Display name of the data store connection.", - "type": "string" - }, - "dialogflowAddTime": { - "description": "Timestamp the data store was added to dialogflow.", - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudDialogflowV3alpha1AclConfig": { - "description": "ACL config for a data store connection.", - "type": "object", - "properties": { - "idpType": { - "description": "Identity provider type set at project/datastore level.", - "type": "string", - "x-google-enum-descriptions": [ - "Default value. ACL search not enabled.", - "Google 1P provider.", - "External 3P provider." - ], - "enum": [ - "IDP_TYPE_NONE", - "IDP_TYPE_GSUITE", - "IDP_TYPE_3P" - ] - }, - "externalIdpConfig": { - "description": "External Identity provider config. Should be set only if idp_type is\nIDP_TYPE_3P.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AclConfigExternalIdpConfig" - }] - } - } - }, - "GoogleCloudDialogflowV3alpha1AclConfigExternalIdpConfig": { - "description": "Third party IDP Config.", - "type": "object", - "properties": { - "workforcePoolName": { - "description": "Workforce pool name.\nFormat:\n`locations//workforcePools/`.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionConnectorConfig": { - "description": "The connector config for the data store connection.", - "type": "object", - "properties": { - "collection": { - "description": "Resource name of the collection the data store belongs to.\nFormat:\n`projects/{project}/locations/{location}/collections/{collection_id}`.", - "type": "string" - }, - "collectionDisplayName": { - "description": "Display name of the collection the data store belongs to.", - "type": "string" - }, - "dataSource": { - "description": "The name of the data source.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1Flow": { - "description": "Flows represents the conversation flows when you build your chatbot agent.\n\nA flow consists of many pages connected by the transition routes.\nConversations always start with the built-in Start Flow (with an all-0 ID).\nTransition routes can direct the conversation session from the current flow\n(parent flow) to another flow (sub flow). When the sub flow is finished,\nDialogflow will bring the session back to the parent flow, where the sub flow\nis started.\n\nUsually, when a transition route is followed by a matched intent, the intent\nwill be \"consumed\". This means the intent won't activate more transition\nroutes. However, when the followed transition route moves the conversation\nsession into a different flow, the matched intent can be carried over and to\nbe consumed in the target flow.", - "type": "object", - "properties": { - "name": { - "description": "The unique identifier of the flow.\nFormat:\n`projects//locations//agents//flows/`.", - "type": "string" - }, - "displayName": { - "description": "Required. The human-readable name of the flow.", - "type": "string" - }, - "description": { - "description": "The description of the flow. The maximum length is 500 characters. If\nexceeded, the request is rejected.", - "type": "string" - }, - "transitionRoutes": { - "description": "A flow's transition routes serve two purposes:\n\n* They are responsible for matching the user's first utterances in the\nflow.\n* They are inherited by every page's transition\nroutes and can support use cases such as the user\nsaying \"help\" or \"can I talk to a human?\", which can be handled in a common\nway regardless of the current page. Transition routes defined in the page\nhave higher priority than those defined in the flow.\n\nTransitionRoutes are evaluated in the following order:\n\n* TransitionRoutes with intent specified.\n* TransitionRoutes with only condition specified.\n\nTransitionRoutes with intent specified are inherited by pages in the flow.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1TransitionRoute" - } - }, - "eventHandlers": { - "description": "A flow's event handlers serve two purposes:\n\n* They are responsible for handling events (e.g. no match,\nwebhook errors) in the flow.\n* They are inherited by every page's event\nhandlers, which can be used to handle common events\nregardless of the current page. Event handlers defined in the page\nhave higher priority than those defined in the flow.\n\nUnlike transition_routes, these handlers are\nevaluated on a first-match basis. The first one that matches the event\nget executed, with the rest being ignored.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1EventHandler" - } - }, - "transitionRouteGroups": { - "description": "Ordered list of `TransitionRouteGroups` added to\nthe flow. If the flow links both flow-level transition route groups and\nagent-level transition route groups, the flow-level ones will have higher\npriority and will be put before the agent-level ones.\n\nA flow's transition route group serve two purposes:\n\n* They are responsible for matching the user's first utterances in the\nflow.\n* They are inherited by every page's transition\nroute groups. Transition route groups\ndefined in the page have higher priority than those defined in the flow.\n\nFormat:`projects//locations//agents//flows//transitionRouteGroups/`\nor\n`projects//locations//agents//transitionRouteGroups/`\nfor agent-level groups.", - "type": "array", - "items": { - "type": "string" - } - }, - "nluSettings": { - "description": "NLU related settings of the flow.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1NluSettings" - }] - }, - "advancedSettings": { - "description": "Hierarchical advanced settings for this flow. The settings exposed at the\nlower level overrides the settings exposed at the higher level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AdvancedSettings" - }] - }, - "knowledgeConnectorSettings": { - "description": "Optional. Knowledge connector configuration.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1KnowledgeConnectorSettings" - }] - }, - "inputParameterDefinitions": { - "description": "Optional. Defined structured input parameters for this flow.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ParameterDefinition" - } - }, - "outputParameterDefinitions": { - "description": "Optional. Defined structured output parameters for this flow.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ParameterDefinition" - } - }, - "multiLanguageSettings": { - "description": "Optional. Multi-lingual agent settings for this flow.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FlowMultiLanguageSettings" - }] - }, - "locked": { - "description": "Indicates whether the flow is locked for changes. If the flow is locked,\nmodifications to the flow will be rejected.", - "type": "boolean" - } - }, - "required": [ - "displayName" - ] - }, - "GoogleCloudDialogflowV3alpha1NluSettings": { - "description": "Settings related to NLU.", - "type": "object", - "properties": { - "modelType": { - "description": "Indicates the type of NLU model.", - "type": "string", - "x-google-enum-descriptions": [ - "Not specified. `MODEL_TYPE_STANDARD` will be used.", - "Use standard NLU model.", - "Use advanced NLU model." - ], - "enum": [ - "MODEL_TYPE_UNSPECIFIED", - "MODEL_TYPE_STANDARD", - "MODEL_TYPE_ADVANCED" - ] - }, - "classificationThreshold": { - "description": "To filter out false positive results and still get variety in matched\nnatural language inputs for your agent, you can tune the machine learning\nclassification threshold. If the returned score value is less than the\nthreshold value, then a no-match event will be triggered. The score values\nrange from 0.0 (completely uncertain) to 1.0 (completely certain). If set\nto 0.0, the default of 0.3 is used. You can set a separate classification\nthreshold for the flow in each language enabled for the agent.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudDialogflowV3alpha1ParameterDefinition": { - "description": "Defines the properties of a parameter.\nUsed to define parameters used in the agent and the\ninput / output parameters for each fulfillment.", - "type": "object", - "properties": { - "name": { - "description": "Required. Name of parameter.", - "type": "string" - }, - "type": { - "description": "Type of parameter.", - "deprecated": true, - "type": "string", - "x-google-enum-descriptions": [ - "Not specified. No validation will be performed.", - "Represents any string value.", - "Represents any number value.", - "Represents a boolean value.", - "Represents a null value.", - "Represents any object value.", - "Represents a repeated value." - ], - "enum": [ - "PARAMETER_TYPE_UNSPECIFIED", - "STRING", - "NUMBER", - "BOOLEAN", - "NULL", - "OBJECT", - "LIST" - ] - }, - "typeSchema": { - "description": "Optional. Type schema of parameter.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1TypeSchema" - }] - }, - "description": { - "description": "Human-readable description of the parameter. Limited to 300 characters.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudDialogflowV3alpha1TypeSchema": { - "description": "Encapsulates different type schema variations: either a reference to an\na schema that's already defined by a tool, or an inline definition.", - "type": "object", - "properties": { - "inlineSchema": { - "description": "Set if this is an inline schema definition.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1InlineSchema" - }] - }, - "schemaReference": { - "description": "Set if this is a schema reference.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1TypeSchemaSchemaReference" - }] - }, - "resourceReference": { - "description": "Set if this is a reference to an agent property, such as entity ID or\nan existing parameter, e.g. sessionId.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1InlineSchema": { - "description": "A type schema object that's specified inline.", - "type": "object", - "properties": { - "type": { - "description": "Data type of the schema.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataType" - }] - }, - "items": { - "description": "Schema of the elements if this is an ARRAY type.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1TypeSchema" - }] - } - } - }, - "GoogleCloudDialogflowV3alpha1TypeSchemaSchemaReference": { - "description": "A reference to the schema of an existing tool.", - "type": "object", - "properties": { - "tool": { - "description": "The tool that contains this schema definition.\nFormat:\n`projects//locations//agents//tools/`.", - "type": "string" - }, - "schema": { - "description": "The name of the schema.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1FlowMultiLanguageSettings": { - "description": "Settings for multi-lingual agents.", - "type": "object", - "properties": { - "enableMultiLanguageDetection": { - "description": "Optional. Enable multi-language detection for this flow. This can be set only if\nagent level multi language\nsetting is enabled.", - "type": "boolean" - }, - "supportedResponseLanguageCodes": { - "description": "Optional. Agent will respond in the detected language if the detected language code\nis in the supported resolved languages for this flow. This will be used\nonly if multi-language training is enabled in the\nagent and multi-language\ndetection is enabled in the\nflow. The\nsupported languages must be a subset of the languages supported by the\nagent.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1Intent": { - "description": "An intent represents a user's intent to interact with a conversational agent.\n\nYou can provide information for the Dialogflow API to use to match user input\nto an intent by adding training phrases (i.e., examples of user input) to\nyour intent.", - "type": "object", - "properties": { - "name": { - "description": "The unique identifier of the intent.\nRequired for the Intents.UpdateIntent method. Intents.CreateIntent\npopulates the name automatically.\nFormat:\n`projects//locations//agents//intents/`.", - "type": "string" - }, - "displayName": { - "description": "Required. The human-readable name of the intent, unique within the agent.", - "type": "string" - }, - "trainingPhrases": { - "description": "The collection of training phrases the agent is trained on to identify the\nintent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1IntentTrainingPhrase" - } - }, - "parameters": { - "description": "The collection of parameters associated with the intent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1IntentParameter" - } - }, - "priority": { - "description": "The priority of this intent. Higher numbers represent higher\npriorities.\n\n- If the supplied value is unspecified or 0, the service\n translates the value to 500,000, which corresponds to the\n `Normal` priority in the console.\n- If the supplied value is negative, the intent is ignored\n in runtime detect intent requests.", - "type": "integer", - "format": "int32" - }, - "isFallback": { - "description": "Indicates whether this is a fallback intent. Currently only default\nfallback intent is allowed in the agent, which is added upon agent\ncreation.\nAdding training phrases to fallback intent is useful in the case of\nrequests that are mistakenly matched, since training phrases assigned to\nfallback intents act as negative examples that triggers no-match event.", - "type": "boolean" - }, - "labels": { - "description": "The key/value metadata to label an intent. Labels can contain\nlowercase letters, digits and the symbols '-' and '_'. International\ncharacters are allowed, including letters from unicase alphabets. Keys must\nstart with a letter. Keys and values can be no longer than 63 characters\nand no more than 128 bytes.\n\nPrefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed\nDialogflow defined labels include:\n* sys-head\n* sys-contextual\nThe above labels do not require value. \"sys-head\" means the intent is a\nhead intent. \"sys-contextual\" means the intent is a contextual intent.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "description": { - "description": "Human readable description for better understanding an intent like its\nscope, content, result etc. Maximum character limit: 140 characters.", - "type": "string" - } - }, - "required": [ - "displayName" - ] - }, - "GoogleCloudDialogflowV3alpha1IntentTrainingPhrase": { - "description": "Represents an example that the agent is trained on to identify the intent.", - "type": "object", - "properties": { - "id": { - "description": "Output only. The unique identifier of the training phrase.", - "readOnly": true, - "type": "string" - }, - "parts": { - "description": "Required. The ordered list of training phrase parts.\nThe parts are concatenated in order to form the training phrase.\n\nNote: The API does not automatically annotate training phrases like the\nDialogflow Console does.\n\nNote: Do not forget to include whitespace at part boundaries, so the\ntraining phrase is well formatted when the parts are concatenated.\n\nIf the training phrase does not need to be annotated with parameters,\nyou just need a single part with only the Part.text field set.\n\nIf you want to annotate the training phrase, you must create multiple\nparts, where the fields of each part are populated in one of two ways:\n\n- `Part.text` is set to a part of the phrase that has no parameters.\n- `Part.text` is set to a part of the phrase that you want to annotate,\n and the `parameter_id` field is set.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1IntentTrainingPhrasePart" - } - }, - "repeatCount": { - "description": "Indicates how many times this example was added to the intent.", - "type": "integer", - "format": "int32" - }, - "synthetic": { - "description": "Optional. Indicates whether this training phrase is synthetically generated.", - "type": "boolean" - } - }, - "required": [ - "parts" - ] - }, - "GoogleCloudDialogflowV3alpha1IntentTrainingPhrasePart": { - "description": "Represents a part of a training phrase.", - "type": "object", - "properties": { - "text": { - "description": "Required. The text for this part.", - "type": "string" - }, - "parameterId": { - "description": "The parameter used to annotate this part of the\ntraining phrase. This field is required for annotated parts of the\ntraining phrase.", - "type": "string" - } - }, - "required": [ - "text" - ] - }, - "GoogleCloudDialogflowV3alpha1IntentParameter": { - "description": "Represents an intent parameter.", - "type": "object", - "properties": { - "id": { - "description": "Required. The unique identifier of the parameter. This field\nis used by training phrases to annotate their\nparts.", - "type": "string" - }, - "entityType": { - "description": "Required. The entity type of the parameter.\nFormat:\n`projects/-/locations/-/agents/-/entityTypes/` for\nsystem entity types (for example,\n`projects/-/locations/-/agents/-/entityTypes/sys.date`), or\n`projects//locations//agents//entityTypes/`\nfor developer entity types.", - "type": "string" - }, - "isList": { - "description": "Indicates whether the parameter represents a list of values.", - "type": "boolean" - }, - "redact": { - "description": "Indicates whether the parameter content should be redacted in log. If\nredaction is enabled, the parameter content will be replaced by parameter\nname during logging.\nNote: the parameter content is subject to redaction if either parameter\nlevel redaction or entity type level redaction is\nenabled.", - "type": "boolean" - } - }, - "required": [ - "id", - "entityType" - ] - }, - "GoogleCloudDialogflowV3alpha1Match": { - "description": "Represents one match result of MatchIntent.", - "type": "object", - "properties": { - "intent": { - "description": "The Intent that matched the query. Some, not all fields are filled in\nthis message, including but not limited to: `name` and `display_name`. Only\nfilled for `INTENT` match type.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Intent" - }] - }, - "event": { - "description": "The event that matched the query. Filled for\n`EVENT`, `NO_MATCH` and\n`NO_INPUT` match types.", - "type": "string" - }, - "parameters": { - "description": "The collection of parameters extracted from the query.\n\nDepending on your protocol or client library language, this is a\nmap, associative array, symbol table, dictionary, or JSON object\ncomposed of a collection of (MapKey, MapValue) pairs:\n\n* MapKey type: string\n* MapKey value: parameter name\n* MapValue type: If parameter's entity type is a composite entity then use\nmap, otherwise, depending on the parameter value type, it could be one of\nstring, number, boolean, null, list or map.\n* MapValue value: If parameter's entity type is a composite entity then use\nmap from composite entity property names to property values, otherwise,\nuse parameter value.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "resolvedInput": { - "description": "Final text input which was matched during MatchIntent. This value can be\ndifferent from original input sent in request because of spelling\ncorrection or other processing.", - "type": "string" - }, - "matchType": { - "description": "Type of this Match.", - "type": "string", - "x-google-enum-descriptions": [ - "Not specified. Should never be used.", - "The query was matched to an intent.", - "The query directly triggered an intent.", - "The query was used for parameter filling.", - "No match was found for the query.", - "Indicates an empty query.", - "The query directly triggered an event.", - "The query was matched to a Knowledge Connector answer.", - "The query was handled by a `Playbook`." - ], - "enum": [ - "MATCH_TYPE_UNSPECIFIED", - "INTENT", - "DIRECT_INTENT", - "PARAMETER_FILLING", - "NO_MATCH", - "NO_INPUT", - "EVENT", - "KNOWLEDGE_CONNECTOR", - "PLAYBOOK" - ] - }, - "confidence": { - "description": "The confidence of this match. Values range from 0.0 (completely uncertain)\nto 1.0 (completely certain).\nThis value is for informational purpose only and is only used to help match\nthe best intent within the classification threshold. This value may change\nfor the same end-user expression at any time due to a model retraining or\nchange in implementation.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudDialogflowV3alpha1GenerativeInfo": { - "description": "Represents the information of a query if handled by generative agent\nresources.", - "type": "object", - "properties": { - "currentPlaybooks": { - "description": "The stack of playbooks that the conversation has\ncurrently entered, with the most recent one on the top.", - "type": "array", - "items": { - "type": "string" - } - }, - "actionTracingInfo": { - "description": "The actions performed by the generative playbook for the current agent\nresponse.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Example" - }] - } - } - }, - "GoogleCloudDialogflowV3alpha1Example": { - "description": "Example represents a sample execution of the playbook in the conversation.\n\nAn example consists of a list of ordered actions performed by end user\nor Dialogflow agent according the playbook instructions to fulfill the task.", - "type": "object", - "properties": { - "name": { - "description": "The unique identifier of the playbook example.\nFormat:\n`projects//locations//agents//playbooks//examples/`.", - "type": "string" - }, - "playbookInput": { - "description": "Optional. The input to the playbook in the example.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookInput" - }] - }, - "playbookOutput": { - "description": "Optional. The output of the playbook in the example.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookOutput" - }] - }, - "actions": { - "description": "Required. The ordered list of actions performed by the end user and the Dialogflow\nagent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Action" - } - }, - "displayName": { - "description": "Required. The display name of the example.", - "type": "string" - }, - "description": { - "description": "Optional. The high level concise description of the example. The max number of\ncharacters is 200.", - "type": "string" - }, - "tokenCount": { - "description": "Output only. Estimated number of tokes current example takes when sent to the LLM.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "createTime": { - "description": "Output only. The timestamp of initial example creation.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. Last time the example was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "conversationState": { - "description": "Required. Example's output state.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1OutputState" - }] - }, - "languageCode": { - "description": "Optional. The language code of the example.\nIf not specified, the agent's default language is used.\nNote: languages must be enabled in the agent before they can be used.\nNote: example's language code is not currently used in dialogflow agents.", - "type": "string" - } - }, - "required": [ - "actions", - "displayName", - "conversationState" - ] - }, - "GoogleCloudDialogflowV3alpha1PlaybookInput": { - "description": "Input of the playbook.", - "type": "object", - "properties": { - "precedingConversationSummary": { - "description": "Optional. Summary string of the preceding conversation for the child playbook\ninvocation.", - "type": "string" - }, - "actionParameters": { - "description": "Optional. A list of input parameters for the action.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudDialogflowV3alpha1PlaybookOutput": { - "description": "Output of the playbook.", - "type": "object", - "properties": { - "executionSummary": { - "description": "Optional. Summary string of the execution result of the child playbook.", - "type": "string" - }, - "state": { - "description": "End state of the playbook.", - "deprecated": true, - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified state.", - "Playbook succeeded.", - "Playbook cancelled.", - "Playbook failed.", - "Playbook failed due to escalation." - ], - "enum": [ - "STATE_UNSPECIFIED", - "OK", - "CANCELLED", - "FAILED", - "ESCALATED" - ] - }, - "actionParameters": { - "description": "Optional. A Struct object of output parameters for the action.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudDialogflowV3alpha1Action": { - "description": "Action performed by end user or Dialogflow agent in the conversation.", - "type": "object", - "properties": { - "userUtterance": { - "description": "Optional. Agent obtained a message from the customer.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1UserUtterance" - }] - }, - "event": { - "description": "Optional. The agent received an event from the customer or a system event is\nemitted.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Event" - }] - }, - "agentUtterance": { - "description": "Optional. Action performed by the agent as a message.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1AgentUtterance" - }] - }, - "toolUse": { - "description": "Optional. Action performed on behalf of the agent by calling a plugin tool.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ToolUse" - }] - }, - "llmCall": { - "description": "Optional. Output only. LLM call performed by the agent.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1LlmCall" - }] - }, - "intentMatch": { - "description": "Optional. Output only. Intent Match in flows.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionIntentMatch" - }] - }, - "flowStateUpdate": { - "description": "Optional. Output only. The state machine update in flows.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionFlowStateUpdate" - }] - }, - "playbookInvocation": { - "description": "Optional. Action performed on behalf of the agent by invoking a child playbook.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookInvocation" - }] - }, - "flowInvocation": { - "description": "Optional. Action performed on behalf of the agent by invoking a CX flow.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FlowInvocation" - }] - }, - "playbookTransition": { - "description": "Optional. Action performed on behalf of the agent by transitioning to a target\nplaybook.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookTransition" - }] - }, - "flowTransition": { - "description": "Optional. Action performed on behalf of the agent by transitioning to a target CX\nflow.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1FlowTransition" - }] - }, - "tts": { - "description": "Optional. Text-to-speech action performed by the agent.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionTTS" - }] - }, - "stt": { - "description": "Optional. Speech-to-text action performed by the agent.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionSTT" - }] - }, - "displayName": { - "description": "Output only. The display name of the action.", - "readOnly": true, - "type": "string" - }, - "startTime": { - "description": "Output only. Timestamp of the start of the agent action.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "completeTime": { - "description": "Output only. Timestamp of the completion of the agent action.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "subExecutionSteps": { - "description": "Optional. The detailed tracing information for sub execution steps of the action.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Span" - } - }, - "status": { - "description": "Optional. Output only. The status of the action.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1Status" - }] - } - } - }, - "GoogleCloudDialogflowV3alpha1UserUtterance": { - "description": "UserUtterance represents one message sent by the customer.", - "type": "object", - "properties": { - "text": { - "description": "Required. Message content in text.", - "type": "string" - }, - "audioTokens": { - "description": "Optional. Tokens of the audio input.", - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - }, - "audio": { - "description": "Optional. Audio input.", - "type": "string", - "format": "byte" - } - }, - "required": [ - "text" - ] - }, - "GoogleCloudDialogflowV3alpha1Event": { - "description": "Event represents the event sent by the customer.", - "type": "object", - "properties": { - "event": { - "description": "Required. Name of the event.", - "type": "string" - }, - "text": { - "description": "Optional. Unstructured text payload of the event.", - "type": "string" - } - }, - "required": [ - "event" - ] - }, - "GoogleCloudDialogflowV3alpha1AgentUtterance": { - "description": "AgentUtterance represents one message sent by the agent.", - "type": "object", - "properties": { - "text": { - "description": "Required. Message content in text.", - "type": "string" - }, - "requireGeneration": { - "description": "Optional. True if the agent utterance needs to be generated by the LLM. Only used in\nwebhook response to differentiate from empty text.\nRevisit whether we need this field or mark `text` as optional when we\nexpose webhook interface to customer.", - "type": "boolean" - } - }, - "required": [ - "text" - ] - }, - "GoogleCloudDialogflowV3alpha1ToolUse": { - "description": "Stores metadata of the invocation of an action supported by a tool.", - "type": "object", - "properties": { - "tool": { - "description": "Required. The tool that should be used.\nFormat:\n`projects//locations//agents//tools/`.", - "type": "string" - }, - "displayName": { - "description": "Output only. The display name of the tool.", - "readOnly": true, - "type": "string" - }, - "action": { - "description": "Optional. Name of the action to be called during the tool use.", - "type": "string" - }, - "inputActionParameters": { - "description": "Optional. A list of input parameters for the action.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "outputActionParameters": { - "description": "Optional. A list of output parameters generated by the action.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "dataStoreToolTrace": { - "description": "Optional. Data store tool trace.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ToolUseDataStoreToolTrace" - }] - }, - "webhookToolTrace": { - "description": "Optional. Webhook tool trace.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ToolUseWebhookToolTrace" - }] - } - }, - "required": [ - "tool" - ] - }, - "GoogleCloudDialogflowV3alpha1ToolUseDataStoreToolTrace": { - "description": "The tracing information for the data store tool.", - "type": "object", - "properties": { - "dataStoreConnectionSignals": { - "description": "Optional. Data store connection feature output signals.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignals" - }] - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignals": { - "description": "Data store connection feature output signals.\nMight be only partially field if processing stop before the final answer.\nReasons for this can be, but are not limited to: empty UCS search results,\npositive RAI check outcome, grounding failure, ...", - "type": "object", - "properties": { - "rewriterModelCallSignals": { - "description": "Optional. Diagnostic info related to the rewriter model call.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsRewriterModelCallSignals" - }] - }, - "rewrittenQuery": { - "description": "Optional. Rewritten string query used for search.", - "type": "string" - }, - "searchSnippets": { - "description": "Optional. Search snippets included in the answer generation prompt.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSearchSnippet" - } - }, - "answerGenerationModelCallSignals": { - "description": "Optional. Diagnostic info related to the answer generation model call.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsAnswerGenerationModelCallSignals" - }] - }, - "answer": { - "description": "Optional. The final compiled answer.", - "type": "string" - }, - "answerParts": { - "description": "Optional. Answer parts with relevant citations.\nConcatenation of texts should add up the `answer` (not counting\nwhitespaces).", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsAnswerPart" - } - }, - "citedSnippets": { - "description": "Optional. Snippets cited by the answer generation model from the most to least\nrelevant.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsCitedSnippet" - } - }, - "groundingSignals": { - "description": "Optional. Grounding signals.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignals" - }] - }, - "safetySignals": { - "description": "Optional. Safety check result.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSafetySignals" - }] - }, - "securitySignals": { - "description": "Optional. Security check result.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSecuritySignals" - }] - }, - "stabilitySignals": { - "description": "Optional. Stability check result.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsStabilitySignals" - }] - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsRewriterModelCallSignals": { - "description": "Diagnostic info related to the rewriter model call.", - "type": "object", - "properties": { - "renderedPrompt": { - "description": "Prompt as sent to the model.", - "type": "string" - }, - "modelOutput": { - "description": "Output of the generative model.", - "type": "string" - }, - "model": { - "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\",\n\"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSearchSnippet": { - "description": "Search snippet details.", - "type": "object", - "properties": { - "documentTitle": { - "description": "Title of the enclosing document.", - "type": "string" - }, - "documentUri": { - "description": "Uri for the document. Present if specified for the document.", - "type": "string" - }, - "text": { - "description": "Text included in the prompt.", - "type": "string" - }, - "metadata": { - "description": "Metadata associated with the document.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsAnswerGenerationModelCallSignals": { - "description": "Diagnostic info related to the answer generation model call.", - "type": "object", - "properties": { - "renderedPrompt": { - "description": "Prompt as sent to the model.", - "type": "string" - }, - "modelOutput": { - "description": "Output of the generative model.", - "type": "string" - }, - "model": { - "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\",\n\"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsAnswerPart": { - "description": "Answer part with citation.", - "type": "object", - "properties": { - "text": { - "description": "Substring of the answer.", - "type": "string" - }, - "supportingIndices": { - "description": "Citations for this answer part. Indices of `search_snippets`.", - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsCitedSnippet": { - "description": "Snippet cited by the answer generation model.", - "type": "object", - "properties": { - "searchSnippet": { - "description": "Details of the snippet.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSearchSnippet" - }] - }, - "snippetIndex": { - "description": "Index of the snippet in `search_snippets` field.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignals": { - "description": "Grounding signals.", - "type": "object", - "properties": { - "decision": { - "description": "Represents the decision of the grounding check.", - "type": "string", - "x-google-enum-descriptions": [ - "Decision not specified.", - "Grounding have accepted the answer.", - "Grounding have rejected the answer." - ], - "enum": [ - "GROUNDING_DECISION_UNSPECIFIED", - "ACCEPTED_BY_GROUNDING", - "REJECTED_BY_GROUNDING" - ] - }, - "score": { - "description": "Grounding score bucket setting.", - "type": "string", - "x-google-enum-descriptions": [ - "Score not specified.", - "We have very low confidence that the answer is grounded.", - "We have low confidence that the answer is grounded.", - "We have medium confidence that the answer is grounded.", - "We have high confidence that the answer is grounded.", - "We have very high confidence that the answer is grounded." - ], - "enum": [ - "GROUNDING_SCORE_BUCKET_UNSPECIFIED", - "VERY_LOW", - "LOW", - "MEDIUM", - "HIGH", - "VERY_HIGH" - ] - }, - "renderedAnswerCandidates": { - "description": "Rendered answer candidates presented to the grounding component.", - "type": "array", - "items": { - "type": "string" - } - }, - "renderedFacts": { - "description": "Rendered facts presented to the grounding component.", - "type": "array", - "items": { - "type": "string" - } - }, - "factTemplate": { - "description": "The fact template string.", - "type": "string" - }, - "factSubstitutions": { - "description": "The fact substitution applied to the template string.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsFactSubstitutions" - } - }, - "explanation": { - "description": "Optional. Explanation for rejecting grounding.", - "type": "string", - "x-google-enum-descriptions": [ - "Explanation not specified.", - "Internal error happened.", - "Grounding was disabled.", - "Source was configured to be ignored.", - "Grounding score was below the threshold.", - "No citations were found.", - "Heuristic number checker rejection.", - "Heuristic pattern checker rejection." - ], - "enum": [ - "GROUNDING_EXPLANATION_UNSPECIFIED", - "INTERNAL_ERROR", - "GROUNDING_DISABLED", - "IGNORE_SOURCE", - "SCORE_BELOW_THRESHOLD", - "NO_CITATIONS", - "HEURISTIC_NUMBER_REJECTED", - "HEURISTIC_PATTERN_REJECTED" - ] - }, - "groundingHeuristicSignals": { - "description": "Grounding heuristic signals, includes information about the execution and\nresult of the grounding heuristics.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsGroundingHeuristicSignals" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsFactSubstitutions": { - "description": "Fact substitutions.", - "type": "object", - "properties": { - "factKeywordSubstitutions": { - "description": "The list of keyword substitutions.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsFactKeywordSubstitution" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsFactKeywordSubstitution": { - "description": "Keyword substitution in the fact template.", - "type": "object", - "properties": { - "key": { - "description": "The template key.", - "type": "string" - }, - "value": { - "description": "The substitution text.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsGroundingSignalsGroundingHeuristicSignals": { - "description": "Grounding heuristic signals, includes information about the execution and\nresult of the grounding heuristics.", - "type": "object", - "properties": { - "heuristicType": { - "description": "The type of the heuristic.", - "type": "string", - "x-google-enum-descriptions": [ - "Heuristic type not specified.", - "Factual numeral checker.", - "Pattern checker." - ], - "enum": [ - "HEURISTIC_TYPE_UNSPECIFIED", - "HEURISTIC_TYPE_NUMBER", - "HEURISTIC_TYPE_PATTERN" - ] - }, - "accepted": { - "description": "Whether the heuristic accepted the answer.", - "type": "boolean" - }, - "debugInfo": { - "description": "Human readable debug information about the execution and result of the\nheuristic. This field is not meant to be consumed programtically or\nexpected to contain specific information.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSafetySignals": { - "description": "Safety check results.", - "type": "object", - "properties": { - "decision": { - "description": "Safety decision.", - "type": "string", - "x-google-enum-descriptions": [ - "Decision not specified.", - "No manual or automatic safety check fired.", - "One ore more safety checks fired." - ], - "enum": [ - "SAFETY_DECISION_UNSPECIFIED", - "ACCEPTED_BY_SAFETY_CHECK", - "REJECTED_BY_SAFETY_CHECK" - ] - }, - "bannedPhraseMatch": { - "description": "Specifies banned phrase match subject.", - "type": "string", - "x-google-enum-descriptions": [ - "No banned phrase check was executed.", - "All banned phrase checks led to no match.", - "A banned phrase matched the query.", - "A banned phrase matched the response." - ], - "enum": [ - "BANNED_PHRASE_MATCH_UNSPECIFIED", - "BANNED_PHRASE_MATCH_NONE", - "BANNED_PHRASE_MATCH_QUERY", - "BANNED_PHRASE_MATCH_RESPONSE" - ] - }, - "matchedBannedPhrase": { - "description": "The matched banned phrase if there was a match.", - "type": "string" - }, - "violatedSafetyCategories": { - "description": "The list of violated safety categories.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsSecuritySignals": { - "description": "Prompt security signals.", - "type": "object", - "properties": { - "renderedPrompt": { - "description": "Optional. Security prompt as sent to the model.", - "type": "string" - }, - "modelOutput": { - "description": "Optional. Raw output of the generative model.", - "type": "string" - }, - "filtered": { - "description": "Whether the user request was blocked by security check.", - "type": "boolean" - }, - "model": { - "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\",\n\"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1DataStoreConnectionSignalsStabilitySignals": { - "description": "Diagnostic info related to the stability module.", - "type": "object", - "properties": { - "relevance": { - "description": "ConversationHistoryRelevance decision.", - "type": "string", - "x-google-enum-descriptions": [ - "The decision is not specified.", - "The conversation history is related to the query.", - "The conversation history is unrelated to the query." - ], - "enum": [ - "CONVERSATION_HISTORY_RELEVANCE_UNSPECIFIED", - "RELEVANT", - "IRRELEVANT" - ] - }, - "decontextualizedQuery": { - "description": "Optional. Deprecated: Stability check no longer returns the decontextualized query.", - "deprecated": true, - "type": "string" - }, - "renderedPrompt": { - "description": "Prompt as sent to the model.", - "type": "string" - }, - "modelOutput": { - "description": "Output of the generative model.", - "type": "string" - }, - "model": { - "description": "Name of the generative model used for stability check.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1ToolUseWebhookToolTrace": { - "description": "The tracing information for the webhook tool.", - "type": "object", - "properties": { - "webhookTag": { - "description": "Optional. The tag of the webhook.", - "type": "string" - }, - "webhookUri": { - "description": "Optional. The url of the webhook.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1LlmCall": { - "description": "Stores metadata of the call of an LLM.", - "type": "object", - "properties": { - "retrievedExamples": { - "description": "A list of relevant examples used for the LLM prompt.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1LlmCallRetrievedExample" - } - }, - "tokenCount": { - "description": "The token counts of the LLM call.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1LlmCallTokenCount" - }] - }, - "model": { - "description": "The model of the LLM call.", - "type": "string" - }, - "temperature": { - "description": "The temperature of the LLM call.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudDialogflowV3alpha1LlmCallRetrievedExample": { - "description": "Relevant example used for the LLM prompt.", - "type": "object", - "properties": { - "exampleId": { - "description": "The id of the example.", - "type": "string" - }, - "exampleDisplayName": { - "description": "The display name of the example.", - "type": "string" - }, - "retrievalStrategy": { - "description": "Retrieval strategy of the example.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1RetrievalStrategy" - }] - }, - "matchedRetrievalLabel": { - "description": "Optional. The matched retrieval label of this LLM call.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1LlmCallTokenCount": { - "description": "Stores token counts of the LLM call.", - "type": "object", - "properties": { - "totalInputTokenCount": { - "description": "The total number of tokens used for the input to the LLM call.", - "type": "string", - "format": "int64" - }, - "conversationContextTokenCount": { - "description": "The number of tokens used for the conversation history in the prompt.", - "type": "string", - "format": "int64" - }, - "exampleTokenCount": { - "description": "The number of tokens used for the retrieved examples in the prompt.", - "type": "string", - "format": "int64" - }, - "totalOutputTokenCount": { - "description": "The total number of tokens used for the output of the LLM call.", - "type": "string", - "format": "int64" - } - } - }, - "GoogleCloudDialogflowV3alpha1ActionIntentMatch": { - "description": "Stores metadata of the intent match action.", - "type": "object", - "properties": { - "matchedIntents": { - "description": "The matched intent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionIntentMatchMatchedIntent" - } - } - } - }, - "GoogleCloudDialogflowV3alpha1ActionIntentMatchMatchedIntent": { - "description": "Stores the matched intent, which is the result of the intent match\naction.", - "type": "object", - "properties": { - "intentId": { - "description": "The ID of the matched intent.", - "type": "string" - }, - "displayName": { - "description": "The display name of the matched intent.", - "type": "string" - }, - "score": { - "description": "The score of the matched intent.", - "type": "number", - "format": "float" - }, - "generativeFallback": { - "description": "The generative fallback response of the matched intent.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudDialogflowV3alpha1ActionFlowStateUpdate": { - "description": "Stores metadata of the state update action, such as a state machine\nexecution in flows.", - "type": "object", - "properties": { - "eventType": { - "description": "The type of the event that triggered the state update.", - "type": "string" - }, - "pageState": { - "description": "The updated page and flow state.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionFlowStateUpdatePageState" - }] - }, - "updatedParameters": { - "description": "The updated parameters.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "destination": { - "description": "The destination of the transition.\nFormat:\n`projects//locations//agents//flows//pages/`\nor\n`projects//locations//agents//playbooks/`.", - "type": "string" - }, - "functionCall": { - "description": "The function call to execute.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ActionFlowStateUpdateFunctionCall" - }] - } - } - }, - "GoogleCloudDialogflowV3alpha1ActionFlowStateUpdatePageState": { - "description": "Stores the state of a page and its flow.", - "type": "object", - "properties": { - "page": { - "description": "The ID of the page.\nFormat:\n`projects//locations//agents//flows//pages/`.", - "type": "string" - }, - "displayName": { - "description": "The display name of the page.", - "type": "string" - }, - "status": { - "description": "The status of the page.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1ActionFlowStateUpdateFunctionCall": { - "description": "Stores the metadata of a function call to execute.", - "type": "object", - "properties": { - "name": { - "description": "The name of the function call.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1PlaybookInvocation": { - "description": "Stores metadata of the invocation of a child playbook. Playbook invocation\nactions enter the child playbook.", - "type": "object", - "properties": { - "playbook": { - "description": "Required. The unique identifier of the playbook.\nFormat:\n`projects//locations//agents//playbooks/`.", - "type": "string" - }, - "displayName": { - "description": "Output only. The display name of the playbook.", - "readOnly": true, - "type": "string" - }, - "playbookInput": { - "description": "Optional. Input of the child playbook invocation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookInput" - }] - }, - "playbookOutput": { - "description": "Optional. Output of the child playbook invocation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1PlaybookOutput" - }] - }, - "playbookState": { - "description": "Required. Playbook invocation's output state.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1OutputState" - }] - } - }, - "required": [ - "playbook", - "playbookState" - ] - }, - "GoogleCloudDialogflowV3alpha1FlowInvocation": { - "description": "Stores metadata of the invocation of a child CX flow. Flow invocation actions\nenter the child flow.", - "type": "object", - "properties": { - "flow": { - "description": "Required. The unique identifier of the flow.\nFormat:\n`projects//locations//agents/`.", - "type": "string" - }, - "displayName": { - "description": "Output only. The display name of the flow.", - "readOnly": true, - "type": "string" - }, - "inputActionParameters": { - "description": "Optional. A list of input parameters for the flow.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "outputActionParameters": { - "description": "Optional. A list of output parameters generated by the flow invocation.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "flowState": { - "description": "Required. Flow invocation's output state.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1OutputState" - }] - } - }, - "required": [ - "flow", - "flowState" - ] - }, - "GoogleCloudDialogflowV3alpha1PlaybookTransition": { - "description": "Stores metadata of the transition to another target playbook. Playbook\ntransition actions exit the caller playbook and enter the target playbook.", - "type": "object", - "properties": { - "playbook": { - "description": "Required. The unique identifier of the playbook.\nFormat:\n`projects//locations//agents//playbooks/`.", - "type": "string" - }, - "displayName": { - "description": "Output only. The display name of the playbook.", - "readOnly": true, - "type": "string" - }, - "inputActionParameters": { - "description": "A list of input parameters for the action.", - "deprecated": true, - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - }, - "required": [ - "playbook" - ] - }, - "GoogleCloudDialogflowV3alpha1FlowTransition": { - "description": "Stores metadata of the transition to a target CX flow. Flow transition\nactions exit the caller playbook and enter the child flow.", - "type": "object", - "properties": { - "flow": { - "description": "Required. The unique identifier of the flow.\nFormat:\n`projects//locations//agents/`.", - "type": "string" - }, - "displayName": { - "description": "Output only. The display name of the flow.", - "readOnly": true, - "type": "string" - }, - "inputActionParameters": { - "description": "A list of input parameters for the action.", - "deprecated": true, - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - }, - "required": [ - "flow" - ] - }, - "GoogleCloudDialogflowV3alpha1ActionTTS": { - "description": "Stores metadata of the Text-to-Speech action.", - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ActionSTT": { - "description": "Stores metadata of the Speech-to-Text action.", - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1Span": { - "description": "A span represents a sub execution step of an action.", - "type": "object", - "properties": { - "name": { - "description": "The name of the span.", - "type": "string" - }, - "tags": { - "description": "The metadata tags of the span such as span type.", - "type": "array", - "items": { - "type": "string" - } - }, - "metrics": { - "description": "The unordered collection of metrics in this span.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1NamedMetric" - } - }, - "startTime": { - "description": "Timestamp of the start of the span.", - "type": "string", - "format": "date-time" - }, - "completeTime": { - "description": "Timestamp of the completion of the span.", - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudDialogflowV3alpha1NamedMetric": { - "description": "A named metric is a metric with name, value and unit.", - "type": "object", - "properties": { - "name": { - "description": "The name of the metric.", - "type": "string" - }, - "value": { - "description": "The value of the metric." - }, - "unit": { - "description": "The unit in which this metric is reported. Follows [The Unified Code for\nUnits of Measure](https://unitsofmeasure.org/ucum.html) standard.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1Status": { - "description": "The status of the action.", - "type": "object", - "properties": { - "exception": { - "description": "Optional. The exception thrown during the execution of the action.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1ExceptionDetail" - }] - } - } - }, - "GoogleCloudDialogflowV3alpha1ExceptionDetail": { - "description": "Exception thrown during the execution of an action.", - "type": "object", - "properties": { - "errorMessage": { - "description": "Optional. The error message.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1SentimentAnalysisResult": { - "description": "The result of sentiment analysis. Sentiment analysis inspects user input\nand identifies the prevailing subjective opinion, especially to determine a\nuser's attitude as positive, negative, or neutral.", - "type": "object", - "properties": { - "score": { - "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive\n sentiment).", - "type": "number", - "format": "float" - }, - "magnitude": { - "description": "A non-negative number in the [0, +inf) range, which represents the absolute\nmagnitude of sentiment, regardless of score (positive or negative).", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudDialogflowV3alpha1OutputAudioConfig": { - "description": "Instructs the speech synthesizer how to generate the output audio content.", - "type": "object", - "properties": { - "audioEncoding": { - "description": "Required. Audio encoding of the synthesized audio content.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1OutputAudioEncoding" - }] - }, - "sampleRateHertz": { - "description": "Optional. The synthesis sample rate (in hertz) for this audio. If not\nprovided, then the synthesizer will use the default sample rate based on\nthe audio encoding. If this is different from the voice's natural sample\nrate, then the synthesizer will honor this request by converting to the\ndesired sample rate (which might result in worse audio quality).", - "type": "integer", - "format": "int32" - }, - "synthesizeSpeechConfig": { - "description": "Optional. Configuration of how speech should be synthesized.\nIf not specified, Agent.text_to_speech_settings is applied.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1SynthesizeSpeechConfig" - }] - } - }, - "required": [ - "audioEncoding" - ] - }, - "GoogleCloudDialogflowV3alpha1SynthesizeSpeechConfig": { - "description": "Configuration of how speech should be synthesized.", - "type": "object", - "properties": { - "speakingRate": { - "description": "Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal\nnative speed supported by the specific voice. 2.0 is twice as fast, and\n0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any\nother values < 0.25 or > 4.0 will return an error.", - "type": "number", - "format": "double" - }, - "pitch": { - "description": "Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20\nsemitones from the original pitch. -20 means decrease 20 semitones from the\noriginal pitch.", - "type": "number", - "format": "double" - }, - "volumeGainDb": { - "description": "Optional. Volume gain (in dB) of the normal native volume supported by the\nspecific voice, in the range [-96.0, 16.0]. If unset, or set to a value of\n0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)\nwill play at approximately half the amplitude of the normal native signal\namplitude. A value of +6.0 (dB) will play at approximately twice the\namplitude of the normal native signal amplitude. We strongly recommend not\nto exceed +10 (dB) as there's usually no effective increase in loudness for\nany value greater than that.", - "type": "number", - "format": "double" - }, - "effectsProfileId": { - "description": "Optional. An identifier which selects 'audio effects' profiles that are\napplied on (post synthesized) text to speech. Effects are applied on top of\neach other in the order they are given.", - "type": "array", - "items": { - "type": "string" - } - }, - "voice": { - "description": "Optional. The desired voice of the synthesized audio.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1VoiceSelectionParams" - }] - }, - "pronunciations": { - "description": "Optional. The custom pronunciations for the synthesized audio.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1CustomPronunciationParams" - } - }, - "speakingPace": { - "description": "Adjusts the speaking pace based on the voice's learned speed distribution\nby the model in the range [-3.0, 3.0] (e.g., 1.0 is 1 standard deviation\nfaster).\n- 0.0: Represents the average/neutral speaking pace.\n- Positive values (>0.0): Make the speech pace faster.\n- Negative values (<0.0): Make the speech pace slower.\nRecommended for achieving consistent speech pace eg. customer care bots.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudDialogflowV3alpha1VoiceSelectionParams": { - "description": "Description of which voice to use for speech synthesis.", - "type": "object", - "properties": { - "name": { - "description": "Optional. The name of the voice. If not set, the service will choose a\nvoice based on the other parameters such as language_code and\nssml_gender.\n\nFor the list of available voices, please refer to [Supported voices and\nlanguages](https://cloud.google.com/text-to-speech/docs/voices).", - "type": "string" - }, - "ssmlGender": { - "description": "Optional. The preferred gender of the voice. If not set, the service will\nchoose a voice based on the other parameters such as language_code and\nname. Note that this is only a preference, not requirement. If a\nvoice of the appropriate gender is not available, the synthesizer should\nsubstitute a voice with a different gender rather than failing the request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1SsmlVoiceGender" - }] - }, - "customVoice": { - "description": "Optional. Configuration for a custom synthesis voice. If specified, the service will\nuse this custom voice instead of taking name and ssml_gender into\naccount to select a voice. If the custom voice doesn't exist or isn't\naccessible, Dialogflow will return an error.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1VoiceSelectionParamsCustomVoiceParams" - }] - }, - "voiceCloningKey": { - "description": "Optional. Key that is generated by Cloud TTS for the voice to clone. If specified,\nDialogflow will pass the key to Cloud TTS.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1VoiceSelectionParamsCustomVoiceParams": { - "description": "Configuration for a custom synthesis voice.", - "type": "object", - "properties": { - "model": { - "description": "Required. The name of the AutoML model that synthesizes the custom voice.", - "type": "string" - }, - "reportedUsage": { - "description": "Optional. The usage of the synthesized audio to be reported.", - "type": "string", - "x-google-enum-descriptions": [ - "Request with reported usage unspecified will be rejected.", - "For scenarios where the synthesized audio is not downloadable and can\nonly be used once. For example, real-time request in IVR system.", - "For scenarios where the synthesized audio is downloadable and can be\nreused. For example, the synthesized audio is downloaded, stored in\ncustomer service system and played repeatedly." - ], - "enum": [ - "REPORTED_USAGE_UNSPECIFIED", - "REALTIME", - "OFFLINE" - ] - } - }, - "required": [ - "model" - ] - }, - "GoogleCloudDialogflowV3alpha1CustomPronunciationParams": { - "description": "Pronunciation customization for a phrase.", - "type": "object", - "properties": { - "phrase": { - "description": "The phrase to which the customization is applied.\nThe phrase can be multiple words, such as proper nouns, but shouldn't span\nthe length of the sentence.", - "type": "string" - }, - "phoneticEncoding": { - "description": "The phonetic encoding of the phrase.", - "type": "string", - "x-google-enum-descriptions": [ - "Not specified.", - "IPA, such as apple -> \u02C8\u00E6p\u0259l.\nhttps://en.wikipedia.org/wiki/International_Phonetic_Alphabet", - "X-SAMPA, such as apple -> \"{p@l\".\nhttps://en.wikipedia.org/wiki/X-SAMPA" - ], - "enum": [ - "PHONETIC_ENCODING_UNSPECIFIED", - "PHONETIC_ENCODING_IPA", - "PHONETIC_ENCODING_X_SAMPA" - ] - }, - "pronunciation": { - "description": "The pronunciation of the phrase. This must be in the phonetic encoding\nspecified above.", - "type": "string" - } - } - }, - "GoogleCloudDialogflowV3alpha1DetectIntentResponseFeatureUsage": { - "description": "Describes feature used during request processing.", - "type": "object", - "properties": { - "feature": { - "description": "Feature name.", - "type": "string", - "x-google-enum-descriptions": [ - "No Feature specified.", - "Generative playbook.", - "Generator.", - "Infobot (data store invocation).", - "Hyper human listening feature.", - "Generative fallback." - ], - "enum": [ - "FEATURE_UNSPECIFIED", - "PLAYBOOK", - "GENERATOR", - "DATA_STORE", - "HYPER_HUMAN_LISTENING", - "GENERATIVE_FALLBACK" - ] - }, - "metrics": { - "description": "Map of feature specific metrics.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudContactcenterinsightsV1AnswerFeedback": { - "description": "The feedback that the customer has about a certain answer in the\nconversation.", - "type": "object", - "properties": { - "correctnessLevel": { - "description": "The correctness level of an answer.", - "type": "string", - "x-google-enum-descriptions": [ - "Correctness level unspecified.", - "Answer is totally wrong.", - "Answer is partially correct.", - "Answer is fully correct." - ], - "enum": [ - "CORRECTNESS_LEVEL_UNSPECIFIED", - "NOT_CORRECT", - "PARTIALLY_CORRECT", - "FULLY_CORRECT" - ] - }, - "clicked": { - "description": "Indicates whether an answer or item was clicked by the human agent.", - "type": "boolean" - }, - "displayed": { - "description": "Indicates whether an answer or item was displayed to the human agent in the\nagent desktop UI.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput": { - "description": "Explicit input used for generating the answer", - "type": "object", - "properties": { - "query": { - "description": "Query text. Article Search uses this to store the input query used\nto generate the search results.", - "type": "string" - }, - "generatorName": { - "description": "The resource name of associated generator. Format:\n`projects//locations//generators/`", - "type": "string" - }, - "querySource": { - "description": "Query source for the answer.", - "type": "string", - "x-google-enum-descriptions": [ - "Unknown query source.", - "The query is from agents.", - "The query is a query from previous suggestions, e.g. from a preceding\nSuggestKnowledgeAssist response.", - "The query is from the end user." - ], - "enum": [ - "QUERY_SOURCE_UNSPECIFIED", - "AGENT_QUERY", - "SUGGESTED_QUERY", - "END_USER_QUERY" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1DialogflowIntent": { - "description": "The data for a Dialogflow intent.\nRepresents a detected intent in the conversation, e.g. MAKES_PROMISE.", - "type": "object", - "properties": { - "displayName": { - "description": "The human-readable name of the intent.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DialogflowCxConversationData": { - "description": "The metadata for a Dialogflow CX conversation.", - "type": "object", - "properties": { - "virtualAgentId": { - "description": "The virtual agent id of this conversation.", - "type": "string" - }, - "flowIds": { - "description": "The deduped flow UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "flowDisplayNames": { - "description": "The deduped flow display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "pageIds": { - "description": "The deduped page UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "pageDisplayNames": { - "description": "The deduped page display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "intentIds": { - "description": "The deduped intent UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "intentDisplayNames": { - "description": "The deduped intent display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "experimentIds": { - "description": "The deduped experiment UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "experimentDisplayNames": { - "description": "The deduped experiment display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "inputAudioDuration": { - "description": "The total duration of the user input audio in this conversation.", - "type": "string", - "format": "google-duration" - }, - "outputAudioDuration": { - "description": "The total duration of the agent output audio in this conversation.", - "type": "string", - "format": "google-duration" - }, - "queryInputStats": { - "description": "Query input stats", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowCxConversationDataQueryInputStats" - }] - }, - "matchTypeStats": { - "description": "Match type stats.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowCxConversationDataMatchTypeStats" - }] - }, - "averageMatchConfidence": { - "description": "Average match confidence for all the initent matches in this conversation.", - "type": "number", - "format": "float" - }, - "endSessionExit": { - "description": "Whether the conversation reaches END_FLOW or END_SESSION.", - "type": "boolean" - }, - "maxWebhookLatency": { - "description": "The maximum webhook latency for an individual webhook call in this\nconversation.", - "type": "string", - "format": "google-duration" - }, - "liveAgentHandoff": { - "description": "Whether the conversation was handed off to a human agent.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1DialogflowCxConversationDataQueryInputStats": { - "description": "Count by input types in this conversation", - "type": "object", - "properties": { - "textCount": { - "description": "The number of requests with text input.", - "type": "integer", - "format": "int32" - }, - "intentCount": { - "description": "The number of requests with intent input.", - "type": "integer", - "format": "int32" - }, - "audioCount": { - "description": "The number of requests with audio input.", - "type": "integer", - "format": "int32" - }, - "eventCount": { - "description": "The number of requests with event input.", - "type": "integer", - "format": "int32" - }, - "dtmfCount": { - "description": "The number of requests with DTMF input.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1DialogflowCxConversationDataMatchTypeStats": { - "description": "Count by match types in this conversation .", - "type": "object", - "properties": { - "intentCount": { - "description": "The number of responses with match type INTENT.", - "type": "integer", - "format": "int32" - }, - "directIntentCount": { - "description": "The number of responses with match type DIRECT_INTENT.", - "type": "integer", - "format": "int32" - }, - "parameterFillingCount": { - "description": "The number of responses with match type PARAMETER_FILLING.", - "type": "integer", - "format": "int32" - }, - "noMatchCount": { - "description": "The number of responses with match type NO_MATCH.", - "type": "integer", - "format": "int32" - }, - "noInputCount": { - "description": "The number of responses with match type NO_INPUT.", - "type": "integer", - "format": "int32" - }, - "eventCount": { - "description": "The number of responses with match type EVENT.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationAgentAssistSupervisorMonitoringStatus": { - "description": "Tracks the status of an AA supervisor monitoring a conversation.", - "type": "object", - "properties": { - "monitored": { - "description": "The conversation was monitored by an AA supervisor.", - "type": "boolean" - }, - "escalatedToSupervisor": { - "description": "The conversation was escalated to an AA supervisor for intervention.", - "type": "boolean" - }, - "assignedSupervisor": { - "description": "The ID of the assigned AA supervisor.", - "type": "string" - }, - "transferredToHumanAgent": { - "description": "The conversation was transferred to a human agent by the AA supervisor.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo": { - "description": "Info for correlating across conversations.", - "type": "object", - "properties": { - "fullConversationCorrelationId": { - "description": "Output only. The full conversation correlation id this conversation is a segment of.", - "readOnly": true, - "type": "string" - }, - "mergedFullConversationCorrelationId": { - "description": "Output only. The full conversation correlation id this conversation is a merged\nconversation of.", - "readOnly": true, - "type": "string" - }, - "correlationTypes": { - "description": "Output only. The correlation types of this conversation. A single conversation can\nhave multiple correlation types. For example a conversation that only has\na single segment is both a SEGMENT and a FULL_CONVERSATION.", - "readOnly": true, - "type": "array", - "items": { - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "This conversation represents a segment of a full conversation. The\nlowest level of granularity.", - "This conversation represents a partial conversation of potentially\nmultiple segments but is not a full conversation.", - "This conversation represents a full conversation of potentially\nmultiple segments.", - "This conversation represents a synthetic conversation." - ], - "enum": [ - "CORRELATION_TYPE_UNSPECIFIED", - "SEGMENT", - "PARTIAL", - "FULL", - "SYNTHETIC" - ] - } - } - } - }, - "GoogleCloudContactcenterinsightsV1UploadConversationRequest": { - "description": "Request to upload a conversation.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the conversation.", - "type": "string" - }, - "conversation": { - "description": "Required. The conversation resource to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - }] - }, - "conversationId": { - "description": "Optional. A unique ID for the new conversation. This ID will become the final\ncomponent of the conversation's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", - "type": "string" - }, - "redactionConfig": { - "description": "Optional. DLP settings for transcript redaction. Will default to the config specified\nin Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig" - }] - }, - "speechConfig": { - "description": "Optional. Speech-to-Text configuration. Will default to the config specified\nin Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig" - }] - } - }, - "required": [ - "parent", - "conversation" - ] - }, - "GoogleCloudContactcenterinsightsV1RedactionConfig": { - "description": "DLP resources used for redaction while ingesting conversations.\nDLP settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint or the Dialogflow / Agent\nAssist runtime integrations. When using Dialogflow / Agent Assist runtime\nintegrations, redaction should be performed in Dialogflow / Agent Assist.", - "type": "object", - "properties": { - "deidentifyTemplate": { - "description": "The fully-qualified DLP deidentify template resource name.\nFormat:\n`projects/{project}/deidentifyTemplates/{template}`", - "type": "string" - }, - "inspectTemplate": { - "description": "The fully-qualified DLP inspect template resource name.\nFormat:\n`projects/{project}/locations/{location}/inspectTemplates/{template}`", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1SpeechConfig": { - "description": "Speech-to-Text configuration.\nSpeech-to-Text settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint.", - "type": "object", - "properties": { - "speechRecognizer": { - "description": "The fully-qualified Speech Recognizer resource name.\nFormat:\n`projects/{project_id}/locations/{location}/recognizer/{recognizer}`", - "type": "string" - }, - "disableWordTimeOffsets": { - "description": "Whether to disable word time offsets.\nIf true, the `enable_word_time_offsets` field in the recognition config\nwill be set to false.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1UploadConversationMetadata": { - "description": "The metadata for an `UploadConversation` operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest" - }] - }, - "analysisOperation": { - "description": "Output only. The operation name for a successfully created analysis operation, if any.", - "readOnly": true, - "type": "string" - }, - "appliedRedactionConfig": { - "description": "Output only. The redaction config applied to the uploaded conversation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ListConversationsResponse": { - "description": "The response of listing conversations.", - "type": "object", - "properties": { - "conversations": { - "description": "The conversations that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - } - }, - "nextPageToken": { - "description": "A token which can be sent as `page_token` to retrieve the next page. If\nthis field is set, it means there is another page available. If it is not\nset, it means no other pages are available.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse": { - "description": "The response from a GenerateConversationSignedAudio request.", - "type": "object", - "properties": { - "signedAudioUris": { - "description": "The signed uris for the audio.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SignedAudioUris" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1SignedAudioUris": { - "description": "Signed audio URIs for a conversation.", - "type": "object", - "properties": { - "signedGcsAudioUri": { - "description": "The signed URI for the audio from the Cloud Storage conversation source.", - "type": "string" - }, - "signedDialogflowAudioUri": { - "description": "The signed URI for the audio from the Dialogflow conversation source.", - "type": "string" - }, - "signedTurnLevelAudios": { - "description": "The signed URI for the audio corresponding to each turn in the\nconversation.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio": { - "description": "A wrapper for holding the audio for any given turn.", - "type": "object", - "properties": { - "audioGcsUri": { - "description": "The Cloud Storage URI of the audio for any given turn.", - "type": "string" - }, - "audioDuration": { - "description": "The duration of the audio.", - "type": "string", - "format": "google-duration" - } - } - }, - "GoogleCloudContactcenterinsightsV1Dataset": { - "description": "Dataset resource represents a collection of conversations\nthat may be bounded (Static Dataset, e.g. golden dataset for training),\nor unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", - "type": "object", - "properties": { - "name": { - "description": "Immutable. Identifier. Resource name of the dataset.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}", - "x-google-immutable": true, - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "Display name for the dataaset", - "type": "string" - }, - "description": { - "description": "Dataset description.", - "type": "string" - }, - "type": { - "description": "Dataset usage type.", - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "For evals only.", - "Dataset with new conversations coming in regularly (Insights legacy\nconversations and AI trainer)" - ], - "enum": [ - "TYPE_UNSPECIFIED", - "EVAL", - "LIVE" - ] - }, - "ttl": { - "description": "Optional. Option TTL for the dataset.", - "type": "string", - "format": "google-duration" - }, - "createTime": { - "description": "Output only. Dataset create time.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. Dataset update time.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListDatasetsResponse": { - "description": "The response to list datasets.", - "type": "object", - "properties": { - "datasets": { - "description": "The datasets that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DeleteDatasetMetadata": { - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1SampleConversationsRequest": { - "description": "The request to sample conversations to a dataset.", - "type": "object", - "properties": { - "destinationDataset": { - "description": "The dataset resource to copy the sampled conversations to.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset" - }] - }, - "parent": { - "description": "Required. The parent resource of the dataset.", - "type": "string" - }, - "sampleRule": { - "description": "Optional. The sample rule used for sampling conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleRule" - }] - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1SampleRule": { - "description": "Message for sampling conversations.", - "type": "object", - "properties": { - "samplePercentage": { - "description": "Percentage of conversations that we should sample based on the dimension\nbetween [0, 100].", - "type": "number", - "format": "double" - }, - "sampleRow": { - "description": "Number of the conversations that we should sample based on the dimension.", - "type": "string", - "format": "int64" - }, - "dimension": { - "description": "Optional. Group by dimension to sample the conversation. If no dimension is\nprovided, the sampling will be applied to the project level.\nCurrent supported dimensions is 'quality_metadata.agent_info.agent_id'.", - "type": "string" - }, - "conversationFilter": { - "description": "To specify the filter for the conversions that should apply this sample\nrule. An empty filter means this sample rule applies to all conversations.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1SampleConversationsResponse": { - "description": "The response to an SampleConversations operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata": { - "description": "The metadata for an SampleConversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for sample conversations to dataset.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsRequest" - }] - }, - "partialErrors": { - "description": "Output only. Partial errors during sample conversations operation that might\ncause the operation output to be incomplete.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "sampleConversationsStats": { - "description": "Output only. Statistics for SampleConversations operation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats": { - "description": "Statistics for SampleConversations operation.", - "type": "object", - "properties": { - "successfulSampleCount": { - "description": "Output only. The number of new conversations added during this sample operation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "failedSampleCount": { - "description": "Output only. The number of objects which were unable to be sampled due to errors.\nThe errors are populated in the partial_errors field.", - "readOnly": true, - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata": { - "description": "Metadata for a create analysis operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "conversation": { - "description": "Output only. The Conversation that this Analysis Operation belongs to.", - "readOnly": true, - "type": "string" - }, - "annotatorSelector": { - "description": "Output only. The annotator selector used for the analysis (if any).", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ListAnalysesResponse": { - "description": "The response to list analyses.", - "type": "object", - "properties": { - "analyses": { - "description": "The analyses that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest": { - "description": "The request to analyze conversations in bulk.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource to create analyses in.", - "type": "string" - }, - "filter": { - "description": "Required. Filter used to select the subset of conversations to analyze.", - "type": "string" - }, - "analysisPercentage": { - "description": "Required. Percentage of selected conversation to analyze, between\n[0, 100].", - "type": "number", - "format": "float" - }, - "annotatorSelector": { - "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector" - }] - } - }, - "required": [ - "parent", - "filter", - "analysisPercentage" - ] - }, - "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse": { - "description": "The response for a bulk analyze conversations operation.", - "type": "object", - "properties": { - "successfulAnalysisCount": { - "description": "Count of successful analyses.", - "type": "integer", - "format": "int32" - }, - "failedAnalysisCount": { - "description": "Count of failed analyses.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata": { - "description": "The metadata for a bulk analyze conversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for bulk analyze.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" - }] - }, - "completedAnalysesCount": { - "description": "The number of requested analyses that have completed successfully so far.", - "type": "integer", - "format": "int32" - }, - "failedAnalysesCount": { - "description": "The number of requested analyses that have failed so far.", - "type": "integer", - "format": "int32" - }, - "totalRequestedAnalysesCount": { - "description": "Total number of analyses requested. Computed by the number of conversations\nreturned by `filter` multiplied by `analysis_percentage` in the request.", - "type": "integer", - "format": "int32" - }, - "partialErrors": { - "description": "Output only. Partial errors during bulk analyze operation that might cause the operation\noutput to be incomplete.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest": { - "description": "The request to delete conversations in bulk.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource to delete conversations from.\nFormat:\nprojects/{project}/locations/{location}", - "type": "string" - }, - "filter": { - "description": "Filter used to select the subset of conversations to delete.", - "type": "string" - }, - "maxDeleteCount": { - "description": "Maximum number of conversations to delete.", - "type": "integer", - "format": "int32" - }, - "force": { - "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", - "type": "boolean" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse": { - "description": "The response for a bulk delete conversations operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata": { - "description": "The metadata for a bulk delete conversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for bulk delete.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during bulk delete conversations operation that might cause\nthe operation output to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1IngestConversationsRequest": { - "description": "The request to ingest conversations.", - "type": "object", - "properties": { - "gcsSource": { - "description": "A cloud storage bucket source. Note that any previously ingested objects\nfrom the source will be skipped to avoid duplication.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource" - }] - }, - "transcriptObjectConfig": { - "description": "Configuration for when `source` contains conversation transcripts.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig" - }] - }, - "parent": { - "description": "Required. The parent resource for new conversations.", - "type": "string" - }, - "conversationConfig": { - "description": "Configuration that applies to all conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig" - }] - }, - "redactionConfig": { - "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config\nspecified in Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig" - }] - }, - "speechConfig": { - "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config\nspecified in Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig" - }] - }, - "sampleSize": { - "description": "Optional. If set, this fields indicates the number of objects to ingest from the\nCloud Storage bucket. If empty, the entire bucket will be ingested.\nUnless they are first deleted, conversations produced through sampling\nwon't be ingested by subsequent ingest requests.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource": { - "description": "Configuration for Cloud Storage bucket sources.", - "type": "object", - "properties": { - "bucketUri": { - "description": "Optional. The Cloud Storage bucket containing source objects.\nAvoid passing this. Pass this through one of `transcript_bucket_uri` or\n`audio_bucket_uri`.", - "type": "string" - }, - "bucketObjectType": { - "description": "Optional. Specifies the type of the objects in `bucket_uri`.\nAvoid passing this. This is inferred from the `transcript_bucket_uri`,\n`audio_bucket_uri`.", - "type": "string", - "x-google-enum-descriptions": [ - "The object type is unspecified and will default to `TRANSCRIPT`.", - "The object is a transcript.", - "The object is an audio file." - ], - "enum": [ - "BUCKET_OBJECT_TYPE_UNSPECIFIED", - "TRANSCRIPT", - "AUDIO" - ] - }, - "transcriptBucketUri": { - "description": "Optional. The Cloud Storage path to the conversation transcripts. Note\nthat: [1] Transcript files are expected to be in JSON format. [2]\nTranscript, audio, metadata files must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", - "type": "string" - }, - "audioBucketUri": { - "description": "Optional. The Cloud Storage path to the conversation audio file.\nNote that: [1] Audio files will be transcribed if not already.\n[2] Audio files and transcript files must be in separate\nbuckets / folders.\n[3] A source file and its corresponding audio file\nmust share the same name to\n be properly ingested, E.g.\n `gs://bucket/transcript/conversation1.json` and\n `gs://bucket/audio/conversation1.mp3`.", - "type": "string" - }, - "metadataBucketUri": { - "description": "Optional. The Cloud Storage path to the conversation metadata. Note that:\n[1] Metadata files are expected to be in JSON format.\n[2] Metadata and source files (transcripts or audio) must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", - "type": "string" - }, - "customMetadataKeys": { - "description": "Optional. Custom keys to extract as conversation labels from metadata files in\n`metadata_bucket_uri`. Keys not included in this field will be ignored.\nNote that there is a limit of 100 labels per conversation.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig": { - "description": "Configuration for processing transcript objects.", - "type": "object", - "properties": { - "medium": { - "description": "Required. The medium transcript objects represent.", - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "The format for conversations that took place over the phone.", - "The format for conversations that took place over chat." - ], - "enum": [ - "MEDIUM_UNSPECIFIED", - "PHONE_CALL", - "CHAT" - ] - } - }, - "required": [ - "medium" - ] - }, - "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig": { - "description": "Configuration that applies to all conversations.", - "type": "object", - "properties": { - "agentId": { - "description": "Optional. An opaque, user-specified string representing a human agent who handled\nall conversations in the import. Note that this will be overridden if\nper-conversation metadata is provided through the `metadata_bucket_uri`.", - "type": "string" - }, - "agentChannel": { - "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", - "type": "integer", - "format": "int32" - }, - "customerChannel": { - "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1IngestConversationsResponse": { - "description": "The response to an IngestConversations operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata": { - "description": "The metadata for an IngestConversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for ingest.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest" - }] - }, - "partialErrors": { - "description": "Output only. Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "ingestConversationsStats": { - "description": "Output only. Statistics for IngestConversations operation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats" - }] - }, - "sampledConversations": { - "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats": { - "description": "Statistics for IngestConversations operation.", - "type": "object", - "properties": { - "processedObjectCount": { - "description": "Output only. The number of objects processed during the ingest operation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "duplicatesSkippedCount": { - "description": "Output only. The number of objects skipped because another conversation with the same\ntranscript uri had already been ingested.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "successfulIngestCount": { - "description": "Output only. The number of new conversations added during this ingest operation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "failedIngestCount": { - "description": "Output only. The number of objects which were unable to be ingested due to errors.\nThe errors are populated in the partial_errors field.", - "readOnly": true, - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest": { - "description": "The request to export insights.", - "type": "object", - "properties": { - "bigQueryDestination": { - "description": "Specified if sink is a BigQuery table.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination" - }] - }, - "parent": { - "description": "Required. The parent resource to export data from.", - "type": "string" - }, - "filter": { - "description": "A filter to reduce results to a specific subset. Useful for exporting\nconversations with specific properties.", - "type": "string" - }, - "kmsKey": { - "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK.\nFormat:\nprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", - "type": "string" - }, - "writeDisposition": { - "description": "Options for what to do if the destination table already exists.", - "type": "string", - "x-google-enum-descriptions": [ - "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", - "If the table already exists, BigQuery will overwrite the table data and\nuse the schema from the load.", - "If the table already exists, BigQuery will append data to the table." - ], - "enum": [ - "WRITE_DISPOSITION_UNSPECIFIED", - "WRITE_TRUNCATE", - "WRITE_APPEND" - ] - }, - "exportSchemaVersion": { - "description": "Optional. Version of the export schema.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified. Defaults to EXPORT_V3.", - "Export schema version 1.", - "Export schema version 2.", - "Export schema version 3.", - "Export schema version 4.", - "Export schema version 5.", - "Export schema version 6.", - "Export schema version 7.", - "Export schema version 8.", - "Export schema version 9.", - "Export schema version 10.", - "Export schema version 11.", - "Export schema version 12.", - "Export schema version 13.", - "Export schema version 14.", - "Export schema version 15.", - "Export schema version 16.", - "Export schema version 17.", - "Export schema version latest available." - ], - "enum": [ - "EXPORT_SCHEMA_VERSION_UNSPECIFIED", - "EXPORT_V1", - "EXPORT_V2", - "EXPORT_V3", - "EXPORT_V4", - "EXPORT_V5", - "EXPORT_V6", - "EXPORT_V7", - "EXPORT_V8", - "EXPORT_V9", - "EXPORT_V10", - "EXPORT_V11", - "EXPORT_V12", - "EXPORT_V13", - "EXPORT_V14", - "EXPORT_V15", - "EXPORT_V16", - "EXPORT_V17", - "EXPORT_VERSION_LATEST_AVAILABLE" - ] - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination": { - "description": "A BigQuery Table Reference.", - "type": "object", - "properties": { - "projectId": { - "description": "A project ID or number. If specified, then export will attempt to\nwrite data to this project instead of the resource project. Otherwise,\nthe resource project will be used.", - "type": "string" - }, - "dataset": { - "description": "Required. The name of the BigQuery dataset that the snapshot result should be\nexported to. If this dataset does not exist, the export call returns an\nINVALID_ARGUMENT error.", - "type": "string" - }, - "table": { - "description": "The BigQuery table name to which the insights data should be written.\nIf this table does not exist, the export call returns an INVALID_ARGUMENT\nerror.", - "type": "string" - } - }, - "required": [ - "dataset" - ] - }, - "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse": { - "description": "Response for an export insights operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata": { - "description": "Metadata for an export insights operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for export.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during export operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "completedExportCount": { - "description": "The number of conversations that were exported successfully.", - "type": "integer", - "format": "int32" - }, - "failedExportCount": { - "description": "The number of conversations that failed to be exported.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1IssueModel": { - "description": "The issue model resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the issue model.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The representative name for the issue model.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this issue model was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the issue model was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "issueCount": { - "description": "Output only. Number of issues in this issue model.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "state": { - "description": "Output only. State of the model.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Model is not deployed but is ready to deploy.", - "Model is being deployed.", - "Model is deployed and is ready to be used. A model can only be used in\nanalysis if it's in this state.", - "Model is being undeployed.", - "Model is being deleted." - ], - "enum": [ - "STATE_UNSPECIFIED", - "UNDEPLOYED", - "DEPLOYING", - "DEPLOYED", - "UNDEPLOYING", - "DELETING" - ] - }, - "inputDataConfig": { - "description": "Configs for the input data that used to create the issue model.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig" - }] - }, - "trainingStats": { - "description": "Output only. Immutable. The issue model's label statistics on its training data.", - "readOnly": true, - "x-google-immutable": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats" - }] - }, - "modelType": { - "description": "Type of the model.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified model type.", - "Type V1.", - "Type V2." - ], - "enum": [ - "MODEL_TYPE_UNSPECIFIED", - "TYPE_V1", - "TYPE_V2" - ] - }, - "languageCode": { - "description": "Language of the model.", - "type": "string" - }, - "multiLingualMatch": { - "description": "Whether the model can be used for analysis with conversations in multiple\nlanguages. The topic names and descriptions will be in the `language_code`\nspecified, but the matching will be performed against conversations in any\nlanguage.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig": { - "description": "Configs for the input data used to create the issue model.", - "type": "object", - "properties": { - "medium": { - "description": "Medium of conversations used in training data. This field is being\ndeprecated. To specify the medium to be used in training a new issue\nmodel, set the `medium` field on `filter`.", - "deprecated": true, - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "The format for conversations that took place over the phone.", - "The format for conversations that took place over chat." - ], - "enum": [ - "MEDIUM_UNSPECIFIED", - "PHONE_CALL", - "CHAT" - ] - }, - "trainingConversationsCount": { - "description": "Output only. Number of conversations used in training. Output only.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "filter": { - "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", - "type": "string" - }, - "customTaxonomy": { - "description": "Custom supplied taxonomy.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelCustomTaxonomy" - }] - }, - "issueGranularity": { - "description": "Issue granularity preference for model training.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Granularity much coarser than default.", - "Granularity coarser than default.", - "Default granularity.", - "Granularity finer than default.", - "Granularity much finer than default." - ], - "enum": [ - "ISSUE_GRANULARITY_UNSPECIFIED", - "MORE_COARSE", - "COARSE", - "STANDARD", - "FINE", - "MORE_FINE" - ] - }, - "industry": { - "description": "Customer industry, used to improve specificity of the topic model.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1IssueModelCustomTaxonomy": { - "description": "Structure for custom supplied taxonomy. A custom taxonomy consists of\nmultiple taxonomy entries organized in a hierarchical way.", - "type": "object", - "properties": { - "taxonomyEntries": { - "description": "List of taxonomy entries.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelCustomTaxonomyTaxonomyEntry" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1IssueModelCustomTaxonomyTaxonomyEntry": { - "description": "Structure for a taxonomy entry.", - "type": "object", - "properties": { - "id": { - "description": "Immutable. The Id of the taxonomy entry", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The content of the taxonomy entry.", - "type": "string" - }, - "parents": { - "description": "Ids of parent taxonomy entries.", - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "description": "The description of the taxonomy entry.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1IssueModelLabelStats": { - "description": "Aggregated statistics about an issue model.", - "type": "object", - "properties": { - "analyzedConversationsCount": { - "description": "Number of conversations the issue model has analyzed at this point in time.", - "type": "string", - "format": "int64" - }, - "unclassifiedConversationsCount": { - "description": "Number of analyzed conversations for which no issue was applicable at this\npoint in time.", - "type": "string", - "format": "int64" - }, - "issueStats": { - "description": "Statistics on each issue. Key is the issue's resource name.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats": { - "description": "Aggregated statistics about an issue.", - "type": "object", - "properties": { - "issue": { - "description": "Issue resource.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", - "type": "string" - }, - "labeledConversationsCount": { - "description": "Number of conversations attached to the issue at this point in time.", - "type": "string", - "format": "int64" - }, - "displayName": { - "description": "Display name of the issue.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata": { - "description": "Metadata for creating an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for creation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest": { - "description": "The request to create an issue model.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the issue model.", - "type": "string" - }, - "issueModel": { - "description": "Required. The issue model to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" - }] - } - }, - "required": [ - "parent", - "issueModel" - ] - }, - "GoogleCloudContactcenterinsightsV1ListIssueModelsResponse": { - "description": "The response of listing issue models.", - "type": "object", - "properties": { - "issueModels": { - "description": "The issue models that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata": { - "description": "Metadata for deleting an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for deletion.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest": { - "description": "The request to delete an issue model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The name of the issue model to delete.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest": { - "description": "The request to deploy an issue model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The issue model to deploy.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse": { - "description": "The response to deploy an issue model.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata": { - "description": "Metadata for deploying an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for deployment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest": { - "description": "The request to undeploy an issue model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The issue model to undeploy.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse": { - "description": "The response to undeploy an issue model.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata": { - "description": "Metadata for undeploying an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for undeployment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest": { - "description": "Request to export an issue model.", - "type": "object", - "properties": { - "gcsDestination": { - "description": "Google Cloud Storage URI to export the issue model to.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination" - }] - }, - "name": { - "description": "Required. The issue model to export.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination": { - "description": "Google Cloud Storage Object URI to save the issue model to.", - "type": "object", - "properties": { - "objectUri": { - "description": "Required. Format: `gs:///`", - "type": "string" - } - }, - "required": [ - "objectUri" - ] - }, - "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse": { - "description": "Response from export issue model", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata": { - "description": "Metadata used for export issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original export request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest": { - "description": "Request to import an issue model.", - "type": "object", - "properties": { - "gcsSource": { - "description": "Google Cloud Storage source message.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource" - }] - }, - "parent": { - "description": "Required. The parent resource of the issue model.", - "type": "string" - }, - "createNewModel": { - "description": "Optional. If set to true, will create an issue model from the imported file with\nrandomly generated IDs for the issue model and corresponding issues.\nOtherwise, replaces an existing model with the same ID as the file.", - "type": "boolean" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource": { - "description": "Google Cloud Storage Object URI to get the issue model file from.", - "type": "object", - "properties": { - "objectUri": { - "description": "Required. Format: `gs:///`", - "type": "string" - } - }, - "required": [ - "objectUri" - ] - }, - "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse": { - "description": "Response from import issue model", - "type": "object", - "properties": { - "issueModel": { - "description": "The issue model that was imported.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata": { - "description": "Metadata used for import issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original import request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1Issue": { - "description": "The issue resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the issue.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The representative name for the issue.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this issue was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time that this issue was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "representativeConversationNames": { - "description": "Output only. Resource names of the most representative conversations matched.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "sampleUtterances": { - "description": "Output only. Resource names of the sample representative utterances that match to this\nissue.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "source": { - "description": "Source of the topic", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Generated based on the customers data - i.e. topic discovered by model.", - "Taxonomy provided by the customer (topic come from custom taxonomy)." - ], - "enum": [ - "ISSUE_SOURCE_UNSPECIFIED", - "GENERATED", - "CUSTOMER_PROVIDED" - ] - }, - "parentIssues": { - "description": "Unique identifiers of the parent topics for hierarchical representation.\nFormat is\n`projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}`", - "type": "array", - "items": { - "type": "string" - } - }, - "alternatives": { - "description": "Additional topic descriptions.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueAlternative" - } - }, - "displayDescription": { - "description": "Representative description of the issue.", - "type": "string" - }, - "matchTarget": { - "description": "Target used for semantic similarity comparisons.\nPopulated on V2 models if the display name was renamed.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1IssueAlternative": { - "description": "Alternative topic names or descriptions to improve inference.", - "type": "object", - "properties": { - "alternative": { - "description": "An alternative topic name.", - "type": "string" - }, - "description": { - "description": "An alternative topic description.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListIssuesResponse": { - "description": "The response of listing issues.", - "type": "object", - "properties": { - "issues": { - "description": "The issues that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1CreateIssueMetadata": { - "description": "Metadata for creating an issue.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for creation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1CreateIssueRequest": { - "description": "The request to create an issue.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the issue.", - "type": "string" - }, - "issue": { - "description": "Required. The values for the new issue.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" - }] - } - }, - "required": [ - "parent", - "issue" - ] - }, - "GoogleCloudContactcenterinsightsV1MergeIssuesRequest": { - "description": "The request to merge issues.", - "type": "object", - "properties": { - "issues": { - "description": "Required. The list of issue resource names to merge.", - "type": "array", - "items": { - "type": "string" - } - }, - "displayName": { - "description": "Required. The display name for the new issue.", - "type": "string" - }, - "displayDescription": { - "description": "Required. The display description for the new issue.", - "type": "string" - } - }, - "required": [ - "issues", - "displayName", - "displayDescription" - ] - }, - "GoogleCloudContactcenterinsightsV1MergeIssuesMetadata": { - "description": "Metadata for creating an issue.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse": { - "description": "Response of querying an issue model's statistics.", - "type": "object", - "properties": { - "currentStats": { - "description": "The latest label statistics for the queried issue model. Includes results\non both training data and data labeled after deployment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1FaqModel": { - "description": "The FAQ model resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the FAQ model.\nFormat:\nprojects/{project}/locations/{location}/faqModels/{faq_model}", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The representative name for the FAQ model.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this FAQ model was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the FAQ model was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "faqEntryCount": { - "description": "Output only. Number of FAQ entries in this FAQ model.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "state": { - "description": "Output only. State of the FAQ model.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Model is not deployed but is ready to deploy.", - "Model is being deleted." - ], - "enum": [ - "STATE_UNSPECIFIED", - "UNDEPLOYED", - "DELETING" - ] - }, - "inputDataConfig": { - "description": "Configs for the input data used to create the FAQ model.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModelInputDataConfig" - }] - }, - "modelTrainingStats": { - "description": "Output only. Immutable. The model statistics on its training data.", - "readOnly": true, - "x-google-immutable": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModelModelStats" - }] - }, - "infobotAgent": { - "description": "Immutable. The resource name of the infobot agent to be used to create generative\nanswers. Format: projects/{project}/locations/{location}/agents/{agent}", - "x-google-immutable": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1FaqModelInputDataConfig": { - "description": "Configs for the input data used to create the FAQ model.", - "type": "object", - "properties": { - "trainingConversationsCount": { - "description": "Output only. Number of conversations used in training. Output only.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "filter": { - "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1FaqModelModelStats": { - "description": "Train/inference statistics for the model.", - "type": "object", - "properties": { - "totalConversationsCount": { - "description": "Total number of conversations analyzed at this point in time.", - "type": "integer", - "format": "int32" - }, - "skippedConversationsCount": { - "description": "Number of analyzed conversations which were skipped e.g. customer\ndisconnected from the call.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1CreateFaqModelMetadata": { - "description": "Metadata for creating an FAQ model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for creation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateFaqModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1CreateFaqModelRequest": { - "description": "The request to create an FAQ model.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the FAQ model.", - "type": "string" - }, - "faqModel": { - "description": "Required. The FAQ model to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" - }] - }, - "faqModelId": { - "description": "Optional. The ID to use for the FAQ model, which will become the final\ncomponent of the FAQ model's resource name.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", - "type": "string" - } - }, - "required": [ - "parent", - "faqModel" - ] - }, - "GoogleCloudContactcenterinsightsV1ListFaqModelsResponse": { - "description": "The response of listing FAQ models.", - "type": "object", - "properties": { - "faqModels": { - "description": "The FAQ models that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DeleteFaqModelMetadata": { - "description": "Metadata for deleting an FAQ model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for deletion.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteFaqModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1DeleteFaqModelRequest": { - "description": "The request to delete an FAQ model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The name of the FAQ model to delete.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1FaqEntry": { - "description": "The FAQ entry resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the FAQ entry.\nFormat:\nprojects/{project}/locations/{location}/faqModels/{faq_model}/faqEntries/{faq_entry}", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "Representative name of the FAQ entry, typically the question text.", - "type": "string" - }, - "question": { - "description": "Output only. Question of the FAQ.", - "readOnly": true, - "type": "string" - }, - "createTime": { - "description": "Output only. FAQ entry creation time.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. FAQ entry last update time.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "representativeConversationNames": { - "description": "Output only. Resource names of the most representative conversations matched.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}\nDeprecated. Use `representative_conversations` instead.", - "readOnly": true, - "deprecated": true, - "type": "array", - "items": { - "type": "string" - } - }, - "trainingStats": { - "description": "Output only. Statistics of the FAQ entry computed from training data.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntryStats" - }] - }, - "botAnswers": { - "description": "Output only. Answers from the bot for the question.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntryBotAnswer" - } - }, - "insightsAnswers": { - "description": "Output only. Answers based on conversation history and live agent questions.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntryInsightsAnswer" - } - }, - "representativeConversations": { - "description": "Output only. Examples of conversations representative of the FaqEntry", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntryRepresentativeConversation" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1FaqEntryStats": { - "description": "Training/inference statistics for the FAQ entry.", - "type": "object", - "properties": { - "conversationCount": { - "description": "Number of conversations asking the faq question.", - "type": "integer", - "format": "int32" - }, - "averageHandlingTime": { - "description": "Average handling time for all conversations.", - "type": "string", - "format": "google-duration" - }, - "trafficPercentage": { - "description": "Percentage of traffic in all conversations.", - "type": "number", - "format": "float" - }, - "averageTurnCount": { - "description": "Average turn count.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudContactcenterinsightsV1FaqEntryBotAnswer": { - "description": "An answer from the bot for the question.", - "type": "object", - "properties": { - "answer": { - "description": "Answer text.", - "type": "string" - }, - "matchingQuestion": { - "description": "The matching question from the bot (e.g. from FAQ Assist).", - "type": "string" - }, - "snippets": { - "description": "All snippets used for this answer, with their source URI\nand data.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntryBotAnswerSnippet" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1FaqEntryBotAnswerSnippet": { - "description": "Snippet Source for a bot answer.", - "type": "object", - "properties": { - "uri": { - "description": "URI the data is sourced from.", - "type": "string" - }, - "text": { - "description": "Text taken from that URI.", - "type": "string" - }, - "title": { - "description": "Title of the document.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1FaqEntryInsightsAnswer": { - "description": "An answer based on conversation history and live agent\nquestions.", - "type": "object", - "properties": { - "answer": { - "description": "Answer text.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1FaqEntryRepresentativeConversation": { - "description": "Represents a point in a conversation that is representative of the parent\nFaqEntry", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the conversation.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}", - "x-google-immutable": true, - "type": "string" - }, - "startTime": { - "description": "The time at which the conversation started.", - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListFaqEntriesResponse": { - "description": "The response of listing FAQ entries.", - "type": "object", - "properties": { - "faqEntries": { - "description": "The FAQ entries that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqEntry" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1PhraseMatcher": { - "description": "The phrase matcher resource.", - "type": "object", - "properties": { - "name": { - "description": "The resource name of the phrase matcher.\nFormat:\nprojects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", - "type": "string" - }, - "revisionId": { - "description": "Output only. Immutable. The revision ID of the phrase matcher.\nA new revision is committed whenever the matcher is changed, except when it\nis activated or deactivated. A server generated random ID will be used.\nExample: locations/global/phraseMatchers/my-first-matcher@1234567", - "readOnly": true, - "x-google-immutable": true, - "type": "string" - }, - "versionTag": { - "description": "The customized version tag to use for the phrase matcher. If not specified,\nit will default to `revision_id`.", - "type": "string" - }, - "revisionCreateTime": { - "description": "Output only. The timestamp of when the revision was created. It is also the create time\nwhen a new matcher is added.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "displayName": { - "description": "The human-readable name of the phrase matcher.", - "type": "string" - }, - "type": { - "description": "Required. The type of this phrase matcher.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Must meet all phrase match rule groups or there is no match.", - "If any of the phrase match rule groups are met, there is a match." - ], - "enum": [ - "PHRASE_MATCHER_TYPE_UNSPECIFIED", - "ALL_OF", - "ANY_OF" - ] - }, - "active": { - "description": "Applies the phrase matcher only when it is active.", - "type": "boolean" - }, - "phraseMatchRuleGroups": { - "description": "A list of phase match rule groups that are included in this matcher.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup" - } - }, - "activationUpdateTime": { - "description": "Output only. The most recent time at which the activation status was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "roleMatch": { - "description": "The role whose utterances the phrase matcher should be matched\nagainst. If the role is ROLE_UNSPECIFIED it will be matched against any\nutterances in the transcript.", - "type": "string", - "x-google-enum-descriptions": [ - "Participant's role is not set.", - "Participant is a human agent.", - "Participant is an automated agent.", - "Participant is an end user who conversed with the contact center.", - "Participant is either a human or automated agent." - ], - "enum": [ - "ROLE_UNSPECIFIED", - "HUMAN_AGENT", - "AUTOMATED_AGENT", - "END_USER", - "ANY_AGENT" - ] - }, - "updateTime": { - "description": "Output only. The most recent time at which the phrase matcher was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "languageCode": { - "description": "The language code of this segment as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".\nIf the language_code is unspecified, it will match everything.", - "type": "string" - } - }, - "required": [ - "type" - ] - }, - "GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup": { - "description": "A message representing a rule in the phrase matcher.", - "type": "object", - "properties": { - "type": { - "description": "Required. The type of this phrase match rule group.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Must meet all phrase match rules or there is no match.", - "If any of the phrase match rules are met, there is a match." - ], - "enum": [ - "PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED", - "ALL_OF", - "ANY_OF" - ] - }, - "phraseMatchRules": { - "description": "A list of phrase match rules that are included in this group.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule" - } - }, - "phraseMatchRuleGroups": { - "description": "A list of phrase match rule groups that are included in this group.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup" - } - }, - "roleMatch": { - "description": "The role whose utterances the phrase matcher should be matched\nagainst. If the role is ROLE_UNSPECIFIED it will be matched against any\nutterances in the transcript.", - "type": "string", - "x-google-enum-descriptions": [ - "Participant's role is not set.", - "Participant is a human agent.", - "Participant is an automated agent.", - "Participant is an end user who conversed with the contact center.", - "Participant is either a human or automated agent." - ], - "enum": [ - "ROLE_UNSPECIFIED", - "HUMAN_AGENT", - "AUTOMATED_AGENT", - "END_USER", - "ANY_AGENT" - ] - }, - "languageCode": { - "description": "The language code of this segment as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".\nIf the language_code is unspecified, it will match everything.", - "type": "string" - } - }, - "required": [ - "type" - ] - }, - "GoogleCloudContactcenterinsightsV1PhraseMatchRule": { - "description": "The data for a phrase match rule.", - "type": "object", - "properties": { - "query": { - "description": "Required. The phrase to be matched.", - "type": "string" - }, - "negated": { - "description": "Specifies whether the phrase must be missing from the transcript segment or\npresent in the transcript segment.", - "type": "boolean" - }, - "config": { - "description": "Provides additional information about the rule that specifies how to apply\nthe rule.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig" - }] - } - }, - "required": [ - "query" - ] - }, - "GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig": { - "description": "Configuration information of a phrase match rule.", - "type": "object", - "properties": { - "exactMatchConfig": { - "description": "The configuration for the exact match rule.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExactMatchConfig" - }] - }, - "semanticMatchConfig": { - "description": "The configuration for the semantic match rule.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SemanticMatchConfig" - }] - }, - "regexMatchConfig": { - "description": "The configuration for the regex match rule.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RegexMatchConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ExactMatchConfig": { - "description": "Exact match configuration.", - "type": "object", - "properties": { - "caseSensitive": { - "description": "Whether to consider case sensitivity when performing an exact match.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1SemanticMatchConfig": { - "description": "Semantic match configuration.", - "type": "object", - "properties": { - "similarityThreshold": { - "description": "Only text with a similarity greater than or equal to the threshold will be\nconsidered to be a match to the provided query. Ranges from 0 - 1.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudContactcenterinsightsV1RegexMatchConfig": { - "description": "Regex match configuration.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse": { - "description": "The response of listing phrase matchers.", - "type": "object", - "properties": { - "phraseMatchers": { - "description": "The phrase matchers that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1CalculateStatsResponse": { - "description": "The response for calculating conversation statistics.", - "type": "object", - "properties": { - "averageDuration": { - "description": "The average duration of all conversations. The average is calculated using\nonly conversations that have a time duration.", - "type": "string", - "format": "google-duration" - }, - "averageTurnCount": { - "description": "The average number of turns per conversation.", - "type": "integer", - "format": "int32" - }, - "conversationCount": { - "description": "The total number of conversations.", - "type": "integer", - "format": "int32" - }, - "smartHighlighterMatches": { - "description": "A map associating each smart highlighter display name with its respective\nnumber of matches in the set of conversations.", - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - }, - "customHighlighterMatches": { - "description": "A map associating each custom highlighter resource name with its respective\nnumber of matches in the set of conversations.", - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - }, - "issueMatches": { - "description": "A map associating each issue resource name with its respective number of\nmatches in the set of conversations. Key has the format:\n`projects//locations//issueModels//issues/`\nDeprecated, use `issue_matches_stats` field instead.", - "deprecated": true, - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - }, - "issueMatchesStats": { - "description": "A map associating each issue resource name with its respective number of\nmatches in the set of conversations. Key has the format:\n`projects//locations//issueModels//issues/`", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" - } - }, - "conversationCountTimeSeries": { - "description": "A time series representing the count of conversations created over time\nthat match that requested filter criteria.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries": { - "description": "A time series representing conversations over time.", - "type": "object", - "properties": { - "intervalDuration": { - "description": "The duration of each interval.", - "type": "string", - "format": "google-duration" - }, - "points": { - "description": "An ordered list of intervals from earliest to latest, where each interval\nrepresents the number of conversations that transpired during the time\nwindow.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval": { - "description": "A single interval in a time series.", - "type": "object", - "properties": { - "startTime": { - "description": "The start time of this interval.", - "type": "string", - "format": "date-time" - }, - "conversationCount": { - "description": "The number of conversations created in this interval.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1CalculateStatsRequest": { - "description": "The request for calculating conversation statistics.", - "type": "object", - "properties": { - "filter": { - "description": "A filter to reduce results to a specific subset. This field is useful for\ngetting statistics about conversations with specific properties.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1CorrelationConfig": { - "description": "A configuration that defines how to correlate conversations for a given\na given project.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. Identifier. The resource name of the correlation config.\nFormat:\nprojects/{project}/locations/{location}/correlationConfig", - "x-google-immutable": true, - "x-google-identifier": true, - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which the correlation config was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The time at which the correlation config was last updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "fullConversationConfig": { - "description": "The correlation type config for full conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationTypeConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1CorrelationTypeConfig": { - "description": "A list of correlation rules for a given correlation type.", - "type": "object", - "properties": { - "correlationRules": { - "description": "A list of correlation rules to be evaluated for correlation.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationRule" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1CorrelationRule": { - "description": "A correlation rule that defines how to join conversations for a given\ncorrelation type.", - "type": "object", - "properties": { - "ruleId": { - "description": "Required. The unique identifier of the rule.", - "type": "string" - }, - "active": { - "description": "Optional. Whether the config is active to be evaluated.", - "type": "boolean" - }, - "joinKeyExpression": { - "description": "Optional. A cel expression (go/cel) to be evaluated as a string value. This string\nvalue will be used as the join key for the correlation.", - "type": "string" - }, - "constraintExpression": { - "description": "Optional. A cel expression (go/cel) to be evaluated as a boolean value.\nTwo variables conversation_a and conversation_b will be available for\nevaluation. This expression should evaluate to true if conversation_a and\nconversation_b should be joined. This is used as an extra constraint on top\nof the join_key_expression to further refine the group of conversations\nthat are joined together and will be evaluated in both directions.\nfor two conversations c1 and c2 and the result will be OR'd. We will\nevaluate: f(c1, c2) OR f(c2, c1)", - "type": "string" - } - }, - "required": [ - "ruleId" - ] - }, - "GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequest": { - "description": "The request to test correlation config.", - "type": "object", - "properties": { - "filter": { - "description": "Optional. Filter to select conversations to test correlation against.\nConversations matching this filter will be sampled based on start time.\nThe most recent `max_sample_count` conversations will be selected.\nIf no conversations match the filter, the request will fail with an\n`INVALID_ARGUMENT` error.", - "type": "string" - }, - "conversations": { - "description": "Optional. A list of conversations to test against.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequestConversations" - }] - }, - "correlationConfig": { - "description": "Required. The correlation config to test.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CorrelationConfig" - }] - }, - "maxSampleCount": { - "description": "Optional. The maximum number of conversations to sample when using the `filter`.\nIf not set, defaults to 1000. Values greater than 1000 are coerced to 1000.\nThis field is ignored if `conversations` is provided.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "correlationConfig" - ] - }, - "GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequestConversations": { - "description": "Wrapper for a list of conversations.", - "type": "object", - "properties": { - "conversations": { - "description": "Optional. The conversations.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse": { - "description": "The response of testing correlation config.", - "type": "object", - "properties": { - "detailedResults": { - "description": "Results for the DETAILED_SYNC execution mode.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults" - }] - }, - "partialErrors": { - "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults": { - "description": "Wrapper for detailed, step-by-step results.", - "type": "object", - "properties": { - "joinKeyResults": { - "description": "A list of join key correlation results for each conversation tested.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCorrelationResult" - } - }, - "constraintResults": { - "description": "A list of constraint evaluation results for each pair of conversations.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult": { - "description": "The result of testing correlation config on a single conversation.", - "type": "object", - "properties": { - "conversation": { - "description": "The conversation resource name.", - "type": "string" - }, - "ruleResults": { - "description": "The results for each correlation rule.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult": { - "description": "The result of a single correlation rule.", - "type": "object", - "properties": { - "correlationId": { - "description": "The correlation ID generated by the join key expression.", - "type": "string" - }, - "error": { - "description": "The error status if the join key expression failed to evaluate.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleRpcStatus" - }] - }, - "ruleId": { - "description": "The rule ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult": { - "description": "The result of testing a constraint expression on a pair of conversations.", - "type": "object", - "properties": { - "conversationA": { - "description": "The first conversation resource name.", - "type": "string" - }, - "conversationB": { - "description": "The second conversation resource name.", - "type": "string" - }, - "ruleConstraintResults": { - "description": "The results for each applicable constraint rule.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult": { - "description": "The result of a single constraint rule on the pair of conversations.", - "type": "object", - "properties": { - "constraintMet": { - "description": "Whether the constraint expression evaluated to true for (A, B) or (B,\nA).", - "type": "boolean" - }, - "error": { - "description": "The error status if the constraint expression failed to evaluate.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleRpcStatus" - }] - }, - "ruleId": { - "description": "The rule ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata": { - "description": "Metadata for testing correlation config.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "dataset": { - "description": "The dataset used for sampling conversations.", - "type": "string" - }, - "stats": { - "description": "The statistics for the operation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats": { - "description": "Statistics for TestCorrelationConfig operation.", - "type": "object", - "properties": { - "sampledConversationsCount": { - "description": "The number of conversations sampled.", - "type": "integer", - "format": "int32" - }, - "correlatedConversationsCount": { - "description": "The number of conversations correlated.", - "type": "integer", - "format": "int32" - }, - "failedConversationsCount": { - "description": "The number of conversations that failed correlation.", - "type": "integer", - "format": "int32" - }, - "partialErrors": { - "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "conversationCorrelationErrors": { - "description": "A list of errors that occurred during correlation, one for each\nconversation that failed.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { - "description": "An error that occurred during correlation for a specific conversation.", - "type": "object", - "properties": { - "conversation": { - "description": "The conversation resource name that had an error during correlation.", - "type": "string" - }, - "status": { - "description": "The error status.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleRpcStatus" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1Settings": { - "description": "The CCAI Insights project wide settings.\nUse these settings to configure the behavior of Insights.\nView these settings with\n[`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings)\nand change the settings with\n[`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings).", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the settings resource.\nFormat:\nprojects/{project}/locations/{location}/settings", - "x-google-immutable": true, - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which the settings was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The time at which the settings were last updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "languageCode": { - "description": "A language code to be applied to each transcript segment unless the segment\nalready specifies a language code. Language code defaults to \"en-US\" if it\nis neither specified on the segment nor here.", - "type": "string" - }, - "conversationTtl": { - "description": "The default TTL for newly-created conversations. If a conversation has a\nspecified expiration, that value will be used instead. Changing this\nvalue will not change the expiration of existing conversations.\nConversations with no expire time persist until they are deleted.", - "type": "string", - "format": "google-duration" - }, - "pubsubNotificationSettings": { - "description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a\nspecified trigger occurs, Insights will notify the corresponding Pub/Sub\ntopic.\n\nKeys are notification triggers. Supported keys are:\n\n* \"all-triggers\": Notify each time any of the supported triggers occurs.\n* \"create-analysis\": Notify each time an analysis is created.\n* \"create-conversation\": Notify each time a conversation is created.\n* \"export-insights-data\": Notify each time an export is complete.\n* \"ingest-conversations\": Notify each time an IngestConversations LRO is\ncomplete.\n* \"update-conversation\": Notify each time a conversation is updated via\nUpdateConversation.\n* \"upload-conversation\": Notify when an UploadConversation LRO is complete.\n* \"update-or-analyze-conversation\": Notify when an analysis for a\nconversation is completed or when the conversation is updated. The message\nwill contain the conversation with transcript, analysis and other metadata.\n\nValues are Pub/Sub topics. The format of each Pub/Sub topic is:\nprojects/{project}/topics/{topic}", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "analysisConfig": { - "description": "Default analysis settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig" - }] - }, - "enableCustomerAgentDetection": { - "description": "Whether to enable customer-agent detection. If specified, then Insights\nwill infer which speakers are customers and which are agents when a\nconversation is created. If a conversation specifies the roles of the\nspeakers, then those roles will be used instead of the detection.", - "type": "boolean" - }, - "redactionConfig": { - "description": "Default DLP redaction resources to be applied while ingesting\nconversations. This applies to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversations coming from CCAI Platform.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig" - }] - }, - "speechConfig": { - "description": "Optional. Default Speech-to-Text resources to use while ingesting audio files.\nOptional, CCAI Insights will create a default if not provided. This applies\nto conversations ingested from the `UploadConversation` and\n`IngestConversations` endpoints, including conversations coming from CCAI\nPlatform.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig" - }] - }, - "screenRecordingBucketUri": { - "description": "Optional. The path to a Cloud Storage bucket containing conversation screen\nrecordings. If provided, Insights will search in the bucket for a screen\nrecording file matching the conversation data source object name prefix. If\nmatches are found, these file URIs will be stored in the conversation\nscreen recordings field.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig": { - "description": "Default configuration when creating Analyses in Insights.", - "type": "object", - "properties": { - "runtimeIntegrationAnalysisPercentage": { - "description": "Percentage of conversations created using Dialogflow runtime integration\nto analyze automatically, between [0, 100].", - "type": "number", - "format": "double" - }, - "uploadConversationAnalysisPercentage": { - "description": "Percentage of conversations created using the UploadConversation endpoint\nto analyze automatically, between [0, 100].", - "type": "number", - "format": "double" - }, - "smartHighlightCustomAgent": { - "description": "Unique ID of the custom Dialogflow agent that is used to produce Smart\nHighlights in addition to the default IDs.\nFormat:\nprojects/{project_id}/locations/{location}/agents/{agent}", - "type": "string" - }, - "disableIssueModeling": { - "description": "Whether to disable issue model inference during analysis.\nBy default issue modeling will be included in analysis if there is an\nactive issue model for the project.", - "deprecated": true, - "type": "boolean" - }, - "annotatorSelector": { - "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1AnalysisRule": { - "description": "The CCAI Insights project wide analysis rule. This rule will be applied to\nall conversations that match the filter defined in the rule. For a\nconversation matches the filter, the annotators specified in the rule will be\nrun. If a conversation matches multiple rules, a union of all the annotators\nwill be run. One project can have multiple analysis rules.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The resource name of the analysis rule.\nFormat:\nprojects/{project}/locations/{location}/analysisRules/{analysis_rule}", - "x-google-identifier": true, - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this analysis rule was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which this analysis rule was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "displayName": { - "description": "Display Name of the analysis rule.", - "type": "string" - }, - "conversationFilter": { - "description": "Filter for the conversations that should apply this analysis\nrule. An empty filter means this analysis rule applies to all\nconversations.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", - "type": "string" - }, - "annotatorSelector": { - "description": "Selector of annotators to run and the phrase matchers to use for\nconversations that matches the conversation_filter. If not specified, NO\nannotators will be run.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector" - }] - }, - "analysisPercentage": { - "description": "Percentage of conversations that we should apply this analysis setting\nautomatically, between [0, 1]. For example, 0.1 means 10%. Conversations\nare sampled in a determenestic way. The original runtime_percentage &\nupload percentage will be replaced by defining filters on the conversation.", - "type": "number", - "format": "double" - }, - "active": { - "description": "If true, apply this rule to conversations. Otherwise, this rule is\ninactive and saved as a draft.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse": { - "description": "The response of listing views.", - "type": "object", - "properties": { - "analysisRules": { - "description": "The analysis_rule that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListAutoLabelingRulesResponse": { - "description": "The response message for listing auto labeling rules.", - "type": "object", - "properties": { - "autoLabelingRules": { - "description": "The auto labeling rules.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1AutoLabelingRule": { - "description": "Rule for auto-labeling conversations.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The resource name of the auto-labeling rule.\nFormat:\nprojects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", - "x-google-identifier": true, - "type": "string" - }, - "active": { - "description": "Whether the rule is active.", - "type": "boolean" - }, - "displayName": { - "description": "The user-provided display name of the rule.", - "type": "string" - }, - "description": { - "description": "The description of the rule.", - "type": "string" - }, - "labelKeyType": { - "description": "The type of the label key.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified label key type.", - "The label key is custom defined by the user." - ], - "enum": [ - "LABEL_KEY_TYPE_UNSPECIFIED", - "LABEL_KEY_TYPE_CUSTOM" - ] - }, - "labelKey": { - "description": "The label key. This is also the {auto_labeling_rule} in the resource name.\nOnly settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.", - "type": "string" - }, - "conditions": { - "description": "Conditions to apply for auto-labeling the label_key.\nRepresenting sequential block of if .. else if .. else statements.\nThe value of the first matching condition will be used.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRuleLabelingCondition" - } - }, - "createTime": { - "description": "Output only. The time at which this rule was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the rule was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1AutoLabelingRuleLabelingCondition": { - "description": "Condition for auto-labeling conversations.", - "type": "object", - "properties": { - "condition": { - "description": "A optional CEL expression to be evaluated as a boolean value.\nOnce evaluated as true, then we will proceed with the value evaluation.\nAn empty condition will be auto evaluated as true.", - "type": "string" - }, - "value": { - "description": "CEL expression to be evaluated as the value.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleRequest": { - "description": "The request message for testing auto labeling rules.", - "type": "object", - "properties": { - "conversation": { - "description": "Required. Conversation data to test rules against.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - }] - }, - "autoLabelingRule": { - "description": "Required. The auto labeling rule to test.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AutoLabelingRule" - }] - } - }, - "required": [ - "conversation", - "autoLabelingRule" - ] - }, - "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleResponse": { - "description": "The response message for testing auto labeling rules.", - "type": "object", - "properties": { - "labelResult": { - "description": "The result of the test auto labeling rule.", - "type": "string" - } - } - }, - "description": "The CCAI Insights project wide assessment rule. This assessment rule will be\napplied to all conversations from the previous sampling cycle that match the\nsample rule defined in the assessment rule. One project can have multiple\nassessment rules.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The resource name of the assessment rule.\nFormat:\nprojects/{project}/locations/{location}/assessmentRules/{assessment_rule}", - "x-google-identifier": true, - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this assessment rule was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which this assessment rule was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "active": { - "description": "If true, apply this rule to conversations. Otherwise, this rule is\ninactive.", - "type": "boolean" - }, - "displayName": { - "description": "Display Name of the assessment rule.", - "type": "string" - }, - "sampleRule": { - "description": "The sample rule for the assessment rule.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleRule" - }] - }, - "scheduleInfo": { - "description": "Schedule info for the assessment rule.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ScheduleInfo" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ScheduleInfo": { - "description": "Message for schedule info.", - "type": "object", - "properties": { - "startTime": { - "description": "Start time of the schedule. If not specified, will start as soon as the\nschedule is created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "End time of the schedule. If not specified, will keep scheduling new\npipelines for execution util the schedule is no longer active or deleted.", - "type": "string", - "format": "date-time" - }, - "schedule": { - "description": "The groc expression.\nFormat: `every number [synchronized]`\nTime units can be: minutes, hours\nSynchronized is optional and indicates that the schedule should be\nsynchronized to the start of the interval: every 5 minutes synchronized\nmeans 00:00, 00:05 ...\nOtherwise the start time is random within the interval.\nExample: `every 5 minutes`\ncould be 00:02, 00:07, 00:12, ...", - "type": "string" - }, - "timeZone": { - "description": "The timezone to use for the groc expression.\nIf not specified, defaults to UTC.", - "type": "string" - } - } - }, - "description": "The response of listing assessment rules.", - "type": "object", - "properties": { - "assessmentRules": { - "description": "The assessment rules that match the request.", - "type": "array", - "items": { - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1EncryptionSpec": { - "description": "A customer-managed encryption key specification that can be applied to all\ncreated resources (e.g. `Conversation`).", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the encryption key specification resource.\nFormat:\nprojects/{project}/locations/{location}/encryptionSpec", - "x-google-immutable": true, - "type": "string" - }, - "kmsKey": { - "description": "Required. The name of customer-managed encryption key that is used to\nsecure a resource and its sub-resources. If empty, the resource is secured\nby our default encryption key. Only the key in the same location as this\nresource is allowed to be used for encryption. Format:\n`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", - "type": "string" - } - }, - "required": [ - "kmsKey" - ] - }, - "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { - "description": "The request to initialize a location-level encryption specification.", - "type": "object", - "properties": { - "encryptionSpec": { - "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms\nkey is in the same region as the endpoint. The same key will be used for\nall provisioned resources, if encryption is available. If the\n`kms_key_name` field is left empty, no encryption will be enforced.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec" - }] - } - }, - "required": [ - "encryptionSpec" - ] - }, - "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { - "description": "The response to initialize a location-level encryption specification.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { - "description": "Metadata for initializing a location-level encryption specification.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for initialization.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during initializing operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1View": { - "description": "The View resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the view.\nFormat:\nprojects/{project}/locations/{location}/views/{view}", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The human-readable display name of the view.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this view was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the view was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "value": { - "description": "A filter to reduce conversation results to a specific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListViewsResponse": { - "description": "The response of listing views.", - "type": "object", - "properties": { - "views": { - "description": "The views that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1View" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryMetricsRequest": { - "description": "The request for querying metrics.", - "type": "object", - "properties": { - "filter": { - "description": "Required. Filter to select a subset of conversations to compute the metrics. Must\nspecify a window of the conversation create time to compute the metrics.\nThe returned metrics will be from the range\n[DATE(starting create time), DATE(ending create time)).", - "type": "string" - }, - "timeGranularity": { - "description": "The time granularity of each data point in the time series.\nDefaults to NONE if this field is unspecified.", - "type": "string", - "x-google-enum-descriptions": [ - "The time granularity is unspecified and will default to NONE.", - "No time granularity. The response won't contain a time series.\nThis is the default value if no time granularity is specified.", - "Data points in the time series will aggregate at a daily granularity.\n1 day means [midnight to midnight).", - "Data points in the time series will aggregate at a daily granularity.\n1 HOUR means [01:00 to 02:00).", - "Data points in the time series will aggregate at a daily granularity.\nPER_MINUTE means [01:00 to 01:01).", - "Data points in the time series will aggregate at a 1 minute granularity.\nPER_5_MINUTES means [01:00 to 01:05).", - "Data points in the time series will aggregate at a monthly granularity.\n1 MONTH means [01st of the month to 1st of the next month)." - ], - "enum": [ - "TIME_GRANULARITY_UNSPECIFIED", - "NONE", - "DAILY", - "HOURLY", - "PER_MINUTE", - "PER_5_MINUTES", - "MONTHLY" - ] - }, - "dimensions": { - "description": "The dimensions that determine the grouping key for the query. Defaults to\nno dimension if this field is unspecified. If a dimension is specified,\nits key must also be specified. Each dimension's key must be unique.\n\nIf a time granularity is also specified, metric values in the dimension\nwill be bucketed by this granularity.\n\nUp to one dimension is supported for now.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dimension" - } - }, - "measureMask": { - "description": "Measures to return. Defaults to all measures if this field is unspecified.\nA valid mask should traverse from the `measure` field from the response.\nFor example, a path from a measure mask to get the conversation count is\n\"conversation_measure.count\".", - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - }, - "required": [ - "filter" - ] - }, - "GoogleCloudContactcenterinsightsV1Dimension": { - "description": "A dimension determines the grouping key for the query. In SQL terms, these\nwould be part of both the \"SELECT\" and \"GROUP BY\" clauses.", - "type": "object", - "properties": { - "issueDimensionMetadata": { - "description": "Output only. Metadata about the issue dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata" - }] - }, - "agentDimensionMetadata": { - "description": "Output only. Metadata about the agent dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata" - }] - }, - "qaQuestionDimensionMetadata": { - "description": "Output only. Metadata about the QA question dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata" - }] - }, - "qaQuestionAnswerDimensionMetadata": { - "description": "Output only. Metadata about the QA question-answer dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata" - }] - }, - "qaScorecardDimensionMetadata": { - "description": "Output only. Metadata about the QA scorecard dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata" - }] - }, - "conversationProfileDimensionMetadata": { - "description": "Output only. Metadata about the conversation profile dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata" - }] - }, - "mediumDimensionMetadata": { - "description": "Output only. Metadata about the conversation medium dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata" - }] - }, - "conversationalAgentsPlaybookDimensionMetadata": { - "description": "Output only. Metadata about the Conversational Agents playbook dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata" - }] - }, - "conversationalAgentsToolDimensionMetadata": { - "description": "Output only. Metadata about the Conversational Agents tool dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata" - }] - }, - "clientSentimentCategoryDimensionMetadata": { - "description": "Output only. Metadata about the client sentiment category dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata" - }] - }, - "agentAssistSupervisorDimensionMetadata": { - "description": "Output only. Metadata about the supervisor for virtual agents dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionAgentAssistSupervisorDimensionMetadata" - }] - }, - "labelDimensionMetadata": { - "description": "Output only. Metadata about conversation labels.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata" - }] - }, - "dimensionKey": { - "description": "The key of the dimension.", - "type": "string", - "x-google-enum-descriptions": [ - "The key of the dimension is unspecified.", - "The dimension is keyed by issues.", - "The dimension is keyed by issue names.", - "The dimension is keyed by agents.", - "The dimension is keyed by agent teams.", - "The dimension is keyed by QaQuestionIds.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing stats for\nthe same question across different scorecard revisions.", - "The dimension is keyed by QaQuestionIds-Answer value pairs.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing\ndistribution of answers per question across different scorecard\nrevisions.", - "The dimension is keyed by QaScorecardIds.\nNote that: We only group by the ScorecardId and not the revision-id of\nthe scorecard. This allows for showing stats for the same scorecard\nacross different revisions.\nThis metric is mostly only useful if querying the average normalized\nscore per scorecard.", - "The dimension is keyed by the conversation profile ID.", - "The dimension is keyed by the conversation medium.", - "The dimension is keyed by the Conversational Agents playbook ID.", - "The dimension is keyed by the Conversational Agents playbook display\nname.", - "The dimension is keyed by the Conversational Agents tool ID.", - "The dimension is keyed by the Conversational Agents tool display name.", - "The dimension is keyed by the client sentiment category.", - "The dimension is keyed by the agent version ID.", - "The dimension is keyed by the agent deployment ID.", - "The dimension is keyed by the supervisor ID of the assigned human\nsupervisor for virtual agents.", - "The dimension is keyed by label keys.", - "The dimension is keyed by label values.", - "The dimension is keyed by label key-value pairs." - ], - "enum": [ - "DIMENSION_KEY_UNSPECIFIED", - "ISSUE", - "ISSUE_NAME", - "AGENT", - "AGENT_TEAM", - "QA_QUESTION_ID", - "QA_QUESTION_ANSWER_VALUE", - "QA_SCORECARD_ID", - "CONVERSATION_PROFILE_ID", - "MEDIUM", - "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", - "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", - "CONVERSATIONAL_AGENTS_TOOL_ID", - "CONVERSATIONAL_AGENTS_TOOL_NAME", - "CLIENT_SENTIMENT_CATEGORY", - "AGENT_VERSION_ID", - "AGENT_DEPLOYMENT_ID", - "AGENT_ASSIST_SUPERVISOR_ID", - "LABEL_KEY", - "LABEL_VALUE", - "LABEL_KEY_AND_VALUE" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata": { - "description": "Metadata about the issue dimension.", - "type": "object", - "properties": { - "issueId": { - "description": "The issue ID.", - "type": "string" - }, - "issueDisplayName": { - "description": "The issue display name.", - "type": "string" - }, - "issueModelId": { - "description": "The parent issue model ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata": { - "description": "Metadata about the agent dimension.", - "type": "object", - "properties": { - "agentId": { - "description": "Optional. A user-specified string representing the agent.\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentDisplayName": { - "description": "Optional. The agent's name\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentTeam": { - "description": "Optional. A user-specified string representing the agent's team.", - "type": "string" - }, - "agentVersionDisplayName": { - "description": "Optional. The agent's version display name. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentVersionId": { - "description": "Optional. The agent's version ID. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentDeploymentDisplayName": { - "description": "Optional. The agent's deployment display name. Only applicable to automated agents.\nThis will be populated for AGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentDeploymentId": { - "description": "Optional. The agent's deployment ID. Only applicable to automated agents.\nThis will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata": { - "description": "Metadata about the QA question dimension.", - "type": "object", - "properties": { - "qaScorecardId": { - "description": "Optional. The QA scorecard ID.", - "type": "string" - }, - "qaQuestionId": { - "description": "Optional. The QA question ID.", - "type": "string" - }, - "questionBody": { - "description": "Optional. The full body of the question.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata": { - "description": "Metadata about the QA question-answer dimension.\nThis is useful for showing the answer distribution for questions for a\ngiven scorecard.", - "type": "object", - "properties": { - "qaScorecardId": { - "description": "Optional. The QA scorecard ID.", - "type": "string" - }, - "qaQuestionId": { - "description": "Optional. The QA question ID.", - "type": "string" - }, - "questionBody": { - "description": "Optional. The full body of the question.", - "type": "string" - }, - "answerValue": { - "description": "Optional. The full body of the question.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata": { - "description": "Metadata about the QA scorecard dimension.", - "type": "object", - "properties": { - "qaScorecardId": { - "description": "Optional. The QA scorecard ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata": { - "description": "Metadata about the conversation profile dimension.", - "type": "object", - "properties": { - "conversationProfileId": { - "description": "Optional. The conversation profile ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata": { - "description": "Metadata about the conversation medium dimension.", - "type": "object", - "properties": { - "medium": { - "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata": { - "description": "Metadata about the Conversational Agents playbook dimension.", - "type": "object", - "properties": { - "playbookId": { - "description": "Optional. The dialogflow playbook ID.", - "type": "string" - }, - "playbookDisplayName": { - "description": "Optional. The dialogflow playbook display name.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata": { - "description": "Metadata about the Conversational Agents tool dimension.", - "type": "object", - "properties": { - "toolId": { - "description": "Optional. The dialogflow tool ID.", - "type": "string" - }, - "toolDisplayName": { - "description": "Optional. The dialogflow tool display name.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata": { - "description": "Metadata about the client sentiment category dimension.", - "type": "object", - "properties": { - "sentimentCategory": { - "description": "Optional. The client sentiment category.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionAgentAssistSupervisorDimensionMetadata": { - "description": "Metadata about AA's human supervisor dimension.", - "type": "object", - "properties": { - "supervisorId": { - "description": "Optional. ID of the assigned supervisor.", - "type": "string" - }, - "supervisorUsername": { - "description": "Optional. User name of the assigned supervisor.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata": { - "description": "Metadata about conversation labels.", - "type": "object", - "properties": { - "labelKey": { - "description": "Optional. The label key.", - "type": "string" - }, - "labelValue": { - "description": "Optional. The label value.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryMetricsResponse": { - "description": "The response for querying metrics.", - "type": "object", - "properties": { - "location": { - "description": "Required. The location of the data.\n\"projects/{project}/locations/{location}\"", - "type": "string" - }, - "updateTime": { - "description": "The metrics last update time.", - "type": "string", - "format": "date-time" - }, - "slices": { - "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" - } - }, - "macroAverageSlice": { - "description": "The macro average slice contains aggregated averages across all selected\ndimensions. i.e. if group_by agent and scorecard_id is specified, this\nfield will contain the average across all agents and all scorecards. This\nfield is only populated if the request specifies a Dimension.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" - }] - } - }, - "required": [ - "location" - ] - }, - "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice": { - "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.\n\nFor example, if the request specifies a single ISSUE dimension and it has a\ncardinality of 2 (i.e. the data used to compute the metrics has 2 issues in\ntotal), the response will have 2 slices:\n\n* Slice 1 -> dimensions=[Issue 1]\n* Slice 2 -> dimensions=[Issue 2]", - "type": "object", - "properties": { - "dimensions": { - "description": "A unique combination of dimensions that this slice represents.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dimension" - } - }, - "total": { - "description": "The total metric value. The interval of this data point is\n[starting create time, ending create time) from the request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" - }] - }, - "timeSeries": { - "description": "A time series of metric values. This is only populated if the request\nspecifies a time granularity other than NONE.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint": { - "description": "A data point contains the metric values mapped to an interval.", - "type": "object", - "properties": { - "conversationMeasure": { - "description": "The measure related to conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure" - }] - }, - "dialogflowInteractionMeasure": { - "description": "The measure related to dialogflow interactions.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" - }] - }, - "interval": { - "description": "The interval that this data point represents.\n\n* If this is the total data point, the interval is\n[starting create time, ending create time) from the request.\n* If this a data point from the time series, the interval is\n[time, time + time granularity from the request).", - "allOf": [{ - "$ref": "#/components/schemas/GoogleTypeInterval" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure": { - "description": "The measure related to conversations.", - "type": "object", - "properties": { - "conversationCount": { - "description": "The conversation count.", - "type": "integer", - "format": "int32" - }, - "averageSilencePercentage": { - "description": "The average silence percentage.", - "type": "number", - "format": "float" - }, - "averageDuration": { - "description": "The average duration.", - "type": "string", - "format": "google-duration" - }, - "averageTurnCount": { - "description": "The average turn count.", - "type": "number", - "format": "float" - }, - "averageAgentSentimentScore": { - "description": "The average agent's sentiment score.", - "type": "number", - "format": "float" - }, - "averageClientSentimentScore": { - "description": "The average client's sentiment score.", - "type": "number", - "format": "float" - }, - "averageCustomerSatisfactionRating": { - "description": "The average customer satisfaction rating.", - "type": "number", - "format": "double" - }, - "averageQaNormalizedScore": { - "description": "The average normalized QA score for a scorecard. When computing the\naverage across a set of conversations, if a conversation has been\nevaluated with multiple revisions of a scorecard, only the latest\nrevision results will be used. Will exclude 0's in average\ncalculation. Will be only populated if the request specifies a\ndimension of QA_SCORECARD_ID.", - "type": "number", - "format": "double" - }, - "qaTagScores": { - "description": "Average QA normalized score for all the tags.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" - } - }, - "averageQaQuestionNormalizedScore": { - "description": "Average QA normalized score averaged for questions averaged across\nall revisions of the parent scorecard.\nWill be only populated if the request specifies a dimension of\nQA_QUESTION_ID.", - "type": "number", - "format": "double" - }, - "knowledgeSearchResultCount": { - "description": "Count of knowledge search results (Generative Knowledge\nAssist) shown to the user.", - "type": "integer", - "format": "int32" - }, - "knowledgeSearchAgentQuerySourceRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nmade by the agent compared to the total number of knowledge search\nqueries made.", - "type": "number", - "format": "double" - }, - "knowledgeSearchSuggestedQuerySourceRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nsuggested compared to the total number of knowledge search\nqueries made.", - "type": "number", - "format": "double" - }, - "knowledgeAssistResultCount": { - "description": "Count of knowledge assist results (Proactive Generative Knowledge\nAssist) shown to the user.", - "type": "integer", - "format": "int32" - }, - "knowledgeSearchUriClickRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had a URL clicked.", - "type": "number", - "format": "double" - }, - "knowledgeAssistUriClickRatio": { - "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had a URL clicked.", - "type": "number", - "format": "double" - }, - "knowledgeSearchPositiveFeedbackRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had positive feedback.", - "type": "number", - "format": "double" - }, - "knowledgeSearchNegativeFeedbackRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had negative feedback.", - "type": "number", - "format": "double" - }, - "knowledgeAssistPositiveFeedbackRatio": { - "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had positive feedback.", - "type": "number", - "format": "double" - }, - "knowledgeAssistNegativeFeedbackRatio": { - "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had negative feedback.", - "type": "number", - "format": "double" - }, - "summarizationSuggestionEditRatio": { - "description": "Proportion of summarization suggestions that were manually edited.", - "type": "number", - "format": "double" - }, - "averageSummarizationSuggestionEditDistance": { - "description": "Average edit distance of the summarization suggestions. Edit\ndistance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion.", - "type": "number", - "format": "double" - }, - "averageSummarizationSuggestionNormalizedEditDistance": { - "description": "Normalized Average edit distance of the summarization suggestions.\nEdit distance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion. Normalized edit distance is the average of (edit distance\n/ summary length).", - "type": "number", - "format": "double" - }, - "conversationSuggestedSummaryRatio": { - "description": "Proportion of conversations that had a suggested summary.", - "type": "number", - "format": "double" - }, - "summarizationSuggestionResultCount": { - "description": "Count of summarization suggestions results.", - "type": "integer", - "format": "int32" - }, - "dialogflowInteractionsNoMatchRatio": { - "description": "Proportion of dialogflow interactions that has no intent match for\nthe input.", - "type": "number", - "format": "double" - }, - "dialogflowInteractionsNoInputRatio": { - "description": "Proportion of dialogflow interactions that has empty input.", - "type": "number", - "format": "double" - }, - "dialogflowWebhookFailureRatio": { - "description": "Proportion of dialogflow webhook calls that failed.", - "type": "number", - "format": "double" - }, - "dialogflowWebhookTimeoutRatio": { - "description": "Proportion of dialogflow webhook calls that timed out.", - "type": "number", - "format": "double" - }, - "dialogflowAverageWebhookLatency": { - "description": "Average latency of dialogflow webhook calls.", - "type": "number", - "format": "double" - }, - "dialogflowConversationsEscalationRatio": { - "description": "Proportion of conversations that was handed off from virtual agent to\nhuman agent.", - "type": "number", - "format": "double" - }, - "dialogflowConversationsEscalationCount": { - "description": "count of conversations that was handed off from virtual agent to\nhuman agent.", - "type": "number", - "format": "double" - }, - "conversationalAgentsToolCallSuccessRatio": { - "description": "Proportion of conversational agents' tool calls that were successful.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageToolCallLatency": { - "description": "Average latency of conversational agents' tool calls.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageTtsLatency": { - "description": "The macro average latency of conversational agents' TTS latency\nper interaction.\nThis is computed as the average of the all the interactions' TTS\nlatencies in a conversation and averaged across conversations.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageLlmCallLatency": { - "description": "The average latency of conversational agents' LLM call latency\nper interaction. This is computed as the average of the all the\ninteractions LLM call latencies in a conversation and averaged across\nconversations.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageAudioInAudioOutLatency": { - "description": "The average latency of conversational agents' audio in audio\nout latency per interaction.\nThis is computed as the average of the all the interactions' audio in\naudio out latencies in a conversation and averaged across\nconversations.", - "type": "number", - "format": "double" - }, - "conversationAiCoachSuggestionRatio": { - "description": "Proportion of conversations that has Ai Coach Suggestions.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionAgentUsageRatio": { - "description": "Proportion of Ai Coach Suggestion that has been used by agents.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionCustomerMessageTriggerRatio": { - "description": "Proportion of customer messages that triggered an Ai Coach\nSuggestion.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageEndToEndLatency": { - "description": "The average latency of conversational agents' latency per\ninteraction. This is computed as the average of the all the\niteractions' end to end latencies in a conversation and averaged\nacross conversations. The e2e latency is the time between the end of\nthe user utterance and the start of the agent utterance on the\ninteraction level.", - "type": "number", - "format": "double" - }, - "conversationAiCoachSuggestionCount": { - "description": "Count of conversations that has Ai Coach Suggestions.", - "type": "integer", - "format": "int32" - }, - "aiCoachSuggestionAgentUsageCount": { - "description": "Count of Ai Coach Suggestion that has been used by agents.", - "type": "integer", - "format": "int32" - }, - "aiCoachSuggestionCustomerMessageTriggerCount": { - "description": "Count of customer messages that triggered an Ai Coach\nSuggestion.", - "type": "integer", - "format": "int32" - }, - "aiCoachSuggestionAgentMessageTriggerCount": { - "description": "Count of agent messages that triggered an Ai Coach Suggestion.", - "type": "integer", - "format": "int32" - }, - "conversationTotalCustomerMessageCount": { - "description": "The customer message count.", - "type": "integer", - "format": "int32" - }, - "conversationTotalAgentMessageCount": { - "description": "The agent message count.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorMonitoredConversationsCount": { - "description": "The number of conversations scanned by the AA human supervisor.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorEscalatedConversationsCount": { - "description": "The number of conversations that were escalated to an AA human\nsupervisor for intervention.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorAssignedConversationsCount": { - "description": "The number of conversations that were assigned to an AA human\nsupervisor.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorDroppedConversationsCount": { - "description": "The number of conversations that were dropped, i.e. escalated but not\nassigned to an AA human supervisor.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorTransferredToHumanAgentConvCount": { - "description": "The number of conversations transferred to a human agent.", - "type": "integer", - "format": "int32" - }, - "avgConversationClientTurnSentimentEma": { - "description": "The exponential moving average of the sentiment score of client turns\nin the conversation.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionMessageTriggerRatio": { - "description": "Proportion of end_of_utterance trigger event messages that triggered\nan Ai Coach Suggestion.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionMessageTriggerCount": { - "description": "Count of end_of_utterance trigger event messages that triggered an Ai\nCoach Suggestion.", - "type": "integer", - "format": "int32" - }, - "containedConversationCount": { - "description": "The number of conversations that were contained.", - "type": "integer", - "format": "int32" - }, - "containedConversationRatio": { - "description": "The percentage of conversations that were contained.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { - "description": "Average QA normalized score for the tag.", - "type": "object", - "properties": { - "tag": { - "description": "Tag name.", - "type": "string" - }, - "averageTagNormalizedScore": { - "description": "Average tag normalized score per tag.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { - "description": "The measure related to dialogflow interactions.", - "type": "object", - "properties": { - "percentileAudioInAudioOutLatency": { - "description": "The percentile result for audio in audio out latency in milliseconds\nper dialogflow interaction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileLlmCallLatency": { - "description": "The percentile result for LLM latency in milliseconds per dialogflow\ninteraction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileTtsLatency": { - "description": "The percentile result for TTS latency in milliseconds per dialogflow\ninteraction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileToolUseLatency": { - "description": "The percentile result for tool use latency in milliseconds per\ndialogflow interaction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileEndToEndLatency": { - "description": "The percentile result for end to end chat latency in milliseconds per\ndialogflow interaction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult": { - "description": "The percentile result. Currently supported percentiles are 50th, 90th,\nand 99th.", - "type": "object", - "properties": { - "p50": { - "description": "The 50th percentile value.", - "type": "number", - "format": "double" - }, - "p90": { - "description": "The 90th percentile value.", - "type": "number", - "format": "double" - }, - "p99": { - "description": "The 99th percentile value.", - "type": "number", - "format": "double" - } - } - }, - "GoogleTypeInterval": { - "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a\nTimestamp end (exclusive).\n\nThe start must be less than or equal to the end.\nWhen the start equals the end, the interval is empty (matches no time).\nWhen both start and end are unspecified, the interval matches any time.", - "type": "object", - "properties": { - "startTime": { - "description": "Optional. Inclusive start of the interval.\n\nIf specified, a Timestamp matching this interval will have to be the same\nor after the start.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Optional. Exclusive end of the interval.\n\nIf specified, a Timestamp matching this interval will have to be before the\nend.", - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries": { - "description": "A time series of metric values.", - "type": "object", - "properties": { - "dataPoints": { - "description": "The data points that make up the time series .", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata": { - "description": "The metadata from querying metrics.", - "type": "object", - "properties": { - "resultIsTruncated": { - "description": "Whether the result rows were truncated because the result row size is too\nlarge to materialize.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsRequest": { - "description": "The request for generative insights.", - "type": "object", - "properties": { - "naturalLanguageQuery": { - "description": "The natural language query specified by the user. If this field is\nspecified, `sql_query` will be ignored.", - "type": "string" - }, - "chart": { - "description": "The full name of the chart resource this request corresponds to.\nFormat:\nprojects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", - "type": "string" - }, - "filter": { - "description": "Filter for the data that can be specified in addition to the natural\nlanguage query. Users are encouraged to use this field to populate\ntime-windows.", - "type": "string" - }, - "comparisonFilter": { - "description": "Optional. Filter for the data that can be specified in addition to the natural\nlanguage query. This `filter` is specifically used for charts where\ncomparisons are possible. For example, \"compare to last month\" or\n\"compare to previous quarter\".", - "type": "string" - }, - "sqlQuery": { - "description": "Optional. The SQL query specified by the user. This query must be in BigQuery SQL\ndialect. The `filter` field will also be ignored, as it is assumed that\nany filtering is already included in the SQL query.", - "type": "string" - }, - "sqlComparisonKey": { - "description": "Optional. For charts with comparison, this key will determine the metric that will be\ncompared between the current and another dataset.", - "type": "string" - }, - "sessionId": { - "description": "Optional. The session id of the conversation. If the session id is not specified,\nbackend will generate a random session id. If the session id is specified,\nwill associate user-provided user_query with the provided session id.", - "type": "string" - }, - "revisionId": { - "description": "Optional. The revision id that maps to the state of the chart state revision.\nWhen specified, the backend will reload the chart with the sql and visual\nspec from that revision.", - "type": "string" - }, - "userProvidedChartSpec": { - "description": "Optional. The user provided chart spec for the chart. This will be used to override\nthe visual spec generated by the LLM.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse": { - "description": "The response for generative insights.", - "type": "object", - "properties": { - "generativeResponses": { - "description": "The full list of generative responses.\nEach response is ordered by time.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse" - } - }, - "transcript": { - "description": "The transcript of the generative insights conversation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse": { - "description": "Wrapper for storing the generative response for a chart.", - "type": "object", - "properties": { - "textOutput": { - "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", - "deprecated": true, - "type": "string" - }, - "generatedSqlQuery": { - "description": "The generated SQL query from the LLM. Will be populated during the\nchart building phase. The generated SQL will be cached in the\ncorresponding chart resource.", - "type": "string" - }, - "chartSpec": { - "description": "The chart spec for the data.\nThis will be specified in the vega-lite or vega format.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "textMessage": { - "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput": { - "description": "Wrapper for text output.", - "type": "object", - "properties": { - "text": { - "description": "The text output from the LLM.", - "type": "array", - "items": { - "type": "string" - } - }, - "textType": { - "description": "The type of text output.", - "type": "string", - "x-google-enum-descriptions": [ - "The type is unspecified.", - "The text is part of LLM reasoning.", - "The text is the final answer from LLM.", - "The text is an informational message about the agent's progress, such\nas a tool being invoked. This is distinct from the agent's internal\nthought process (`THOUGHT`) and the final answer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the agent's\nactions." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "THOUGHT", - "FINAL_RESPONSE", - "PROGRESS" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript": { - "description": "The conversation transcript for the chart.", - "type": "object", - "properties": { - "conversationId": { - "description": "The conversation id of the chart.", - "type": "string" - }, - "createTime": { - "description": "Output only. The create time of the conversation.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The update time of the conversation.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "messages": { - "description": "Ordered list of messages, including user inputs and system responses.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage": { - "description": "The message in the conversation.", - "type": "object", - "properties": { - "userMessage": { - "description": "A message from the user that is interacting with the system.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage" - }] - }, - "systemMessageWrapper": { - "description": "A wrapper for system messages per turn.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages" - }] - }, - "messageId": { - "description": "The message id of the message.", - "type": "string" - }, - "createTime": { - "description": "Output only. For user messages, this is the time at which the system received the\nmessage. For system messages, this is the time at which the system\ngenerated the message.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage": { - "description": "The user message.", - "type": "object", - "properties": { - "text": { - "description": "A message from the user that is interacting with the system.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages": { - "description": "A wrapper for system messages per turn.", - "type": "object", - "properties": { - "systemMessages": { - "description": "A message from the system in response to the user.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage": { - "description": "A message from the system in response to the user. This message can\nalso be a message from the user as historical context for multiturn\nconversations with the system.", - "type": "object", - "properties": { - "textMessage": { - "description": "A direct natural language response to the user message.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" - }] - }, - "generatedSqlQuery": { - "description": "Raw SQL from LLM, before templatization", - "type": "string" - }, - "chartSpec": { - "description": "Chart spec from LLM", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "userProvidedSqlQuery": { - "description": "Optional. User provided SQL query", - "type": "string" - }, - "userProvidedChartSpec": { - "description": "Optional. User provided chart spec", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { - "description": "A text output message from the system.", - "type": "object", - "properties": { - "text": { - "description": "The parts of the message.", - "type": "array", - "items": { - "type": "string" - } - }, - "textType": { - "description": "The type of the text message.", - "type": "string", - "x-google-enum-descriptions": [ - "The default text type.", - "The text is a thinking plan generated by the thinking tool.", - "The text is a final response to the user question.", - "The text is an informational message about the agent's\nprogress, such as a tool being invoked. This is distinct from\nthe agent's internal thought process (`THOUGHT`) and the final\nanswer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the\nagent's actions." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "THOUGHT", - "FINAL_RESPONSE", - "PROGRESS" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata": { - "description": "The metadata for generative insights.", - "type": "object", - "properties": { - "errorMessages": { - "description": "The error message when the generative insights request fails.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest": { - "description": "The request for summarizing performance according to different metrics for\nconversations over a specified time window.", - "type": "object", - "properties": { - "agentPerformanceSource": { - "description": "Conversations are from a single agent.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequestAgentSource" - }] - }, - "filter": { - "description": "Optional. Filter to select a subset of conversations to compute the performance\noverview. Supports the same filters as the filter field in\nQueryMetricsRequest. The source and query interval/comparison query\ninterval should not be included here.", - "type": "string" - }, - "queryInterval": { - "description": "Required. The time window of the conversations to derive performance stats from.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryInterval" - }] - }, - "comparisonQueryInterval": { - "description": "The time window of the conversations to compare the performance to.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryInterval" - }] - } - }, - "required": [ - "queryInterval" - ] - }, - "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequestAgentSource": { - "description": "The entity whose performance is being queried is a single agent.", - "type": "object", - "properties": { - "agentId": { - "description": "Required. Agent id to query performance overview for.", - "type": "string" - } - }, - "required": [ - "agentId" - ] - }, - "GoogleCloudContactcenterinsightsV1QueryInterval": { - "description": "A time window for querying conversations.", - "type": "object", - "properties": { - "startTime": { - "description": "Required. The start time of the time window.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Required. The end time of the time window.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "startTime", - "endTime" - ] - }, - "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse": { - "description": "The response for querying performance overview.", - "type": "object", - "properties": { - "summaryText": { - "description": "The summary text of the performance.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata": { - "description": "The metadata for querying performance overview.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1QaQuestion": { - "description": "A single question to be scored by the Insights QA feature.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The resource name of the question.\nFormat:\nprojects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", - "x-google-identifier": true, - "type": "string" - }, - "abbreviation": { - "description": "Short, descriptive string, used in the UI where it's not practical\nto display the full question body. E.g., \"Greeting\".", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this question was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the question was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "questionType": { - "description": "The type of question.", - "type": "string", - "x-google-enum-descriptions": [ - "The type of the question is unspecified.", - "The default question type. The question is fully customizable by the\nuser.", - "The question type is using a predefined model provided by CCAI\nteams. Users are not allowed to edit the question_body, answer_choices,\nupload feedback labels for the question nor fine-tune the question.\nHowever, users may edit other fields like question tags, question order,\netc." - ], - "enum": [ - "QA_QUESTION_TYPE_UNSPECIFIED", - "CUSTOMIZABLE", - "PREDEFINED" - ] - }, - "questionMedium": { - "description": "The medium of the question.", - "type": "string", - "x-google-enum-descriptions": [ - "The medium of the question is unspecified.", - "The question is for chat conversations and will expect a chat transcript\nto be present before scoring.", - "The question is for voice conversations and does NOT expect any chat\ntranscripts to be present before scoring." - ], - "enum": [ - "QA_QUESTION_MEDIUM_UNSPECIFIED", - "CHAT", - "VOICE" - ] - }, - "qaQuestionDataOptions": { - "description": "Options for configuring the data used to generate the QA question.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionQaQuestionDataOptions" - }] - }, - "predefinedQuestionConfig": { - "description": "The configuration of the predefined question. This field will only be set\nif the Question Type is predefined.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionPredefinedQuestionConfig" - }] - }, - "questionBody": { - "description": "Question text. E.g., \"Did the agent greet the customer?\"", - "type": "string" - }, - "answerInstructions": { - "description": "Instructions describing how to determine the answer.", - "type": "string" - }, - "answerChoices": { - "description": "A list of valid answers to the question, which the LLM must choose from.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice" - } - }, - "tags": { - "description": "Questions are tagged for categorization and scoring. Tags can either be:\n- Default Tags: These are predefined categories. They are identified by\ntheir string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\").\n- Custom Tags: These are user-defined categories. They are identified by\ntheir full resource name (e.g.,\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}).\nBoth default and custom tags are used to group questions and to influence\nthe scoring of each question.", - "type": "array", - "items": { - "type": "string" - } - }, - "order": { - "description": "Defines the order of the question within its parent scorecard revision.", - "type": "integer", - "format": "int32" - }, - "metrics": { - "description": "Metrics of the underlying tuned LLM over a holdout/test set while fine\ntuning the underlying LLM for the given question. This field will only be\npopulated if and only if the question is part of a scorecard revision that\nhas been tuned.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionMetrics" - }] - }, - "tuningMetadata": { - "description": "Metadata about the tuning operation for the question.This field will only\nbe populated if and only if the question is part of a scorecard revision\nthat has been tuned.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1QaQuestionQaQuestionDataOptions": { - "description": "Options for configuring the data used to generate the QA question.", - "type": "object", - "properties": { - "conversationDataOptions": { - "description": "Options for configuring the conversation data used to generate the QA\nquestion.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataOptions" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ConversationDataOptions": { - "description": "Options for configuring what metadata is included in the conversation data\nused in QAI and Discovery Engine.", - "type": "object", - "properties": { - "includeDialogflowInteractionData": { - "description": "Whether to include the per turn Dialogflow interaction data in conversation\ntranscript.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1QaQuestionPredefinedQuestionConfig": { - "description": "Configuration for a predefined question. This field will only be set if the\nQuestion Type is predefined.", - "type": "object", - "properties": { - "type": { - "description": "The type of the predefined question.", - "type": "string", - "x-google-enum-descriptions": [ - "The type of the predefined question is unspecified.", - "A prebuilt classifier classfying the outcome of the conversation.\nFor example, if the customer issue mentioned in a conversation has\nbeen resolved or not.", - "A prebuilt classifier classfying the initiator of the conversation\nescalation. For example, if it was initiated by the customer or the\nagent." - ], - "enum": [ - "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", - "CONVERSATION_OUTCOME", - "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice": { - "description": "Message representing a possible answer to the question.", - "type": "object", - "properties": { - "strValue": { - "description": "String value.", - "type": "string" - }, - "numValue": { - "description": "Numerical value.", - "type": "number", - "format": "double" - }, - "boolValue": { - "description": "Boolean value.", - "type": "boolean" - }, - "naValue": { - "description": "A value of \"Not Applicable (N/A)\". If provided, this field may only\nbe set to `true`. If a question receives this answer, it will be\nexcluded from any score calculations.", - "type": "boolean" - }, - "key": { - "description": "A short string used as an identifier.", - "type": "string" - }, - "score": { - "description": "Numerical score of the answer, used for generating the overall score of\na QaScorecardResult. If the answer uses na_value, this field is unused.", - "type": "number", - "format": "double" - }, - "nextActionConfig": { - "description": "Configuration for the next action to take if this answerChoice is\nselected for this question.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfig": { - "description": "The configuration for the next action. This is used to configure the next\naction to take if an answer choice is selected.", - "type": "object", - "properties": { - "runChildQaQuestionsAction": { - "description": "The list of questions to evaluate next, i.e., child questions.\nRequirements for this action are the following:\n1. The current question and child questions must be in the same\n scorecard and present in the same scorecard revision.\n2. The current question and child questions must not introduce a\n cycle, i.e., Q1 -> [Q2, Q3], then Q2 -> [Q1] should not be\n allowed, where Q1, Q2, and Q3 are questions.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction" - }] - }, - "terminateChildQaQuestionsAction": { - "description": "Terminate any further evaluation of child questions.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction": { - "description": "The configuration for evaluating child questions.", - "type": "object", - "properties": { - "childQaQuestionNames": { - "description": "A list of resource names representing the child questions to evaluate\nnext. The format for each question resource name is:\nprojects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions": { - "description": "Indicates termination.", - "type": "object", - "properties": { - "terminationType": { - "description": "The type of termination to perform.", - "type": "string", - "x-google-enum-descriptions": [ - "The termination type is unspecified.", - "A failed scorecard would mean the overall scorecard score will be\nzeroed out, i.e., the scorecard score will be 0.", - "The overall scorecard score will be calculated based on the\nscores of the questions answered in the chain up until the last\nscored question that was answered. This is the default behavior." - ], - "enum": [ - "TERMINATION_TYPE_UNSPECIFIED", - "TERMINATE_WITH_SCORECARD_FAILURE", - "TERMINATE_WITH_CALCULATED_SCORE" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1QaQuestionMetrics": { - "description": "A wrapper representing metrics calculated against a test-set on a LLM that\nwas fine tuned for this question.", - "type": "object", - "properties": { - "accuracy": { - "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the\nmodel gave on the test set.", - "readOnly": true, - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata": { - "description": "Metadata about the tuning operation for the question. Will only be set if a\nscorecard containing this question has been tuned.", - "type": "object", - "properties": { - "totalValidLabelCount": { - "description": "Total number of valid labels provided for the question at the time of\ntuining.", - "type": "string", - "format": "int64" - }, - "datasetValidationWarnings": { - "description": "A list of any applicable data validation warnings about the question's\nfeedback labels.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DatasetValidationWarning" - } - }, - "tuningError": { - "description": "Error status of the tuning operation for the question. Will only be set\nif the tuning operation failed.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse": { - "description": "The response from a ListQaQuestions request.", - "type": "object", - "properties": { - "qaQuestions": { - "description": "The QaQuestions under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1QaQuestionTag": { - "description": "A tag is a resource which aims to categorize a set of questions across\nmultiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Resource name for the QaQuestionTag\nFormat\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}\nIn the above format, the last segment, i.e., qa_question_tag, is a\nserver-generated ID corresponding to the tag resource.", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "Required. A user-specified display name for the tag.", - "type": "string" - }, - "qaQuestionIds": { - "description": "Optional. The list of Scorecard Question IDs that the tag applies to.\nEach QaQuestionId is represented as a full resource name containing the\nQuestion ID. Lastly, Since a tag may not necessarily be referenced by any\nScorecard Questions, we treat this field as optional.", - "type": "array", - "items": { - "type": "string" - } - }, - "createTime": { - "description": "Output only. The time at which the question tag was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the question tag was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - }, - "required": [ - "displayName" - ] - }, - "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata": { - "description": "The metadata for updating a QaQuestionTag Resource.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest": { - "description": "The request for updating a QaQuestionTag.", - "type": "object", - "properties": { - "qaQuestionTag": { - "description": "Required. The QaQuestionTag to update.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" - }] - }, - "updateMask": { - "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `qa_question_tag_name` - the name of the tag\n* `qa_question_ids` - the list of questions the tag applies to", - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - }, - "required": [ - "qaQuestionTag" - ] - }, - "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata": { - "description": "The metadata for deleting a QaQuestionTag Resource.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest": { - "description": "The request for deleting a QaQuestionTag.", - "type": "object", - "properties": { - "name": { - "description": "Required. The name of the QaQuestionTag to delete.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse": { - "description": "The response from a ListQaQuestionTags request.", - "type": "object", - "properties": { - "qaQuestionTags": { - "description": "The parent resource of the questions.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1QaScorecard": { - "description": "A QaScorecard represents a collection of questions to be scored during\nanalysis.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The scorecard name.\nFormat:\nprojects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "The user-specified display name of the scorecard.", - "type": "string" - }, - "description": { - "description": "A text description explaining the intent of the scorecard.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this scorecard was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the scorecard was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "isDefault": { - "description": "Whether the scorecard is the default one for the project.\nA default scorecard cannot be deleted and will always appear first in\nscorecard selector.", - "type": "boolean" - }, - "source": { - "description": "Output only. The source of the scorecard.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardSource" - }] - }, - "isArchived": { - "description": "Whether the scorecard is archived. Archived scorecards will not be shown\nnor used in analyses of conversations. Similarly, archived scorecards and\nany sub-resources of the scorecard (e.g., questions) will not be used to\nfilter conversations. To emphasize, arhiving scorecards will not delete\nthe scorecard (or any of its sub-resources), nor will it delete any past\nanalyses that have been ran using the scorecard. Lastly, archived\nscorecards can be unarchived.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse": { - "description": "The response from a ListQaScorecards request.", - "type": "object", - "properties": { - "qaScorecards": { - "description": "The QaScorecards under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1QaScorecardRevision": { - "description": "A revision of a QaScorecard.\n\nModifying published scorecard fields would invalidate existing scorecard\nresults \u2014 the questions may have changed, or the score weighting will make\nexisting scores impossible to understand. So changes must create a new\nrevision, rather than modifying the existing resource.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The name of the scorecard revision.\nFormat:\nprojects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}", - "x-google-identifier": true, - "type": "string" - }, - "snapshot": { - "description": "The snapshot of the scorecard at the time of this revision's creation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard" - }] - }, - "createTime": { - "description": "Output only. The timestamp that the revision was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "alternateIds": { - "description": "Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "state": { - "description": "Output only. State of the scorecard revision, indicating whether it's ready to\nbe used in analysis.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "The scorecard revision can be edited.", - "Scorecard model training is in progress.", - "Scorecard revision model training failed.", - "The revision can be used in analysis.", - "Scorecard is being deleted.", - "Scorecard model training was explicitly cancelled by the user." - ], - "enum": [ - "STATE_UNSPECIFIED", - "EDITABLE", - "TRAINING", - "TRAINING_FAILED", - "READY", - "DELETING", - "TRAINING_CANCELLED" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest": { - "description": "Request for TuneQaScorecardRevision endpoint.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource for new fine tuning job instance.", - "type": "string" - }, - "filter": { - "description": "Required. Filter for selecting the feedback labels that needs to be\nused for training.\nThis filter can be used to limit the feedback labels used for tuning to a\nfeedback labels created or updated for a specific time-window etc.", - "type": "string" - }, - "validateOnly": { - "description": "Optional. Run in validate only mode, no fine tuning will actually run.\nData quality validations like training data distributions will run.\nEven when set to false, the data quality validations will still run but\nonce the validations complete we will proceed with the fine tune, if\napplicable.", - "type": "boolean" - } - }, - "required": [ - "parent", - "filter" - ] - }, - "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionResponse": { - "description": "Response for TuneQaScorecardRevision endpoint.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadata": { - "description": "Metadata for TuneQaScorecardRevision endpoint.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest" - }] - }, - "qaQuestionDatasetValidationResults": { - "description": "Output only. The results of data validation per question in the request.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetValidationResult" - } - }, - "qaQuestionDatasetTuningMetrics": { - "description": "Output only. The metrics for each QaQuestion in the TuneScorecardRevision request.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetTuningMetrics" - } - }, - "tuningCompletionRatio": { - "description": "Output only. The percentage of the tuning job that has completed. Always between 0 and 1\nwhere 0 indicates the job has not started i.e. 0% and 1 indicates the job\nhas completed i.e. 100%.", - "readOnly": true, - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetValidationResult": { - "description": "Contains validation results for a question in the tuning request.", - "type": "object", - "properties": { - "question": { - "description": "Output only. The resource path of the question whose dataset was evaluated for tuning.", - "readOnly": true, - "type": "string" - }, - "datasetValidationWarnings": { - "description": "A list of any applicable data validation warnings about the question's\nfeedback labels.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DatasetValidationWarning" - } - }, - "validFeedbackLabelsCount": { - "description": "The number of valid feedback labels in the question's dataset.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetTuningMetrics": { - "description": "Contains performance metrics for each QaQuestion in the\nTuneScorecardRevision request.", - "type": "object", - "properties": { - "question": { - "description": "Output only. The resource path of the question whose dataset was evaluated for tuning.", - "readOnly": true, - "type": "string" - }, - "metrics": { - "description": "Output only. The metrics for the question's dataset.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetTuningMetricsMetrics" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadataQaQuestionDatasetTuningMetricsMetrics": { - "description": "Performance metrics for the question's dataset calculated over the tuned\nmodel.", - "type": "object", - "properties": { - "accuracy": { - "description": "Accuracy of the question's dataset.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsRequest": { - "description": "The request for bulk updating QaQuestions.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource for the bulk update job instance.", - "type": "string" - }, - "qaQuestions": { - "description": "Required. All the questions to be updated", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" - } - }, - "updateMask": { - "description": "Optional. All questions will be updated with the same mask.\nAn empty mask will means updating all updatable fields.", - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - }, - "required": [ - "parent", - "qaQuestions" - ] - }, - "GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsResponse": { - "description": "The response for bulk updating QaQuestions.", - "type": "object", - "properties": { - "qaQuestions": { - "description": "The QaQuestions that were updated.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsMetadata": { - "description": "The metadata for bulk updating QaQuestions.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest": { - "description": "The request to deploy a QaScorecardRevision", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest": { - "description": "The request to undeploy a QaScorecardRevision", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse": { - "description": "The response from a ListQaScorecardRevisions request.", - "type": "object", - "properties": { - "qaScorecardRevisions": { - "description": "The QaScorecards under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse": { - "description": "The response for listing feedback labels.", - "type": "object", - "properties": { - "feedbackLabels": { - "description": "The feedback labels that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - }, - "nextPageToken": { - "description": "The next page token.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse": { - "description": "The response for listing all feedback labels.", - "type": "object", - "properties": { - "feedbackLabels": { - "description": "The feedback labels that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest": { - "description": "The request for bulk uploading feedback labels.", - "type": "object", - "properties": { - "gcsSource": { - "description": "A cloud storage bucket source.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource" - }] - }, - "sheetsSource": { - "description": "A sheets document source.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource" - }] - }, - "parent": { - "description": "Required. The parent resource for new feedback labels.", - "type": "string" - }, - "validateOnly": { - "description": "Optional. If set, upload will not happen and the labels will be validated.\nIf not set, then default behavior will be to upload the labels after\nvalidation is complete.", - "type": "boolean" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource": { - "description": "Google Cloud Storage Object details to get the feedback label file from.", - "type": "object", - "properties": { - "format": { - "description": "Required. File format which will be ingested.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified format.", - "CSV format.", - "JSON format." - ], - "enum": [ - "FORMAT_UNSPECIFIED", - "CSV", - "JSON" - ] - }, - "objectUri": { - "description": "Required. The Google Cloud Storage URI of the file to import.\nFormat: `gs://bucket_name/object_name`", - "type": "string" - } - }, - "required": [ - "format", - "objectUri" - ] - }, - "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource": { - "description": "Google Sheets document details to get the feedback label file from.", - "type": "object", - "properties": { - "spreadsheetUri": { - "description": "Required. The Google Sheets document to write the feedback labels to.\nRetrieved from Google Sheets URI.\nE.g. `https://docs.google.com/spreadsheets/d/1234567890`\nThe spreadsheet must be shared with the Insights P4SA.", - "type": "string" - } - }, - "required": [ - "spreadsheetUri" - ] - }, - "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsResponse": { - "description": "Response for the Bulk Upload Feedback Labels API.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsMetadata": { - "description": "Metadata for the Bulk Upload Feedback Labels API.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for ingest.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "uploadStats": { - "description": "Output only. Statistics for BulkUploadFeedbackLabels operation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsMetadataUploadStats" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsMetadataUploadStats": { - "description": "Statistics for BulkUploadFeedbackLabels operation.", - "type": "object", - "properties": { - "processedObjectCount": { - "description": "The number of objects processed during the upload operation.", - "type": "integer", - "format": "int32" - }, - "failedValidationCount": { - "description": "The number of objects skipped because of failed validation", - "type": "integer", - "format": "int32" - }, - "successfulUploadCount": { - "description": "The number of new feedback labels added during this ingest operation.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest": { - "description": "Request for the BulkDownloadFeedbackLabel endpoint.", - "type": "object", - "properties": { - "gcsDestination": { - "description": "A cloud storage bucket destination.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination" - }] - }, - "sheetsDestination": { - "description": "A sheets document destination.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination" - }] - }, - "parent": { - "description": "Required. The parent resource for new feedback labels.", - "type": "string" - }, - "filter": { - "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", - "type": "string" - }, - "maxDownloadCount": { - "description": "Optional. Limits the maximum number of feedback labels that will be downloaded.\nThe first `N` feedback labels will be downloaded.", - "type": "integer", - "format": "int32" - }, - "feedbackLabelType": { - "description": "Optional. The type of feedback labels that will be downloaded.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified format", - "Downloaded file will contain all Quality AI labels from the latest\nscorecard revision.", - "Downloaded file will contain only Topic Modeling labels.", - "Agent Assist Summarization labels." - ], - "enum": [ - "FEEDBACK_LABEL_TYPE_UNSPECIFIED", - "QUALITY_AI", - "TOPIC_MODELING", - "AGENT_ASSIST_SUMMARY" - ] - }, - "conversationFilter": { - "description": "Optional. Filter parent conversations to download feedback labels for.\nWhen specified, the feedback labels will be downloaded for the\nconversations that match the filter.\nIf `template_qa_scorecard_id` is set, all the conversations that match the\nfilter will be paired with the questions under the scorecard for labeling.", - "type": "string" - }, - "templateQaScorecardId": { - "description": "Optional. If set, a template for labeling conversations and scorecard questions will\nbe created from the conversation_filter and the questions under the\nscorecard(s). The feedback label `filter` will be ignored.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination": { - "description": "Google Cloud Storage Object details to write the feedback labels to.", - "type": "object", - "properties": { - "format": { - "description": "Required. File format in which the labels will be exported.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified format.", - "CSV format.\n1,000 labels are stored per CSV file by default.", - "JSON format.\n1 label stored per JSON file by default." - ], - "enum": [ - "FORMAT_UNSPECIFIED", - "CSV", - "JSON" - ] - }, - "objectUri": { - "description": "Required. The Google Cloud Storage URI to write the feedback labels to.\nThe file name will be used as a prefix for the files written to the\nbucket if the output needs to be split across multiple files, otherwise\nit will be used as is. The file extension will be appended to the file\nname based on the format selected.\n E.g. `gs://bucket_name/object_uri_prefix`", - "type": "string" - }, - "addWhitespace": { - "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases\nfile size. Only applicable for JSON format.", - "type": "boolean" - }, - "alwaysPrintEmptyFields": { - "description": "Optional. Always print fields with no presence.\nThis is useful for printing fields that are not set, like implicit 0\nvalue or empty lists/maps. Only applicable for JSON format.", - "type": "boolean" - }, - "recordsPerFileCount": { - "description": "Optional. The number of records per file. Applicable for either format.", - "type": "string", - "format": "int64" - } - }, - "required": [ - "format", - "objectUri" - ] - }, - "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination": { - "description": "Google Sheets document details to write the feedback labels to.", - "type": "object", - "properties": { - "spreadsheetUri": { - "description": "Required. The Google Sheets document to write the feedback labels to.\nRetrieved from Google Sheets URI.\nE.g. `https://docs.google.com/spreadsheets/d/1234567890`\nThe spreadsheet must be shared with the Insights P4SA.\nThe spreadsheet ID written to will be returned as `file_names` in the\nBulkDownloadFeedbackLabelsMetadata.", - "type": "string" - }, - "sheetTitle": { - "description": "Optional. The title of the new sheet to write the feedback labels to.", - "type": "string" - } - }, - "required": [ - "spreadsheetUri" - ] - }, - "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse": { - "description": "Response for the BulkDownloadFeedbackLabel endpoint.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata": { - "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for download.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "downloadStats": { - "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats": { - "description": "Statistics for BulkDownloadFeedbackLabels operation.", - "type": "object", - "properties": { - "processedObjectCount": { - "description": "The number of objects processed during the download operation.", - "type": "integer", - "format": "int32" - }, - "successfulDownloadCount": { - "description": "The number of new feedback labels downloaded during this operation.\nDifferent from \"processed\" because some labels might not be downloaded\nbecause an error.", - "type": "integer", - "format": "int32" - }, - "totalFilesWritten": { - "description": "Total number of files written to the provided Cloud Storage bucket.", - "type": "integer", - "format": "int32" - }, - "fileNames": { - "description": "Output only. Full name of the files written to Cloud storage.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest": { - "description": "Request for the BulkDeleteFeedbackLabels endpoint.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource for new feedback labels.", - "type": "string" - }, - "filter": { - "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", - "type": "string" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse": { - "description": "Response for the BulkDeleteFeedbackLabels endpoint.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata": { - "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", - "type": "object", - "properties": { - "request": { - "description": "Output only. The original request for delete.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during deletion operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1AuthorizedViewSet": { - "description": "An AuthorizedViewSet contains a set of AuthorizedView resources.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The resource name of the AuthorizedViewSet.\nFormat:\nprojects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "Display Name. Limit 64 characters.", - "type": "string" - }, - "createTime": { - "description": "Output only. Create time.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. Update time.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse": { - "description": "The response from a ListAuthorizedViewSet request.", - "type": "object", - "properties": { - "authorizedViewSets": { - "description": "The AuthorizedViewSets under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1AuthorizedView": { - "description": "An AuthorizedView represents a view of accessible Insights resources (for\nexample, Conversation and Scorecard). Who have read access to the\nAuthorizedView resource will have access to these Insight resources as well.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The resource name of the AuthorizedView.\nFormat:\nprojects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "Display Name. Limit 64 characters.", - "type": "string" - }, - "conversationFilter": { - "description": "A filter to reduce conversation results to a specific subset.\nThe AuthorizedView's assigned permission (read/write) could be applied to\nthe subset of conversations.\n\nIf conversation_filter is empty, there is no restriction on the\nconversations that the AuthorizedView can access.\n\nHaving *authorizedViews.get* access to the AuthorizedView means having the\nsame read/write access to the Conversations (as well as\nmetadata/annotations linked to the conversation) that this AuthorizedView\nhas.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which the authorized view was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the authorized view was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse": { - "description": "The response from a ListAuthorizedViews request.", - "type": "object", - "properties": { - "authorizedViews": { - "description": "The AuthorizedViews under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse": { - "description": "The response from a ListAuthorizedViews request.", - "type": "object", - "properties": { - "authorizedViews": { - "description": "The AuthorizedViews under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1Assessment": { - "description": "The assessment resource.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The resource name of the assessment.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}", - "x-google-identifier": true, - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which the assessment was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The time at which the assessment was last updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "state": { - "description": "Output only. The state of the assessment.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "The state is unspecified. This value should not be used.", - "The default state of all new assessments.", - "The assessment has been published.", - "The assessment has been appealed.", - "The assessment has been finalized." - ], - "enum": [ - "STATE_UNSPECIFIED", - "DRAFT", - "PUBLISHED", - "APPEALED", - "FINALIZED" - ] - }, - "agentInfo": { - "description": "Information about the agent the assessment is for.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ListAssessmentsResponse": { - "description": "The response of listing assessments.", - "type": "object", - "properties": { - "assessments": { - "description": "The assessments that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1PublishAssessmentRequest": { - "description": "The message to publish an assessment. Draft and appealed assessments can be\npublished. Publishing simply changes the state of the assessment to\npublished, allowing the console and authorized views to filter on the state.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1AppealAssessmentRequest": { - "description": "The message to appeal an assessment.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest": { - "description": "The message to finalize an assessment. Finalizing makes an assessment and\nits notes immutable.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1Note": { - "description": "The conversation assessment note resource.", - "type": "object", - "properties": { - "conversationTurnNote": { - "description": "The note is associated with a conversation turn.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1NoteConversationTurnNote" - }] - }, - "qaQuestionNote": { - "description": "The note is associated with a QA question in one of the conversation's\nscorecard results.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1NoteQaQuestionNote" - }] - }, - "assessmentNote": { - "description": "The note is associated to the entire parent assessment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1NoteAssessmentNote" - }] - }, - "name": { - "description": "Identifier. The resource name of the note.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", - "x-google-identifier": true, - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which the note was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The time at which the note was last updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "noteCreator": { - "description": "Output only. The user that created the note.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UserInfo" - }] - }, - "content": { - "description": "The note content.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1NoteConversationTurnNote": { - "description": "A note about a conversation turn.", - "type": "object", - "properties": { - "turnIndex": { - "description": "The conversation turn index that the note is associated with.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1NoteQaQuestionNote": { - "description": "A note about a QA question.", - "type": "object", - "properties": { - "qaQuestion": { - "description": "The question resource that the note is associated with.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1NoteAssessmentNote": { - "description": "A note about the entire parent assessment.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1UserInfo": { - "description": "Information about a user.", - "type": "object", - "properties": { - "username": { - "description": "The user's username.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListNotesResponse": { - "description": "The response of listing notes.", - "type": "object", - "properties": { - "notes": { - "description": "The notes that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Note" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1Dashboard": { - "description": "Configurable dashboard", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Dashboard resource name.\nFormat:\nprojects/{project}/locations/{location}/dashboards/{dashboard}", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "User provided display name of the dashboard.", - "type": "string" - }, - "rootContainer": { - "description": "The dashboard's root widget container. We want to display the dashboard\nlayout in a tree-like structure, where the root container contains other\nwidgets (containers or charts) as children.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Container" - }] - }, - "description": { - "description": "Dashboard description", - "type": "string" - }, - "createTime": { - "description": "Output only. Dashboard creation time.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. Dashboard last update time.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "filter": { - "description": "Filter applied to all charts in the dashboard.\nShould support scope later.", - "type": "string" - }, - "dateRangeConfig": { - "description": "Date range config applied to all charts in the dashboard.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DateRangeConfig" - }] - }, - "readOnly": { - "description": "Output only. Whether the dashboard is read-only. All predefined dashboards are\nread-only and cannot be modified by the user.", - "readOnly": true, - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1Container": { - "description": "Configurable dashboard's container. Container can contain multiple widgets.", - "type": "object", - "properties": { - "displayName": { - "description": "User provided display name of the Container.", - "type": "string" - }, - "widgets": { - "description": "Widgets in the Container.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Widget" - } - }, - "description": { - "description": "Container description", - "type": "string" - }, - "filter": { - "description": "Filter applied to all charts in the container.\nShould support scope later.", - "type": "string" - }, - "width": { - "description": "The width of the container in grid units.", - "type": "integer", - "format": "int32" - }, - "height": { - "description": "The height of the container in grid units.", - "type": "integer", - "format": "int32" - }, - "containerId": { - "description": "Output only. Unique ID for the container.", - "readOnly": true, - "type": "string" - }, - "dateRangeConfig": { - "description": "Date range config applied to all charts in the container.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DateRangeConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1Widget": { - "description": "Represents a dashboard element, could be a nested Container or Chart.", - "type": "object", - "properties": { - "container": { - "description": "A container widget.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Container" - }] - }, - "chart": { - "description": "A chart widget.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" - }] - }, - "chartReference": { - "description": "A reference to a chart widget.\nFormat:\nprojects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", - "type": "string" - }, - "filter": { - "description": "Filter applied to all charts in the container.\nShould support scope later.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1Chart": { - "description": "Configurable dashboard's widget that displays data as a chart.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Chart resource name.\nFormat:\nprojects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "User provided display name of the chart.", - "type": "string" - }, - "description": { - "description": "Chart description", - "type": "string" - }, - "chartVisualizationType": { - "description": "Chart visualization type.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ChartVisualizationType" - }] - }, - "width": { - "description": "The width of the chart in grid units.", - "type": "integer", - "format": "int32" - }, - "height": { - "description": "The height of the chart in grid units.", - "type": "integer", - "format": "int32" - }, - "createTime": { - "description": "Output only. Chart create time.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. Chart last update time.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "chartType": { - "description": "Output only. Chart type.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified chart type.", - "Pre-defined chart type.", - "Configurable chart type." - ], - "enum": [ - "CHART_TYPE_UNSPECIFIED", - "SYSTEM_DEFINED", - "USER_DEFINED" - ] - }, - "dataSource": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ChartDataSource" - }, - "filter": { - "description": "Filter applied to all charts in the container.\nShould support scope later.", - "type": "string" - }, - "dateRangeConfig": { - "description": "Date range config applied to the chart.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DateRangeConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1ChartDataSource": { - "description": "The request data for visualizing the dataset in the chart.", - "type": "object", - "properties": { - "generativeInsights": { - "description": "Use natural language query to generate the chart.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsights" - }] - }, - "queryMetrics": { - "description": "Use the existing QueryMetrics to generate the chart.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetrics" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsights": { - "description": "Request that use natural language query to generate the chart.", - "type": "object", - "properties": { - "request": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL." - } - }, - "chartSpec": { - "description": "Chart spec for the chart.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "sqlQuery": { - "description": "SQL query used to generate the chart.", - "type": "string" - }, - "sqlComparisonKey": { - "description": "Optional. For charts with comparison, this key will determine the metric that will be\ncompared between the current and another dataset.", - "type": "string" - }, - "chartConversations": { - "description": "Output only. The chart conversations used to generate the chart.", - "readOnly": true, - "deprecated": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversation" - } - }, - "chartCheckpoint": { - "description": "The chart checkpoint used to generate the chart.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartCheckpoint" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversation": { - "description": "The conversation used to generate the chart.", - "type": "object", - "properties": { - "conversationId": { - "description": "The conversation id of the chart.", - "type": "string" - }, - "createTime": { - "description": "The create time of the conversation.", - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "The update time of the conversation.", - "type": "string", - "format": "date-time" - }, - "messages": { - "description": "Ordered list of messages, including user inputs and system responses.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessage" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessage": { - "description": "The message in the conversation.", - "type": "object", - "properties": { - "userMessage": { - "description": "A message from the user that is interacting with the system.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageUserMessage" - }] - }, - "systemMessage": { - "description": "A message from the system in response to the user.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessage" - }] - }, - "messageId": { - "description": "The message id of the message.", - "type": "string" - }, - "createTime": { - "description": "For user messages, this is the time at which the system received the\nmessage. For system messages, this is the time at which the system\ngenerated the message.", - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageUserMessage": { - "description": "The user message.", - "type": "object", - "properties": { - "text": { - "description": "A message from the user that is interacting with the system.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessage": { - "description": "A message from the system in response to the user. This message can\nalso be a message from the user as historical context for multiturn\nconversations with the system.", - "type": "object", - "properties": { - "textOutput": { - "description": "A direct natural language response to the user message.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessageTextOutput" - }] - }, - "generatedSqlQuery": { - "description": "Raw SQL from LLM, before templatization", - "type": "string" - }, - "chartSpec": { - "description": "Chart spec from LLM", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessageTextOutput": { - "description": "A text output message from the system.", - "type": "object", - "properties": { - "texts": { - "description": "The parts of the message.", - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "description": "The type of the text message.", - "type": "string", - "x-google-enum-descriptions": [ - "The default text type.", - "The text is a thinking plan generated by the thinking tool.", - "The text is a final response to the user question.", - "The text is an informational message about the agent's\nprogress, such as a tool being invoked. This is distinct from\nthe agent's internal thought process (`THOUGHT`) and the final\nanswer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the\nagent's actions." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "THOUGHT", - "FINAL_RESPONSE", - "PROGRESS" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartCheckpoint": { - "description": "The current chart checkpoint state.", - "type": "object", - "properties": { - "sessionId": { - "description": "The session id of the chart.", - "type": "string" - }, - "revisionId": { - "description": "The revision id of the chart.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1QueryMetrics": { - "description": "Request data that use the existing QueryMetrics.", - "type": "object", - "properties": { - "request": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL." - } - } - } - }, - "GoogleCloudContactcenterinsightsV1DateRangeConfig": { - "description": "Date range configuration for dashboard charts.", - "type": "object", - "properties": { - "relativeDateRange": { - "description": "A relative date range.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DateRangeConfigRelativeDateRange" - }] - }, - "absoluteDateRange": { - "description": "An absolute date range.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryInterval" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1DateRangeConfigRelativeDateRange": { - "description": "Relative date range configuration.", - "type": "object", - "properties": { - "quantity": { - "description": "Required. The quantity of units in the past.", - "type": "string", - "format": "int64" - }, - "unit": { - "description": "Required. The unit of time.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Day.", - "Week.", - "Month.", - "Quarter.", - "Year." - ], - "enum": [ - "TIME_UNIT_UNSPECIFIED", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR" - ] - } - }, - "required": [ - "quantity", - "unit" - ] - }, - "GoogleCloudContactcenterinsightsV1ListDashboardsResponse": { - "description": "The response of listing dashboards.", - "type": "object", - "properties": { - "dashboards": { - "description": "The dashboards under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Dashboard" - } - }, - "nextPageToken": { - "description": "The value returned by the last `ListDashboardsResponse`. This value\nindicates that this is a continuation of a prior `ListDashboards` call and\nthat the system should return the next page of data.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListChartsResponse": { - "description": "The response of listing charts.", - "type": "object", - "properties": { - "charts": { - "description": "The charts under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Chart" - } - }, - "nextPageToken": { - "description": "The value returned by the last `ListChartsResponse`. This value\nindicates that this is a continuation of a prior `ListCharts` call and\nthat the system should return the next page of data.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListDiscoveryWorkspacesResponse": { - "description": "The response of listing discovery workspaces.", - "type": "object", - "properties": { - "discoveryWorkspaces": { - "description": "The discovery workspaces under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspace" - } - }, - "nextPageToken": { - "description": "The value returned by the last `ListDiscoveryWorkspacesResponse`. This\nvalue indicates that this is a continuation of a prior\n`ListDiscoveryWorkspaces` call and that the system should return the next\npage of data.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryWorkspace": { - "description": "The discovery workspace resource. One discovery workspace can only have one\ndiscovery tree. It stores pointers to the root of discovery tree and snapshot\nof the tree used for analysis.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Resource name of the discovery workspace.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}", - "x-google-identifier": true, - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this discovery workspace was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the discovery workspace was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "rootDiscovery": { - "description": "Output only. The id for the discovery at the root of the discovery workspace.", - "readOnly": true, - "type": "string" - }, - "deploymentSpec": { - "description": "Output only. The configuration used for running analysis with a snapshot of the\ndiscovery workspace. When this field is set, the discovery workspace can be\nused for live inference.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspaceDeploymentSpec" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryWorkspaceDeploymentSpec": { - "description": "Specifies the discovery subtree chosen for running analysis and the\nQaScorecard/QaQuestions resources backing the analysis.", - "type": "object", - "properties": { - "qaScorecardRevision": { - "description": "The QA scorecard revision to use for live inference. Format:\nprojects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}", - "type": "string" - }, - "discoveryRevisionMappings": { - "description": "The mappings of discovery revisions to QA questions.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspaceDeploymentSpecDiscoveryRevisionMapping" - } - }, - "rediscoveryConfig": { - "description": "Optional. Configuration specifying how rediscovery should be run.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1RediscoveryConfig" - }] - }, - "analysisRule": { - "description": "Optional. The analysis rule to be applied to the conversations selected under\nthis deployment. Format:\nprojects/{project}/locations/{location}/analysisRules/{analysis_rule}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryWorkspaceDeploymentSpecDiscoveryRevisionMapping": { - "description": "The mapping of discovery revisions to QA questions.", - "type": "object", - "properties": { - "discoveryRevision": { - "description": "A discovery revision in the live tree. Format:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discoveryWorkspace}/discoveries/{discovery}/revisions/{revision}", - "type": "string" - }, - "qaQuestion": { - "description": "The QaQuestion resource name corresponding to the discovery revision in\nthe live tree. Format:\nprojects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}", - "type": "string" - }, - "questionAbbreviation": { - "description": "The display name of the question. Used to reference the discovery goal\nof the discovery revision in the UI.", - "type": "string" - }, - "answerChoices": { - "description": "The answer choices for the question, corresponding to the discovery\ndiscovery results of the revision.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1RediscoveryConfig": { - "description": "Configuration specifying how rediscovery should be run.", - "type": "object", - "properties": { - "rediscoveryFrequency": { - "type": "string", - "x-google-enum-descriptions": [ - "", - "Detect emerging results less frequently than standard. Currently this\nwill configure rediscovery to run quarterly.", - "Detect emerging results on a monthly basis.", - "Detect emerging results more frequently than standard. Currently this\nwill configure rediscovery to run weekly." - ], - "enum": [ - "REDISCOVERY_FREQUENCY_UNSPECIFIED", - "LESS_SENSITIVE", - "STANDARD", - "MORE_SENSITIVE" - ] - }, - "disableRediscoveryAutoDeployment": { - "description": "If true, the rediscovery tree will not be automatically deployed. Defaults\nto false. i.e. the rediscovery tree will be automatically deployed.", - "type": "boolean" - }, - "scheduleId": { - "description": "The schedule id for the rediscovery pipeline. When not provided, a new\nschedule will be created. Otherwise, the schedule will be updated.\nThe primary key for the PipelineSchedules table.", - "type": "string", - "format": "int64" - } - } - }, - "GoogleCloudContactcenterinsightsV1FetchDiscoveryWorkspaceTreeResponse": { - "description": "The response of fetching a discovery workspace tree.", - "type": "object", - "properties": { - "parent": { - "description": "The workspace parent of the tree.", - "type": "string" - }, - "discoveryRevisions": { - "description": "The tree of discoveries at specific revisions.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" - } - }, - "otherDiscoveryRevisions": { - "description": "A list of the other revisions of each Discovery in the tree. Defaults to\nthe latest 200 revisions of each Discovery.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" - } - }, - "discoveryResults": { - "description": "A list of results in the tree.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryRevision": { - "description": "The discovery result revision resource. A revision is created when client\nspecifically requests via calling CreateDiscoveryRevision API. This\nusually happens when client is finalizing the feedbacks to previous revision.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Resource name of the DiscoveryRevision.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", - "x-google-identifier": true, - "type": "string" - }, - "snapshot": { - "description": "Output only. The snapshot of the discovery result at this revision.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" - }] - }, - "createTime": { - "description": "Output only. The time at which this discovery result revision was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the discovery result revision was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "feedback": { - "description": "The feedback for the discovery result under source_revision.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevisionFeedback" - }] - }, - "inputData": { - "description": "The input data to be used to create this revision.\nWhen not provided, the input data from the source revision will be used.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryInputDataConfig" - }] - }, - "sourceRevision": { - "description": "Immutable. The source of this discovery revision. i.e. this discovery revision is\nthe result of applying changes on top of source_revision. Format:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", - "x-google-immutable": true, - "type": "string" - }, - "state": { - "description": "Output only. The state of the discovery.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "This value is unused.", - "The discovery is running. There may be discovery results generated but\nthe final list or distributions are not finalized.", - "The discovery is completed. The final list or distributions are\nfinalized." - ], - "enum": [ - "STATE_UNSPECIFIED", - "RUNNING", - "COMPLETED" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1Discovery": { - "description": "The discovery resource.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Resource name of the discovery.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "User provided display name of the discovery. Modifying this will not change\nthe discovery result or behaviour.", - "type": "string" - }, - "languageCode": { - "description": "Immutable. The language code of the discovery results. When drill_down_parent is\nspecified, this field is inherited from the parent discovery.\nWhen neither language_code nor drill_down_parent is specified, defaults to\nen.", - "x-google-immutable": true, - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this discovery was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the discovery was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "drillDownParent": { - "description": "Name of the discovery discovery result this discovery is a drill down of.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}\nIf empty, this discovery is a top level discovery.\nServer enforces at discovery resource creation time that this resource\nreference creates a tree structure and there's no cycle in the resource\nhierarchy. This field should not be updated once the discovery is created.", - "type": "string" - }, - "discoveryGoal": { - "description": "Required. Immutable. User specified goal for the discovery. This field is immutable once the\ndiscovery is created.", - "x-google-immutable": true, - "type": "string" - }, - "inputData": { - "description": "Specs for the input data used for this discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryInputDataConfig" - }] - }, - "customTaxonomy": { - "description": "User provided taxonomy to guide the discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryCustomTaxonomy" - }] - }, - "advancedOptions": { - "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryDiscoveryAdvancedOptions" - }] - } - }, - "required": [ - "discoveryGoal" - ] - }, - "GoogleCloudContactcenterinsightsV1DiscoveryInputDataConfig": { - "description": "Configuration for the input data used for discovery.", - "type": "object", - "properties": { - "conversationFilter": { - "description": "Optional. The filter for querying conversations.", - "type": "string" - }, - "maxSampleSize": { - "description": "Optional. Maximum number of conversations to sample.", - "type": "string", - "format": "int64" - }, - "dataset": { - "description": "Optional. The resource name of the Dataset to scope the discovery to.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}\nIf provided, discovery will only run on conversations within this dataset.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryCustomTaxonomy": { - "description": "User provided taxonomy to guide the discovery.", - "type": "object", - "properties": { - "taxonomyEntries": { - "description": "Entries in the custom taxonomy.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryCustomTaxonomyTaxonomyEntry" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryCustomTaxonomyTaxonomyEntry": { - "description": "A single entry in the custom taxonomy.", - "type": "object", - "properties": { - "displayName": { - "description": "Name of the taxonomy entry.", - "type": "string" - }, - "description": { - "description": "Description of the taxonomy entry.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryDiscoveryAdvancedOptions": { - "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", - "type": "object", - "properties": { - "conversationDataOptions": { - "description": "Options for configuring what metadata goes into conversation\ntranscript.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataOptions" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryRevisionFeedback": { - "description": "Feedback for the discovery results under previous_revision.", - "type": "object", - "properties": { - "resultFeedback": { - "description": "DiscoveryResult level feedback.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevisionFeedbackResultFeedback" - } - }, - "revisionFeedback": { - "description": "DiscoveryRevision level feedback.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryRevisionFeedbackResultFeedback": { - "description": "Content of a DiscoveryResult level feedback. i.e. Feedback applied\nspecifically to a DiscoveryResult.", - "type": "object", - "properties": { - "result": { - "description": "Resource name of the discovery result this feedback is for.\nThe parent discovery revision of the result must be the same as what's\nspecified in the source_revision field.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}", - "type": "string" - }, - "feedback": { - "description": "The feedback for the discovery result.", - "type": "string" - }, - "userAction": { - "description": "The user action for the entry feedback.", - "type": "string", - "x-google-enum-descriptions": [ - "Default value.", - "The user wants to remove the discovery result.", - "The user provides an exact replacement for the display name.", - "The user provides an exact replacement for the description.", - "The user provides comments/instructions on how to modify the display\nname.", - "The user provides comments/instructions on how to modify the\ndescription." - ], - "enum": [ - "USER_ACTION_UNSPECIFIED", - "REMOVE", - "SET_DISPLAY_NAME", - "SET_DESCRIPTION", - "SUGGEST_DISPLAY_NAME_EDIT", - "SUGGEST_DESCRIPTION_EDIT" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryResult": { - "description": "The discovery result resource. This resource is read only.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Resource name of the DiscoveryResult.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "Output only. Display name of the discovery result.", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Output only. Description of the discovery result.", - "readOnly": true, - "type": "string" - }, - "relativeConversationCount": { - "description": "Number of conversations assigned to this discovery result for the purpose\nof calculating conversation volume distribution. The conversation volume of\neach discovery result doesn't add up to the total conversation volume of\nthe discovery.", - "type": "string", - "format": "int64" - }, - "drillDownChildren": { - "description": "Output only. The Discovery resource names that's a drill down of this discovery result.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "source": { - "description": "Output only. The source of the discovery result.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "The source is unspecified.", - "The discovery result is emerged from data that's not already covered by\nby provided taxonomy.", - "The discovery result is from provided customer taxonomy." - ], - "enum": [ - "SOURCE_UNSPECIFIED", - "EMERGED", - "CUSTOMER_PROVIDED" - ] - }, - "exampleConversations": { - "description": "Example conversations assigned to this discovery result.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryResultExampleConversation" - } - }, - "suggestedDrillDownQuestions": { - "description": "Output only. Unordered list. Suggested questions for drill down into this discovery result.\nA maximum of 5 suggestions can be returned. Each suggestion is limited to\n128 characters.", - "readOnly": true, - "x-google-unordered-list": true, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryResultExampleConversation": { - "description": "An example conversation assigned to this discovery result.", - "type": "object", - "properties": { - "name": { - "description": "The conversation name.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}", - "type": "string" - }, - "summary": { - "description": "The summary of the conversation.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DeployDiscoveryWorkspaceRequest": { - "description": "The request to deploy a discovery workspace.", - "type": "object", - "properties": { - "displayName": { - "description": "Required. The display name to set for the discovery workspace deployment and the\nassociated QaScorecard.", - "type": "string" - }, - "discoveryRevisions": { - "description": "Required. The discovery revisions to deploy.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "displayName", - "discoveryRevisions" - ] - }, - "GoogleCloudContactcenterinsightsV1DeployDiscoveryWorkspaceResponse": { - "description": "The response of deploying a discovery workspace.", - "type": "object", - "properties": { - "discoveryWorkspace": { - "description": "The deployed discovery workspace.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspace" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1UndeployDiscoveryWorkspaceRequest": { - "description": "The request to undeploy a discovery workspace.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1UndeployDiscoveryWorkspaceResponse": { - "description": "The response of undeploying a discovery workspace.", - "type": "object", - "properties": { - "discoveryWorkspace": { - "description": "The undeployed discovery workspace.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryWorkspace" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1GenerateDiscoveryRequest": { - "description": "The request to generate a discovery.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent of generated discovery request.\nWhen it's a Location resource, this operation creates a root discovery and\nits discovery workspace will be automatically created.\nWhen it's a discovery workspace resource, this operation creates a drill\ndown discovery. discovery.drill_down_parent should have the same discovery\nworkspace as the parent.", - "type": "string" - }, - "discovery": { - "description": "Required. Specifies the discovery to generate. The name field of the discovery will\nbe ignored.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" - }] - } - }, - "required": [ - "parent", - "discovery" - ] - }, - "GoogleCloudContactcenterinsightsV1GenerateDiscoveryResponse": { - "description": "The response of generating a discovery.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1GenerateDiscoveryMetadata": { - "description": "Metadata for GenerateDiscovery operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The request to create the discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryRequest" - }] - }, - "progress": { - "description": "The progress of the discovery creation operation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryProgress" - }] - }, - "resultRevision": { - "description": "Output only. The DiscoveryRevision resource name that contains the result entries\ngenerated in this discovery.", - "readOnly": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1DiscoveryProgress": { - "description": "Progress information for a discovery.", - "type": "object", - "properties": { - "progressState": { - "description": "Output only. The state of the discovery creation or refinement.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "Default value. This value is unused.", - "The input data is being preprocessed.", - "Summarizing the conversations to extract features.", - "Generating the results based on the features.", - "Calculating the distributions for the results.", - "The discovery is being finalized.", - "The GenerateDiscovery operation has completed successfully." - ], - "enum": [ - "PROGRESS_STATE_UNSPECIFIED", - "PREPROCESSING", - "SUMMARIZING", - "GENERATING_RESULTS", - "COMPUTING_DISTRIBUTIONS", - "FINALIZING", - "SUCCEEDED" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1ListDiscoveriesResponse": { - "description": "The response of listing discoveries.", - "type": "object", - "properties": { - "discoveries": { - "description": "The discoveries under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Discovery" - } - }, - "nextPageToken": { - "description": "The value returned by the last `ListDiscoveriesResponse`. This value\nindicates that this is a continuation of a prior `ListDiscoveries` call and\nthat the system should return the next page of data.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionMetadata": { - "description": "Metadata for a discovery revision creation operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The request to create the discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionRequest" - }] - }, - "progress": { - "description": "The progress of the discovery creation operation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryProgress" - }] - }, - "resultRevision": { - "description": "Output only. The newly created discovery revision resource name.", - "readOnly": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionRequest": { - "description": "The request to create a discovery revision.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the discovery.", - "type": "string" - }, - "discoveryRevision": { - "description": "Required. The discovery revision to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" - }] - }, - "discoveryRevisionId": { - "description": "Optional. The ID of the discovery revision to create.", - "type": "string" - } - }, - "required": [ - "parent", - "discoveryRevision" - ] - }, - "GoogleCloudContactcenterinsightsV1ListDiscoveryRevisionsResponse": { - "description": "Response of listing discovery revisions.", - "type": "object", - "properties": { - "discoveryRevisions": { - "description": "The discovery revisions under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" - } - }, - "nextPageToken": { - "description": "The value returned by the last `ListDiscoveryRevisionsResponse`. This\nvalue indicates that this is a continuation of a prior\n`ListDiscoveryRevisions` call and that the system should return the next\npage of data.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1ListDiscoveryResultsResponse": { - "description": "Response of listing discovery results.", - "type": "object", - "properties": { - "discoveryResults": { - "description": "The discovery results under the parent.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryResult" - } - }, - "nextPageToken": { - "description": "The value returned by the last `ListDiscoveryResultsResponse`. This\nvalue indicates that this is a continuation of a prior\n`ListDiscoveryResults` call and that the system should return the\nnext page of data.", - "type": "string" - } - } - }, - "GoogleIamV1SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "type": "object", - "properties": { - "policy": { - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Google Cloud services (such as Projects)\nmight reject them.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleIamV1Policy" - }] - }, - "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\n\n`paths: \"bindings, etag\"`", - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - } - }, - "GoogleIamV1Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members`, or principals, to a single `role`. Principals can be user\naccounts, service accounts, Google groups, and domains (such as G Suite). A\n`role` is a named list of permissions; each `role` can be an IAM predefined\nrole or a user-created custom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n```\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n```\n\n**YAML example:**\n\n```\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n etag: BwWWja0YfJA=\n version: 3\n```\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", - "type": "object", - "properties": { - "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "type": "integer", - "format": "int32" - }, - "bindings": { - "description": "Associates a list of `members`, or principals, with a `role`. Optionally,\nmay specify a `condition` that determines how and when the `bindings` are\napplied. Each of the `bindings` must contain at least one principal.\n\nThe `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250\nof these principals can be Google groups. Each occurrence of a principal\ncounts towards these limits. For example, if the `bindings` grant 50\ndifferent roles to `user:alice@example.com`, and not to any other\nprincipal, then you can add another 1,450 principals to the `bindings` in\nthe `Policy`.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleIamV1Binding" - } - }, - "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleIamV1AuditConfig" - } - }, - "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.", - "type": "string", - "format": "byte" - } - } - }, - "GoogleIamV1Binding": { - "description": "Associates `members`, or principals, with a `role`.", - "type": "object", - "properties": { - "role": { - "description": "Role that is assigned to the list of `members`, or principals.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\n\nFor an overview of the IAM roles and permissions, see the\n[IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For\na list of the available pre-defined roles, see\n[here](https://cloud.google.com/iam/docs/understanding-roles).", - "type": "string" - }, - "members": { - "description": "Specifies the principals requesting access for a Google Cloud resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n Does not include identities that come from external identity providers\n (IdPs) through identity federation.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a Google\n service account. For example,\n `my-other-app@appspot.gserviceaccount.com`.\n\n* `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An\n identifier for a\n [Kubernetes service\n account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).\n For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n\n\n\n* `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:\n A single identity in a workforce identity pool.\n\n* `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:\n All workforce identities in a group.\n\n* `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:\n All workforce identities with a specific attribute value.\n\n* `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:\n All identities in a workforce identity pool.\n\n* `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:\n A single identity in a workload identity pool.\n\n* `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:\n A workload identity pool group.\n\n* `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:\n All identities in a workload identity pool with a certain attribute.\n\n* `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:\n All identities in a workload identity pool.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n* `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:\n Deleted single identity in a workforce identity pool. For example,\n `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", - "type": "array", - "items": { - "type": "string" - } - }, - "condition": { - "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the principals in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "allOf": [{ - "$ref": "#/components/schemas/GoogleTypeExpr" - }] - } - } - }, - "GoogleTypeExpr": { - "description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.", - "type": "object", - "properties": { - "expression": { - "description": "Textual representation of an expression in Common Expression Language\nsyntax.", - "type": "string" - }, - "title": { - "description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", - "type": "string" - }, - "description": { - "description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", - "type": "string" - }, - "location": { - "description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.", - "type": "string" - } - } - }, - "GoogleIamV1AuditConfig": { - "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\",\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\"\n },\n {\n \"log_type\": \"ADMIN_READ\"\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\",\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\"\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts `jose@example.com` from DATA_READ logging, and\n`aliya@example.com` from DATA_WRITE logging.", - "type": "object", - "properties": { - "service": { - "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", - "type": "string" - }, - "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleIamV1AuditLogConfig" - } - } - } - }, - "GoogleIamV1AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\"\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.", - "type": "object", - "properties": { - "logType": { - "description": "The log type that this config enables.", - "type": "string", - "x-google-enum-descriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" - ], - "enum": [ - "LOG_TYPE_UNSPECIFIED", - "ADMIN_READ", - "DATA_WRITE", - "DATA_READ" - ] - }, - "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleIamV1TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as `*` or `storage.*`) are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleIamV1TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata": { - "description": "The metadata for a bulk analyze conversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for bulk analyze.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" - }] - }, - "completedAnalysesCount": { - "description": "The number of requested analyses that have completed successfully so far.", - "type": "integer", - "format": "int32" - }, - "failedAnalysesCount": { - "description": "The number of requested analyses that have failed so far.", - "type": "integer", - "format": "int32" - }, - "totalRequestedAnalysesCount": { - "description": "Total number of analyses requested. Computed by the number of conversations\nreturned by `filter` multiplied by `analysis_percentage` in the request.", - "type": "integer", - "format": "int32" - }, - "partialErrors": { - "description": "Output only. Partial errors during bulk analyze operation that might cause the operation\noutput to be incomplete.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest": { - "description": "The request to analyze conversations in bulk.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource to create analyses in.", - "type": "string" - }, - "filter": { - "description": "Required. Filter used to select the subset of conversations to analyze.", - "type": "string" - }, - "analysisPercentage": { - "description": "Required. Percentage of selected conversation to analyze, between\n[0, 100].", - "type": "number", - "format": "float" - }, - "annotatorSelector": { - "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" - }] - } - }, - "required": [ - "parent", - "filter", - "analysisPercentage" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector": { - "description": "Selector of all available annotators and phrase matchers to run.", - "type": "object", - "properties": { - "runInterruptionAnnotator": { - "description": "Whether to run the interruption annotator.", - "type": "boolean" - }, - "runSilenceAnnotator": { - "description": "Whether to run the silence annotator.", - "type": "boolean" - }, - "runPhraseMatcherAnnotator": { - "description": "Whether to run the active phrase matcher annotator(s).", - "type": "boolean" - }, - "phraseMatchers": { - "description": "The list of phrase matchers to run. If not provided, all active phrase\nmatchers will be used. If inactive phrase matchers are provided, they will\nnot be used. Phrase matchers will be run only if\nrun_phrase_matcher_annotator is set to true. Format:\nprojects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", - "type": "array", - "items": { - "type": "string" - } - }, - "runSentimentAnnotator": { - "description": "Whether to run the sentiment annotator.", - "type": "boolean" - }, - "runEntityAnnotator": { - "description": "Whether to run the entity annotator.", - "type": "boolean" - }, - "runIntentAnnotator": { - "description": "Whether to run the intent annotator.", - "type": "boolean" - }, - "runIssueModelAnnotator": { - "description": "Whether to run the issue model annotator. A model should have already been\ndeployed for this to take effect.", - "type": "boolean" - }, - "issueModels": { - "description": "The issue model to run. If not provided, the most recently deployed topic\nmodel will be used. The provided issue model will only be used for\ninference if the issue model is deployed and if run_issue_model_annotator\nis set to true. If more than one issue model is provided, only the first\nprovided issue model will be used for inference.", - "type": "array", - "items": { - "type": "string" - } - }, - "runSummarizationAnnotator": { - "description": "Whether to run the summarization annotator.", - "type": "boolean" - }, - "summarizationConfig": { - "description": "Configuration for the summarization annotator.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig" - }] - }, - "runQaAnnotator": { - "description": "Whether to run the QA annotator.", - "type": "boolean" - }, - "qaConfig": { - "description": "Configuration for the QA annotator.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig": { - "description": "Configuration for summarization.", - "type": "object", - "properties": { - "conversationProfile": { - "description": "Resource name of the Dialogflow conversation profile.\nFormat:\nprojects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", - "type": "string" - }, - "summarizationModel": { - "description": "Default summarization model to be used.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified summarization model.", - "The CCAI baseline model. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead.", - "The CCAI baseline model, V2.0. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead." - ], - "x-google-enum-deprecated": [ - false, - true, - true - ], - "enum": [ - "SUMMARIZATION_MODEL_UNSPECIFIED", - "BASELINE_MODEL", - "BASELINE_MODEL_V2_0" - ] - }, - "generator": { - "description": "The resource name of the existing created generator. Format:\nprojects//locations//generators/", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig": { - "description": "Configuration for the QA feature.", - "type": "object", - "properties": { - "scorecardList": { - "description": "A manual list of scorecards to score.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList": { - "description": "Container for a list of scorecards.", - "type": "object", - "properties": { - "qaScorecardRevisions": { - "description": "List of QaScorecardRevisions.", - "type": "array", - "items": { - "type": "string" - } - }, - "predefinedQaScorecards": { - "description": "List of predefined scorecards.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PredefinedQaScorecardType" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse": { - "description": "The response for a bulk analyze conversations operation.", - "type": "object", - "properties": { - "successfulAnalysisCount": { - "description": "Count of successful analyses.", - "type": "integer", - "format": "int32" - }, - "failedAnalysisCount": { - "description": "Count of failed analyses.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata": { - "description": "The metadata for a bulk delete conversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for bulk delete.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during bulk delete conversations operation that might cause\nthe operation output to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest": { - "description": "The request to delete conversations in bulk.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource to delete conversations from.\nFormat:\nprojects/{project}/locations/{location}", - "type": "string" - }, - "filter": { - "description": "Filter used to select the subset of conversations to delete.", - "type": "string" - }, - "maxDeleteCount": { - "description": "Maximum number of conversations to delete.", - "type": "integer", - "format": "int32" - }, - "force": { - "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", - "type": "boolean" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse": { - "description": "The response for a bulk delete conversations operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata": { - "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", - "type": "object", - "properties": { - "request": { - "description": "Output only. The original request for delete.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during deletion operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest": { - "description": "Request for the BulkDeleteFeedbackLabels endpoint.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource for new feedback labels.", - "type": "string" - }, - "filter": { - "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", - "type": "string" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse": { - "description": "Response for the BulkDeleteFeedbackLabels endpoint.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkUpdateQaQuestionsMetadata": { - "description": "The metadata for bulk updating QaQuestions.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkUpdateQaQuestionsRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkUpdateQaQuestionsRequest": { - "description": "The request for bulk updating QaQuestions.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource for the bulk update job instance.", - "type": "string" - }, - "qaQuestions": { - "description": "Required. All the questions to be updated", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestion" - } - }, - "updateMask": { - "description": "Optional. All questions will be updated with the same mask.\nAn empty mask will means updating all updatable fields.", - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - }, - "required": [ - "parent", - "qaQuestions" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1QaQuestion": { - "description": "A single question to be scored by the Insights QA feature.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The resource name of the question.\nFormat:\nprojects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", - "x-google-identifier": true, - "type": "string" - }, - "abbreviation": { - "description": "Short, descriptive string, used in the UI where it's not practical\nto display the full question body. E.g., \"Greeting\".", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this question was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the question was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "questionType": { - "description": "The type of question.", - "type": "string", - "x-google-enum-descriptions": [ - "The type of the question is unspecified.", - "The default question type. The question is fully customizable by the\nuser.", - "The question type is using a predefined model provided by CCAI\nteams. Users are not allowed to edit the question_body, answer_choices,\nupload feedback labels for the question nor fine-tune the question.\nHowever, users may edit other fields like question tags, question order,\netc." - ], - "enum": [ - "QA_QUESTION_TYPE_UNSPECIFIED", - "CUSTOMIZABLE", - "PREDEFINED" - ] - }, - "questionMedium": { - "description": "The medium of the question.", - "type": "string", - "x-google-enum-descriptions": [ - "The medium of the question is unspecified.", - "The question is for chat conversations and will expect a chat transcript\nto be present before scoring.", - "The question is for voice conversations and does NOT expect any chat\ntranscripts to be present before scoring." - ], - "enum": [ - "QA_QUESTION_MEDIUM_UNSPECIFIED", - "CHAT", - "VOICE" - ] - }, - "qaQuestionDataOptions": { - "description": "Options for configuring the data used to generate the QA question.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions" - }] - }, - "predefinedQuestionConfig": { - "description": "The configuration of the predefined question. This field will only be set\nif the Question Type is predefined.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig" - }] - }, - "questionBody": { - "description": "Question text. E.g., \"Did the agent greet the customer?\"", - "type": "string" - }, - "answerInstructions": { - "description": "Instructions describing how to determine the answer.", - "type": "string" - }, - "answerChoices": { - "description": "A list of valid answers to the question, which the LLM must choose from.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice" - } - }, - "tags": { - "description": "Questions are tagged for categorization and scoring. Tags can either be:\n- Default Tags: These are predefined categories. They are identified by\ntheir string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\").\n- Custom Tags: These are user-defined categories. They are identified by\ntheir full resource name (e.g.,\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}).\nBoth default and custom tags are used to group questions and to influence\nthe scoring of each question.", - "type": "array", - "items": { - "type": "string" - } - }, - "order": { - "description": "Defines the order of the question within its parent scorecard revision.", - "type": "integer", - "format": "int32" - }, - "metrics": { - "description": "Metrics of the underlying tuned LLM over a holdout/test set while fine\ntuning the underlying LLM for the given question. This field will only be\npopulated if and only if the question is part of a scorecard revision that\nhas been tuned.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics" - }] - }, - "tuningMetadata": { - "description": "Metadata about the tuning operation for the question.This field will only\nbe populated if and only if the question is part of a scorecard revision\nthat has been tuned.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions": { - "description": "Options for configuring the data used to generate the QA question.", - "type": "object", - "properties": { - "conversationDataOptions": { - "description": "Options for configuring the conversation data used to generate the QA\nquestion.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions": { - "description": "Options for configuring what metadata is included in the conversation data\nused in QAI and Discovery Engine.", - "type": "object", - "properties": { - "includeDialogflowInteractionData": { - "description": "Whether to include the per turn Dialogflow interaction data in conversation\ntranscript.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig": { - "description": "Configuration for a predefined question. This field will only be set if the\nQuestion Type is predefined.", - "type": "object", - "properties": { - "type": { - "description": "The type of the predefined question.", - "type": "string", - "x-google-enum-descriptions": [ - "The type of the predefined question is unspecified.", - "A prebuilt classifier classfying the outcome of the conversation.\nFor example, if the customer issue mentioned in a conversation has\nbeen resolved or not.", - "A prebuilt classifier classfying the initiator of the conversation\nescalation. For example, if it was initiated by the customer or the\nagent." - ], - "enum": [ - "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", - "CONVERSATION_OUTCOME", - "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice": { - "description": "Message representing a possible answer to the question.", - "type": "object", - "properties": { - "strValue": { - "description": "String value.", - "type": "string" - }, - "numValue": { - "description": "Numerical value.", - "type": "number", - "format": "double" - }, - "boolValue": { - "description": "Boolean value.", - "type": "boolean" - }, - "naValue": { - "description": "A value of \"Not Applicable (N/A)\". If provided, this field may only\nbe set to `true`. If a question receives this answer, it will be\nexcluded from any score calculations.", - "type": "boolean" - }, - "key": { - "description": "A short string used as an identifier.", - "type": "string" - }, - "score": { - "description": "Numerical score of the answer, used for generating the overall score of\na QaScorecardResult. If the answer uses na_value, this field is unused.", - "type": "number", - "format": "double" - }, - "nextActionConfig": { - "description": "Configuration for the next action to take if this answerChoice is\nselected for this question.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfig": { - "description": "The configuration for the next action. This is used to configure the next\naction to take if an answer choice is selected.", - "type": "object", - "properties": { - "runChildQaQuestionsAction": { - "description": "The list of questions to evaluate next, i.e., child questions.\nRequirements for this action are the following:\n1. The current question and child questions must be in the same\n scorecard and present in the same scorecard revision.\n2. The current question and child questions must not introduce a\n cycle, i.e., Q1 -> [Q2, Q3], then Q2 -> [Q1] should not be\n allowed, where Q1, Q2, and Q3 are questions.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction" - }] - }, - "terminateChildQaQuestionsAction": { - "description": "Terminate any further evaluation of child questions.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction": { - "description": "The configuration for evaluating child questions.", - "type": "object", - "properties": { - "childQaQuestionNames": { - "description": "A list of resource names representing the child questions to evaluate\nnext. The format for each question resource name is:\nprojects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions": { - "description": "Indicates termination.", - "type": "object", - "properties": { - "terminationType": { - "description": "The type of termination to perform.", - "type": "string", - "x-google-enum-descriptions": [ - "The termination type is unspecified.", - "A failed scorecard would mean the overall scorecard score will be\nzeroed out, i.e., the scorecard score will be 0.", - "The overall scorecard score will be calculated based on the\nscores of the questions answered in the chain up until the last\nscored question that was answered. This is the default behavior." - ], - "enum": [ - "TERMINATION_TYPE_UNSPECIFIED", - "TERMINATE_WITH_SCORECARD_FAILURE", - "TERMINATE_WITH_CALCULATED_SCORE" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics": { - "description": "A wrapper representing metrics calculated against a test-set on a LLM that\nwas fine tuned for this question.", - "type": "object", - "properties": { - "accuracy": { - "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the\nmodel gave on the test set.", - "readOnly": true, - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata": { - "description": "Metadata about the tuning operation for the question. Will only be set if a\nscorecard containing this question has been tuned.", - "type": "object", - "properties": { - "totalValidLabelCount": { - "description": "Total number of valid labels provided for the question at the time of\ntuining.", - "type": "string", - "format": "int64" - }, - "datasetValidationWarnings": { - "description": "A list of any applicable data validation warnings about the question's\nfeedback labels.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DatasetValidationWarning" - } - }, - "tuningError": { - "description": "Error status of the tuning operation for the question. Will only be set\nif the tuning operation failed.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1BulkUpdateQaQuestionsResponse": { - "description": "The response for bulk updating QaQuestions.", - "type": "object", - "properties": { - "qaQuestions": { - "description": "The QaQuestions that were updated.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestion" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata": { - "description": "Metadata for a create analysis operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "conversation": { - "description": "Output only. The Conversation that this Analysis Operation belongs to.", - "readOnly": true, - "type": "string" - }, - "annotatorSelector": { - "description": "Output only. The annotator selector used for the analysis (if any).", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1CreateDiscoveryRevisionMetadata": { - "description": "Metadata for a discovery revision creation operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The request to create the discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateDiscoveryRevisionRequest" - }] - }, - "progress": { - "description": "The progress of the discovery creation operation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryProgress" - }] - }, - "resultRevision": { - "description": "Output only. The newly created discovery revision resource name.", - "readOnly": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1CreateDiscoveryRevisionRequest": { - "description": "The request to create a discovery revision.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the discovery.", - "type": "string" - }, - "discoveryRevision": { - "description": "Required. The discovery revision to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevision" - }] - }, - "discoveryRevisionId": { - "description": "Optional. The ID of the discovery revision to create.", - "type": "string" - } - }, - "required": [ - "parent", - "discoveryRevision" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevision": { - "description": "The discovery result revision resource. A revision is created when client\nspecifically requests via calling CreateDiscoveryRevision API. This\nusually happens when client is finalizing the feedbacks to previous revision.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Resource name of the DiscoveryRevision.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", - "x-google-identifier": true, - "type": "string" - }, - "snapshot": { - "description": "Output only. The snapshot of the discovery result at this revision.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Discovery" - }] - }, - "createTime": { - "description": "Output only. The time at which this discovery result revision was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the discovery result revision was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "feedback": { - "description": "The feedback for the discovery result under source_revision.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevisionFeedback" - }] - }, - "inputData": { - "description": "The input data to be used to create this revision.\nWhen not provided, the input data from the source revision will be used.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryInputDataConfig" - }] - }, - "sourceRevision": { - "description": "Immutable. The source of this discovery revision. i.e. this discovery revision is\nthe result of applying changes on top of source_revision. Format:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", - "x-google-immutable": true, - "type": "string" - }, - "state": { - "description": "Output only. The state of the discovery.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "This value is unused.", - "The discovery is running. There may be discovery results generated but\nthe final list or distributions are not finalized.", - "The discovery is completed. The final list or distributions are\nfinalized." - ], - "enum": [ - "STATE_UNSPECIFIED", - "RUNNING", - "COMPLETED" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1Discovery": { - "description": "The discovery resource.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Resource name of the discovery.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "User provided display name of the discovery. Modifying this will not change\nthe discovery result or behaviour.", - "type": "string" - }, - "languageCode": { - "description": "Immutable. The language code of the discovery results. When drill_down_parent is\nspecified, this field is inherited from the parent discovery.\nWhen neither language_code nor drill_down_parent is specified, defaults to\nen.", - "x-google-immutable": true, - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this discovery was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the discovery was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "drillDownParent": { - "description": "Name of the discovery discovery result this discovery is a drill down of.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}\nIf empty, this discovery is a top level discovery.\nServer enforces at discovery resource creation time that this resource\nreference creates a tree structure and there's no cycle in the resource\nhierarchy. This field should not be updated once the discovery is created.", - "type": "string" - }, - "discoveryGoal": { - "description": "Required. Immutable. User specified goal for the discovery. This field is immutable once the\ndiscovery is created.", - "x-google-immutable": true, - "type": "string" - }, - "inputData": { - "description": "Specs for the input data used for this discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryInputDataConfig" - }] - }, - "customTaxonomy": { - "description": "User provided taxonomy to guide the discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryCustomTaxonomy" - }] - }, - "advancedOptions": { - "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryDiscoveryAdvancedOptions" - }] - } - }, - "required": [ - "discoveryGoal" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1DiscoveryInputDataConfig": { - "description": "Configuration for the input data used for discovery.", - "type": "object", - "properties": { - "conversationFilter": { - "description": "Optional. The filter for querying conversations.", - "type": "string" - }, - "maxSampleSize": { - "description": "Optional. Maximum number of conversations to sample.", - "type": "string", - "format": "int64" - }, - "dataset": { - "description": "Optional. The resource name of the Dataset to scope the discovery to.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}\nIf provided, discovery will only run on conversations within this dataset.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DiscoveryCustomTaxonomy": { - "description": "User provided taxonomy to guide the discovery.", - "type": "object", - "properties": { - "taxonomyEntries": { - "description": "Entries in the custom taxonomy.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryCustomTaxonomyTaxonomyEntry" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DiscoveryCustomTaxonomyTaxonomyEntry": { - "description": "A single entry in the custom taxonomy.", - "type": "object", - "properties": { - "displayName": { - "description": "Name of the taxonomy entry.", - "type": "string" - }, - "description": { - "description": "Description of the taxonomy entry.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DiscoveryDiscoveryAdvancedOptions": { - "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", - "type": "object", - "properties": { - "conversationDataOptions": { - "description": "Options for configuring what metadata goes into conversation\ntranscript.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevisionFeedback": { - "description": "Feedback for the discovery results under previous_revision.", - "type": "object", - "properties": { - "resultFeedback": { - "description": "DiscoveryResult level feedback.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevisionFeedbackResultFeedback" - } - }, - "revisionFeedback": { - "description": "DiscoveryRevision level feedback.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DiscoveryRevisionFeedbackResultFeedback": { - "description": "Content of a DiscoveryResult level feedback. i.e. Feedback applied\nspecifically to a DiscoveryResult.", - "type": "object", - "properties": { - "result": { - "description": "Resource name of the discovery result this feedback is for.\nThe parent discovery revision of the result must be the same as what's\nspecified in the source_revision field.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}", - "type": "string" - }, - "feedback": { - "description": "The feedback for the discovery result.", - "type": "string" - }, - "userAction": { - "description": "The user action for the entry feedback.", - "type": "string", - "x-google-enum-descriptions": [ - "Default value.", - "The user wants to remove the discovery result.", - "The user provides an exact replacement for the display name.", - "The user provides an exact replacement for the description.", - "The user provides comments/instructions on how to modify the display\nname.", - "The user provides comments/instructions on how to modify the\ndescription." - ], - "enum": [ - "USER_ACTION_UNSPECIFIED", - "REMOVE", - "SET_DISPLAY_NAME", - "SET_DESCRIPTION", - "SUGGEST_DISPLAY_NAME_EDIT", - "SUGGEST_DESCRIPTION_EDIT" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DiscoveryProgress": { - "description": "Progress information for a discovery.", - "type": "object", - "properties": { - "progressState": { - "description": "Output only. The state of the discovery creation or refinement.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "Default value. This value is unused.", - "The input data is being preprocessed.", - "Summarizing the conversations to extract features.", - "Generating the results based on the features.", - "Calculating the distributions for the results.", - "The discovery is being finalized.", - "The GenerateDiscovery operation has completed successfully." - ], - "enum": [ - "PROGRESS_STATE_UNSPECIFIED", - "PREPROCESSING", - "SUMMARIZING", - "GENERATING_RESULTS", - "COMPUTING_DISTRIBUTIONS", - "FINALIZING", - "SUCCEEDED" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1CreateFaqModelMetadata": { - "description": "Metadata for creating an FAQ model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for creation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateFaqModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1CreateFaqModelRequest": { - "description": "The request to create an FAQ model.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the FAQ model.", - "type": "string" - }, - "faqModel": { - "description": "Required. The FAQ model to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqModel" - }] - }, - "faqModelId": { - "description": "Optional. The ID to use for the FAQ model, which will become the final\ncomponent of the FAQ model's resource name.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", - "type": "string" - } - }, - "required": [ - "parent", - "faqModel" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1FaqModel": { - "description": "The FAQ model resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the FAQ model.\nFormat:\nprojects/{project}/locations/{location}/faqModels/{faq_model}", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The representative name for the FAQ model.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this FAQ model was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the FAQ model was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "faqEntryCount": { - "description": "Output only. Number of FAQ entries in this FAQ model.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "state": { - "description": "Output only. State of the FAQ model.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Model is not deployed but is ready to deploy.", - "Model is being deleted." - ], - "enum": [ - "STATE_UNSPECIFIED", - "UNDEPLOYED", - "DELETING" - ] - }, - "inputDataConfig": { - "description": "Configs for the input data used to create the FAQ model.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqModelInputDataConfig" - }] - }, - "modelTrainingStats": { - "description": "Output only. Immutable. The model statistics on its training data.", - "readOnly": true, - "x-google-immutable": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqModelModelStats" - }] - }, - "infobotAgent": { - "description": "Immutable. The resource name of the infobot agent to be used to create generative\nanswers. Format: projects/{project}/locations/{location}/agents/{agent}", - "x-google-immutable": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1FaqModelInputDataConfig": { - "description": "Configs for the input data used to create the FAQ model.", - "type": "object", - "properties": { - "trainingConversationsCount": { - "description": "Output only. Number of conversations used in training. Output only.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "filter": { - "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1FaqModelModelStats": { - "description": "Train/inference statistics for the model.", - "type": "object", - "properties": { - "totalConversationsCount": { - "description": "Total number of conversations analyzed at this point in time.", - "type": "integer", - "format": "int32" - }, - "skippedConversationsCount": { - "description": "Number of analyzed conversations which were skipped e.g. customer\ndisconnected from the call.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata": { - "description": "Metadata for creating an issue.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for creation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest": { - "description": "The request to create an issue.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the issue.", - "type": "string" - }, - "issue": { - "description": "Required. The values for the new issue.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Issue" - }] - } - }, - "required": [ - "parent", - "issue" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1Issue": { - "description": "The issue resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the issue.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The representative name for the issue.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this issue was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time that this issue was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "representativeConversationNames": { - "description": "Output only. Resource names of the most representative conversations matched.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "sampleUtterances": { - "description": "Output only. Resource names of the sample representative utterances that match to this\nissue.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "source": { - "description": "Source of the topic", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Generated based on the customers data - i.e. topic discovered by model.", - "Taxonomy provided by the customer (topic come from custom taxonomy)." - ], - "enum": [ - "ISSUE_SOURCE_UNSPECIFIED", - "GENERATED", - "CUSTOMER_PROVIDED" - ] - }, - "parentIssues": { - "description": "Unique identifiers of the parent topics for hierarchical representation.\nFormat is\n`projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}`", - "type": "array", - "items": { - "type": "string" - } - }, - "alternatives": { - "description": "Additional topic descriptions.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAlternative" - } - }, - "displayDescription": { - "description": "Representative description of the issue.", - "type": "string" - }, - "matchTarget": { - "description": "Target used for semantic similarity comparisons.\nPopulated on V2 models if the display name was renamed.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IssueAlternative": { - "description": "Alternative topic names or descriptions to improve inference.", - "type": "object", - "properties": { - "alternative": { - "description": "An alternative topic name.", - "type": "string" - }, - "description": { - "description": "An alternative topic description.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata": { - "description": "Metadata for creating an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for creation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest": { - "description": "The request to create an issue model.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the issue model.", - "type": "string" - }, - "issueModel": { - "description": "Required. The issue model to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel" - }] - } - }, - "required": [ - "parent", - "issueModel" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1IssueModel": { - "description": "The issue model resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the issue model.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The representative name for the issue model.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this issue model was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the issue model was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "issueCount": { - "description": "Output only. Number of issues in this issue model.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "state": { - "description": "Output only. State of the model.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Model is not deployed but is ready to deploy.", - "Model is being deployed.", - "Model is deployed and is ready to be used. A model can only be used in\nanalysis if it's in this state.", - "Model is being undeployed.", - "Model is being deleted." - ], - "enum": [ - "STATE_UNSPECIFIED", - "UNDEPLOYED", - "DEPLOYING", - "DEPLOYED", - "UNDEPLOYING", - "DELETING" - ] - }, - "inputDataConfig": { - "description": "Configs for the input data that used to create the issue model.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig" - }] - }, - "trainingStats": { - "description": "Output only. Immutable. The issue model's label statistics on its training data.", - "readOnly": true, - "x-google-immutable": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats" - }] - }, - "modelType": { - "description": "Type of the model.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified model type.", - "Type V1.", - "Type V2." - ], - "enum": [ - "MODEL_TYPE_UNSPECIFIED", - "TYPE_V1", - "TYPE_V2" - ] - }, - "languageCode": { - "description": "Language of the model.", - "type": "string" - }, - "multiLingualMatch": { - "description": "Whether the model can be used for analysis with conversations in multiple\nlanguages. The topic names and descriptions will be in the `language_code`\nspecified, but the matching will be performed against conversations in any\nlanguage.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig": { - "description": "Configs for the input data used to create the issue model.", - "type": "object", - "properties": { - "medium": { - "description": "Medium of conversations used in training data. This field is being\ndeprecated. To specify the medium to be used in training a new issue\nmodel, set the `medium` field on `filter`.", - "deprecated": true, - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "The format for conversations that took place over the phone.", - "The format for conversations that took place over chat." - ], - "enum": [ - "MEDIUM_UNSPECIFIED", - "PHONE_CALL", - "CHAT" - ] - }, - "trainingConversationsCount": { - "description": "Output only. Number of conversations used in training. Output only.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "filter": { - "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", - "type": "string" - }, - "customTaxonomy": { - "description": "Custom supplied taxonomy.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelCustomTaxonomy" - }] - }, - "issueGranularity": { - "description": "Issue granularity preference for model training.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Granularity much coarser than default.", - "Granularity coarser than default.", - "Default granularity.", - "Granularity finer than default.", - "Granularity much finer than default." - ], - "enum": [ - "ISSUE_GRANULARITY_UNSPECIFIED", - "MORE_COARSE", - "COARSE", - "STANDARD", - "FINE", - "MORE_FINE" - ] - }, - "industry": { - "description": "Customer industry, used to improve specificity of the topic model.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IssueModelCustomTaxonomy": { - "description": "Structure for custom supplied taxonomy. A custom taxonomy consists of\nmultiple taxonomy entries organized in a hierarchical way.", - "type": "object", - "properties": { - "taxonomyEntries": { - "description": "List of taxonomy entries.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelCustomTaxonomyTaxonomyEntry" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IssueModelCustomTaxonomyTaxonomyEntry": { - "description": "Structure for a taxonomy entry.", - "type": "object", - "properties": { - "id": { - "description": "Immutable. The Id of the taxonomy entry", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The content of the taxonomy entry.", - "type": "string" - }, - "parents": { - "description": "Ids of parent taxonomy entries.", - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "description": "The description of the taxonomy entry.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats": { - "description": "Aggregated statistics about an issue model.", - "type": "object", - "properties": { - "analyzedConversationsCount": { - "description": "Number of conversations the issue model has analyzed at this point in time.", - "type": "string", - "format": "int64" - }, - "unclassifiedConversationsCount": { - "description": "Number of analyzed conversations for which no issue was applicable at this\npoint in time.", - "type": "string", - "format": "int64" - }, - "issueStats": { - "description": "Statistics on each issue. Key is the issue's resource name.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats": { - "description": "Aggregated statistics about an issue.", - "type": "object", - "properties": { - "issue": { - "description": "Issue resource.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", - "type": "string" - }, - "labeledConversationsCount": { - "description": "Number of conversations attached to the issue at this point in time.", - "type": "string", - "format": "int64" - }, - "displayName": { - "description": "Display name of the issue.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DeleteFaqModelMetadata": { - "description": "Metadata for deleting an FAQ model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for deletion.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteFaqModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DeleteFaqModelRequest": { - "description": "The request to delete an FAQ model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The name of the FAQ model to delete.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata": { - "description": "Metadata for deleting an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for deletion.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest": { - "description": "The request to delete an issue model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The name of the issue model to delete.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata": { - "description": "The metadata for deleting a QaQuestionTag Resource.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest": { - "description": "The request for deleting a QaQuestionTag.", - "type": "object", - "properties": { - "name": { - "description": "Required. The name of the QaQuestionTag to delete.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata": { - "description": "Metadata for deploying an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for deployment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest": { - "description": "The request to deploy an issue model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The issue model to deploy.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse": { - "description": "The response to deploy an issue model.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata": { - "description": "Metadata for an export insights operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for export.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during export operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "completedExportCount": { - "description": "The number of conversations that were exported successfully.", - "type": "integer", - "format": "int32" - }, - "failedExportCount": { - "description": "The number of conversations that failed to be exported.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest": { - "description": "The request to export insights.", - "type": "object", - "properties": { - "bigQueryDestination": { - "description": "Specified if sink is a BigQuery table.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination" - }] - }, - "parent": { - "description": "Required. The parent resource to export data from.", - "type": "string" - }, - "filter": { - "description": "A filter to reduce results to a specific subset. Useful for exporting\nconversations with specific properties.", - "type": "string" - }, - "kmsKey": { - "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK.\nFormat:\nprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", - "type": "string" - }, - "writeDisposition": { - "description": "Options for what to do if the destination table already exists.", - "type": "string", - "x-google-enum-descriptions": [ - "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", - "If the table already exists, BigQuery will overwrite the table data and\nuse the schema from the load.", - "If the table already exists, BigQuery will append data to the table." - ], - "enum": [ - "WRITE_DISPOSITION_UNSPECIFIED", - "WRITE_TRUNCATE", - "WRITE_APPEND" - ] - }, - "exportSchemaVersion": { - "description": "Optional. Version of the export schema.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified. Defaults to EXPORT_V3.", - "Export schema version 1.", - "Export schema version 2.", - "Export schema version 3.", - "Export schema version 4.", - "Export schema version 5.", - "Export schema version 6.", - "Export schema version 7.", - "Export schema version 8.", - "Export schema version 9.", - "Export schema version 10.", - "Export schema version 11.", - "Export schema version 12.", - "Export schema version 13.", - "Export schema version 14.", - "Export schema version 15.", - "Export schema version 16.", - "Export schema version 17.", - "Export schema version latest available." - ], - "enum": [ - "EXPORT_SCHEMA_VERSION_UNSPECIFIED", - "EXPORT_V1", - "EXPORT_V2", - "EXPORT_V3", - "EXPORT_V4", - "EXPORT_V5", - "EXPORT_V6", - "EXPORT_V7", - "EXPORT_V8", - "EXPORT_V9", - "EXPORT_V10", - "EXPORT_V11", - "EXPORT_V12", - "EXPORT_V13", - "EXPORT_V14", - "EXPORT_V15", - "EXPORT_V16", - "EXPORT_V17", - "EXPORT_VERSION_LATEST_AVAILABLE" - ] - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination": { - "description": "A BigQuery Table Reference.", - "type": "object", - "properties": { - "projectId": { - "description": "A project ID or number. If specified, then export will attempt to\nwrite data to this project instead of the resource project. Otherwise,\nthe resource project will be used.", - "type": "string" - }, - "dataset": { - "description": "Required. The name of the BigQuery dataset that the snapshot result should be\nexported to. If this dataset does not exist, the export call returns an\nINVALID_ARGUMENT error.", - "type": "string" - }, - "table": { - "description": "The BigQuery table name to which the insights data should be written.\nIf this table does not exist, the export call returns an INVALID_ARGUMENT\nerror.", - "type": "string" - } - }, - "required": [ - "dataset" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse": { - "description": "Response for an export insights operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata": { - "description": "Metadata used for export issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original export request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest": { - "description": "Request to export an issue model.", - "type": "object", - "properties": { - "gcsDestination": { - "description": "Google Cloud Storage URI to export the issue model to.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination" - }] - }, - "name": { - "description": "Required. The issue model to export.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination": { - "description": "Google Cloud Storage Object URI to save the issue model to.", - "type": "object", - "properties": { - "objectUri": { - "description": "Required. Format: `gs:///`", - "type": "string" - } - }, - "required": [ - "objectUri" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse": { - "description": "Response from export issue model", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerateDiscoveryMetadata": { - "description": "Metadata for GenerateDiscovery operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The request to create the discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerateDiscoveryRequest" - }] - }, - "progress": { - "description": "The progress of the discovery creation operation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DiscoveryProgress" - }] - }, - "resultRevision": { - "description": "Output only. The DiscoveryRevision resource name that contains the result entries\ngenerated in this discovery.", - "readOnly": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerateDiscoveryRequest": { - "description": "The request to generate a discovery.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent of generated discovery request.\nWhen it's a Location resource, this operation creates a root discovery and\nits discovery workspace will be automatically created.\nWhen it's a discovery workspace resource, this operation creates a drill\ndown discovery. discovery.drill_down_parent should have the same discovery\nworkspace as the parent.", - "type": "string" - }, - "discovery": { - "description": "Required. Specifies the discovery to generate. The name field of the discovery will\nbe ignored.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Discovery" - }] - } - }, - "required": [ - "parent", - "discovery" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerateDiscoveryResponse": { - "description": "The response of generating a discovery.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata": { - "description": "The metadata for generative insights.", - "type": "object", - "properties": { - "errorMessages": { - "description": "The error message when the generative insights request fails.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse": { - "description": "The response for generative insights.", - "type": "object", - "properties": { - "generativeResponses": { - "description": "The full list of generative responses.\nEach response is ordered by time.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse" - } - }, - "transcript": { - "description": "The transcript of the generative insights conversation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse": { - "description": "Wrapper for storing the generative response for a chart.", - "type": "object", - "properties": { - "textOutput": { - "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", - "deprecated": true, - "type": "string" - }, - "generatedSqlQuery": { - "description": "The generated SQL query from the LLM. Will be populated during the\nchart building phase. The generated SQL will be cached in the\ncorresponding chart resource.", - "type": "string" - }, - "chartSpec": { - "description": "The chart spec for the data.\nThis will be specified in the vega-lite or vega format.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "textMessage": { - "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput": { - "description": "Wrapper for text output.", - "type": "object", - "properties": { - "text": { - "description": "The text output from the LLM.", - "type": "array", - "items": { - "type": "string" - } - }, - "textType": { - "description": "The type of text output.", - "type": "string", - "x-google-enum-descriptions": [ - "The type is unspecified.", - "The text is part of LLM reasoning.", - "The text is the final answer from LLM.", - "The text is an informational message about the agent's progress, such\nas a tool being invoked. This is distinct from the agent's internal\nthought process (`THOUGHT`) and the final answer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the agent's\nactions." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "THOUGHT", - "FINAL_RESPONSE", - "PROGRESS" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript": { - "description": "The conversation transcript for the chart.", - "type": "object", - "properties": { - "conversationId": { - "description": "The conversation id of the chart.", - "type": "string" - }, - "createTime": { - "description": "Output only. The create time of the conversation.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The update time of the conversation.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "messages": { - "description": "Ordered list of messages, including user inputs and system responses.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage": { - "description": "The message in the conversation.", - "type": "object", - "properties": { - "userMessage": { - "description": "A message from the user that is interacting with the system.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage" - }] - }, - "systemMessageWrapper": { - "description": "A wrapper for system messages per turn.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages" - }] - }, - "messageId": { - "description": "The message id of the message.", - "type": "string" - }, - "createTime": { - "description": "Output only. For user messages, this is the time at which the system received the\nmessage. For system messages, this is the time at which the system\ngenerated the message.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage": { - "description": "The user message.", - "type": "object", - "properties": { - "text": { - "description": "A message from the user that is interacting with the system.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages": { - "description": "A wrapper for system messages per turn.", - "type": "object", - "properties": { - "systemMessages": { - "description": "A message from the system in response to the user.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage": { - "description": "A message from the system in response to the user. This message can\nalso be a message from the user as historical context for multiturn\nconversations with the system.", - "type": "object", - "properties": { - "textMessage": { - "description": "A direct natural language response to the user message.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" - }] - }, - "generatedSqlQuery": { - "description": "Raw SQL from LLM, before templatization", - "type": "string" - }, - "chartSpec": { - "description": "Chart spec from LLM", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "userProvidedSqlQuery": { - "description": "Optional. User provided SQL query", - "type": "string" - }, - "userProvidedChartSpec": { - "description": "Optional. User provided chart spec", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { - "description": "A text output message from the system.", - "type": "object", - "properties": { - "text": { - "description": "The parts of the message.", - "type": "array", - "items": { - "type": "string" - } - }, - "textType": { - "description": "The type of the text message.", - "type": "string", - "x-google-enum-descriptions": [ - "The default text type.", - "The text is a thinking plan generated by the thinking tool.", - "The text is a final response to the user question.", - "The text is an informational message about the agent's\nprogress, such as a tool being invoked. This is distinct from\nthe agent's internal thought process (`THOUGHT`) and the final\nanswer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the\nagent's actions." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "THOUGHT", - "FINAL_RESPONSE", - "PROGRESS" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata": { - "description": "Metadata used for import issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original import request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest": { - "description": "Request to import an issue model.", - "type": "object", - "properties": { - "gcsSource": { - "description": "Google Cloud Storage source message.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource" - }] - }, - "parent": { - "description": "Required. The parent resource of the issue model.", - "type": "string" - }, - "createNewModel": { - "description": "Optional. If set to true, will create an issue model from the imported file with\nrandomly generated IDs for the issue model and corresponding issues.\nOtherwise, replaces an existing model with the same ID as the file.", - "type": "boolean" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource": { - "description": "Google Cloud Storage Object URI to get the issue model file from.", - "type": "object", - "properties": { - "objectUri": { - "description": "Required. Format: `gs:///`", - "type": "string" - } - }, - "required": [ - "objectUri" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse": { - "description": "Response from import issue model", - "type": "object", - "properties": { - "issueModel": { - "description": "The issue model that was imported.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata": { - "description": "The metadata for an IngestConversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for ingest.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" - }] - }, - "partialErrors": { - "description": "Output only. Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "ingestConversationsStats": { - "description": "Output only. Statistics for IngestConversations operation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats" - }] - }, - "sampledConversations": { - "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest": { - "description": "The request to ingest conversations.", - "type": "object", - "properties": { - "gcsSource": { - "description": "A cloud storage bucket source. Note that any previously ingested objects\nfrom the source will be skipped to avoid duplication.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource" - }] - }, - "transcriptObjectConfig": { - "description": "Configuration for when `source` contains conversation transcripts.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig" - }] - }, - "parent": { - "description": "Required. The parent resource for new conversations.", - "type": "string" - }, - "conversationConfig": { - "description": "Configuration that applies to all conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig" - }] - }, - "redactionConfig": { - "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config\nspecified in Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" - }] - }, - "speechConfig": { - "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config\nspecified in Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" - }] - }, - "sampleSize": { - "description": "Optional. If set, this fields indicates the number of objects to ingest from the\nCloud Storage bucket. If empty, the entire bucket will be ingested.\nUnless they are first deleted, conversations produced through sampling\nwon't be ingested by subsequent ingest requests.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource": { - "description": "Configuration for Cloud Storage bucket sources.", - "type": "object", - "properties": { - "bucketUri": { - "description": "Optional. The Cloud Storage bucket containing source objects.\nAvoid passing this. Pass this through one of `transcript_bucket_uri` or\n`audio_bucket_uri`.", - "type": "string" - }, - "bucketObjectType": { - "description": "Optional. Specifies the type of the objects in `bucket_uri`.\nAvoid passing this. This is inferred from the `transcript_bucket_uri`,\n`audio_bucket_uri`.", - "type": "string", - "x-google-enum-descriptions": [ - "The object type is unspecified and will default to `TRANSCRIPT`.", - "The object is a transcript.", - "The object is an audio file." - ], - "enum": [ - "BUCKET_OBJECT_TYPE_UNSPECIFIED", - "TRANSCRIPT", - "AUDIO" - ] - }, - "transcriptBucketUri": { - "description": "Optional. The Cloud Storage path to the conversation transcripts. Note\nthat: [1] Transcript files are expected to be in JSON format. [2]\nTranscript, audio, metadata files must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", - "type": "string" - }, - "audioBucketUri": { - "description": "Optional. The Cloud Storage path to the conversation audio file.\nNote that: [1] Audio files will be transcribed if not already.\n[2] Audio files and transcript files must be in separate\nbuckets / folders.\n[3] A source file and its corresponding audio file\nmust share the same name to\n be properly ingested, E.g.\n `gs://bucket/transcript/conversation1.json` and\n `gs://bucket/audio/conversation1.mp3`.", - "type": "string" - }, - "metadataBucketUri": { - "description": "Optional. The Cloud Storage path to the conversation metadata. Note that:\n[1] Metadata files are expected to be in JSON format.\n[2] Metadata and source files (transcripts or audio) must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", - "type": "string" - }, - "customMetadataKeys": { - "description": "Optional. Custom keys to extract as conversation labels from metadata files in\n`metadata_bucket_uri`. Keys not included in this field will be ignored.\nNote that there is a limit of 100 labels per conversation.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig": { - "description": "Configuration for processing transcript objects.", - "type": "object", - "properties": { - "medium": { - "description": "Required. The medium transcript objects represent.", - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "The format for conversations that took place over the phone.", - "The format for conversations that took place over chat." - ], - "enum": [ - "MEDIUM_UNSPECIFIED", - "PHONE_CALL", - "CHAT" - ] - } - }, - "required": [ - "medium" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig": { - "description": "Configuration that applies to all conversations.", - "type": "object", - "properties": { - "agentId": { - "description": "Optional. An opaque, user-specified string representing a human agent who handled\nall conversations in the import. Note that this will be overridden if\nper-conversation metadata is provided through the `metadata_bucket_uri`.", - "type": "string" - }, - "agentChannel": { - "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", - "type": "integer", - "format": "int32" - }, - "customerChannel": { - "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig": { - "description": "DLP resources used for redaction while ingesting conversations.\nDLP settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint or the Dialogflow / Agent\nAssist runtime integrations. When using Dialogflow / Agent Assist runtime\nintegrations, redaction should be performed in Dialogflow / Agent Assist.", - "type": "object", - "properties": { - "deidentifyTemplate": { - "description": "The fully-qualified DLP deidentify template resource name.\nFormat:\n`projects/{project}/deidentifyTemplates/{template}`", - "type": "string" - }, - "inspectTemplate": { - "description": "The fully-qualified DLP inspect template resource name.\nFormat:\n`projects/{project}/locations/{location}/inspectTemplates/{template}`", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig": { - "description": "Speech-to-Text configuration.\nSpeech-to-Text settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint.", - "type": "object", - "properties": { - "speechRecognizer": { - "description": "The fully-qualified Speech Recognizer resource name.\nFormat:\n`projects/{project_id}/locations/{location}/recognizer/{recognizer}`", - "type": "string" - }, - "disableWordTimeOffsets": { - "description": "Whether to disable word time offsets.\nIf true, the `enable_word_time_offsets` field in the recognition config\nwill be set to false.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats": { - "description": "Statistics for IngestConversations operation.", - "type": "object", - "properties": { - "processedObjectCount": { - "description": "Output only. The number of objects processed during the ingest operation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "duplicatesSkippedCount": { - "description": "Output only. The number of objects skipped because another conversation with the same\ntranscript uri had already been ingested.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "successfulIngestCount": { - "description": "Output only. The number of new conversations added during this ingest operation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "failedIngestCount": { - "description": "Output only. The number of objects which were unable to be ingested due to errors.\nThe errors are populated in the partial_errors field.", - "readOnly": true, - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse": { - "description": "The response to an IngestConversations operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata": { - "description": "Metadata for initializing a location-level encryption specification.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for initialization.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during initializing operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest": { - "description": "The request to initialize a location-level encryption specification.", - "type": "object", - "properties": { - "encryptionSpec": { - "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms\nkey is in the same region as the endpoint. The same key will be used for\nall provisioned resources, if encryption is available. If the\n`kms_key_name` field is left empty, no encryption will be enforced.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" - }] - } - }, - "required": [ - "encryptionSpec" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { - "description": "A customer-managed encryption key specification that can be applied to all\ncreated resources (e.g. `Conversation`).", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the encryption key specification resource.\nFormat:\nprojects/{project}/locations/{location}/encryptionSpec", - "x-google-immutable": true, - "type": "string" - }, - "kmsKey": { - "description": "Required. The name of customer-managed encryption key that is used to\nsecure a resource and its sub-resources. If empty, the resource is secured\nby our default encryption key. Only the key in the same location as this\nresource is allowed to be used for encryption. Format:\n`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", - "type": "string" - } - }, - "required": [ - "kmsKey" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse": { - "description": "The response to initialize a location-level encryption specification.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse": { - "description": "The response for listing all feedback labels.", - "type": "object", - "properties": { - "feedbackLabels": { - "description": "The feedback labels that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel": { - "description": "Represents a conversation, resource, and label provided by the user.\nCan take the form of a string label or a QaAnswer label.\nQaAnswer labels are used for Quality AI example conversations.\nString labels are used for Topic Modeling.\nAgentAssistSummary labels are used for Agent Assist Summarization.", - "type": "object", - "properties": { - "label": { - "description": "String label used for Topic Modeling.", - "type": "string" - }, - "qaAnswerLabel": { - "description": "QaAnswer label used for Quality AI example conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" - }] - }, - "name": { - "description": "Immutable. Resource name of the FeedbackLabel.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", - "x-google-immutable": true, - "type": "string" - }, - "labeledResource": { - "description": "Name of the resource to be labeled.\nSupported resources are:\n\n* `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}`\n* `projects/{project}/locations/{location}/issueModels/{issue_model}`\n* `projects/{project}/locations/{location}/generators/{generator_id}`", - "type": "string" - }, - "createTime": { - "description": "Output only. Create time of the label.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. Update time of the label.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue": { - "description": "Message for holding the value of a QaAnswer.\nQaQuestion.AnswerChoice defines the possible answer values for a\nquestion.", - "type": "object", - "properties": { - "strValue": { - "description": "String value.", - "type": "string" - }, - "numValue": { - "description": "Numerical value.", - "type": "number", - "format": "double" - }, - "boolValue": { - "description": "Boolean value.", - "type": "boolean" - }, - "naValue": { - "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", - "type": "boolean" - }, - "skipValue": { - "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`.\nIf a question receives this answer, it will be excluded from any score\ncalculations. This would mean that the question was not evaluated.", - "readOnly": true, - "type": "boolean" - }, - "key": { - "description": "A short string used as an identifier. Matches the value used in\nQaQuestion.AnswerChoice.key.", - "type": "string" - }, - "score": { - "description": "Output only. Numerical score of the answer.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "Output only. The maximum potential score of the question.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "rationale": { - "description": "Output only. The rationale for the answer. This field is only populated for answers\nthat are generated by the LLM. Manual edits currently do not have\nrationales.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale": { - "description": "Wrapper for the rationale for the answer.", - "type": "object", - "properties": { - "rationale": { - "description": "The rationale string for the answer.", - "type": "string" - }, - "rationaleSource": { - "description": "The source of the rationale. A manual edit AnswerValue could still\ncontain a system generated rationale if user didn't provide one. Manual\nedit would override the system generated rationale.", - "type": "string", - "x-google-enum-descriptions": [ - "The rationale source is unspecified. This value should generally not\nbe used.", - "The rationale is system generated.", - "The rationale is manually added by the user." - ], - "enum": [ - "RATIONALE_SOURCE_UNSPECIFIED", - "RATIONALE_SOURCE_SYSTEM_GENERATED", - "RATIONALE_SOURCE_MANUAL_EDIT" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse": { - "description": "The response for listing feedback labels.", - "type": "object", - "properties": { - "feedbackLabels": { - "description": "The feedback labels that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" - } - }, - "nextPageToken": { - "description": "The next page token.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1MergeIssuesMetadata": { - "description": "Metadata for creating an issue.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata": { - "description": "The metadata from querying metrics.", - "type": "object", - "properties": { - "resultIsTruncated": { - "description": "Whether the result rows were truncated because the result row size is too\nlarge to materialize.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse": { - "description": "The response for querying metrics.", - "type": "object", - "properties": { - "location": { - "description": "Required. The location of the data.\n\"projects/{project}/locations/{location}\"", - "type": "string" - }, - "updateTime": { - "description": "The metrics last update time.", - "type": "string", - "format": "date-time" - }, - "slices": { - "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" - } - }, - "macroAverageSlice": { - "description": "The macro average slice contains aggregated averages across all selected\ndimensions. i.e. if group_by agent and scorecard_id is specified, this\nfield will contain the average across all agents and all scorecards. This\nfield is only populated if the request specifies a Dimension.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" - }] - } - }, - "required": [ - "location" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice": { - "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.\n\nFor example, if the request specifies a single ISSUE dimension and it has a\ncardinality of 2 (i.e. the data used to compute the metrics has 2 issues in\ntotal), the response will have 2 slices:\n\n* Slice 1 -> dimensions=[Issue 1]\n* Slice 2 -> dimensions=[Issue 2]", - "type": "object", - "properties": { - "dimensions": { - "description": "A unique combination of dimensions that this slice represents.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Dimension" - } - }, - "total": { - "description": "The total metric value. The interval of this data point is\n[starting create time, ending create time) from the request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" - }] - }, - "timeSeries": { - "description": "A time series of metric values. This is only populated if the request\nspecifies a time granularity other than NONE.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1Dimension": { - "description": "A dimension determines the grouping key for the query. In SQL terms, these\nwould be part of both the \"SELECT\" and \"GROUP BY\" clauses.", - "type": "object", - "properties": { - "issueDimensionMetadata": { - "description": "Output only. Metadata about the issue dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata" - }] - }, - "agentDimensionMetadata": { - "description": "Output only. Metadata about the agent dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata" - }] - }, - "qaQuestionDimensionMetadata": { - "description": "Output only. Metadata about the QA question dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata" - }] - }, - "qaQuestionAnswerDimensionMetadata": { - "description": "Output only. Metadata about the QA question-answer dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata" - }] - }, - "qaScorecardDimensionMetadata": { - "description": "Output only. Metadata about the QA scorecard dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata" - }] - }, - "conversationProfileDimensionMetadata": { - "description": "Output only. Metadata about the conversation profile dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata" - }] - }, - "mediumDimensionMetadata": { - "description": "Output only. Metadata about the conversation medium dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata" - }] - }, - "conversationalAgentsPlaybookDimensionMetadata": { - "description": "Output only. Metadata about the Conversational Agents playbook dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata" - }] - }, - "conversationalAgentsToolDimensionMetadata": { - "description": "Output only. Metadata about the Conversational Agents tool dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata" - }] - }, - "clientSentimentCategoryDimensionMetadata": { - "description": "Output only. Metadata about the client sentiment category dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata" - }] - }, - "agentAssistSupervisorDimensionMetadata": { - "description": "Output only. Metadata about the supervisor for virtual agents dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionAgentAssistSupervisorDimensionMetadata" - }] - }, - "labelDimensionMetadata": { - "description": "Output only. Metadata about conversation labels.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata" - }] - }, - "dimensionKey": { - "description": "The key of the dimension.", - "type": "string", - "x-google-enum-descriptions": [ - "The key of the dimension is unspecified.", - "The dimension is keyed by issues.", - "The dimension is keyed by issue names.", - "The dimension is keyed by agents.", - "The dimension is keyed by agent teams.", - "The dimension is keyed by QaQuestionIds.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing stats for\nthe same question across different scorecard revisions.", - "The dimension is keyed by QaQuestionIds-Answer value pairs.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing\ndistribution of answers per question across different scorecard\nrevisions.", - "The dimension is keyed by QaScorecardIds.\nNote that: We only group by the ScorecardId and not the revision-id of\nthe scorecard. This allows for showing stats for the same scorecard\nacross different revisions.\nThis metric is mostly only useful if querying the average normalized\nscore per scorecard.", - "The dimension is keyed by the conversation profile ID.", - "The dimension is keyed by the conversation medium.", - "The dimension is keyed by the Conversational Agents playbook ID.", - "The dimension is keyed by the Conversational Agents playbook display\nname.", - "The dimension is keyed by the Conversational Agents tool ID.", - "The dimension is keyed by the Conversational Agents tool display name.", - "The dimension is keyed by the client sentiment category.", - "The dimension is keyed by the agent version ID.", - "The dimension is keyed by the agent deployment ID.", - "The dimension is keyed by the supervisor ID of the assigned human\nsupervisor for virtual agents.", - "The dimension is keyed by label keys.", - "The dimension is keyed by label values.", - "The dimension is keyed by label key-value pairs." - ], - "enum": [ - "DIMENSION_KEY_UNSPECIFIED", - "ISSUE", - "ISSUE_NAME", - "AGENT", - "AGENT_TEAM", - "QA_QUESTION_ID", - "QA_QUESTION_ANSWER_VALUE", - "QA_SCORECARD_ID", - "CONVERSATION_PROFILE_ID", - "MEDIUM", - "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", - "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", - "CONVERSATIONAL_AGENTS_TOOL_ID", - "CONVERSATIONAL_AGENTS_TOOL_NAME", - "CLIENT_SENTIMENT_CATEGORY", - "AGENT_VERSION_ID", - "AGENT_DEPLOYMENT_ID", - "AGENT_ASSIST_SUPERVISOR_ID", - "LABEL_KEY", - "LABEL_VALUE", - "LABEL_KEY_AND_VALUE" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata": { - "description": "Metadata about the issue dimension.", - "type": "object", - "properties": { - "issueId": { - "description": "The issue ID.", - "type": "string" - }, - "issueDisplayName": { - "description": "The issue display name.", - "type": "string" - }, - "issueModelId": { - "description": "The parent issue model ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata": { - "description": "Metadata about the agent dimension.", - "type": "object", - "properties": { - "agentId": { - "description": "Optional. A user-specified string representing the agent.\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentDisplayName": { - "description": "Optional. The agent's name\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentTeam": { - "description": "Optional. A user-specified string representing the agent's team.", - "type": "string" - }, - "agentVersionDisplayName": { - "description": "Optional. The agent's version display name. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentVersionId": { - "description": "Optional. The agent's version ID. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentDeploymentDisplayName": { - "description": "Optional. The agent's deployment display name. Only applicable to automated agents.\nThis will be populated for AGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentDeploymentId": { - "description": "Optional. The agent's deployment ID. Only applicable to automated agents.\nThis will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata": { - "description": "Metadata about the QA question dimension.", - "type": "object", - "properties": { - "qaScorecardId": { - "description": "Optional. The QA scorecard ID.", - "type": "string" - }, - "qaQuestionId": { - "description": "Optional. The QA question ID.", - "type": "string" - }, - "questionBody": { - "description": "Optional. The full body of the question.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata": { - "description": "Metadata about the QA question-answer dimension.\nThis is useful for showing the answer distribution for questions for a\ngiven scorecard.", - "type": "object", - "properties": { - "qaScorecardId": { - "description": "Optional. The QA scorecard ID.", - "type": "string" - }, - "qaQuestionId": { - "description": "Optional. The QA question ID.", - "type": "string" - }, - "questionBody": { - "description": "Optional. The full body of the question.", - "type": "string" - }, - "answerValue": { - "description": "Optional. The full body of the question.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata": { - "description": "Metadata about the QA scorecard dimension.", - "type": "object", - "properties": { - "qaScorecardId": { - "description": "Optional. The QA scorecard ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata": { - "description": "Metadata about the conversation profile dimension.", - "type": "object", - "properties": { - "conversationProfileId": { - "description": "Optional. The conversation profile ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata": { - "description": "Metadata about the conversation medium dimension.", - "type": "object", - "properties": { - "medium": { - "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata": { - "description": "Metadata about the Conversational Agents playbook dimension.", - "type": "object", - "properties": { - "playbookId": { - "description": "Optional. The dialogflow playbook ID.", - "type": "string" - }, - "playbookDisplayName": { - "description": "Optional. The dialogflow playbook display name.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata": { - "description": "Metadata about the Conversational Agents tool dimension.", - "type": "object", - "properties": { - "toolId": { - "description": "Optional. The dialogflow tool ID.", - "type": "string" - }, - "toolDisplayName": { - "description": "Optional. The dialogflow tool display name.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata": { - "description": "Metadata about the client sentiment category dimension.", - "type": "object", - "properties": { - "sentimentCategory": { - "description": "Optional. The client sentiment category.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentAssistSupervisorDimensionMetadata": { - "description": "Metadata about AA's human supervisor dimension.", - "type": "object", - "properties": { - "supervisorId": { - "description": "Optional. ID of the assigned supervisor.", - "type": "string" - }, - "supervisorUsername": { - "description": "Optional. User name of the assigned supervisor.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata": { - "description": "Metadata about conversation labels.", - "type": "object", - "properties": { - "labelKey": { - "description": "Optional. The label key.", - "type": "string" - }, - "labelValue": { - "description": "Optional. The label value.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint": { - "description": "A data point contains the metric values mapped to an interval.", - "type": "object", - "properties": { - "conversationMeasure": { - "description": "The measure related to conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure" - }] - }, - "dialogflowInteractionMeasure": { - "description": "The measure related to dialogflow interactions.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" - }] - }, - "interval": { - "description": "The interval that this data point represents.\n\n* If this is the total data point, the interval is\n[starting create time, ending create time) from the request.\n* If this a data point from the time series, the interval is\n[time, time + time granularity from the request).", - "allOf": [{ - "$ref": "#/components/schemas/GoogleTypeInterval" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure": { - "description": "The measure related to conversations.", - "type": "object", - "properties": { - "conversationCount": { - "description": "The conversation count.", - "type": "integer", - "format": "int32" - }, - "averageSilencePercentage": { - "description": "The average silence percentage.", - "type": "number", - "format": "float" - }, - "averageDuration": { - "description": "The average duration.", - "type": "string", - "format": "google-duration" - }, - "averageTurnCount": { - "description": "The average turn count.", - "type": "number", - "format": "float" - }, - "averageAgentSentimentScore": { - "description": "The average agent's sentiment score.", - "type": "number", - "format": "float" - }, - "averageClientSentimentScore": { - "description": "The average client's sentiment score.", - "type": "number", - "format": "float" - }, - "averageCustomerSatisfactionRating": { - "description": "The average customer satisfaction rating.", - "type": "number", - "format": "double" - }, - "averageQaNormalizedScore": { - "description": "The average normalized QA score for a scorecard. When computing the\naverage across a set of conversations, if a conversation has been\nevaluated with multiple revisions of a scorecard, only the latest\nrevision results will be used. Will exclude 0's in average\ncalculation. Will be only populated if the request specifies a\ndimension of QA_SCORECARD_ID.", - "type": "number", - "format": "double" - }, - "qaTagScores": { - "description": "Average QA normalized score for all the tags.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" - } - }, - "averageQaQuestionNormalizedScore": { - "description": "Average QA normalized score averaged for questions averaged across\nall revisions of the parent scorecard.\nWill be only populated if the request specifies a dimension of\nQA_QUESTION_ID.", - "type": "number", - "format": "double" - }, - "knowledgeSearchResultCount": { - "description": "Count of knowledge search results (Generative Knowledge\nAssist) shown to the user.", - "type": "integer", - "format": "int32" - }, - "knowledgeSearchAgentQuerySourceRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nmade by the agent compared to the total number of knowledge search\nqueries made.", - "type": "number", - "format": "double" - }, - "knowledgeSearchSuggestedQuerySourceRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nsuggested compared to the total number of knowledge search\nqueries made.", - "type": "number", - "format": "double" - }, - "knowledgeAssistResultCount": { - "description": "Count of knowledge assist results (Proactive Generative Knowledge\nAssist) shown to the user.", - "type": "integer", - "format": "int32" - }, - "knowledgeSearchUriClickRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had a URL clicked.", - "type": "number", - "format": "double" - }, - "knowledgeAssistUriClickRatio": { - "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had a URL clicked.", - "type": "number", - "format": "double" - }, - "knowledgeSearchPositiveFeedbackRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had positive feedback.", - "type": "number", - "format": "double" - }, - "knowledgeSearchNegativeFeedbackRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had negative feedback.", - "type": "number", - "format": "double" - }, - "knowledgeAssistPositiveFeedbackRatio": { - "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had positive feedback.", - "type": "number", - "format": "double" - }, - "knowledgeAssistNegativeFeedbackRatio": { - "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had negative feedback.", - "type": "number", - "format": "double" - }, - "summarizationSuggestionEditRatio": { - "description": "Proportion of summarization suggestions that were manually edited.", - "type": "number", - "format": "double" - }, - "averageSummarizationSuggestionEditDistance": { - "description": "Average edit distance of the summarization suggestions. Edit\ndistance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion.", - "type": "number", - "format": "double" - }, - "averageSummarizationSuggestionNormalizedEditDistance": { - "description": "Normalized Average edit distance of the summarization suggestions.\nEdit distance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion. Normalized edit distance is the average of (edit distance\n/ summary length).", - "type": "number", - "format": "double" - }, - "conversationSuggestedSummaryRatio": { - "description": "Proportion of conversations that had a suggested summary.", - "type": "number", - "format": "double" - }, - "summarizationSuggestionResultCount": { - "description": "Count of summarization suggestions results.", - "type": "integer", - "format": "int32" - }, - "dialogflowInteractionsNoMatchRatio": { - "description": "Proportion of dialogflow interactions that has no intent match for\nthe input.", - "type": "number", - "format": "double" - }, - "dialogflowInteractionsNoInputRatio": { - "description": "Proportion of dialogflow interactions that has empty input.", - "type": "number", - "format": "double" - }, - "dialogflowWebhookFailureRatio": { - "description": "Proportion of dialogflow webhook calls that failed.", - "type": "number", - "format": "double" - }, - "dialogflowWebhookTimeoutRatio": { - "description": "Proportion of dialogflow webhook calls that timed out.", - "type": "number", - "format": "double" - }, - "dialogflowAverageWebhookLatency": { - "description": "Average latency of dialogflow webhook calls.", - "type": "number", - "format": "double" - }, - "dialogflowConversationsEscalationRatio": { - "description": "Proportion of conversations that was handed off from virtual agent to\nhuman agent.", - "type": "number", - "format": "double" - }, - "dialogflowConversationsEscalationCount": { - "description": "count of conversations that was handed off from virtual agent to\nhuman agent.", - "type": "number", - "format": "double" - }, - "conversationalAgentsToolCallSuccessRatio": { - "description": "Proportion of conversational agents' tool calls that were successful.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageToolCallLatency": { - "description": "Average latency of conversational agents' tool calls.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageTtsLatency": { - "description": "The macro average latency of conversational agents' TTS latency\nper interaction.\nThis is computed as the average of the all the interactions' TTS\nlatencies in a conversation and averaged across conversations.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageLlmCallLatency": { - "description": "The average latency of conversational agents' LLM call latency\nper interaction. This is computed as the average of the all the\ninteractions LLM call latencies in a conversation and averaged across\nconversations.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageAudioInAudioOutLatency": { - "description": "The average latency of conversational agents' audio in audio\nout latency per interaction.\nThis is computed as the average of the all the interactions' audio in\naudio out latencies in a conversation and averaged across\nconversations.", - "type": "number", - "format": "double" - }, - "conversationAiCoachSuggestionRatio": { - "description": "Proportion of conversations that has Ai Coach Suggestions.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionAgentUsageRatio": { - "description": "Proportion of Ai Coach Suggestion that has been used by agents.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionCustomerMessageTriggerRatio": { - "description": "Proportion of customer messages that triggered an Ai Coach\nSuggestion.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageEndToEndLatency": { - "description": "The average latency of conversational agents' latency per\ninteraction. This is computed as the average of the all the\niteractions' end to end latencies in a conversation and averaged\nacross conversations. The e2e latency is the time between the end of\nthe user utterance and the start of the agent utterance on the\ninteraction level.", - "type": "number", - "format": "double" - }, - "conversationAiCoachSuggestionCount": { - "description": "Count of conversations that has Ai Coach Suggestions.", - "type": "integer", - "format": "int32" - }, - "aiCoachSuggestionAgentUsageCount": { - "description": "Count of Ai Coach Suggestion that has been used by agents.", - "type": "integer", - "format": "int32" - }, - "aiCoachSuggestionCustomerMessageTriggerCount": { - "description": "Count of customer messages that triggered an Ai Coach\nSuggestion.", - "type": "integer", - "format": "int32" - }, - "aiCoachSuggestionAgentMessageTriggerCount": { - "description": "Count of agent messages that triggered an Ai Coach Suggestion.", - "type": "integer", - "format": "int32" - }, - "conversationTotalCustomerMessageCount": { - "description": "The customer message count.", - "type": "integer", - "format": "int32" - }, - "conversationTotalAgentMessageCount": { - "description": "The agent message count.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorMonitoredConversationsCount": { - "description": "The number of conversations scanned by the AA human supervisor.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorEscalatedConversationsCount": { - "description": "The number of conversations that were escalated to an AA human\nsupervisor for intervention.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorAssignedConversationsCount": { - "description": "The number of conversations that were assigned to an AA human\nsupervisor.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorDroppedConversationsCount": { - "description": "The number of conversations that were dropped, i.e. escalated but not\nassigned to an AA human supervisor.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorTransferredToHumanAgentConvCount": { - "description": "The number of conversations transferred to a human agent.", - "type": "integer", - "format": "int32" - }, - "avgConversationClientTurnSentimentEma": { - "description": "The exponential moving average of the sentiment score of client turns\nin the conversation.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionMessageTriggerRatio": { - "description": "Proportion of end_of_utterance trigger event messages that triggered\nan Ai Coach Suggestion.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionMessageTriggerCount": { - "description": "Count of end_of_utterance trigger event messages that triggered an Ai\nCoach Suggestion.", - "type": "integer", - "format": "int32" - }, - "containedConversationCount": { - "description": "The number of conversations that were contained.", - "type": "integer", - "format": "int32" - }, - "containedConversationRatio": { - "description": "The percentage of conversations that were contained.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { - "description": "Average QA normalized score for the tag.", - "type": "object", - "properties": { - "tag": { - "description": "Tag name.", - "type": "string" - }, - "averageTagNormalizedScore": { - "description": "Average tag normalized score per tag.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { - "description": "The measure related to dialogflow interactions.", - "type": "object", - "properties": { - "percentileAudioInAudioOutLatency": { - "description": "The percentile result for audio in audio out latency in milliseconds\nper dialogflow interaction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileLlmCallLatency": { - "description": "The percentile result for LLM latency in milliseconds per dialogflow\ninteraction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileTtsLatency": { - "description": "The percentile result for TTS latency in milliseconds per dialogflow\ninteraction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileToolUseLatency": { - "description": "The percentile result for tool use latency in milliseconds per\ndialogflow interaction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileEndToEndLatency": { - "description": "The percentile result for end to end chat latency in milliseconds per\ndialogflow interaction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult": { - "description": "The percentile result. Currently supported percentiles are 50th, 90th,\nand 99th.", - "type": "object", - "properties": { - "p50": { - "description": "The 50th percentile value.", - "type": "number", - "format": "double" - }, - "p90": { - "description": "The 90th percentile value.", - "type": "number", - "format": "double" - }, - "p99": { - "description": "The 99th percentile value.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries": { - "description": "A time series of metric values.", - "type": "object", - "properties": { - "dataPoints": { - "description": "The data points that make up the time series .", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata": { - "description": "The metadata for querying performance overview.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse": { - "description": "The response for querying performance overview.", - "type": "object", - "properties": { - "summaryText": { - "description": "The summary text of the performance.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata": { - "description": "The metadata for an SampleConversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for sample conversations to dataset.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" - }] - }, - "partialErrors": { - "description": "Output only. Partial errors during sample conversations operation that might\ncause the operation output to be incomplete.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "sampleConversationsStats": { - "description": "Output only. Statistics for SampleConversations operation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest": { - "description": "The request to sample conversations to a dataset.", - "type": "object", - "properties": { - "destinationDataset": { - "description": "The dataset resource to copy the sampled conversations to.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Dataset" - }] - }, - "parent": { - "description": "Required. The parent resource of the dataset.", - "type": "string" - }, - "sampleRule": { - "description": "Optional. The sample rule used for sampling conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SampleRule" - }] - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1Dataset": { - "description": "Dataset resource represents a collection of conversations\nthat may be bounded (Static Dataset, e.g. golden dataset for training),\nor unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", - "type": "object", - "properties": { - "name": { - "description": "Immutable. Identifier. Resource name of the dataset.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}", - "x-google-immutable": true, - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "Display name for the dataaset", - "type": "string" - }, - "description": { - "description": "Dataset description.", - "type": "string" - }, - "type": { - "description": "Dataset usage type.", - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "For evals only.", - "Dataset with new conversations coming in regularly (Insights legacy\nconversations and AI trainer)" - ], - "enum": [ - "TYPE_UNSPECIFIED", - "EVAL", - "LIVE" - ] - }, - "ttl": { - "description": "Optional. Option TTL for the dataset.", - "type": "string", - "format": "google-duration" - }, - "createTime": { - "description": "Output only. Dataset create time.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. Dataset update time.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1SampleRule": { - "description": "Message for sampling conversations.", - "type": "object", - "properties": { - "samplePercentage": { - "description": "Percentage of conversations that we should sample based on the dimension\nbetween [0, 100].", - "type": "number", - "format": "double" - }, - "sampleRow": { - "description": "Number of the conversations that we should sample based on the dimension.", - "type": "string", - "format": "int64" - }, - "dimension": { - "description": "Optional. Group by dimension to sample the conversation. If no dimension is\nprovided, the sampling will be applied to the project level.\nCurrent supported dimensions is 'quality_metadata.agent_info.agent_id'.", - "type": "string" - }, - "conversationFilter": { - "description": "To specify the filter for the conversions that should apply this sample\nrule. An empty filter means this sample rule applies to all conversations.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats": { - "description": "Statistics for SampleConversations operation.", - "type": "object", - "properties": { - "successfulSampleCount": { - "description": "Output only. The number of new conversations added during this sample operation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "failedSampleCount": { - "description": "Output only. The number of objects which were unable to be sampled due to errors.\nThe errors are populated in the partial_errors field.", - "readOnly": true, - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse": { - "description": "The response to an SampleConversations operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata": { - "description": "Metadata for testing correlation config.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "dataset": { - "description": "The dataset used for sampling conversations.", - "type": "string" - }, - "stats": { - "description": "The statistics for the operation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats": { - "description": "Statistics for TestCorrelationConfig operation.", - "type": "object", - "properties": { - "sampledConversationsCount": { - "description": "The number of conversations sampled.", - "type": "integer", - "format": "int32" - }, - "correlatedConversationsCount": { - "description": "The number of conversations correlated.", - "type": "integer", - "format": "int32" - }, - "failedConversationsCount": { - "description": "The number of conversations that failed correlation.", - "type": "integer", - "format": "int32" - }, - "partialErrors": { - "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "conversationCorrelationErrors": { - "description": "A list of errors that occurred during correlation, one for each\nconversation that failed.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { - "description": "An error that occurred during correlation for a specific conversation.", - "type": "object", - "properties": { - "conversation": { - "description": "The conversation resource name that had an error during correlation.", - "type": "string" - }, - "status": { - "description": "The error status.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleRpcStatus" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse": { - "description": "The response of testing correlation config.", - "type": "object", - "properties": { - "detailedResults": { - "description": "Results for the DETAILED_SYNC execution mode.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults" - }] - }, - "partialErrors": { - "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults": { - "description": "Wrapper for detailed, step-by-step results.", - "type": "object", - "properties": { - "joinKeyResults": { - "description": "A list of join key correlation results for each conversation tested.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult" - } - }, - "constraintResults": { - "description": "A list of constraint evaluation results for each pair of conversations.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult": { - "description": "The result of testing correlation config on a single conversation.", - "type": "object", - "properties": { - "conversation": { - "description": "The conversation resource name.", - "type": "string" - }, - "ruleResults": { - "description": "The results for each correlation rule.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult": { - "description": "The result of a single correlation rule.", - "type": "object", - "properties": { - "correlationId": { - "description": "The correlation ID generated by the join key expression.", - "type": "string" - }, - "error": { - "description": "The error status if the join key expression failed to evaluate.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleRpcStatus" - }] - }, - "ruleId": { - "description": "The rule ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult": { - "description": "The result of testing a constraint expression on a pair of conversations.", - "type": "object", - "properties": { - "conversationA": { - "description": "The first conversation resource name.", - "type": "string" - }, - "conversationB": { - "description": "The second conversation resource name.", - "type": "string" - }, - "ruleConstraintResults": { - "description": "The results for each applicable constraint rule.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult": { - "description": "The result of a single constraint rule on the pair of conversations.", - "type": "object", - "properties": { - "constraintMet": { - "description": "Whether the constraint expression evaluated to true for (A, B) or (B,\nA).", - "type": "boolean" - }, - "error": { - "description": "The error status if the constraint expression failed to evaluate.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleRpcStatus" - }] - }, - "ruleId": { - "description": "The rule ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata": { - "description": "Metadata for undeploying an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for undeployment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest": { - "description": "The request to undeploy an issue model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The issue model to undeploy.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse": { - "description": "The response to undeploy an issue model.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata": { - "description": "The metadata for updating a QaQuestionTag Resource.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest": { - "description": "The request for updating a QaQuestionTag.", - "type": "object", - "properties": { - "qaQuestionTag": { - "description": "Required. The QaQuestionTag to update.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" - }] - }, - "updateMask": { - "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `qa_question_tag_name` - the name of the tag\n* `qa_question_ids` - the list of questions the tag applies to", - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - }, - "required": [ - "qaQuestionTag" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag": { - "description": "A tag is a resource which aims to categorize a set of questions across\nmultiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Resource name for the QaQuestionTag\nFormat\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}\nIn the above format, the last segment, i.e., qa_question_tag, is a\nserver-generated ID corresponding to the tag resource.", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "Required. A user-specified display name for the tag.", - "type": "string" - }, - "qaQuestionIds": { - "description": "Optional. The list of Scorecard Question IDs that the tag applies to.\nEach QaQuestionId is represented as a full resource name containing the\nQuestion ID. Lastly, Since a tag may not necessarily be referenced by any\nScorecard Questions, we treat this field as optional.", - "type": "array", - "items": { - "type": "string" - } - }, - "createTime": { - "description": "Output only. The time at which the question tag was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the question tag was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - }, - "required": [ - "displayName" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata": { - "description": "The metadata for an `UploadConversation` operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest" - }] - }, - "analysisOperation": { - "description": "Output only. The operation name for a successfully created analysis operation, if any.", - "readOnly": true, - "type": "string" - }, - "appliedRedactionConfig": { - "description": "Output only. The redaction config applied to the uploaded conversation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest": { - "description": "Request to upload a conversation.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the conversation.", - "type": "string" - }, - "conversation": { - "description": "Required. The conversation resource to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation" - }] - }, - "conversationId": { - "description": "Optional. A unique ID for the new conversation. This ID will become the final\ncomponent of the conversation's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", - "type": "string" - }, - "redactionConfig": { - "description": "Optional. DLP settings for transcript redaction. Will default to the config specified\nin Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" - }] - }, - "speechConfig": { - "description": "Optional. Speech-to-Text configuration. Will default to the config specified\nin Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" - }] - } - }, - "required": [ - "parent", - "conversation" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1Conversation": { - "description": "The conversation resource.", - "type": "object", - "properties": { - "callMetadata": { - "description": "Call-specific metadata.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata" - }] - }, - "expireTime": { - "description": "The time at which this conversation should expire. After this time, the\nconversation data and any associated analyses will be deleted.", - "type": "string", - "format": "date-time" - }, - "ttl": { - "description": "Input only. The TTL for this resource. If specified, then this TTL will\nbe used to calculate the expire time.", - "writeOnly": true, - "type": "string", - "format": "google-duration" - }, - "name": { - "description": "Immutable. The resource name of the conversation.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}", - "x-google-immutable": true, - "type": "string" - }, - "dataSource": { - "description": "The source of the audio and transcription for the conversation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource" - }] - }, - "createTime": { - "description": "Output only. The time at which the conversation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the conversation was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "startTime": { - "description": "The time at which the conversation started.", - "type": "string", - "format": "date-time" - }, - "languageCode": { - "description": "A user-specified language code for the conversation.", - "type": "string" - }, - "agentId": { - "description": "An opaque, user-specified string representing the human agent who handled\nthe conversation.", - "type": "string" - }, - "customerId": { - "description": "An opaque, user-specified string representing the customer identifier.", - "type": "string" - }, - "labels": { - "description": "A map for the user to specify any custom fields. A maximum of 100 labels\nper conversation is allowed, with a maximum of 256 characters per entry.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "qualityMetadata": { - "description": "Conversation metadata related to quality management.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata" - }] - }, - "metadataJson": { - "description": "Input only. JSON metadata encoded as a string.\nThis field is primarily used by Insights integrations with various\ntelephony systems and must be in one of Insight's supported formats.", - "writeOnly": true, - "type": "string" - }, - "transcript": { - "description": "Output only. The conversation transcript.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript" - }] - }, - "medium": { - "description": "Immutable. The conversation medium.", - "x-google-immutable": true, - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "The format for conversations that took place over the phone.", - "The format for conversations that took place over chat." - ], - "enum": [ - "MEDIUM_UNSPECIFIED", - "PHONE_CALL", - "CHAT" - ] - }, - "duration": { - "description": "Output only. The duration of the conversation.", - "readOnly": true, - "type": "string", - "format": "google-duration" - }, - "turnCount": { - "description": "Output only. The number of turns in the conversation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "latestAnalysis": { - "description": "Output only. The conversation's latest analysis, if one exists.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis" - }] - }, - "latestSummary": { - "description": "Output only. Latest summary of the conversation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" - }] - }, - "runtimeAnnotations": { - "description": "Output only. The annotations that were generated during the customer and agent\ninteraction.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" - } - }, - "dialogflowIntents": { - "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a\nDialogflow intent, format:\nprojects/{project}/agent/{agent}/intents/{intent}", - "readOnly": true, - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent" - } - }, - "obfuscatedUserId": { - "description": "Obfuscated user ID which the customer sent to us.", - "type": "string" - }, - "dialogflowCxConversationData": { - "description": "The Dialogflow conversation raw data. It will only be populated when\nConversationView is DF_CONVERSATION_BASIC or DF_CONVERSATION_FULL.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationData" - }] - }, - "aaSupervisorMonitoringStatus": { - "description": "Output only. Data from the monitoring status of a conversation by a human supervisor in\nAA. A human supervisor is a human agent that is monitoring virtual agent\nconversations.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationAgentAssistSupervisorMonitoringStatus" - }] - }, - "correlationInfo": { - "description": "Output only. Info for correlating across conversations.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata": { - "description": "Call-specific metadata.", - "type": "object", - "properties": { - "customerChannel": { - "description": "The audio channel that contains the customer.", - "type": "integer", - "format": "int32" - }, - "agentChannel": { - "description": "The audio channel that contains the agent.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource": { - "description": "The conversation source, which is a combination of transcript and audio.", - "type": "object", - "properties": { - "gcsSource": { - "description": "A Cloud Storage location specification for the audio and transcript.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource" - }] - }, - "dialogflowSource": { - "description": "The source when the conversation comes from Dialogflow.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource" - }] - }, - "metadataUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation\nmetadata.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1GcsSource": { - "description": "A Cloud Storage source of conversation data.", - "type": "object", - "properties": { - "audioUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", - "type": "string" - }, - "transcriptUri": { - "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation\ntranscript.", - "x-google-immutable": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource": { - "description": "A Dialogflow source of conversation data.", - "type": "object", - "properties": { - "dialogflowConversation": { - "description": "Output only. The name of the Dialogflow conversation that this conversation\nresource is derived from. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}", - "readOnly": true, - "type": "string" - }, - "audioUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata": { - "description": "Conversation metadata related to quality management.", - "type": "object", - "properties": { - "customerSatisfactionRating": { - "description": "An arbitrary integer value indicating the customer's satisfaction rating.", - "type": "integer", - "format": "int32" - }, - "waitDuration": { - "description": "The amount of time the customer waited to connect with an agent.", - "type": "string", - "format": "google-duration" - }, - "menuPath": { - "description": "An arbitrary string value specifying the menu path the customer took.", - "type": "string" - }, - "agentInfo": { - "description": "Information about agents involved in the call.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" - } - }, - "feedbackLabels": { - "description": "Input only. The feedback labels associated with the conversation.", - "writeOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo": { - "description": "Information about an agent involved in the conversation.", - "type": "object", - "properties": { - "agentId": { - "description": "A user-specified string representing the agent.", - "type": "string" - }, - "displayName": { - "description": "The agent's name.", - "type": "string" - }, - "team": { - "description": "A user-specified string representing the agent's team. Deprecated in\nfavor of the `teams` field.", - "deprecated": true, - "type": "string" - }, - "teams": { - "description": "User-specified strings representing the agent's teams.", - "type": "array", - "items": { - "type": "string" - } - }, - "dispositionCode": { - "description": "A user-provided string indicating the outcome of the agent's segment of\nthe call.", - "type": "string" - }, - "agentType": { - "description": "The agent type, e.g. HUMAN_AGENT.", - "type": "string", - "x-google-enum-descriptions": [ - "Participant's role is not set.", - "Participant is a human agent.", - "Participant is an automated agent.", - "Participant is an end user who conversed with the contact center.", - "Participant is either a human or automated agent." - ], - "enum": [ - "ROLE_UNSPECIFIED", - "HUMAN_AGENT", - "AUTOMATED_AGENT", - "END_USER", - "ANY_AGENT" - ] - }, - "location": { - "description": "The agent's location.", - "type": "string" - }, - "deploymentId": { - "description": "The agent's deployment ID. Only applicable to automated agents.", - "type": "string" - }, - "deploymentDisplayName": { - "description": "The agent's deployment display name. Only applicable to automated\nagents.", - "type": "string" - }, - "versionId": { - "description": "The agent's version ID. Only applicable to automated agents.", - "type": "string" - }, - "versionDisplayName": { - "description": "The agent's version display name. Only applicable to automated agents.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript": { - "description": "A message representing the transcript of a conversation.", - "type": "object", - "properties": { - "transcriptSegments": { - "description": "A list of sequential transcript segments that comprise the conversation.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment": { - "description": "A segment of a full transcript.", - "type": "object", - "properties": { - "messageTime": { - "description": "The time that the message occurred, if provided.", - "type": "string", - "format": "date-time" - }, - "text": { - "description": "The text of this segment.", - "type": "string" - }, - "confidence": { - "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nsegment. A default value of 0.0 indicates that the value is unset.", - "type": "number", - "format": "float" - }, - "words": { - "description": "A list of the word-specific information for each word in the segment.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo" - } - }, - "languageCode": { - "description": "The language code of this segment as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".", - "type": "string" - }, - "channelTag": { - "description": "For conversations derived from multi-channel audio, this is the channel\nnumber corresponding to the audio from that channel. For\naudioChannelCount = N, its output values can range from '1' to 'N'. A\nchannel tag of 0 indicates that the audio is mono.", - "type": "integer", - "format": "int32" - }, - "segmentParticipant": { - "description": "The participant of this segment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant" - }] - }, - "dialogflowSegmentMetadata": { - "description": "CCAI metadata relating to the current transcript segment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" - }] - }, - "sentiment": { - "description": "The sentiment for this transcript segment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo": { - "description": "Word-level info for words in a transcript.", - "type": "object", - "properties": { - "startOffset": { - "description": "Time offset of the start of this word relative to the beginning of\nthe total conversation.", - "type": "string", - "format": "google-duration" - }, - "endOffset": { - "description": "Time offset of the end of this word relative to the beginning of the\ntotal conversation.", - "type": "string", - "format": "google-duration" - }, - "word": { - "description": "The word itself. Includes punctuation marks that surround the word.", - "type": "string" - }, - "confidence": { - "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nword. A default value of 0.0 indicates that the value is unset.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant": { - "description": "The call participant speaking for a given utterance.", - "type": "object", - "properties": { - "dialogflowParticipantName": { - "description": "The name of the participant provided by Dialogflow. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", - "type": "string" - }, - "userId": { - "description": "A user-specified ID representing the participant.", - "type": "string" - }, - "dialogflowParticipant": { - "description": "Deprecated. Use `dialogflow_participant_name` instead.\nThe name of the Dialogflow participant. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", - "deprecated": true, - "type": "string" - }, - "obfuscatedExternalUserId": { - "description": "Obfuscated user ID from Dialogflow.", - "type": "string" - }, - "role": { - "description": "The role of the participant.", - "type": "string", - "x-google-enum-descriptions": [ - "Participant's role is not set.", - "Participant is a human agent.", - "Participant is an automated agent.", - "Participant is an end user who conversed with the contact center.", - "Participant is either a human or automated agent." - ], - "enum": [ - "ROLE_UNSPECIFIED", - "HUMAN_AGENT", - "AUTOMATED_AGENT", - "END_USER", - "ANY_AGENT" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { - "description": "Metadata from Dialogflow relating to the current transcript segment.", - "type": "object", - "properties": { - "smartReplyAllowlistCovered": { - "description": "Whether the transcript segment was covered under the configured smart\nreply allowlist in Agent Assist.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1SentimentData": { - "description": "The data for a sentiment annotation.", - "type": "object", - "properties": { - "magnitude": { - "description": "A non-negative number from 0 to infinity which represents the absolute\nmagnitude of sentiment regardless of score.", - "type": "number", - "format": "float" - }, - "score": { - "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", - "type": "number", - "format": "float" - }, - "rationale": { - "description": "The rationale for the sentiment result.", - "type": "string" - }, - "modelType": { - "description": "The sentiment model used to produce the sentiment result.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified model type.", - "V1 model.", - "V2 LLM model." - ], - "enum": [ - "SENTIMENT_MODEL_TYPE_UNSPECIFIED", - "SENTIMENT_MODEL_TYPE_V1", - "SENTIMENT_MODEL_TYPE_V2" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1Analysis": { - "description": "The analysis resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the analysis.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", - "x-google-immutable": true, - "type": "string" - }, - "requestTime": { - "description": "Output only. The time at which the analysis was requested.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "createTime": { - "description": "Output only. The time at which the analysis was created, which occurs when the\nlong-running operation completes.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "analysisResult": { - "description": "Output only. The result of the analysis, which is populated when the analysis\nfinishes.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult" - }] - }, - "annotatorSelector": { - "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult": { - "description": "The result of an analysis.", - "type": "object", - "properties": { - "callAnalysisMetadata": { - "description": "Call-specific metadata created by the analysis.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata" - }] - }, - "endTime": { - "description": "The time at which the analysis ended.", - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata": { - "description": "Call-specific metadata created during analysis.", - "type": "object", - "properties": { - "annotations": { - "description": "A list of call annotations that apply to this call.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation" - } - }, - "entities": { - "description": "All the entities in the call.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity" - } - }, - "sentiments": { - "description": "Overall conversation-level sentiment for each channel of the call.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment" - } - }, - "silence": { - "description": "Overall conversation-level silence during the call.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence" - }] - }, - "intents": { - "description": "All the matched intents in the call.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent" - } - }, - "phraseMatchers": { - "description": "All the matched phrase matchers in the call.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" - } - }, - "issueModelResult": { - "description": "Overall conversation-level issue modeling result.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult" - }] - }, - "semanticMatchMetadata": { - "description": "Metadata used in the semantic match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SemanticMatchMetadata" - }] - }, - "qaScorecardResults": { - "description": "Results of scoring QaScorecards.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation": { - "description": "A piece of metadata that applies to a window of a call.", - "type": "object", - "properties": { - "interruptionData": { - "description": "Data specifying an interruption.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData" - }] - }, - "sentimentData": { - "description": "Data specifying sentiment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData" - }] - }, - "silenceData": { - "description": "Data specifying silence.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData" - }] - }, - "holdData": { - "description": "Data specifying a hold.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1HoldData" - }] - }, - "entityMentionData": { - "description": "Data specifying an entity mention.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData" - }] - }, - "intentMatchData": { - "description": "Data specifying an intent match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IntentMatchData" - }] - }, - "phraseMatchData": { - "description": "Data specifying a phrase match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" - }] - }, - "issueMatchData": { - "description": "Data specifying an issue match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData" - }] - }, - "channelTag": { - "description": "The channel of the audio where the annotation occurs. For single-channel\naudio, this field is not populated.", - "type": "integer", - "format": "int32" - }, - "annotationStartBoundary": { - "description": "The boundary in the conversation where the annotation starts, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" - }] - }, - "annotationEndBoundary": { - "description": "The boundary in the conversation where the annotation ends, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1InterruptionData": { - "description": "The data for an interruption annotation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1SilenceData": { - "description": "The data for a silence annotation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1HoldData": { - "description": "The data for a hold annotation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData": { - "description": "The data for an entity mention annotation.\nThis represents a mention of an `Entity` in the conversation.", - "type": "object", - "properties": { - "entityUniqueId": { - "description": "The key of this entity in conversation entities.\nCan be used to retrieve the exact `Entity` this mention is attached to.", - "type": "string" - }, - "type": { - "description": "The type of the entity mention.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Proper noun.", - "Common noun (or noun compound)." - ], - "enum": [ - "MENTION_TYPE_UNSPECIFIED", - "PROPER", - "COMMON" - ] - }, - "sentiment": { - "description": "Sentiment expressed for this mention of the entity.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData": { - "description": "The data for an intent match.\nRepresents an intent match for a text segment in the conversation. A text\nsegment can be part of a sentence, a complete sentence, or an utterance\nwith multiple sentences.", - "type": "object", - "properties": { - "intentUniqueId": { - "description": "The id of the matched intent.\nCan be used to retrieve the corresponding intent information.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData": { - "description": "The data for a matched phrase matcher.\nRepresents information identifying a phrase matcher for a given match.", - "type": "object", - "properties": { - "phraseMatcher": { - "description": "The unique identifier (the resource name) of the phrase matcher.", - "type": "string" - }, - "displayName": { - "description": "The human-readable name of the phrase matcher.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData": { - "description": "The data for an issue match annotation.", - "type": "object", - "properties": { - "issueAssignment": { - "description": "Information about the issue's assignment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment": { - "description": "Information about the issue.", - "type": "object", - "properties": { - "issue": { - "description": "Resource name of the assigned issue.", - "type": "string" - }, - "score": { - "description": "Score indicating the likelihood of the issue assignment.\ncurrently bounded on [0,1].", - "type": "number", - "format": "double" - }, - "displayName": { - "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis\nand immutable since then.", - "x-google-immutable": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary": { - "description": "A point in a conversation that marks the start or the end of an annotation.", - "type": "object", - "properties": { - "wordIndex": { - "description": "The word index of this boundary with respect to the first word in the\ntranscript piece. This index starts at zero.", - "type": "integer", - "format": "int32" - }, - "transcriptIndex": { - "description": "The index in the sequence of transcribed pieces of the conversation where\nthe boundary is located. This index starts at zero.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1Entity": { - "description": "The data for an entity annotation.\nRepresents a phrase in the conversation that is a known entity, such\nas a person, an organization, or location.", - "type": "object", - "properties": { - "displayName": { - "description": "The representative name for the entity.", - "type": "string" - }, - "type": { - "description": "The entity type.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Person.", - "Location.", - "Organization.", - "Event.", - "Artwork.", - "Consumer product.", - "Other types of entities.", - "Phone number.\n\nThe metadata lists the phone number (formatted according to local\nconvention), plus whichever additional elements appear in the text:\n\n* `number` - The actual number, broken down into sections according to\nlocal convention.\n* `national_prefix` - Country code, if detected.\n* `area_code` - Region or area code, if detected.\n* `extension` - Phone extension (to be dialed after connection), if\ndetected.", - "Address.\n\nThe metadata identifies the street number and locality plus whichever\nadditional elements appear in the text:\n\n* `street_number` - Street number.\n* `locality` - City or town.\n* `street_name` - Street/route name, if detected.\n* `postal_code` - Postal code, if detected.\n* `country` - Country, if detected.\n* `broad_region` - Administrative area, such as the state, if detected.\n* `narrow_region` - Smaller administrative area, such as county, if\ndetected.\n* `sublocality` - Used in Asian addresses to demark a district within a\ncity, if detected.", - "Date.\n\nThe metadata identifies the components of the date:\n\n* `year` - Four digit year, if detected.\n* `month` - Two digit month number, if detected.\n* `day` - Two digit day number, if detected.", - "Number.\n\nThe metadata is the number itself.", - "Price.\n\nThe metadata identifies the `value` and `currency`." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "PERSON", - "LOCATION", - "ORGANIZATION", - "EVENT", - "WORK_OF_ART", - "CONSUMER_GOOD", - "OTHER", - "PHONE_NUMBER", - "ADDRESS", - "DATE", - "NUMBER", - "PRICE" - ] - }, - "metadata": { - "description": "Metadata associated with the entity.\n\nFor most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)\nand Knowledge Graph MID (`mid`), if they are available. For the metadata\nassociated with other entity types, see the Type table below.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "salience": { - "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.", - "type": "number", - "format": "float" - }, - "sentiment": { - "description": "The aggregate sentiment expressed for this entity in the conversation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment": { - "description": "One channel of conversation-level sentiment data.", - "type": "object", - "properties": { - "channelTag": { - "description": "The channel of the audio that the data applies to.", - "type": "integer", - "format": "int32" - }, - "sentimentData": { - "description": "Data specifying sentiment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence": { - "description": "Conversation-level silence data.", - "type": "object", - "properties": { - "silenceDuration": { - "description": "Amount of time calculated to be in silence.", - "type": "string", - "format": "google-duration" - }, - "silencePercentage": { - "description": "Percentage of the total conversation spent in silence.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1Intent": { - "description": "The data for an intent.\nRepresents a detected intent in the conversation, for example MAKES_PROMISE.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the intent.", - "type": "string" - }, - "displayName": { - "description": "The human-readable name of the intent.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult": { - "description": "Issue Modeling result on a conversation.", - "type": "object", - "properties": { - "issueModel": { - "description": "Issue model that generates the result.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", - "type": "string" - }, - "issues": { - "description": "All the matched issues.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1SemanticMatchMetadata": { - "description": "Semantic match metadata used in an analysis.", - "type": "object", - "properties": { - "issueModel": { - "description": "Issue model that's used in the semantic match.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult": { - "description": "The results of scoring a single conversation against a QaScorecard. Contains\na collection of QaAnswers and aggregate score.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The name of the scorecard result.\nFormat:\nprojects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", - "x-google-identifier": true, - "type": "string" - }, - "qaScorecardRevision": { - "description": "The QaScorecardRevision scored by this result.", - "type": "string" - }, - "conversation": { - "description": "The conversation scored by this result.", - "type": "string" - }, - "createTime": { - "description": "Output only. The timestamp that the revision was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "agentId": { - "description": "ID of the agent that handled the conversation.", - "type": "string" - }, - "qaAnswers": { - "description": "Set of QaAnswers represented in the result.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswer" - } - }, - "score": { - "description": "The overall numerical score of the result, incorporating any manual edits\nif they exist.", - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "The normalized score, which is the score divided by the potential score.\nAny manual edits are included if they exist.", - "type": "number", - "format": "double" - }, - "qaTagResults": { - "description": "Collection of tags and their scores.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" - } - }, - "scoreSources": { - "description": "List of all individual score sets.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaAnswer": { - "description": "An answer to a QaQuestion.", - "type": "object", - "properties": { - "qaQuestion": { - "description": "The QaQuestion answered by this answer.", - "type": "string" - }, - "conversation": { - "description": "The conversation the answer applies to.", - "type": "string" - }, - "questionBody": { - "description": "Question text. E.g., \"Did the agent greet the customer?\"", - "type": "string" - }, - "answerValue": { - "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" - }] - }, - "tags": { - "description": "User-defined list of arbitrary tags. Matches the value from\nQaScorecard.ScorecardQuestion.tags. Used for grouping/organization and\nfor weighting the score of each answer.", - "type": "array", - "items": { - "type": "string" - } - }, - "answerSources": { - "description": "Lists all answer sources containing one or more answer values of a\nspecific source type, e.g., all system-generated answer sources, or all\nmanual edit answer sources.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource": { - "description": "A question may have multiple answers from varying sources, one of which\nbecomes the \"main\" answer above. AnswerSource represents each individual\nanswer.", - "type": "object", - "properties": { - "sourceType": { - "description": "What created the answer.", - "type": "string", - "x-google-enum-descriptions": [ - "Source type is unspecified.", - "Answer was system-generated; created during an Insights analysis.", - "Answer was created by a human via manual edit." - ], - "enum": [ - "SOURCE_TYPE_UNSPECIFIED", - "SYSTEM_GENERATED", - "MANUAL_EDIT" - ] - }, - "answerValue": { - "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult": { - "description": "Tags and their corresponding results.", - "type": "object", - "properties": { - "tag": { - "description": "The tag the score applies to.", - "type": "string" - }, - "score": { - "description": "The score the tag applies to.", - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "The potential score the tag applies to.", - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "The normalized score the tag applies to.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource": { - "description": "A scorecard result may have multiple sets of scores from varying sources,\none of which becomes the \"main\" answer above. A ScoreSource represents\neach individual set of scores.", - "type": "object", - "properties": { - "sourceType": { - "description": "What created the score.", - "type": "string", - "x-google-enum-descriptions": [ - "Source type is unspecified.", - "Score is derived only from system-generated answers.", - "Score is derived from both system-generated answers, and includes\nany manual edits if they exist." - ], - "enum": [ - "SOURCE_TYPE_UNSPECIFIED", - "SYSTEM_GENERATED_ONLY", - "INCLUDES_MANUAL_EDITS" - ] - }, - "score": { - "description": "The overall numerical score of the result.", - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "The normalized score, which is the score divided by the potential score.", - "type": "number", - "format": "double" - }, - "qaTagResults": { - "description": "Collection of tags and their scores.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData": { - "description": "Conversation summarization suggestion data.", - "type": "object", - "properties": { - "text": { - "description": "The summarization content that is concatenated into one string.", - "type": "string" - }, - "textSections": { - "description": "The summarization content that is divided into sections. The key is the\nsection's name and the value is the section's content. There is no\nspecific format for the key or value.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "confidence": { - "description": "The confidence score of the summarization.", - "type": "number", - "format": "float" - }, - "metadata": { - "description": "A map that contains metadata about the summarization and the document\nfrom which it originates.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "answerRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - }, - "conversationModel": { - "description": "The name of the model that generates this summary.\nFormat:\nprojects/{project}/locations/{location}/conversationModels/{conversation_model}", - "type": "string" - }, - "generatorId": { - "description": "Agent Assist generator ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation": { - "description": "An annotation that was generated during the customer and agent interaction.", - "type": "object", - "properties": { - "articleSuggestion": { - "description": "Agent Assist Article Suggestion data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData" - }] - }, - "faqAnswer": { - "description": "Agent Assist FAQ answer data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData" - }] - }, - "smartReply": { - "description": "Agent Assist Smart Reply data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData" - }] - }, - "smartComposeSuggestion": { - "description": "Agent Assist Smart Compose suggestion data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData" - }] - }, - "dialogflowInteraction": { - "description": "Dialogflow interaction data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData" - }] - }, - "conversationSummarizationSuggestion": { - "description": "Conversation summarization suggestion data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" - }] - }, - "annotationId": { - "description": "The unique identifier of the annotation.\nFormat:\nprojects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", - "type": "string" - }, - "createTime": { - "description": "The time at which this annotation was created.", - "type": "string", - "format": "date-time" - }, - "startBoundary": { - "description": "The boundary in the conversation where the annotation starts, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" - }] - }, - "endBoundary": { - "description": "The boundary in the conversation where the annotation ends, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" - }] - }, - "answerFeedback": { - "description": "The feedback that the customer has about the answer in `data`.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback" - }] - }, - "userInput": { - "description": "Explicit input used for generating the answer", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData": { - "description": "Agent Assist Article Suggestion data.", - "type": "object", - "properties": { - "title": { - "description": "Article title.", - "type": "string" - }, - "uri": { - "description": "Article URI.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this article is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "float" - }, - "metadata": { - "description": "Map that contains metadata about the Article Suggestion and the document\nthat it originates from.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - }, - "source": { - "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData": { - "description": "Agent Assist frequently-asked-question answer data.", - "type": "object", - "properties": { - "answer": { - "description": "The piece of text from the `source` knowledge base document.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this answer is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "float" - }, - "question": { - "description": "The corresponding FAQ question.", - "type": "string" - }, - "metadata": { - "description": "Map that contains metadata about the FAQ answer and the document that\nit originates from.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - }, - "source": { - "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData": { - "description": "Agent Assist Smart Reply data.", - "type": "object", - "properties": { - "reply": { - "description": "The content of the reply.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this reply is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "double" - }, - "metadata": { - "description": "Map that contains metadata about the Smart Reply and the document from\nwhich it originates.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData": { - "description": "Agent Assist Smart Compose suggestion data.", - "type": "object", - "properties": { - "suggestion": { - "description": "The content of the suggestion.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this suggestion is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "double" - }, - "metadata": { - "description": "Map that contains metadata about the Smart Compose suggestion and the\ndocument from which it originates.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData": { - "description": "Dialogflow interaction data.", - "type": "object", - "properties": { - "dialogflowIntentId": { - "description": "The Dialogflow intent resource path. Format:\nprojects/{project}/agent/{agent}/intents/{intent}", - "type": "string" - }, - "confidence": { - "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0\n(completely certain).", - "type": "number", - "format": "float" - }, - "detectIntentRequest": { - "description": "The Dialogflow conversation DetectIntentRequest raw data of this turn. This\nfield will only be populated in the GetConversation response and its data\nformat should be same as Dialogflow [DetectIntentRequest] of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL." - } - }, - "detectIntentResponse": { - "description": "The Dialogflow conversation DetectIntentResponse raw data of this turn.\nThis field will only be populated in the GetConversation response and its\ndata format should be same as Dialogflow DetectIntentResponse of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL." - } - }, - "flowId": { - "description": "The Dialogflow flow id.", - "type": "string" - }, - "flowDisplayName": { - "description": "The Dialogflow flow display name.\nThe Dialogflow environment display name.", - "type": "string" - }, - "pageId": { - "description": "The Dialogflow page ID.", - "type": "string" - }, - "pageDisplayName": { - "description": "The Dialogflow page display name.\nThe Dialogflow environment display name.", - "type": "string" - }, - "intentId": { - "description": "The Dialogflow intent ID.", - "type": "string" - }, - "intentDisplayName": { - "description": "The Dialogflow intent display name.\nThe Dialogflow environment display name.", - "type": "string" - }, - "endFlowOrSession": { - "description": "The turn reaches END_FLOW or END_SESSION.", - "type": "boolean" - }, - "liveAgentHandoff": { - "description": "Whether the turn was handed off to a human agent.", - "type": "boolean" - }, - "inputType": { - "description": "The input type in this turn.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified. Should never be used.", - "Text input.", - "Intent input.", - "Audio input.", - "Event input.", - "DTMF input." - ], - "enum": [ - "INPUT_TYPE_UNSPECIFIED", - "INPUT_TYPE_TEXT", - "INPUT_TYPE_INTENT", - "INPUT_TYPE_AUDIO", - "INPUT_TYPE_EVENT", - "INPUT_TYPE_DTMF" - ] - }, - "matchType": { - "description": "The match type in this turn.", - "type": "string", - "x-google-enum-descriptions": [ - "Not specified. Should never be used.", - "An intent is matched.", - "The input is an intent.", - "The input is for parameter filling.", - "No intent match for the input.", - "Indicates an empty input.", - "The input is an event." - ], - "enum": [ - "MATCH_TYPE_UNSPECIFIED", - "MATCH_TYPE_INTENT", - "MATCH_TYPE_DIRECT_INTENT", - "MATCH_TYPE_PARAMETER_FILLING", - "MATCH_TYPE_NO_MATCH", - "MATCH_TYPE_NO_INPUT", - "MATCH_TYPE_EVENT" - ] - }, - "detectIntentResponseV3": { - "description": "The Dialogflow v3 DetectIntentResponse raw data of this turn.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DetectIntentResponse" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback": { - "description": "The feedback that the customer has about a certain answer in the\nconversation.", - "type": "object", - "properties": { - "correctnessLevel": { - "description": "The correctness level of an answer.", - "type": "string", - "x-google-enum-descriptions": [ - "Correctness level unspecified.", - "Answer is totally wrong.", - "Answer is partially correct.", - "Answer is fully correct." - ], - "enum": [ - "CORRECTNESS_LEVEL_UNSPECIFIED", - "NOT_CORRECT", - "PARTIALLY_CORRECT", - "FULLY_CORRECT" - ] - }, - "clicked": { - "description": "Indicates whether an answer or item was clicked by the human agent.", - "type": "boolean" - }, - "displayed": { - "description": "Indicates whether an answer or item was displayed to the human agent in the\nagent desktop UI.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput": { - "description": "Explicit input used for generating the answer", - "type": "object", - "properties": { - "query": { - "description": "Query text. Article Search uses this to store the input query used\nto generate the search results.", - "type": "string" - }, - "generatorName": { - "description": "The resource name of associated generator. Format:\n`projects//locations//generators/`", - "type": "string" - }, - "querySource": { - "description": "Query source for the answer.", - "type": "string", - "x-google-enum-descriptions": [ - "Unknown query source.", - "The query is from agents.", - "The query is a query from previous suggestions, e.g. from a preceding\nSuggestKnowledgeAssist response.", - "The query is from the end user." - ], - "enum": [ - "QUERY_SOURCE_UNSPECIFIED", - "AGENT_QUERY", - "SUGGESTED_QUERY", - "END_USER_QUERY" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent": { - "description": "The data for a Dialogflow intent.\nRepresents a detected intent in the conversation, e.g. MAKES_PROMISE.", - "type": "object", - "properties": { - "displayName": { - "description": "The human-readable name of the intent.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationData": { - "description": "The metadata for a Dialogflow CX conversation.", - "type": "object", - "properties": { - "virtualAgentId": { - "description": "The virtual agent id of this conversation.", - "type": "string" - }, - "flowIds": { - "description": "The deduped flow UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "flowDisplayNames": { - "description": "The deduped flow display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "pageIds": { - "description": "The deduped page UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "pageDisplayNames": { - "description": "The deduped page display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "intentIds": { - "description": "The deduped intent UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "intentDisplayNames": { - "description": "The deduped intent display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "experimentIds": { - "description": "The deduped experiment UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "experimentDisplayNames": { - "description": "The deduped experiment display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "inputAudioDuration": { - "description": "The total duration of the user input audio in this conversation.", - "type": "string", - "format": "google-duration" - }, - "outputAudioDuration": { - "description": "The total duration of the agent output audio in this conversation.", - "type": "string", - "format": "google-duration" - }, - "queryInputStats": { - "description": "Query input stats", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationDataQueryInputStats" - }] - }, - "matchTypeStats": { - "description": "Match type stats.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationDataMatchTypeStats" - }] - }, - "averageMatchConfidence": { - "description": "Average match confidence for all the initent matches in this conversation.", - "type": "number", - "format": "float" - }, - "endSessionExit": { - "description": "Whether the conversation reaches END_FLOW or END_SESSION.", - "type": "boolean" - }, - "maxWebhookLatency": { - "description": "The maximum webhook latency for an individual webhook call in this\nconversation.", - "type": "string", - "format": "google-duration" - }, - "liveAgentHandoff": { - "description": "Whether the conversation was handed off to a human agent.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationDataQueryInputStats": { - "description": "Count by input types in this conversation", - "type": "object", - "properties": { - "textCount": { - "description": "The number of requests with text input.", - "type": "integer", - "format": "int32" - }, - "intentCount": { - "description": "The number of requests with intent input.", - "type": "integer", - "format": "int32" - }, - "audioCount": { - "description": "The number of requests with audio input.", - "type": "integer", - "format": "int32" - }, - "eventCount": { - "description": "The number of requests with event input.", - "type": "integer", - "format": "int32" - }, - "dtmfCount": { - "description": "The number of requests with DTMF input.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1DialogflowCxConversationDataMatchTypeStats": { - "description": "Count by match types in this conversation .", - "type": "object", - "properties": { - "intentCount": { - "description": "The number of responses with match type INTENT.", - "type": "integer", - "format": "int32" - }, - "directIntentCount": { - "description": "The number of responses with match type DIRECT_INTENT.", - "type": "integer", - "format": "int32" - }, - "parameterFillingCount": { - "description": "The number of responses with match type PARAMETER_FILLING.", - "type": "integer", - "format": "int32" - }, - "noMatchCount": { - "description": "The number of responses with match type NO_MATCH.", - "type": "integer", - "format": "int32" - }, - "noInputCount": { - "description": "The number of responses with match type NO_INPUT.", - "type": "integer", - "format": "int32" - }, - "eventCount": { - "description": "The number of responses with match type EVENT.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationAgentAssistSupervisorMonitoringStatus": { - "description": "Tracks the status of an AA supervisor monitoring a conversation.", - "type": "object", - "properties": { - "monitored": { - "description": "The conversation was monitored by an AA supervisor.", - "type": "boolean" - }, - "escalatedToSupervisor": { - "description": "The conversation was escalated to an AA supervisor for intervention.", - "type": "boolean" - }, - "assignedSupervisor": { - "description": "The ID of the assigned AA supervisor.", - "type": "string" - }, - "transferredToHumanAgent": { - "description": "The conversation was transferred to a human agent by the AA supervisor.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo": { - "description": "Info for correlating across conversations.", - "type": "object", - "properties": { - "fullConversationCorrelationId": { - "description": "Output only. The full conversation correlation id this conversation is a segment of.", - "readOnly": true, - "type": "string" - }, - "mergedFullConversationCorrelationId": { - "description": "Output only. The full conversation correlation id this conversation is a merged\nconversation of.", - "readOnly": true, - "type": "string" - }, - "correlationTypes": { - "description": "Output only. The correlation types of this conversation. A single conversation can\nhave multiple correlation types. For example a conversation that only has\na single segment is both a SEGMENT and a FULL_CONVERSATION.", - "readOnly": true, - "type": "array", - "items": { - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "This conversation represents a segment of a full conversation. The\nlowest level of granularity.", - "This conversation represents a partial conversation of potentially\nmultiple segments but is not a full conversation.", - "This conversation represents a full conversation of potentially\nmultiple segments.", - "This conversation represents a synthetic conversation." - ], - "enum": [ - "CORRELATION_TYPE_UNSPECIFIED", - "SEGMENT", - "PARTIAL", - "FULL", - "SYNTHETIC" - ] - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata": { - "description": "The metadata for a bulk analyze conversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for bulk analyze.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest" - }] - }, - "completedAnalysesCount": { - "description": "The number of requested analyses that have completed successfully so far.", - "type": "integer", - "format": "int32" - }, - "failedAnalysesCount": { - "description": "The number of requested analyses that have failed so far.", - "type": "integer", - "format": "int32" - }, - "totalRequestedAnalysesCount": { - "description": "Total number of analyses requested. Computed by the number of conversations\nreturned by `filter` multiplied by `analysis_percentage` in the request.", - "type": "integer", - "format": "int32" - }, - "partialErrors": { - "description": "Output only. Partial errors during bulk analyze operation that might cause the operation\noutput to be incomplete.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest": { - "description": "The request to analyze conversations in bulk.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource to create analyses in.", - "type": "string" - }, - "filter": { - "description": "Required. Filter used to select the subset of conversations to analyze.", - "type": "string" - }, - "analysisPercentage": { - "description": "Required. Percentage of selected conversation to analyze, between\n[0, 100].", - "type": "number", - "format": "float" - }, - "annotatorSelector": { - "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" - }] - } - }, - "required": [ - "parent", - "filter", - "analysisPercentage" - ] - }, - "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector": { - "description": "Selector of all available annotators and phrase matchers to run.", - "type": "object", - "properties": { - "runInterruptionAnnotator": { - "description": "Whether to run the interruption annotator.", - "type": "boolean" - }, - "runSilenceAnnotator": { - "description": "Whether to run the silence annotator.", - "type": "boolean" - }, - "runPhraseMatcherAnnotator": { - "description": "Whether to run the active phrase matcher annotator(s).", - "type": "boolean" - }, - "phraseMatchers": { - "description": "The list of phrase matchers to run. If not provided, all active phrase\nmatchers will be used. If inactive phrase matchers are provided, they will\nnot be used. Phrase matchers will be run only if\nrun_phrase_matcher_annotator is set to true. Format:\nprojects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", - "type": "array", - "items": { - "type": "string" - } - }, - "runSentimentAnnotator": { - "description": "Whether to run the sentiment annotator.", - "type": "boolean" - }, - "runEntityAnnotator": { - "description": "Whether to run the entity annotator.", - "type": "boolean" - }, - "runIntentAnnotator": { - "description": "Whether to run the intent annotator.", - "type": "boolean" - }, - "runIssueModelAnnotator": { - "description": "Whether to run the issue model annotator. A model should have already been\ndeployed for this to take effect.", - "type": "boolean" - }, - "issueModels": { - "description": "The issue model to run. If not provided, the most recently deployed topic\nmodel will be used. The provided issue model will only be used for\ninference if the issue model is deployed and if run_issue_model_annotator\nis set to true. If more than one issue model is provided, only the first\nprovided issue model will be used for inference.", - "type": "array", - "items": { - "type": "string" - } - }, - "runSummarizationAnnotator": { - "description": "Whether to run the summarization annotator.", - "type": "boolean" - }, - "summarizationConfig": { - "description": "Configuration for the summarization annotator.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig" - }] - }, - "runQaAnnotator": { - "description": "Whether to run the QA annotator.", - "type": "boolean" - }, - "qaConfig": { - "description": "Configuration for the QA annotator.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig": { - "description": "Configuration for summarization.", - "type": "object", - "properties": { - "conversationProfile": { - "description": "Resource name of the Dialogflow conversation profile.\nFormat:\nprojects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", - "type": "string" - }, - "summarizationModel": { - "description": "Default summarization model to be used.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified summarization model.", - "The CCAI baseline model. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead.", - "The CCAI baseline model, V2.0. This model is deprecated and will be\nremoved in the future. We recommend using `generator` instead." - ], - "x-google-enum-deprecated": [ - false, - true, - true - ], - "enum": [ - "SUMMARIZATION_MODEL_UNSPECIFIED", - "BASELINE_MODEL", - "BASELINE_MODEL_V2_0" - ] - }, - "generator": { - "description": "The resource name of the existing created generator. Format:\nprojects//locations//generators/", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig": { - "description": "Configuration for the QA feature.", - "type": "object", - "properties": { - "scorecardList": { - "description": "A manual list of scorecards to score.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList": { - "description": "Container for a list of scorecards.", - "type": "object", - "properties": { - "qaScorecardRevisions": { - "description": "List of QaScorecardRevisions.", - "type": "array", - "items": { - "type": "string" - } - }, - "predefinedQaScorecards": { - "description": "List of predefined scorecards.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainPredefinedQaScorecardType" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse": { - "description": "The response for a bulk analyze conversations operation.", - "type": "object", - "properties": { - "successfulAnalysisCount": { - "description": "Count of successful analyses.", - "type": "integer", - "format": "int32" - }, - "failedAnalysisCount": { - "description": "Count of failed analyses.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata": { - "description": "The metadata for a bulk delete conversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for bulk delete.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during bulk delete conversations operation that might cause\nthe operation output to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest": { - "description": "The request to delete conversations in bulk.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource to delete conversations from.\nFormat:\nprojects/{project}/locations/{location}", - "type": "string" - }, - "filter": { - "description": "Filter used to select the subset of conversations to delete.", - "type": "string" - }, - "maxDeleteCount": { - "description": "Maximum number of conversations to delete.", - "type": "integer", - "format": "int32" - }, - "force": { - "description": "If set to true, all of this conversation's analyses will also be deleted.\nOtherwise, the request will only succeed if the conversation has no\nanalyses.", - "type": "boolean" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse": { - "description": "The response for a bulk delete conversations operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata": { - "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", - "type": "object", - "properties": { - "request": { - "description": "Output only. The original request for delete.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during deletion operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest": { - "description": "Request for the BulkDeleteFeedbackLabels endpoint.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource for new feedback labels.", - "type": "string" - }, - "filter": { - "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", - "type": "string" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse": { - "description": "Response for the BulkDeleteFeedbackLabels endpoint.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata": { - "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for download.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "downloadStats": { - "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest": { - "description": "Request for the BulkDownloadFeedbackLabel endpoint.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource for new feedback labels.", - "type": "string" - }, - "filter": { - "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR)\nand conjunctions (AND).\n\nSupported fields:\n\n* `issue_model_id`\n* `qa_question_id`\n* `qa_scorecard_id`\n* `min_create_time`\n* `max_create_time`\n* `min_update_time`\n* `max_update_time`\n* `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", - "type": "string" - }, - "gcsDestination": { - "description": "A cloud storage bucket destination.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination" - }] - }, - "sheetsDestination": { - "description": "A sheets document destination.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination" - }] - }, - "maxDownloadCount": { - "description": "Optional. Limits the maximum number of feedback labels that will be downloaded.\nThe first `N` feedback labels will be downloaded.", - "type": "integer", - "format": "int32" - }, - "feedbackLabelType": { - "description": "Optional. The type of feedback labels that will be downloaded.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified format", - "Downloaded file will contain all Quality AI labels from the latest\nscorecard revision.", - "Downloaded file will contain only Topic Modeling labels.", - "Agent Assist Summarization labels." - ], - "enum": [ - "FEEDBACK_LABEL_TYPE_UNSPECIFIED", - "QUALITY_AI", - "TOPIC_MODELING", - "AGENT_ASSIST_SUMMARY" - ] - }, - "conversationFilter": { - "description": "Optional. Filter parent conversations to download feedback labels for.\nWhen specified, the feedback labels will be downloaded for the\nconversations that match the filter.\nIf `template_qa_scorecard_id` is set, all the conversations that match the\nfilter will be paired with the questions under the scorecard for labeling.", - "type": "string" - }, - "templateQaScorecardId": { - "description": "Optional. If set, a template for labeling conversations and scorecard questions will\nbe created from the conversation_filter and the questions under the\nscorecard(s). The feedback label `filter` will be ignored.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination": { - "description": "Google Cloud Storage Object details to write the feedback labels to.", - "type": "object", - "properties": { - "format": { - "description": "Required. File format in which the labels will be exported.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified format.", - "CSV format.\n1,000 labels are stored per CSV file by default.", - "JSON format.\n1 label stored per JSON file by default." - ], - "enum": [ - "FORMAT_UNSPECIFIED", - "CSV", - "JSON" - ] - }, - "objectUri": { - "description": "Required. The Google Cloud Storage URI to write the feedback labels to.\nThe file name will be used as a prefix for the files written to the\nbucket if the output needs to be split across multiple files, otherwise\nit will be used as is. The file extension will be appended to the file\nname based on the format selected.\n E.g. `gs://bucket_name/object_uri_prefix`", - "type": "string" - }, - "addWhitespace": { - "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases\nfile size. Only applicable for JSON format.", - "type": "boolean" - }, - "alwaysPrintEmptyFields": { - "description": "Optional. Always print fields with no presence.\nThis is useful for printing fields that are not set, like implicit 0\nvalue or empty lists/maps. Only applicable for JSON format.", - "type": "boolean" - }, - "recordsPerFileCount": { - "description": "Optional. The number of records per file. Applicable for either format.", - "type": "string", - "format": "int64" - } - }, - "required": [ - "format", - "objectUri" - ] - }, - "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination": { - "description": "Google Sheets document details to write the feedback labels to.", - "type": "object", - "properties": { - "spreadsheetUri": { - "description": "Required. The Google Sheets document to write the feedback labels to.\nRetrieved from Google Sheets URI.\nE.g. `https://docs.google.com/spreadsheets/d/1234567890`\nThe spreadsheet must be shared with the Insights P4SA.\nThe spreadsheet ID written to will be returned as `file_names` in the\nBulkDownloadFeedbackLabelsMetadata.", - "type": "string" - }, - "sheetTitle": { - "description": "Optional. The title of the new sheet to write the feedback labels to.", - "type": "string" - } - }, - "required": [ - "spreadsheetUri" - ] - }, - "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats": { - "description": "Statistics for BulkDownloadFeedbackLabels operation.", - "type": "object", - "properties": { - "processedObjectCount": { - "description": "The number of objects processed during the download operation.", - "type": "integer", - "format": "int32" - }, - "successfulDownloadCount": { - "description": "The number of new feedback labels downloaded during this operation.\nDifferent from \"processed\" because some labels might not be downloaded\nbecause an error.", - "type": "integer", - "format": "int32" - }, - "totalFilesWritten": { - "description": "Total number of files written to the provided Cloud Storage bucket.", - "type": "integer", - "format": "int32" - }, - "fileNames": { - "description": "Output only. Full name of the files written to Cloud storage.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse": { - "description": "Response for the BulkDownloadFeedbackLabel endpoint.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainBulkUpdateQaQuestionsMetadata": { - "description": "The metadata for bulk updating QaQuestions.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainBulkUpdateQaQuestionsRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainBulkUpdateQaQuestionsRequest": { - "description": "The request for bulk updating QaQuestions.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource for the bulk update job instance.", - "type": "string" - }, - "qaQuestions": { - "description": "Required. All the questions to be updated", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestion" - } - }, - "updateMask": { - "description": "Optional. All questions will be updated with the same mask.\nAn empty mask will means updating all updatable fields.", - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - }, - "required": [ - "parent", - "qaQuestions" - ] - }, - "GoogleCloudContactcenterinsightsV1mainQaQuestion": { - "description": "A single question to be scored by the Insights QA feature.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The resource name of the question.\nFormat:\nprojects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", - "x-google-identifier": true, - "type": "string" - }, - "abbreviation": { - "description": "Short, descriptive string, used in the UI where it's not practical\nto display the full question body. E.g., \"Greeting\".", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this question was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the question was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "questionType": { - "description": "The type of question.", - "type": "string", - "x-google-enum-descriptions": [ - "The type of the question is unspecified.", - "The default question type. The question is fully customizable by the\nuser.", - "The question type is using a predefined model provided by CCAI\nteams. Users are not allowed to edit the question_body, answer_choices,\nupload feedback labels for the question nor fine-tune the question.\nHowever, users may edit other fields like question tags, question order,\netc." - ], - "enum": [ - "QA_QUESTION_TYPE_UNSPECIFIED", - "CUSTOMIZABLE", - "PREDEFINED" - ] - }, - "questionMedium": { - "description": "The medium of the question.", - "type": "string", - "x-google-enum-descriptions": [ - "The medium of the question is unspecified.", - "The question is for chat conversations and will expect a chat transcript\nto be present before scoring.", - "The question is for voice conversations and does NOT expect any chat\ntranscripts to be present before scoring." - ], - "enum": [ - "QA_QUESTION_MEDIUM_UNSPECIFIED", - "CHAT", - "VOICE" - ] - }, - "qaQuestionDataOptions": { - "description": "Options for configuring the data used to generate the QA question.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionQaQuestionDataOptions" - }] - }, - "predefinedQuestionConfig": { - "description": "The configuration of the predefined question. This field will only be set\nif the Question Type is predefined.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionPredefinedQuestionConfig" - }] - }, - "questionBody": { - "description": "Question text. E.g., \"Did the agent greet the customer?\"", - "type": "string" - }, - "answerInstructions": { - "description": "Instructions describing how to determine the answer.", - "type": "string" - }, - "answerChoices": { - "description": "A list of valid answers to the question, which the LLM must choose from.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoice" - } - }, - "tags": { - "description": "Questions are tagged for categorization and scoring. Tags can either be:\n- Default Tags: These are predefined categories. They are identified by\ntheir string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\").\n- Custom Tags: These are user-defined categories. They are identified by\ntheir full resource name (e.g.,\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}).\nBoth default and custom tags are used to group questions and to influence\nthe scoring of each question.", - "type": "array", - "items": { - "type": "string" - } - }, - "order": { - "description": "Defines the order of the question within its parent scorecard revision.", - "type": "integer", - "format": "int32" - }, - "metrics": { - "description": "Metrics of the underlying tuned LLM over a holdout/test set while fine\ntuning the underlying LLM for the given question. This field will only be\npopulated if and only if the question is part of a scorecard revision that\nhas been tuned.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionMetrics" - }] - }, - "tuningMetadata": { - "description": "Metadata about the tuning operation for the question.This field will only\nbe populated if and only if the question is part of a scorecard revision\nthat has been tuned.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionTuningMetadata" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaQuestionQaQuestionDataOptions": { - "description": "Options for configuring the data used to generate the QA question.", - "type": "object", - "properties": { - "conversationDataOptions": { - "description": "Options for configuring the conversation data used to generate the QA\nquestion.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationDataOptions" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationDataOptions": { - "description": "Options for configuring what metadata is included in the conversation data\nused in QAI and Discovery Engine.", - "type": "object", - "properties": { - "includeDialogflowInteractionData": { - "description": "Whether to include the per turn Dialogflow interaction data in conversation\ntranscript.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaQuestionPredefinedQuestionConfig": { - "description": "Configuration for a predefined question. This field will only be set if the\nQuestion Type is predefined.", - "type": "object", - "properties": { - "type": { - "description": "The type of the predefined question.", - "type": "string", - "x-google-enum-descriptions": [ - "The type of the predefined question is unspecified.", - "A prebuilt classifier classfying the outcome of the conversation.\nFor example, if the customer issue mentioned in a conversation has\nbeen resolved or not.", - "A prebuilt classifier classfying the initiator of the conversation\nescalation. For example, if it was initiated by the customer or the\nagent." - ], - "enum": [ - "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", - "CONVERSATION_OUTCOME", - "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoice": { - "description": "Message representing a possible answer to the question.", - "type": "object", - "properties": { - "key": { - "description": "A short string used as an identifier.", - "type": "string" - }, - "strValue": { - "description": "String value.", - "type": "string" - }, - "numValue": { - "description": "Numerical value.", - "type": "number", - "format": "double" - }, - "boolValue": { - "description": "Boolean value.", - "type": "boolean" - }, - "naValue": { - "description": "A value of \"Not Applicable (N/A)\". If provided, this field may only\nbe set to `true`. If a question receives this answer, it will be\nexcluded from any score calculations.", - "type": "boolean" - }, - "score": { - "description": "Numerical score of the answer, used for generating the overall score of\na QaScorecardResult. If the answer uses na_value, this field is unused.", - "type": "number", - "format": "double" - }, - "nextActionConfig": { - "description": "Configuration for the next action to take if this answerChoice is\nselected for this question.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfig": { - "description": "The configuration for the next action. This is used to configure the next\naction to take if an answer choice is selected.", - "type": "object", - "properties": { - "runChildQaQuestionsAction": { - "description": "The list of questions to evaluate next, i.e., child questions.\nRequirements for this action are the following:\n1. The current question and child questions must be in the same\n scorecard and present in the same scorecard revision.\n2. The current question and child questions must not introduce a\n cycle, i.e., Q1 -> [Q2, Q3], then Q2 -> [Q1] should not be\n allowed, where Q1, Q2, and Q3 are questions.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction" - }] - }, - "terminateChildQaQuestionsAction": { - "description": "Terminate any further evaluation of child questions.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfigRunChildQaQuestionsAction": { - "description": "The configuration for evaluating child questions.", - "type": "object", - "properties": { - "childQaQuestionNames": { - "description": "A list of resource names representing the child questions to evaluate\nnext. The format for each question resource name is:\nprojects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaQuestionAnswerChoiceNextActionConfigTerminateChildQaQuestions": { - "description": "Indicates termination.", - "type": "object", - "properties": { - "terminationType": { - "description": "The type of termination to perform.", - "type": "string", - "x-google-enum-descriptions": [ - "The termination type is unspecified.", - "A failed scorecard would mean the overall scorecard score will be\nzeroed out, i.e., the scorecard score will be 0.", - "The overall scorecard score will be calculated based on the\nscores of the questions answered in the chain up until the last\nscored question that was answered. This is the default behavior." - ], - "enum": [ - "TERMINATION_TYPE_UNSPECIFIED", - "TERMINATE_WITH_SCORECARD_FAILURE", - "TERMINATE_WITH_CALCULATED_SCORE" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaQuestionMetrics": { - "description": "A wrapper representing metrics calculated against a test-set on a LLM that\nwas fine tuned for this question.", - "type": "object", - "properties": { - "accuracy": { - "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the\nmodel gave on the test set.", - "readOnly": true, - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaQuestionTuningMetadata": { - "description": "Metadata about the tuning operation for the question. Will only be set if a\nscorecard containing this question has been tuned.", - "type": "object", - "properties": { - "totalValidLabelCount": { - "description": "Total number of valid labels provided for the question at the time of\ntuining.", - "type": "string", - "format": "int64" - }, - "datasetValidationWarnings": { - "description": "A list of any applicable data validation warnings about the question's\nfeedback labels.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDatasetValidationWarning" - } - }, - "tuningError": { - "description": "Error status of the tuning operation for the question. Will only be set\nif the tuning operation failed.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainBulkUpdateQaQuestionsResponse": { - "description": "The response for bulk updating QaQuestions.", - "type": "object", - "properties": { - "qaQuestions": { - "description": "The QaQuestions that were updated.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestion" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata": { - "description": "Metadata for a create analysis operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "conversation": { - "description": "Output only. The Conversation that this Analysis Operation belongs to.", - "readOnly": true, - "type": "string" - }, - "annotatorSelector": { - "description": "Output only. The annotator selector used for the analysis (if any).", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainCreateDiscoveryRevisionMetadata": { - "description": "Metadata for a discovery revision creation operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The request to create the discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainCreateDiscoveryRevisionRequest" - }] - }, - "progress": { - "description": "The progress of the discovery creation operation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryProgress" - }] - }, - "resultRevision": { - "description": "Output only. The newly created discovery revision resource name.", - "readOnly": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainCreateDiscoveryRevisionRequest": { - "description": "The request to create a discovery revision.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the discovery.", - "type": "string" - }, - "discoveryRevision": { - "description": "Required. The discovery revision to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryRevision" - }] - }, - "discoveryRevisionId": { - "description": "Optional. The ID of the discovery revision to create.", - "type": "string" - } - }, - "required": [ - "parent", - "discoveryRevision" - ] - }, - "GoogleCloudContactcenterinsightsV1mainDiscoveryRevision": { - "description": "The discovery result revision resource. A revision is created when client\nspecifically requests via calling CreateDiscoveryRevision API. This\nusually happens when client is finalizing the feedbacks to previous revision.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Resource name of the DiscoveryRevision.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", - "x-google-identifier": true, - "type": "string" - }, - "snapshot": { - "description": "Output only. The snapshot of the discovery result at this revision.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscovery" - }] - }, - "createTime": { - "description": "Output only. The time at which this discovery result revision was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the discovery result revision was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "feedback": { - "description": "The feedback for the discovery result under source_revision.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryRevisionFeedback" - }] - }, - "inputData": { - "description": "The input data to be used to create this revision.\nWhen not provided, the input data from the source revision will be used.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryInputDataConfig" - }] - }, - "sourceRevision": { - "description": "Immutable. The source of this discovery revision. i.e. this discovery revision is\nthe result of applying changes on top of source_revision. Format:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}", - "x-google-immutable": true, - "type": "string" - }, - "state": { - "description": "Output only. The state of the discovery.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "This value is unused.", - "The discovery is running. There may be discovery results generated but\nthe final list or distributions are not finalized.", - "The discovery is completed. The final list or distributions are\nfinalized." - ], - "enum": [ - "STATE_UNSPECIFIED", - "RUNNING", - "COMPLETED" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDiscovery": { - "description": "The discovery resource.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Resource name of the discovery.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "User provided display name of the discovery. Modifying this will not change\nthe discovery result or behaviour.", - "type": "string" - }, - "languageCode": { - "description": "Immutable. The language code of the discovery results. When drill_down_parent is\nspecified, this field is inherited from the parent discovery.\nWhen neither language_code nor drill_down_parent is specified, defaults to\nen.", - "x-google-immutable": true, - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this discovery was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the discovery was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "drillDownParent": { - "description": "Name of the discovery discovery result this discovery is a drill down of.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}\nIf empty, this discovery is a top level discovery.\nServer enforces at discovery resource creation time that this resource\nreference creates a tree structure and there's no cycle in the resource\nhierarchy. This field should not be updated once the discovery is created.", - "type": "string" - }, - "discoveryGoal": { - "description": "Required. Immutable. User specified goal for the discovery. This field is immutable once the\ndiscovery is created.", - "x-google-immutable": true, - "type": "string" - }, - "inputData": { - "description": "Specs for the input data used for this discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryInputDataConfig" - }] - }, - "customTaxonomy": { - "description": "User provided taxonomy to guide the discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryCustomTaxonomy" - }] - }, - "advancedOptions": { - "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryDiscoveryAdvancedOptions" - }] - } - }, - "required": [ - "discoveryGoal" - ] - }, - "GoogleCloudContactcenterinsightsV1mainDiscoveryInputDataConfig": { - "description": "Configuration for the input data used for discovery.", - "type": "object", - "properties": { - "conversationFilter": { - "description": "Optional. The filter for querying conversations.", - "type": "string" - }, - "maxSampleSize": { - "description": "Optional. Maximum number of conversations to sample.", - "type": "string", - "format": "int64" - }, - "dataset": { - "description": "Optional. The resource name of the Dataset to scope the discovery to.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}\nIf provided, discovery will only run on conversations within this dataset.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDiscoveryCustomTaxonomy": { - "description": "User provided taxonomy to guide the discovery.", - "type": "object", - "properties": { - "taxonomyEntries": { - "description": "Entries in the custom taxonomy.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryCustomTaxonomyTaxonomyEntry" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDiscoveryCustomTaxonomyTaxonomyEntry": { - "description": "A single entry in the custom taxonomy.", - "type": "object", - "properties": { - "displayName": { - "description": "Name of the taxonomy entry.", - "type": "string" - }, - "description": { - "description": "Description of the taxonomy entry.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDiscoveryDiscoveryAdvancedOptions": { - "description": "Advanced options for creating a discovery. Provides additional\nconfiguration options for type of information available to DE and\npreference about output format.", - "type": "object", - "properties": { - "conversationDataOptions": { - "description": "Options for configuring what metadata goes into conversation\ntranscript.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationDataOptions" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDiscoveryRevisionFeedback": { - "description": "Feedback for the discovery results under previous_revision.", - "type": "object", - "properties": { - "resultFeedback": { - "description": "DiscoveryResult level feedback.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryRevisionFeedbackResultFeedback" - } - }, - "revisionFeedback": { - "description": "DiscoveryRevision level feedback.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDiscoveryRevisionFeedbackResultFeedback": { - "description": "Content of a DiscoveryResult level feedback. i.e. Feedback applied\nspecifically to a DiscoveryResult.", - "type": "object", - "properties": { - "result": { - "description": "Resource name of the discovery result this feedback is for.\nThe parent discovery revision of the result must be the same as what's\nspecified in the source_revision field.\nFormat:\nprojects/{project}/locations/{location}/discoveryWorkspaces/{discovery_workspace}/discoveries/{discovery}/revisions/{revision}/results/{result}", - "type": "string" - }, - "feedback": { - "description": "The feedback for the discovery result.", - "type": "string" - }, - "userAction": { - "description": "The user action for the entry feedback.", - "type": "string", - "x-google-enum-descriptions": [ - "Default value.", - "The user wants to remove the discovery result.", - "The user provides an exact replacement for the display name.", - "The user provides an exact replacement for the description.", - "The user provides comments/instructions on how to modify the display\nname.", - "The user provides comments/instructions on how to modify the\ndescription." - ], - "enum": [ - "USER_ACTION_UNSPECIFIED", - "REMOVE", - "SET_DISPLAY_NAME", - "SET_DESCRIPTION", - "SUGGEST_DISPLAY_NAME_EDIT", - "SUGGEST_DESCRIPTION_EDIT" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDiscoveryProgress": { - "description": "Progress information for a discovery.", - "type": "object", - "properties": { - "progressState": { - "description": "Output only. The state of the discovery creation or refinement.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "Default value. This value is unused.", - "The input data is being preprocessed.", - "Summarizing the conversations to extract features.", - "Generating the results based on the features.", - "Calculating the distributions for the results.", - "The discovery is being finalized.", - "The GenerateDiscovery operation has completed successfully." - ], - "enum": [ - "PROGRESS_STATE_UNSPECIFIED", - "PREPROCESSING", - "SUMMARIZING", - "GENERATING_RESULTS", - "COMPUTING_DISTRIBUTIONS", - "FINALIZING", - "SUCCEEDED" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainCreateFaqModelMetadata": { - "description": "Metadata for creating an FAQ model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for creation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainCreateFaqModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainCreateFaqModelRequest": { - "description": "The request to create an FAQ model.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the FAQ model.", - "type": "string" - }, - "faqModel": { - "description": "Required. The FAQ model to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFaqModel" - }] - }, - "faqModelId": { - "description": "Optional. The ID to use for the FAQ model, which will become the final\ncomponent of the FAQ model's resource name.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", - "type": "string" - } - }, - "required": [ - "parent", - "faqModel" - ] - }, - "GoogleCloudContactcenterinsightsV1mainFaqModel": { - "description": "The FAQ model resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the FAQ model.\nFormat:\nprojects/{project}/locations/{location}/faqModels/{faq_model}", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The representative name for the FAQ model.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this FAQ model was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the FAQ model was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "faqEntryCount": { - "description": "Output only. Number of FAQ entries in this FAQ model.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "state": { - "description": "Output only. State of the FAQ model.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Model is not deployed but is ready to deploy.", - "Model is being deleted." - ], - "enum": [ - "STATE_UNSPECIFIED", - "UNDEPLOYED", - "DELETING" - ] - }, - "inputDataConfig": { - "description": "Configs for the input data used to create the FAQ model.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFaqModelInputDataConfig" - }] - }, - "modelTrainingStats": { - "description": "Output only. Immutable. The model statistics on its training data.", - "readOnly": true, - "x-google-immutable": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFaqModelModelStats" - }] - }, - "infobotAgent": { - "description": "Immutable. The resource name of the infobot agent to be used to create generative\nanswers. Format: projects/{project}/locations/{location}/agents/{agent}", - "x-google-immutable": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainFaqModelInputDataConfig": { - "description": "Configs for the input data used to create the FAQ model.", - "type": "object", - "properties": { - "trainingConversationsCount": { - "description": "Output only. Number of conversations used in training. Output only.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "filter": { - "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainFaqModelModelStats": { - "description": "Train/inference statistics for the model.", - "type": "object", - "properties": { - "totalConversationsCount": { - "description": "Total number of conversations analyzed at this point in time.", - "type": "integer", - "format": "int32" - }, - "skippedConversationsCount": { - "description": "Number of analyzed conversations which were skipped e.g. customer\ndisconnected from the call.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata": { - "description": "Metadata for creating an issue.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for creation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainCreateIssueRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest": { - "description": "The request to create an issue.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the issue.", - "type": "string" - }, - "issue": { - "description": "Required. The values for the new issue.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssue" - }] - } - }, - "required": [ - "parent", - "issue" - ] - }, - "GoogleCloudContactcenterinsightsV1mainIssue": { - "description": "The issue resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the issue.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The representative name for the issue.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this issue was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time that this issue was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "representativeConversationNames": { - "description": "Output only. Resource names of the most representative conversations matched.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "sampleUtterances": { - "description": "Output only. Resource names of the sample representative utterances that match to this\nissue.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "source": { - "description": "Source of the topic", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Generated based on the customers data - i.e. topic discovered by model.", - "Taxonomy provided by the customer (topic come from custom taxonomy)." - ], - "enum": [ - "ISSUE_SOURCE_UNSPECIFIED", - "GENERATED", - "CUSTOMER_PROVIDED" - ] - }, - "parentIssues": { - "description": "Unique identifiers of the parent topics for hierarchical representation.\nFormat is\n`projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}`", - "type": "array", - "items": { - "type": "string" - } - }, - "alternatives": { - "description": "Additional topic descriptions.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueAlternative" - } - }, - "displayDescription": { - "description": "Representative description of the issue.", - "type": "string" - }, - "matchTarget": { - "description": "Target used for semantic similarity comparisons.\nPopulated on V2 models if the display name was renamed.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIssueAlternative": { - "description": "Alternative topic names or descriptions to improve inference.", - "type": "object", - "properties": { - "alternative": { - "description": "An alternative topic name.", - "type": "string" - }, - "description": { - "description": "An alternative topic description.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata": { - "description": "Metadata for creating an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for creation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest": { - "description": "The request to create an issue model.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the issue model.", - "type": "string" - }, - "issueModel": { - "description": "Required. The issue model to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModel" - }] - } - }, - "required": [ - "parent", - "issueModel" - ] - }, - "GoogleCloudContactcenterinsightsV1mainIssueModel": { - "description": "The issue model resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the issue model.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The representative name for the issue model.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this issue model was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the issue model was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "issueCount": { - "description": "Output only. Number of issues in this issue model.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "state": { - "description": "Output only. State of the model.", - "readOnly": true, - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Model is not deployed but is ready to deploy.", - "Model is being deployed.", - "Model is deployed and is ready to be used. A model can only be used in\nanalysis if it's in this state.", - "Model is being undeployed.", - "Model is being deleted." - ], - "enum": [ - "STATE_UNSPECIFIED", - "UNDEPLOYED", - "DEPLOYING", - "DEPLOYED", - "UNDEPLOYING", - "DELETING" - ] - }, - "inputDataConfig": { - "description": "Configs for the input data that used to create the issue model.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig" - }] - }, - "trainingStats": { - "description": "Output only. Immutable. The issue model's label statistics on its training data.", - "readOnly": true, - "x-google-immutable": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats" - }] - }, - "modelType": { - "description": "Type of the model.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified model type.", - "Type V1.", - "Type V2." - ], - "enum": [ - "MODEL_TYPE_UNSPECIFIED", - "TYPE_V1", - "TYPE_V2" - ] - }, - "languageCode": { - "description": "Language of the model.", - "type": "string" - }, - "multiLingualMatch": { - "description": "Whether the model can be used for analysis with conversations in multiple\nlanguages. The topic names and descriptions will be in the `language_code`\nspecified, but the matching will be performed against conversations in any\nlanguage.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig": { - "description": "Configs for the input data used to create the issue model.", - "type": "object", - "properties": { - "medium": { - "description": "Medium of conversations used in training data. This field is being\ndeprecated. To specify the medium to be used in training a new issue\nmodel, set the `medium` field on `filter`.", - "deprecated": true, - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "The format for conversations that took place over the phone.", - "The format for conversations that took place over chat." - ], - "enum": [ - "MEDIUM_UNSPECIFIED", - "PHONE_CALL", - "CHAT" - ] - }, - "trainingConversationsCount": { - "description": "Output only. Number of conversations used in training. Output only.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "filter": { - "description": "A filter to reduce the conversations used for training the model to a\nspecific subset.\nRefer to https://cloud.google.com/contact-center/insights/docs/filtering\nfor details.", - "type": "string" - }, - "customTaxonomy": { - "description": "Custom supplied taxonomy.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelCustomTaxonomy" - }] - }, - "issueGranularity": { - "description": "Issue granularity preference for model training.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Granularity much coarser than default.", - "Granularity coarser than default.", - "Default granularity.", - "Granularity finer than default.", - "Granularity much finer than default." - ], - "enum": [ - "ISSUE_GRANULARITY_UNSPECIFIED", - "MORE_COARSE", - "COARSE", - "STANDARD", - "FINE", - "MORE_FINE" - ] - }, - "industry": { - "description": "Customer industry, used to improve specificity of the topic model.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIssueModelCustomTaxonomy": { - "description": "Structure for custom supplied taxonomy. A custom taxonomy consists of\nmultiple taxonomy entries organized in a hierarchical way.", - "type": "object", - "properties": { - "taxonomyEntries": { - "description": "List of taxonomy entries.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelCustomTaxonomyTaxonomyEntry" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIssueModelCustomTaxonomyTaxonomyEntry": { - "description": "Structure for a taxonomy entry.", - "type": "object", - "properties": { - "id": { - "description": "Immutable. The Id of the taxonomy entry", - "x-google-immutable": true, - "type": "string" - }, - "displayName": { - "description": "The content of the taxonomy entry.", - "type": "string" - }, - "parents": { - "description": "Ids of parent taxonomy entries.", - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "description": "The description of the taxonomy entry.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats": { - "description": "Aggregated statistics about an issue model.", - "type": "object", - "properties": { - "analyzedConversationsCount": { - "description": "Number of conversations the issue model has analyzed at this point in time.", - "type": "string", - "format": "int64" - }, - "unclassifiedConversationsCount": { - "description": "Number of analyzed conversations for which no issue was applicable at this\npoint in time.", - "type": "string", - "format": "int64" - }, - "issueStats": { - "description": "Statistics on each issue. Key is the issue's resource name.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats": { - "description": "Aggregated statistics about an issue.", - "type": "object", - "properties": { - "issue": { - "description": "Issue resource.\nFormat:\nprojects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", - "type": "string" - }, - "labeledConversationsCount": { - "description": "Number of conversations attached to the issue at this point in time.", - "type": "string", - "format": "int64" - }, - "displayName": { - "description": "Display name of the issue.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDeleteFaqModelMetadata": { - "description": "Metadata for deleting an FAQ model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for deletion.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDeleteFaqModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDeleteFaqModelRequest": { - "description": "The request to delete an FAQ model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The name of the FAQ model to delete.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata": { - "description": "Metadata for deleting an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for deletion.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest": { - "description": "The request to delete an issue model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The name of the issue model to delete.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata": { - "description": "The metadata for deleting a QaQuestionTag Resource.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest": { - "description": "The request for deleting a QaQuestionTag.", - "type": "object", - "properties": { - "name": { - "description": "Required. The name of the QaQuestionTag to delete.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata": { - "description": "Metadata for deploying an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for deployment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest": { - "description": "The request to deploy an issue model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The issue model to deploy.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse": { - "description": "The response to deploy an issue model.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata": { - "description": "Metadata for an export insights operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for export.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during export operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "completedExportCount": { - "description": "The number of conversations that were exported successfully.", - "type": "integer", - "format": "int32" - }, - "failedExportCount": { - "description": "The number of conversations that failed to be exported.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest": { - "description": "The request to export insights.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource to export data from.", - "type": "string" - }, - "bigQueryDestination": { - "description": "Specified if sink is a BigQuery table.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination" - }] - }, - "filter": { - "description": "A filter to reduce results to a specific subset. Useful for exporting\nconversations with specific properties.", - "type": "string" - }, - "kmsKey": { - "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK.\nFormat:\nprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", - "type": "string" - }, - "writeDisposition": { - "description": "Options for what to do if the destination table already exists.", - "type": "string", - "x-google-enum-descriptions": [ - "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", - "If the table already exists, BigQuery will overwrite the table data and\nuse the schema from the load.", - "If the table already exists, BigQuery will append data to the table." - ], - "enum": [ - "WRITE_DISPOSITION_UNSPECIFIED", - "WRITE_TRUNCATE", - "WRITE_APPEND" - ] - }, - "exportSchemaVersion": { - "description": "Optional. Version of the export schema.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified. Defaults to EXPORT_V3.", - "Export schema version 1.", - "Export schema version 2.", - "Export schema version 3.", - "Export schema version 4.", - "Export schema version 5.", - "Export schema version 6.", - "Export schema version 7.", - "Export schema version 8.", - "Export schema version 9.", - "Export schema version 10.", - "Export schema version 11.", - "Export schema version 12.", - "Export schema version 13.", - "Export schema version 14.", - "Export schema version 15.", - "Export schema version 16.", - "Export schema version 17.", - "Export schema version latest available." - ], - "enum": [ - "EXPORT_SCHEMA_VERSION_UNSPECIFIED", - "EXPORT_V1", - "EXPORT_V2", - "EXPORT_V3", - "EXPORT_V4", - "EXPORT_V5", - "EXPORT_V6", - "EXPORT_V7", - "EXPORT_V8", - "EXPORT_V9", - "EXPORT_V10", - "EXPORT_V11", - "EXPORT_V12", - "EXPORT_V13", - "EXPORT_V14", - "EXPORT_V15", - "EXPORT_V16", - "EXPORT_V17", - "EXPORT_VERSION_LATEST_AVAILABLE" - ] - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination": { - "description": "A BigQuery Table Reference.", - "type": "object", - "properties": { - "projectId": { - "description": "A project ID or number. If specified, then export will attempt to\nwrite data to this project instead of the resource project. Otherwise,\nthe resource project will be used.", - "type": "string" - }, - "dataset": { - "description": "Required. The name of the BigQuery dataset that the snapshot result should be\nexported to. If this dataset does not exist, the export call returns an\nINVALID_ARGUMENT error.", - "type": "string" - }, - "table": { - "description": "The BigQuery table name to which the insights data should be written.\nIf this table does not exist, the export call returns an INVALID_ARGUMENT\nerror.", - "type": "string" - } - }, - "required": [ - "dataset" - ] - }, - "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse": { - "description": "Response for an export insights operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata": { - "description": "Metadata used for export issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original export request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest": { - "description": "Request to export an issue model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The issue model to export.", - "type": "string" - }, - "gcsDestination": { - "description": "Google Cloud Storage URI to export the issue model to.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination" - }] - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination": { - "description": "Google Cloud Storage Object URI to save the issue model to.", - "type": "object", - "properties": { - "objectUri": { - "description": "Required. Format: `gs:///`", - "type": "string" - } - }, - "required": [ - "objectUri" - ] - }, - "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse": { - "description": "Response from export issue model", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainGenerateDiscoveryMetadata": { - "description": "Metadata for GenerateDiscovery operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The request to create the discovery.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerateDiscoveryRequest" - }] - }, - "progress": { - "description": "The progress of the discovery creation operation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscoveryProgress" - }] - }, - "resultRevision": { - "description": "Output only. The DiscoveryRevision resource name that contains the result entries\ngenerated in this discovery.", - "readOnly": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainGenerateDiscoveryRequest": { - "description": "The request to generate a discovery.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent of generated discovery request.\nWhen it's a Location resource, this operation creates a root discovery and\nits discovery workspace will be automatically created.\nWhen it's a discovery workspace resource, this operation creates a drill\ndown discovery. discovery.drill_down_parent should have the same discovery\nworkspace as the parent.", - "type": "string" - }, - "discovery": { - "description": "Required. Specifies the discovery to generate. The name field of the discovery will\nbe ignored.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDiscovery" - }] - } - }, - "required": [ - "parent", - "discovery" - ] - }, - "GoogleCloudContactcenterinsightsV1mainGenerateDiscoveryResponse": { - "description": "The response of generating a discovery.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata": { - "description": "The metadata for generative insights.", - "type": "object", - "properties": { - "errorMessages": { - "description": "The error message when the generative insights request fails.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse": { - "description": "The response for generative insights.", - "type": "object", - "properties": { - "generativeResponses": { - "description": "The full list of generative responses.\nEach response is ordered by time.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse" - } - }, - "transcript": { - "description": "The transcript of the generative insights conversation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse": { - "description": "Wrapper for storing the generative response for a chart.", - "type": "object", - "properties": { - "textOutput": { - "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", - "deprecated": true, - "type": "string" - }, - "generatedSqlQuery": { - "description": "The generated SQL query from the LLM. Will be populated during the\nchart building phase. The generated SQL will be cached in the\ncorresponding chart resource.", - "type": "string" - }, - "chartSpec": { - "description": "The chart spec for the data.\nThis will be specified in the vega-lite or vega format.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "textMessage": { - "description": "The text output from the LLM. Will be populated during the chart\nbuilding phase. For a reloaded chart, this will NOT be populated.\nMay contain THOUGHT or a FINAL response or some in-progress response.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput": { - "description": "Wrapper for text output.", - "type": "object", - "properties": { - "text": { - "description": "The text output from the LLM.", - "type": "array", - "items": { - "type": "string" - } - }, - "textType": { - "description": "The type of text output.", - "type": "string", - "x-google-enum-descriptions": [ - "The type is unspecified.", - "The text is part of LLM reasoning.", - "The text is the final answer from LLM.", - "The text is an informational message about the agent's progress, such\nas a tool being invoked. This is distinct from the agent's internal\nthought process (`THOUGHT`) and the final answer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the agent's\nactions." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "THOUGHT", - "FINAL_RESPONSE", - "PROGRESS" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript": { - "description": "The conversation transcript for the chart.", - "type": "object", - "properties": { - "conversationId": { - "description": "The conversation id of the chart.", - "type": "string" - }, - "createTime": { - "description": "Output only. The create time of the conversation.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The update time of the conversation.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "messages": { - "description": "Ordered list of messages, including user inputs and system responses.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage": { - "description": "The message in the conversation.", - "type": "object", - "properties": { - "messageId": { - "description": "The message id of the message.", - "type": "string" - }, - "createTime": { - "description": "Output only. For user messages, this is the time at which the system received the\nmessage. For system messages, this is the time at which the system\ngenerated the message.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "userMessage": { - "description": "A message from the user that is interacting with the system.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage" - }] - }, - "systemMessageWrapper": { - "description": "A wrapper for system messages per turn.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage": { - "description": "The user message.", - "type": "object", - "properties": { - "text": { - "description": "A message from the user that is interacting with the system.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages": { - "description": "A wrapper for system messages per turn.", - "type": "object", - "properties": { - "systemMessages": { - "description": "A message from the system in response to the user.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage": { - "description": "A message from the system in response to the user. This message can\nalso be a message from the user as historical context for multiturn\nconversations with the system.", - "type": "object", - "properties": { - "textMessage": { - "description": "A direct natural language response to the user message.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" - }] - }, - "generatedSqlQuery": { - "description": "Raw SQL from LLM, before templatization", - "type": "string" - }, - "chartSpec": { - "description": "Chart spec from LLM", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - }, - "userProvidedSqlQuery": { - "description": "Optional. User provided SQL query", - "type": "string" - }, - "userProvidedChartSpec": { - "description": "Optional. User provided chart spec", - "type": "object", - "additionalProperties": { - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { - "description": "A text output message from the system.", - "type": "object", - "properties": { - "text": { - "description": "The parts of the message.", - "type": "array", - "items": { - "type": "string" - } - }, - "textType": { - "description": "The type of the text message.", - "type": "string", - "x-google-enum-descriptions": [ - "The default text type.", - "The text is a thinking plan generated by the thinking tool.", - "The text is a final response to the user question.", - "The text is an informational message about the agent's\nprogress, such as a tool being invoked. This is distinct from\nthe agent's internal thought process (`THOUGHT`) and the final\nanswer to the user\n(`FINAL_RESPONSE`). These messages provide insight into the\nagent's actions." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "THOUGHT", - "FINAL_RESPONSE", - "PROGRESS" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata": { - "description": "Metadata used for import issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "The time the operation was created.", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time the operation finished running.", - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original import request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest": { - "description": "Request to import an issue model.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the issue model.", - "type": "string" - }, - "gcsSource": { - "description": "Google Cloud Storage source message.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource" - }] - }, - "createNewModel": { - "description": "Optional. If set to true, will create an issue model from the imported file with\nrandomly generated IDs for the issue model and corresponding issues.\nOtherwise, replaces an existing model with the same ID as the file.", - "type": "boolean" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource": { - "description": "Google Cloud Storage Object URI to get the issue model file from.", - "type": "object", - "properties": { - "objectUri": { - "description": "Required. Format: `gs:///`", - "type": "string" - } - }, - "required": [ - "objectUri" - ] - }, - "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse": { - "description": "Response from import issue model", - "type": "object", - "properties": { - "issueModel": { - "description": "The issue model that was imported.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModel" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata": { - "description": "The metadata for an IngestConversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for ingest.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest" - }] - }, - "partialErrors": { - "description": "Output only. Partial errors during ingest operation that might cause the operation\noutput to be incomplete.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "ingestConversationsStats": { - "description": "Output only. Statistics for IngestConversations operation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats" - }] - }, - "sampledConversations": { - "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest": { - "description": "The request to ingest conversations.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource for new conversations.", - "type": "string" - }, - "gcsSource": { - "description": "A cloud storage bucket source. Note that any previously ingested objects\nfrom the source will be skipped to avoid duplication.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource" - }] - }, - "transcriptObjectConfig": { - "description": "Configuration for when `source` contains conversation transcripts.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig" - }] - }, - "conversationConfig": { - "description": "Configuration that applies to all conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig" - }] - }, - "redactionConfig": { - "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config\nspecified in Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainRedactionConfig" - }] - }, - "speechConfig": { - "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config\nspecified in Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSpeechConfig" - }] - }, - "sampleSize": { - "description": "Optional. If set, this fields indicates the number of objects to ingest from the\nCloud Storage bucket. If empty, the entire bucket will be ingested.\nUnless they are first deleted, conversations produced through sampling\nwon't be ingested by subsequent ingest requests.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource": { - "description": "Configuration for Cloud Storage bucket sources.", - "type": "object", - "properties": { - "bucketUri": { - "description": "Optional. The Cloud Storage bucket containing source objects.\nAvoid passing this. Pass this through one of `transcript_bucket_uri` or\n`audio_bucket_uri`.", - "type": "string" - }, - "bucketObjectType": { - "description": "Optional. Specifies the type of the objects in `bucket_uri`.\nAvoid passing this. This is inferred from the `transcript_bucket_uri`,\n`audio_bucket_uri`.", - "type": "string", - "x-google-enum-descriptions": [ - "The object type is unspecified and will default to `TRANSCRIPT`.", - "The object is a transcript.", - "The object is an audio file." - ], - "enum": [ - "BUCKET_OBJECT_TYPE_UNSPECIFIED", - "TRANSCRIPT", - "AUDIO" - ] - }, - "transcriptBucketUri": { - "description": "Optional. The Cloud Storage path to the conversation transcripts. Note\nthat: [1] Transcript files are expected to be in JSON format. [2]\nTranscript, audio, metadata files must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", - "type": "string" - }, - "audioBucketUri": { - "description": "Optional. The Cloud Storage path to the conversation audio file.\nNote that: [1] Audio files will be transcribed if not already.\n[2] Audio files and transcript files must be in separate\nbuckets / folders.\n[3] A source file and its corresponding audio file\nmust share the same name to\n be properly ingested, E.g.\n `gs://bucket/transcript/conversation1.json` and\n `gs://bucket/audio/conversation1.mp3`.", - "type": "string" - }, - "metadataBucketUri": { - "description": "Optional. The Cloud Storage path to the conversation metadata. Note that:\n[1] Metadata files are expected to be in JSON format.\n[2] Metadata and source files (transcripts or audio) must be in\n separate buckets / folders.\n[3] A source file and its corresponding metadata file must share the same\nname to\n be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and\n `gs://bucket/metadata/conversation1.json`.", - "type": "string" - }, - "customMetadataKeys": { - "description": "Optional. Custom keys to extract as conversation labels from metadata files in\n`metadata_bucket_uri`. Keys not included in this field will be ignored.\nNote that there is a limit of 100 labels per conversation.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig": { - "description": "Configuration for processing transcript objects.", - "type": "object", - "properties": { - "medium": { - "description": "Required. The medium transcript objects represent.", - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "The format for conversations that took place over the phone.", - "The format for conversations that took place over chat." - ], - "enum": [ - "MEDIUM_UNSPECIFIED", - "PHONE_CALL", - "CHAT" - ] - } - }, - "required": [ - "medium" - ] - }, - "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig": { - "description": "Configuration that applies to all conversations.", - "type": "object", - "properties": { - "agentId": { - "description": "Optional. An opaque, user-specified string representing a human agent who handled\nall conversations in the import. Note that this will be overridden if\nper-conversation metadata is provided through the `metadata_bucket_uri`.", - "type": "string" - }, - "agentChannel": { - "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", - "type": "integer", - "format": "int32" - }, - "customerChannel": { - "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that\nthis must be set for conversations to be properly displayed and analyzed.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainRedactionConfig": { - "description": "DLP resources used for redaction while ingesting conversations.\nDLP settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint or the Dialogflow / Agent\nAssist runtime integrations. When using Dialogflow / Agent Assist runtime\nintegrations, redaction should be performed in Dialogflow / Agent Assist.", - "type": "object", - "properties": { - "deidentifyTemplate": { - "description": "The fully-qualified DLP deidentify template resource name.\nFormat:\n`projects/{project}/deidentifyTemplates/{template}`", - "type": "string" - }, - "inspectTemplate": { - "description": "The fully-qualified DLP inspect template resource name.\nFormat:\n`projects/{project}/locations/{location}/inspectTemplates/{template}`", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainSpeechConfig": { - "description": "Speech-to-Text configuration.\nSpeech-to-Text settings are applied to conversations ingested from the\n`UploadConversation` and `IngestConversations` endpoints, including\nconversation coming from CCAI Platform. They are not applied to conversations\ningested from the `CreateConversation` endpoint.", - "type": "object", - "properties": { - "speechRecognizer": { - "description": "The fully-qualified Speech Recognizer resource name.\nFormat:\n`projects/{project_id}/locations/{location}/recognizer/{recognizer}`", - "type": "string" - }, - "disableWordTimeOffsets": { - "description": "Whether to disable word time offsets.\nIf true, the `enable_word_time_offsets` field in the recognition config\nwill be set to false.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats": { - "description": "Statistics for IngestConversations operation.", - "type": "object", - "properties": { - "processedObjectCount": { - "description": "Output only. The number of objects processed during the ingest operation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "duplicatesSkippedCount": { - "description": "Output only. The number of objects skipped because another conversation with the same\ntranscript uri had already been ingested.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "successfulIngestCount": { - "description": "Output only. The number of new conversations added during this ingest operation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "failedIngestCount": { - "description": "Output only. The number of objects which were unable to be ingested due to errors.\nThe errors are populated in the partial_errors field.", - "readOnly": true, - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse": { - "description": "The response to an IngestConversations operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata": { - "description": "Metadata for initializing a location-level encryption specification.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for initialization.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest" - }] - }, - "partialErrors": { - "description": "Partial errors during initializing operation that might cause the operation\noutput to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest": { - "description": "The request to initialize a location-level encryption specification.", - "type": "object", - "properties": { - "encryptionSpec": { - "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms\nkey is in the same region as the endpoint. The same key will be used for\nall provisioned resources, if encryption is available. If the\n`kms_key_name` field is left empty, no encryption will be enforced.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainEncryptionSpec" - }] - } - }, - "required": [ - "encryptionSpec" - ] - }, - "GoogleCloudContactcenterinsightsV1mainEncryptionSpec": { - "description": "A customer-managed encryption key specification that can be applied to all\ncreated resources (e.g. `Conversation`).", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the encryption key specification resource.\nFormat:\nprojects/{project}/locations/{location}/encryptionSpec", - "x-google-immutable": true, - "type": "string" - }, - "kmsKey": { - "description": "Required. The name of customer-managed encryption key that is used to\nsecure a resource and its sub-resources. If empty, the resource is secured\nby our default encryption key. Only the key in the same location as this\nresource is allowed to be used for encryption. Format:\n`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", - "type": "string" - } - }, - "required": [ - "kmsKey" - ] - }, - "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse": { - "description": "The response to initialize a location-level encryption specification.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse": { - "description": "The response for listing all feedback labels.", - "type": "object", - "properties": { - "feedbackLabels": { - "description": "The feedback labels that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFeedbackLabel" - } - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainFeedbackLabel": { - "description": "Represents a conversation, resource, and label provided by the user.\nCan take the form of a string label or a QaAnswer label.\nQaAnswer labels are used for Quality AI example conversations.\nString labels are used for Topic Modeling.\nAgentAssistSummary labels are used for Agent Assist Summarization.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. Resource name of the FeedbackLabel.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", - "x-google-immutable": true, - "type": "string" - }, - "labeledResource": { - "description": "Name of the resource to be labeled.\nSupported resources are:\n\n* `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}`\n* `projects/{project}/locations/{location}/issueModels/{issue_model}`\n* `projects/{project}/locations/{location}/generators/{generator_id}`", - "type": "string" - }, - "label": { - "description": "String label used for Topic Modeling.", - "type": "string" - }, - "qaAnswerLabel": { - "description": "QaAnswer label used for Quality AI example conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" - }] - }, - "createTime": { - "description": "Output only. Create time of the label.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. Update time of the label.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue": { - "description": "Message for holding the value of a QaAnswer.\nQaQuestion.AnswerChoice defines the possible answer values for a\nquestion.", - "type": "object", - "properties": { - "key": { - "description": "A short string used as an identifier. Matches the value used in\nQaQuestion.AnswerChoice.key.", - "type": "string" - }, - "strValue": { - "description": "String value.", - "type": "string" - }, - "numValue": { - "description": "Numerical value.", - "type": "number", - "format": "double" - }, - "boolValue": { - "description": "Boolean value.", - "type": "boolean" - }, - "naValue": { - "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", - "type": "boolean" - }, - "skipValue": { - "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`.\nIf a question receives this answer, it will be excluded from any score\ncalculations. This would mean that the question was not evaluated.", - "readOnly": true, - "type": "boolean" - }, - "score": { - "description": "Output only. Numerical score of the answer.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "Output only. The maximum potential score of the question.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "rationale": { - "description": "Output only. The rationale for the answer. This field is only populated for answers\nthat are generated by the LLM. Manual edits currently do not have\nrationales.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValueQaAnswerRationale" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValueQaAnswerRationale": { - "description": "Wrapper for the rationale for the answer.", - "type": "object", - "properties": { - "rationale": { - "description": "The rationale string for the answer.", - "type": "string" - }, - "rationaleSource": { - "description": "The source of the rationale. A manual edit AnswerValue could still\ncontain a system generated rationale if user didn't provide one. Manual\nedit would override the system generated rationale.", - "type": "string", - "x-google-enum-descriptions": [ - "The rationale source is unspecified. This value should generally not\nbe used.", - "The rationale is system generated.", - "The rationale is manually added by the user." - ], - "enum": [ - "RATIONALE_SOURCE_UNSPECIFIED", - "RATIONALE_SOURCE_SYSTEM_GENERATED", - "RATIONALE_SOURCE_MANUAL_EDIT" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse": { - "description": "The response for listing feedback labels.", - "type": "object", - "properties": { - "feedbackLabels": { - "description": "The feedback labels that match the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFeedbackLabel" - } - }, - "nextPageToken": { - "description": "The next page token.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainMergeIssuesMetadata": { - "description": "Metadata for creating an issue.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata": { - "description": "The metadata from querying metrics.", - "type": "object", - "properties": { - "resultIsTruncated": { - "description": "Whether the result rows were truncated because the result row size is too\nlarge to materialize.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse": { - "description": "The response for querying metrics.", - "type": "object", - "properties": { - "location": { - "description": "Required. The location of the data.\n\"projects/{project}/locations/{location}\"", - "type": "string" - }, - "updateTime": { - "description": "The metrics last update time.", - "type": "string", - "format": "date-time" - }, - "slices": { - "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" - } - }, - "macroAverageSlice": { - "description": "The macro average slice contains aggregated averages across all selected\ndimensions. i.e. if group_by agent and scorecard_id is specified, this\nfield will contain the average across all agents and all scorecards. This\nfield is only populated if the request specifies a Dimension.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" - }] - } - }, - "required": [ - "location" - ] - }, - "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice": { - "description": "A slice contains a total and (if the request specified a time granularity)\na time series of metric values. Each slice contains a unique combination of\nthe cardinality of dimensions from the request.\n\nFor example, if the request specifies a single ISSUE dimension and it has a\ncardinality of 2 (i.e. the data used to compute the metrics has 2 issues in\ntotal), the response will have 2 slices:\n\n* Slice 1 -> dimensions=[Issue 1]\n* Slice 2 -> dimensions=[Issue 2]", - "type": "object", - "properties": { - "dimensions": { - "description": "A unique combination of dimensions that this slice represents.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimension" - } - }, - "total": { - "description": "The total metric value. The interval of this data point is\n[starting create time, ending create time) from the request.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" - }] - }, - "timeSeries": { - "description": "A time series of metric values. This is only populated if the request\nspecifies a time granularity other than NONE.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimension": { - "description": "A dimension determines the grouping key for the query. In SQL terms, these\nwould be part of both the \"SELECT\" and \"GROUP BY\" clauses.", - "type": "object", - "properties": { - "dimensionKey": { - "description": "The key of the dimension.", - "type": "string", - "x-google-enum-descriptions": [ - "The key of the dimension is unspecified.", - "The dimension is keyed by issues.", - "The dimension is keyed by issue names.", - "The dimension is keyed by agents.", - "The dimension is keyed by agent teams.", - "The dimension is keyed by QaQuestionIds.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing stats for\nthe same question across different scorecard revisions.", - "The dimension is keyed by QaQuestionIds-Answer value pairs.\nNote that: We only group by the QuestionId and not the revision-id of the\nscorecard this question is a part of. This allows for showing\ndistribution of answers per question across different scorecard\nrevisions.", - "The dimension is keyed by QaScorecardIds.\nNote that: We only group by the ScorecardId and not the revision-id of\nthe scorecard. This allows for showing stats for the same scorecard\nacross different revisions.\nThis metric is mostly only useful if querying the average normalized\nscore per scorecard.", - "The dimension is keyed by the conversation profile ID.", - "The dimension is keyed by the conversation medium.", - "The dimension is keyed by the Conversational Agents playbook ID.", - "The dimension is keyed by the Conversational Agents playbook display\nname.", - "The dimension is keyed by the Conversational Agents tool ID.", - "The dimension is keyed by the Conversational Agents tool display name.", - "The dimension is keyed by the client sentiment category.", - "The dimension is keyed by the agent version ID.", - "The dimension is keyed by the agent deployment ID.", - "The dimension is keyed by the supervisor ID of the assigned human\nsupervisor for virtual agents.", - "The dimension is keyed by label keys.", - "The dimension is keyed by label values.", - "The dimension is keyed by label key-value pairs." - ], - "enum": [ - "DIMENSION_KEY_UNSPECIFIED", - "ISSUE", - "ISSUE_NAME", - "AGENT", - "AGENT_TEAM", - "QA_QUESTION_ID", - "QA_QUESTION_ANSWER_VALUE", - "QA_SCORECARD_ID", - "CONVERSATION_PROFILE_ID", - "MEDIUM", - "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", - "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", - "CONVERSATIONAL_AGENTS_TOOL_ID", - "CONVERSATIONAL_AGENTS_TOOL_NAME", - "CLIENT_SENTIMENT_CATEGORY", - "AGENT_VERSION_ID", - "AGENT_DEPLOYMENT_ID", - "AGENT_ASSIST_SUPERVISOR_ID", - "LABEL_KEY", - "LABEL_VALUE", - "LABEL_KEY_AND_VALUE" - ] - }, - "issueDimensionMetadata": { - "description": "Output only. Metadata about the issue dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata" - }] - }, - "agentDimensionMetadata": { - "description": "Output only. Metadata about the agent dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata" - }] - }, - "qaQuestionDimensionMetadata": { - "description": "Output only. Metadata about the QA question dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata" - }] - }, - "qaQuestionAnswerDimensionMetadata": { - "description": "Output only. Metadata about the QA question-answer dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata" - }] - }, - "qaScorecardDimensionMetadata": { - "description": "Output only. Metadata about the QA scorecard dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata" - }] - }, - "conversationProfileDimensionMetadata": { - "description": "Output only. Metadata about the conversation profile dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata" - }] - }, - "mediumDimensionMetadata": { - "description": "Output only. Metadata about the conversation medium dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata" - }] - }, - "conversationalAgentsPlaybookDimensionMetadata": { - "description": "Output only. Metadata about the Conversational Agents playbook dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata" - }] - }, - "conversationalAgentsToolDimensionMetadata": { - "description": "Output only. Metadata about the Conversational Agents tool dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata" - }] - }, - "clientSentimentCategoryDimensionMetadata": { - "description": "Output only. Metadata about the client sentiment category dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata" - }] - }, - "agentAssistSupervisorDimensionMetadata": { - "description": "Output only. Metadata about the supervisor for virtual agents dimension.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionAgentAssistSupervisorDimensionMetadata" - }] - }, - "labelDimensionMetadata": { - "description": "Output only. Metadata about conversation labels.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata": { - "description": "Metadata about the issue dimension.", - "type": "object", - "properties": { - "issueId": { - "description": "The issue ID.", - "type": "string" - }, - "issueDisplayName": { - "description": "The issue display name.", - "type": "string" - }, - "issueModelId": { - "description": "The parent issue model ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata": { - "description": "Metadata about the agent dimension.", - "type": "object", - "properties": { - "agentId": { - "description": "Optional. A user-specified string representing the agent.\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentDisplayName": { - "description": "Optional. The agent's name\nThis will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentTeam": { - "description": "Optional. A user-specified string representing the agent's team.", - "type": "string" - }, - "agentVersionDisplayName": { - "description": "Optional. The agent's version display name. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentVersionId": { - "description": "Optional. The agent's version ID. Only applicable to automated agents.\nThis will be populated for AGENT_VERSION_ID, and\nAGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentDeploymentDisplayName": { - "description": "Optional. The agent's deployment display name. Only applicable to automated agents.\nThis will be populated for AGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - }, - "agentDeploymentId": { - "description": "Optional. The agent's deployment ID. Only applicable to automated agents.\nThis will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata": { - "description": "Metadata about the QA question dimension.", - "type": "object", - "properties": { - "qaScorecardId": { - "description": "Optional. The QA scorecard ID.", - "type": "string" - }, - "qaQuestionId": { - "description": "Optional. The QA question ID.", - "type": "string" - }, - "questionBody": { - "description": "Optional. The full body of the question.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata": { - "description": "Metadata about the QA question-answer dimension.\nThis is useful for showing the answer distribution for questions for a\ngiven scorecard.", - "type": "object", - "properties": { - "qaScorecardId": { - "description": "Optional. The QA scorecard ID.", - "type": "string" - }, - "qaQuestionId": { - "description": "Optional. The QA question ID.", - "type": "string" - }, - "questionBody": { - "description": "Optional. The full body of the question.", - "type": "string" - }, - "answerValue": { - "description": "Optional. The full body of the question.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata": { - "description": "Metadata about the QA scorecard dimension.", - "type": "object", - "properties": { - "qaScorecardId": { - "description": "Optional. The QA scorecard ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata": { - "description": "Metadata about the conversation profile dimension.", - "type": "object", - "properties": { - "conversationProfileId": { - "description": "Optional. The conversation profile ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata": { - "description": "Metadata about the conversation medium dimension.", - "type": "object", - "properties": { - "medium": { - "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata": { - "description": "Metadata about the Conversational Agents playbook dimension.", - "type": "object", - "properties": { - "playbookId": { - "description": "Optional. The dialogflow playbook ID.", - "type": "string" - }, - "playbookDisplayName": { - "description": "Optional. The dialogflow playbook display name.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata": { - "description": "Metadata about the Conversational Agents tool dimension.", - "type": "object", - "properties": { - "toolId": { - "description": "Optional. The dialogflow tool ID.", - "type": "string" - }, - "toolDisplayName": { - "description": "Optional. The dialogflow tool display name.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata": { - "description": "Metadata about the client sentiment category dimension.", - "type": "object", - "properties": { - "sentimentCategory": { - "description": "Optional. The client sentiment category.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionAgentAssistSupervisorDimensionMetadata": { - "description": "Metadata about AA's human supervisor dimension.", - "type": "object", - "properties": { - "supervisorId": { - "description": "Optional. ID of the assigned supervisor.", - "type": "string" - }, - "supervisorUsername": { - "description": "Optional. User name of the assigned supervisor.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata": { - "description": "Metadata about conversation labels.", - "type": "object", - "properties": { - "labelKey": { - "description": "Optional. The label key.", - "type": "string" - }, - "labelValue": { - "description": "Optional. The label value.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint": { - "description": "A data point contains the metric values mapped to an interval.", - "type": "object", - "properties": { - "interval": { - "description": "The interval that this data point represents.\n\n* If this is the total data point, the interval is\n[starting create time, ending create time) from the request.\n* If this a data point from the time series, the interval is\n[time, time + time granularity from the request).", - "allOf": [{ - "$ref": "#/components/schemas/GoogleTypeInterval" - }] - }, - "conversationMeasure": { - "description": "The measure related to conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure" - }] - }, - "dialogflowInteractionMeasure": { - "description": "The measure related to dialogflow interactions.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure": { - "description": "The measure related to conversations.", - "type": "object", - "properties": { - "conversationCount": { - "description": "The conversation count.", - "type": "integer", - "format": "int32" - }, - "averageSilencePercentage": { - "description": "The average silence percentage.", - "type": "number", - "format": "float" - }, - "averageDuration": { - "description": "The average duration.", - "type": "string", - "format": "google-duration" - }, - "averageTurnCount": { - "description": "The average turn count.", - "type": "number", - "format": "float" - }, - "averageAgentSentimentScore": { - "description": "The average agent's sentiment score.", - "type": "number", - "format": "float" - }, - "averageClientSentimentScore": { - "description": "The average client's sentiment score.", - "type": "number", - "format": "float" - }, - "averageCustomerSatisfactionRating": { - "description": "The average customer satisfaction rating.", - "type": "number", - "format": "double" - }, - "averageQaNormalizedScore": { - "description": "The average normalized QA score for a scorecard. When computing the\naverage across a set of conversations, if a conversation has been\nevaluated with multiple revisions of a scorecard, only the latest\nrevision results will be used. Will exclude 0's in average\ncalculation. Will be only populated if the request specifies a\ndimension of QA_SCORECARD_ID.", - "type": "number", - "format": "double" - }, - "qaTagScores": { - "description": "Average QA normalized score for all the tags.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" - } - }, - "averageQaQuestionNormalizedScore": { - "description": "Average QA normalized score averaged for questions averaged across\nall revisions of the parent scorecard.\nWill be only populated if the request specifies a dimension of\nQA_QUESTION_ID.", - "type": "number", - "format": "double" - }, - "knowledgeSearchResultCount": { - "description": "Count of knowledge search results (Generative Knowledge\nAssist) shown to the user.", - "type": "integer", - "format": "int32" - }, - "knowledgeSearchAgentQuerySourceRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nmade by the agent compared to the total number of knowledge search\nqueries made.", - "type": "number", - "format": "double" - }, - "knowledgeSearchSuggestedQuerySourceRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nsuggested compared to the total number of knowledge search\nqueries made.", - "type": "number", - "format": "double" - }, - "knowledgeAssistResultCount": { - "description": "Count of knowledge assist results (Proactive Generative Knowledge\nAssist) shown to the user.", - "type": "integer", - "format": "int32" - }, - "knowledgeSearchUriClickRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had a URL clicked.", - "type": "number", - "format": "double" - }, - "knowledgeAssistUriClickRatio": { - "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had a URL clicked.", - "type": "number", - "format": "double" - }, - "knowledgeSearchPositiveFeedbackRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had positive feedback.", - "type": "number", - "format": "double" - }, - "knowledgeSearchNegativeFeedbackRatio": { - "description": "Proportion of knowledge search (Generative Knowledge Assist) queries\nthat had negative feedback.", - "type": "number", - "format": "double" - }, - "knowledgeAssistPositiveFeedbackRatio": { - "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had positive feedback.", - "type": "number", - "format": "double" - }, - "knowledgeAssistNegativeFeedbackRatio": { - "description": "Proportion of knowledge assist (Proactive Generative Knowledge\nAssist) queries that had negative feedback.", - "type": "number", - "format": "double" - }, - "summarizationSuggestionEditRatio": { - "description": "Proportion of summarization suggestions that were manually edited.", - "type": "number", - "format": "double" - }, - "averageSummarizationSuggestionEditDistance": { - "description": "Average edit distance of the summarization suggestions. Edit\ndistance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion.", - "type": "number", - "format": "double" - }, - "averageSummarizationSuggestionNormalizedEditDistance": { - "description": "Normalized Average edit distance of the summarization suggestions.\nEdit distance (also called as levenshtein distance) is calculated by\nsumming up number of insertions, deletions and substitutions required\nto transform the summization feedback to the original summary\nsuggestion. Normalized edit distance is the average of (edit distance\n/ summary length).", - "type": "number", - "format": "double" - }, - "conversationSuggestedSummaryRatio": { - "description": "Proportion of conversations that had a suggested summary.", - "type": "number", - "format": "double" - }, - "summarizationSuggestionResultCount": { - "description": "Count of summarization suggestions results.", - "type": "integer", - "format": "int32" - }, - "dialogflowInteractionsNoMatchRatio": { - "description": "Proportion of dialogflow interactions that has no intent match for\nthe input.", - "type": "number", - "format": "double" - }, - "dialogflowInteractionsNoInputRatio": { - "description": "Proportion of dialogflow interactions that has empty input.", - "type": "number", - "format": "double" - }, - "dialogflowWebhookFailureRatio": { - "description": "Proportion of dialogflow webhook calls that failed.", - "type": "number", - "format": "double" - }, - "dialogflowWebhookTimeoutRatio": { - "description": "Proportion of dialogflow webhook calls that timed out.", - "type": "number", - "format": "double" - }, - "dialogflowAverageWebhookLatency": { - "description": "Average latency of dialogflow webhook calls.", - "type": "number", - "format": "double" - }, - "dialogflowConversationsEscalationRatio": { - "description": "Proportion of conversations that was handed off from virtual agent to\nhuman agent.", - "type": "number", - "format": "double" - }, - "dialogflowConversationsEscalationCount": { - "description": "count of conversations that was handed off from virtual agent to\nhuman agent.", - "type": "number", - "format": "double" - }, - "conversationalAgentsToolCallSuccessRatio": { - "description": "Proportion of conversational agents' tool calls that were successful.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageToolCallLatency": { - "description": "Average latency of conversational agents' tool calls.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageTtsLatency": { - "description": "The macro average latency of conversational agents' TTS latency\nper interaction.\nThis is computed as the average of the all the interactions' TTS\nlatencies in a conversation and averaged across conversations.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageLlmCallLatency": { - "description": "The average latency of conversational agents' LLM call latency\nper interaction. This is computed as the average of the all the\ninteractions LLM call latencies in a conversation and averaged across\nconversations.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageAudioInAudioOutLatency": { - "description": "The average latency of conversational agents' audio in audio\nout latency per interaction.\nThis is computed as the average of the all the interactions' audio in\naudio out latencies in a conversation and averaged across\nconversations.", - "type": "number", - "format": "double" - }, - "conversationAiCoachSuggestionRatio": { - "description": "Proportion of conversations that has Ai Coach Suggestions.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionAgentUsageRatio": { - "description": "Proportion of Ai Coach Suggestion that has been used by agents.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionCustomerMessageTriggerRatio": { - "description": "Proportion of customer messages that triggered an Ai Coach\nSuggestion.", - "type": "number", - "format": "double" - }, - "conversationalAgentsAverageEndToEndLatency": { - "description": "The average latency of conversational agents' latency per\ninteraction. This is computed as the average of the all the\niteractions' end to end latencies in a conversation and averaged\nacross conversations. The e2e latency is the time between the end of\nthe user utterance and the start of the agent utterance on the\ninteraction level.", - "type": "number", - "format": "double" - }, - "conversationAiCoachSuggestionCount": { - "description": "Count of conversations that has Ai Coach Suggestions.", - "type": "integer", - "format": "int32" - }, - "aiCoachSuggestionAgentUsageCount": { - "description": "Count of Ai Coach Suggestion that has been used by agents.", - "type": "integer", - "format": "int32" - }, - "aiCoachSuggestionCustomerMessageTriggerCount": { - "description": "Count of customer messages that triggered an Ai Coach\nSuggestion.", - "type": "integer", - "format": "int32" - }, - "aiCoachSuggestionAgentMessageTriggerCount": { - "description": "Count of agent messages that triggered an Ai Coach Suggestion.", - "type": "integer", - "format": "int32" - }, - "conversationTotalCustomerMessageCount": { - "description": "The customer message count.", - "type": "integer", - "format": "int32" - }, - "conversationTotalAgentMessageCount": { - "description": "The agent message count.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorMonitoredConversationsCount": { - "description": "The number of conversations scanned by the AA human supervisor.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorEscalatedConversationsCount": { - "description": "The number of conversations that were escalated to an AA human\nsupervisor for intervention.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorAssignedConversationsCount": { - "description": "The number of conversations that were assigned to an AA human\nsupervisor.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorDroppedConversationsCount": { - "description": "The number of conversations that were dropped, i.e. escalated but not\nassigned to an AA human supervisor.", - "type": "integer", - "format": "int32" - }, - "aaSupervisorTransferredToHumanAgentConvCount": { - "description": "The number of conversations transferred to a human agent.", - "type": "integer", - "format": "int32" - }, - "avgConversationClientTurnSentimentEma": { - "description": "The exponential moving average of the sentiment score of client turns\nin the conversation.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionMessageTriggerRatio": { - "description": "Proportion of end_of_utterance trigger event messages that triggered\nan Ai Coach Suggestion.", - "type": "number", - "format": "double" - }, - "aiCoachSuggestionMessageTriggerCount": { - "description": "Count of end_of_utterance trigger event messages that triggered an Ai\nCoach Suggestion.", - "type": "integer", - "format": "int32" - }, - "containedConversationCount": { - "description": "The number of conversations that were contained.", - "type": "integer", - "format": "int32" - }, - "containedConversationRatio": { - "description": "The percentage of conversations that were contained.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { - "description": "Average QA normalized score for the tag.", - "type": "object", - "properties": { - "tag": { - "description": "Tag name.", - "type": "string" - }, - "averageTagNormalizedScore": { - "description": "Average tag normalized score per tag.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { - "description": "The measure related to dialogflow interactions.", - "type": "object", - "properties": { - "percentileAudioInAudioOutLatency": { - "description": "The percentile result for audio in audio out latency in milliseconds\nper dialogflow interaction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileLlmCallLatency": { - "description": "The percentile result for LLM latency in milliseconds per dialogflow\ninteraction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileTtsLatency": { - "description": "The percentile result for TTS latency in milliseconds per dialogflow\ninteraction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileToolUseLatency": { - "description": "The percentile result for tool use latency in milliseconds per\ndialogflow interaction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" - }] - }, - "percentileEndToEndLatency": { - "description": "The percentile result for end to end chat latency in milliseconds per\ndialogflow interaction level.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult": { - "description": "The percentile result. Currently supported percentiles are 50th, 90th,\nand 99th.", - "type": "object", - "properties": { - "p50": { - "description": "The 50th percentile value.", - "type": "number", - "format": "double" - }, - "p90": { - "description": "The 90th percentile value.", - "type": "number", - "format": "double" - }, - "p99": { - "description": "The 99th percentile value.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries": { - "description": "A time series of metric values.", - "type": "object", - "properties": { - "dataPoints": { - "description": "The data points that make up the time series .", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata": { - "description": "The metadata for querying performance overview.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse": { - "description": "The response for querying performance overview.", - "type": "object", - "properties": { - "summaryText": { - "description": "The summary text of the performance.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata": { - "description": "The metadata for an SampleConversations operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request for sample conversations to dataset.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest" - }] - }, - "partialErrors": { - "description": "Output only. Partial errors during sample conversations operation that might\ncause the operation output to be incomplete.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "sampleConversationsStats": { - "description": "Output only. Statistics for SampleConversations operation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest": { - "description": "The request to sample conversations to a dataset.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the dataset.", - "type": "string" - }, - "sampleRule": { - "description": "Optional. The sample rule used for sampling conversations.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSampleRule" - }] - }, - "destinationDataset": { - "description": "The dataset resource to copy the sampled conversations to.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDataset" - }] - } - }, - "required": [ - "parent" - ] - }, - "GoogleCloudContactcenterinsightsV1mainSampleRule": { - "description": "Message for sampling conversations.", - "type": "object", - "properties": { - "samplePercentage": { - "description": "Percentage of conversations that we should sample based on the dimension\nbetween [0, 100].", - "type": "number", - "format": "double" - }, - "sampleRow": { - "description": "Number of the conversations that we should sample based on the dimension.", - "type": "string", - "format": "int64" - }, - "dimension": { - "description": "Optional. Group by dimension to sample the conversation. If no dimension is\nprovided, the sampling will be applied to the project level.\nCurrent supported dimensions is 'quality_metadata.agent_info.agent_id'.", - "type": "string" - }, - "conversationFilter": { - "description": "To specify the filter for the conversions that should apply this sample\nrule. An empty filter means this sample rule applies to all conversations.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDataset": { - "description": "Dataset resource represents a collection of conversations\nthat may be bounded (Static Dataset, e.g. golden dataset for training),\nor unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", - "type": "object", - "properties": { - "name": { - "description": "Immutable. Identifier. Resource name of the dataset.\nFormat: projects/{project}/locations/{location}/datasets/{dataset}", - "x-google-immutable": true, - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "Display name for the dataaset", - "type": "string" - }, - "description": { - "description": "Dataset description.", - "type": "string" - }, - "type": { - "description": "Dataset usage type.", - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "For evals only.", - "Dataset with new conversations coming in regularly (Insights legacy\nconversations and AI trainer)" - ], - "enum": [ - "TYPE_UNSPECIFIED", - "EVAL", - "LIVE" - ] - }, - "ttl": { - "description": "Optional. Option TTL for the dataset.", - "type": "string", - "format": "google-duration" - }, - "createTime": { - "description": "Output only. Dataset create time.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. Dataset update time.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats": { - "description": "Statistics for SampleConversations operation.", - "type": "object", - "properties": { - "successfulSampleCount": { - "description": "Output only. The number of new conversations added during this sample operation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "failedSampleCount": { - "description": "Output only. The number of objects which were unable to be sampled due to errors.\nThe errors are populated in the partial_errors field.", - "readOnly": true, - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse": { - "description": "The response to an SampleConversations operation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata": { - "description": "Metadata for testing correlation config.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "dataset": { - "description": "The dataset used for sampling conversations.", - "type": "string" - }, - "stats": { - "description": "The statistics for the operation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats": { - "description": "Statistics for TestCorrelationConfig operation.", - "type": "object", - "properties": { - "sampledConversationsCount": { - "description": "The number of conversations sampled.", - "type": "integer", - "format": "int32" - }, - "correlatedConversationsCount": { - "description": "The number of conversations correlated.", - "type": "integer", - "format": "int32" - }, - "failedConversationsCount": { - "description": "The number of conversations that failed correlation.", - "type": "integer", - "format": "int32" - }, - "partialErrors": { - "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - }, - "conversationCorrelationErrors": { - "description": "A list of errors that occurred during correlation, one for each\nconversation that failed.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { - "description": "An error that occurred during correlation for a specific conversation.", - "type": "object", - "properties": { - "conversation": { - "description": "The conversation resource name that had an error during correlation.", - "type": "string" - }, - "status": { - "description": "The error status.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleRpcStatus" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse": { - "description": "The response of testing correlation config.", - "type": "object", - "properties": { - "detailedResults": { - "description": "Results for the DETAILED_SYNC execution mode.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults" - }] - }, - "partialErrors": { - "description": "Partial errors during test correlation config operation that might cause\nthe operation output to be incomplete.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleRpcStatus" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults": { - "description": "Wrapper for detailed, step-by-step results.", - "type": "object", - "properties": { - "joinKeyResults": { - "description": "A list of join key correlation results for each conversation tested.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult" - } - }, - "constraintResults": { - "description": "A list of constraint evaluation results for each pair of conversations.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult": { - "description": "The result of testing correlation config on a single conversation.", - "type": "object", - "properties": { - "conversation": { - "description": "The conversation resource name.", - "type": "string" - }, - "ruleResults": { - "description": "The results for each correlation rule.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult": { - "description": "The result of a single correlation rule.", - "type": "object", - "properties": { - "ruleId": { - "description": "The rule ID.", - "type": "string" - }, - "correlationId": { - "description": "The correlation ID generated by the join key expression.", - "type": "string" - }, - "error": { - "description": "The error status if the join key expression failed to evaluate.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleRpcStatus" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult": { - "description": "The result of testing a constraint expression on a pair of conversations.", - "type": "object", - "properties": { - "conversationA": { - "description": "The first conversation resource name.", - "type": "string" - }, - "conversationB": { - "description": "The second conversation resource name.", - "type": "string" - }, - "ruleConstraintResults": { - "description": "The results for each applicable constraint rule.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult": { - "description": "The result of a single constraint rule on the pair of conversations.", - "type": "object", - "properties": { - "ruleId": { - "description": "The rule ID.", - "type": "string" - }, - "constraintMet": { - "description": "Whether the constraint expression evaluated to true for (A, B) or (B,\nA).", - "type": "boolean" - }, - "error": { - "description": "The error status if the constraint expression failed to evaluate.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleRpcStatus" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata": { - "description": "Metadata for undeploying an issue model.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "The original request for undeployment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest": { - "description": "The request to undeploy an issue model.", - "type": "object", - "properties": { - "name": { - "description": "Required. The issue model to undeploy.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse": { - "description": "The response to undeploy an issue model.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata": { - "description": "The metadata for updating a QaQuestionTag Resource.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest": { - "description": "The request for updating a QaQuestionTag.", - "type": "object", - "properties": { - "qaQuestionTag": { - "description": "Required. The QaQuestionTag to update.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaQuestionTag" - }] - }, - "updateMask": { - "description": "Optional. The list of fields to be updated. All possible fields can be updated by\npassing `*`, or a subset of the following updateable fields can be\nprovided:\n\n* `qa_question_tag_name` - the name of the tag\n* `qa_question_ids` - the list of questions the tag applies to", - "type": "string", - "pattern": "^(\\s*[^,\\s.]+(\\s*[,.]\\s*[^,\\s.]+)*)?$", - "format": "google-fieldmask" - } - }, - "required": [ - "qaQuestionTag" - ] - }, - "GoogleCloudContactcenterinsightsV1mainQaQuestionTag": { - "description": "A tag is a resource which aims to categorize a set of questions across\nmultiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. Resource name for the QaQuestionTag\nFormat\nprojects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}\nIn the above format, the last segment, i.e., qa_question_tag, is a\nserver-generated ID corresponding to the tag resource.", - "x-google-identifier": true, - "type": "string" - }, - "displayName": { - "description": "Required. A user-specified display name for the tag.", - "type": "string" - }, - "qaQuestionIds": { - "description": "Optional. The list of Scorecard Question IDs that the tag applies to.\nEach QaQuestionId is represented as a full resource name containing the\nQuestion ID. Lastly, Since a tag may not necessarily be referenced by any\nScorecard Questions, we treat this field as optional.", - "type": "array", - "items": { - "type": "string" - } - }, - "createTime": { - "description": "Output only. The time at which the question tag was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the question tag was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - } - }, - "required": [ - "displayName" - ] - }, - "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata": { - "description": "The metadata for an `UploadConversation` operation.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "request": { - "description": "Output only. The original request.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainUploadConversationRequest" - }] - }, - "analysisOperation": { - "description": "Output only. The operation name for a successfully created analysis operation, if any.", - "readOnly": true, - "type": "string" - }, - "appliedRedactionConfig": { - "description": "Output only. The redaction config applied to the uploaded conversation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainRedactionConfig" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest": { - "description": "Request to upload a conversation.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The parent resource of the conversation.", - "type": "string" - }, - "conversation": { - "description": "Required. The conversation resource to create.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversation" - }] - }, - "conversationId": { - "description": "Optional. A unique ID for the new conversation. This ID will become the final\ncomponent of the conversation's resource name. If no ID is specified, a\nserver-generated ID will be used.\n\nThis value should be 4-64 characters and must match the regular\nexpression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", - "type": "string" - }, - "redactionConfig": { - "description": "Optional. DLP settings for transcript redaction. Will default to the config specified\nin Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainRedactionConfig" - }] - }, - "speechConfig": { - "description": "Optional. Speech-to-Text configuration. Will default to the config specified\nin Settings.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSpeechConfig" - }] - } - }, - "required": [ - "parent", - "conversation" - ] - }, - "GoogleCloudContactcenterinsightsV1mainConversation": { - "description": "The conversation resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the conversation.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}", - "x-google-immutable": true, - "type": "string" - }, - "dataSource": { - "description": "The source of the audio and transcription for the conversation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationDataSource" - }] - }, - "createTime": { - "description": "Output only. The time at which the conversation was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "updateTime": { - "description": "Output only. The most recent time at which the conversation was updated.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "startTime": { - "description": "The time at which the conversation started.", - "type": "string", - "format": "date-time" - }, - "languageCode": { - "description": "A user-specified language code for the conversation.", - "type": "string" - }, - "agentId": { - "description": "An opaque, user-specified string representing the human agent who handled\nthe conversation.", - "type": "string" - }, - "customerId": { - "description": "An opaque, user-specified string representing the customer identifier.", - "type": "string" - }, - "labels": { - "description": "A map for the user to specify any custom fields. A maximum of 100 labels\nper conversation is allowed, with a maximum of 256 characters per entry.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "callMetadata": { - "description": "Call-specific metadata.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationCallMetadata" - }] - }, - "qualityMetadata": { - "description": "Conversation metadata related to quality management.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata" - }] - }, - "metadataJson": { - "description": "Input only. JSON metadata encoded as a string.\nThis field is primarily used by Insights integrations with various\ntelephony systems and must be in one of Insight's supported formats.", - "writeOnly": true, - "type": "string" - }, - "transcript": { - "description": "Output only. The conversation transcript.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationTranscript" - }] - }, - "medium": { - "description": "Immutable. The conversation medium.", - "x-google-immutable": true, - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "The format for conversations that took place over the phone.", - "The format for conversations that took place over chat." - ], - "enum": [ - "MEDIUM_UNSPECIFIED", - "PHONE_CALL", - "CHAT" - ] - }, - "duration": { - "description": "Output only. The duration of the conversation.", - "readOnly": true, - "type": "string", - "format": "google-duration" - }, - "turnCount": { - "description": "Output only. The number of turns in the conversation.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "latestAnalysis": { - "description": "Output only. The conversation's latest analysis, if one exists.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnalysis" - }] - }, - "latestSummary": { - "description": "Output only. Latest summary of the conversation.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" - }] - }, - "runtimeAnnotations": { - "description": "Output only. The annotations that were generated during the customer and agent\ninteraction.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation" - } - }, - "expireTime": { - "description": "The time at which this conversation should expire. After this time, the\nconversation data and any associated analyses will be deleted.", - "type": "string", - "format": "date-time" - }, - "ttl": { - "description": "Input only. The TTL for this resource. If specified, then this TTL will\nbe used to calculate the expire time.", - "writeOnly": true, - "type": "string", - "format": "google-duration" - }, - "dialogflowIntents": { - "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a\nDialogflow intent, format:\nprojects/{project}/agent/{agent}/intents/{intent}", - "readOnly": true, - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowIntent" - } - }, - "obfuscatedUserId": { - "description": "Obfuscated user ID which the customer sent to us.", - "type": "string" - }, - "dialogflowCxConversationData": { - "description": "The Dialogflow conversation raw data. It will only be populated when\nConversationView is DF_CONVERSATION_BASIC or DF_CONVERSATION_FULL.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationData" - }] - }, - "aaSupervisorMonitoringStatus": { - "description": "Output only. Data from the monitoring status of a conversation by a human supervisor in\nAA. A human supervisor is a human agent that is monitoring virtual agent\nconversations.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationAgentAssistSupervisorMonitoringStatus" - }] - }, - "correlationInfo": { - "description": "Output only. Info for correlating across conversations.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationDataSource": { - "description": "The conversation source, which is a combination of transcript and audio.", - "type": "object", - "properties": { - "gcsSource": { - "description": "A Cloud Storage location specification for the audio and transcript.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainGcsSource" - }] - }, - "dialogflowSource": { - "description": "The source when the conversation comes from Dialogflow.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowSource" - }] - }, - "metadataUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation\nmetadata.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainGcsSource": { - "description": "A Cloud Storage source of conversation data.", - "type": "object", - "properties": { - "audioUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", - "type": "string" - }, - "transcriptUri": { - "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation\ntranscript.", - "x-google-immutable": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDialogflowSource": { - "description": "A Dialogflow source of conversation data.", - "type": "object", - "properties": { - "dialogflowConversation": { - "description": "Output only. The name of the Dialogflow conversation that this conversation\nresource is derived from. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}", - "readOnly": true, - "type": "string" - }, - "audioUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation\naudio.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata": { - "description": "Call-specific metadata.", - "type": "object", - "properties": { - "customerChannel": { - "description": "The audio channel that contains the customer.", - "type": "integer", - "format": "int32" - }, - "agentChannel": { - "description": "The audio channel that contains the agent.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata": { - "description": "Conversation metadata related to quality management.", - "type": "object", - "properties": { - "customerSatisfactionRating": { - "description": "An arbitrary integer value indicating the customer's satisfaction rating.", - "type": "integer", - "format": "int32" - }, - "waitDuration": { - "description": "The amount of time the customer waited to connect with an agent.", - "type": "string", - "format": "google-duration" - }, - "menuPath": { - "description": "An arbitrary string value specifying the menu path the customer took.", - "type": "string" - }, - "agentInfo": { - "description": "Information about agents involved in the call.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo" - } - }, - "feedbackLabels": { - "description": "Input only. The feedback labels associated with the conversation.", - "writeOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFeedbackLabel" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo": { - "description": "Information about an agent involved in the conversation.", - "type": "object", - "properties": { - "agentId": { - "description": "A user-specified string representing the agent.", - "type": "string" - }, - "displayName": { - "description": "The agent's name.", - "type": "string" - }, - "team": { - "description": "A user-specified string representing the agent's team. Deprecated in\nfavor of the `teams` field.", - "deprecated": true, - "type": "string" - }, - "teams": { - "description": "User-specified strings representing the agent's teams.", - "type": "array", - "items": { - "type": "string" - } - }, - "dispositionCode": { - "description": "A user-provided string indicating the outcome of the agent's segment of\nthe call.", - "type": "string" - }, - "agentType": { - "description": "The agent type, e.g. HUMAN_AGENT.", - "type": "string", - "x-google-enum-descriptions": [ - "Participant's role is not set.", - "Participant is a human agent.", - "Participant is an automated agent.", - "Participant is an end user who conversed with the contact center.", - "Participant is either a human or automated agent." - ], - "enum": [ - "ROLE_UNSPECIFIED", - "HUMAN_AGENT", - "AUTOMATED_AGENT", - "END_USER", - "ANY_AGENT" - ] - }, - "location": { - "description": "The agent's location.", - "type": "string" - }, - "deploymentId": { - "description": "The agent's deployment ID. Only applicable to automated agents.", - "type": "string" - }, - "deploymentDisplayName": { - "description": "The agent's deployment display name. Only applicable to automated\nagents.", - "type": "string" - }, - "versionId": { - "description": "The agent's version ID. Only applicable to automated agents.", - "type": "string" - }, - "versionDisplayName": { - "description": "The agent's version display name. Only applicable to automated agents.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationTranscript": { - "description": "A message representing the transcript of a conversation.", - "type": "object", - "properties": { - "transcriptSegments": { - "description": "A list of sequential transcript segments that comprise the conversation.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment": { - "description": "A segment of a full transcript.", - "type": "object", - "properties": { - "messageTime": { - "description": "The time that the message occurred, if provided.", - "type": "string", - "format": "date-time" - }, - "text": { - "description": "The text of this segment.", - "type": "string" - }, - "confidence": { - "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nsegment. A default value of 0.0 indicates that the value is unset.", - "type": "number", - "format": "float" - }, - "words": { - "description": "A list of the word-specific information for each word in the segment.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo" - } - }, - "languageCode": { - "description": "The language code of this segment as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".", - "type": "string" - }, - "channelTag": { - "description": "For conversations derived from multi-channel audio, this is the channel\nnumber corresponding to the audio from that channel. For\naudioChannelCount = N, its output values can range from '1' to 'N'. A\nchannel tag of 0 indicates that the audio is mono.", - "type": "integer", - "format": "int32" - }, - "segmentParticipant": { - "description": "The participant of this segment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationParticipant" - }] - }, - "dialogflowSegmentMetadata": { - "description": "CCAI metadata relating to the current transcript segment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" - }] - }, - "sentiment": { - "description": "The sentiment for this transcript segment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo": { - "description": "Word-level info for words in a transcript.", - "type": "object", - "properties": { - "startOffset": { - "description": "Time offset of the start of this word relative to the beginning of\nthe total conversation.", - "type": "string", - "format": "google-duration" - }, - "endOffset": { - "description": "Time offset of the end of this word relative to the beginning of the\ntotal conversation.", - "type": "string", - "format": "google-duration" - }, - "word": { - "description": "The word itself. Includes punctuation marks that surround the word.", - "type": "string" - }, - "confidence": { - "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this\nword. A default value of 0.0 indicates that the value is unset.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationParticipant": { - "description": "The call participant speaking for a given utterance.", - "type": "object", - "properties": { - "dialogflowParticipant": { - "description": "Deprecated. Use `dialogflow_participant_name` instead.\nThe name of the Dialogflow participant. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", - "deprecated": true, - "type": "string" - }, - "dialogflowParticipantName": { - "description": "The name of the participant provided by Dialogflow. Format:\nprojects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", - "type": "string" - }, - "userId": { - "description": "A user-specified ID representing the participant.", - "type": "string" - }, - "obfuscatedExternalUserId": { - "description": "Obfuscated user ID from Dialogflow.", - "type": "string" - }, - "role": { - "description": "The role of the participant.", - "type": "string", - "x-google-enum-descriptions": [ - "Participant's role is not set.", - "Participant is a human agent.", - "Participant is an automated agent.", - "Participant is an end user who conversed with the contact center.", - "Participant is either a human or automated agent." - ], - "enum": [ - "ROLE_UNSPECIFIED", - "HUMAN_AGENT", - "AUTOMATED_AGENT", - "END_USER", - "ANY_AGENT" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { - "description": "Metadata from Dialogflow relating to the current transcript segment.", - "type": "object", - "properties": { - "smartReplyAllowlistCovered": { - "description": "Whether the transcript segment was covered under the configured smart\nreply allowlist in Agent Assist.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainSentimentData": { - "description": "The data for a sentiment annotation.", - "type": "object", - "properties": { - "magnitude": { - "description": "A non-negative number from 0 to infinity which represents the absolute\nmagnitude of sentiment regardless of score.", - "type": "number", - "format": "float" - }, - "score": { - "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", - "type": "number", - "format": "float" - }, - "rationale": { - "description": "The rationale for the sentiment result.", - "type": "string" - }, - "modelType": { - "description": "The sentiment model used to produce the sentiment result.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified model type.", - "V1 model.", - "V2 LLM model." - ], - "enum": [ - "SENTIMENT_MODEL_TYPE_UNSPECIFIED", - "SENTIMENT_MODEL_TYPE_V1", - "SENTIMENT_MODEL_TYPE_V2" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainAnalysis": { - "description": "The analysis resource.", - "type": "object", - "properties": { - "name": { - "description": "Immutable. The resource name of the analysis.\nFormat:\nprojects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", - "x-google-immutable": true, - "type": "string" - }, - "requestTime": { - "description": "Output only. The time at which the analysis was requested.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "createTime": { - "description": "Output only. The time at which the analysis was created, which occurs when the\nlong-running operation completes.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "analysisResult": { - "description": "Output only. The result of the analysis, which is populated when the analysis\nfinishes.", - "readOnly": true, - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnalysisResult" - }] - }, - "annotatorSelector": { - "description": "To select the annotators to run and the phrase matchers to use\n(if any). If not specified, all annotators will be run.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainAnalysisResult": { - "description": "The result of an analysis.", - "type": "object", - "properties": { - "endTime": { - "description": "The time at which the analysis ended.", - "type": "string", - "format": "date-time" - }, - "callAnalysisMetadata": { - "description": "Call-specific metadata created by the analysis.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata": { - "description": "Call-specific metadata created during analysis.", - "type": "object", - "properties": { - "annotations": { - "description": "A list of call annotations that apply to this call.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainCallAnnotation" - } - }, - "entities": { - "description": "All the entities in the call.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainEntity" - } - }, - "sentiments": { - "description": "Overall conversation-level sentiment for each channel of the call.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment" - } - }, - "silence": { - "description": "Overall conversation-level silence during the call.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationLevelSilence" - }] - }, - "intents": { - "description": "All the matched intents in the call.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIntent" - } - }, - "phraseMatchers": { - "description": "All the matched phrase matchers in the call.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainPhraseMatchData" - } - }, - "issueModelResult": { - "description": "Overall conversation-level issue modeling result.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueModelResult" - }] - }, - "semanticMatchMetadata": { - "description": "Metadata used in the semantic match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSemanticMatchMetadata" - }] - }, - "qaScorecardResults": { - "description": "Results of scoring QaScorecards.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaScorecardResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainCallAnnotation": { - "description": "A piece of metadata that applies to a window of a call.", - "type": "object", - "properties": { - "channelTag": { - "description": "The channel of the audio where the annotation occurs. For single-channel\naudio, this field is not populated.", - "type": "integer", - "format": "int32" - }, - "annotationStartBoundary": { - "description": "The boundary in the conversation where the annotation starts, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" - }] - }, - "annotationEndBoundary": { - "description": "The boundary in the conversation where the annotation ends, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" - }] - }, - "interruptionData": { - "description": "Data specifying an interruption.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainInterruptionData" - }] - }, - "sentimentData": { - "description": "Data specifying sentiment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSentimentData" - }] - }, - "silenceData": { - "description": "Data specifying silence.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSilenceData" - }] - }, - "holdData": { - "description": "Data specifying a hold.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainHoldData" - }] - }, - "entityMentionData": { - "description": "Data specifying an entity mention.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainEntityMentionData" - }] - }, - "intentMatchData": { - "description": "Data specifying an intent match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIntentMatchData" - }] - }, - "phraseMatchData": { - "description": "Data specifying a phrase match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainPhraseMatchData" - }] - }, - "issueMatchData": { - "description": "Data specifying an issue match.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueMatchData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary": { - "description": "A point in a conversation that marks the start or the end of an annotation.", - "type": "object", - "properties": { - "transcriptIndex": { - "description": "The index in the sequence of transcribed pieces of the conversation where\nthe boundary is located. This index starts at zero.", - "type": "integer", - "format": "int32" - }, - "wordIndex": { - "description": "The word index of this boundary with respect to the first word in the\ntranscript piece. This index starts at zero.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainInterruptionData": { - "description": "The data for an interruption annotation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainSilenceData": { - "description": "The data for a silence annotation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainHoldData": { - "description": "The data for a hold annotation.", - "type": "object" - }, - "GoogleCloudContactcenterinsightsV1mainEntityMentionData": { - "description": "The data for an entity mention annotation.\nThis represents a mention of an `Entity` in the conversation.", - "type": "object", - "properties": { - "entityUniqueId": { - "description": "The key of this entity in conversation entities.\nCan be used to retrieve the exact `Entity` this mention is attached to.", - "type": "string" - }, - "type": { - "description": "The type of the entity mention.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Proper noun.", - "Common noun (or noun compound)." - ], - "enum": [ - "MENTION_TYPE_UNSPECIFIED", - "PROPER", - "COMMON" - ] - }, - "sentiment": { - "description": "Sentiment expressed for this mention of the entity.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIntentMatchData": { - "description": "The data for an intent match.\nRepresents an intent match for a text segment in the conversation. A text\nsegment can be part of a sentence, a complete sentence, or an utterance\nwith multiple sentences.", - "type": "object", - "properties": { - "intentUniqueId": { - "description": "The id of the matched intent.\nCan be used to retrieve the corresponding intent information.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainPhraseMatchData": { - "description": "The data for a matched phrase matcher.\nRepresents information identifying a phrase matcher for a given match.", - "type": "object", - "properties": { - "phraseMatcher": { - "description": "The unique identifier (the resource name) of the phrase matcher.", - "type": "string" - }, - "displayName": { - "description": "The human-readable name of the phrase matcher.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIssueMatchData": { - "description": "The data for an issue match annotation.", - "type": "object", - "properties": { - "issueAssignment": { - "description": "Information about the issue's assignment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueAssignment" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIssueAssignment": { - "description": "Information about the issue.", - "type": "object", - "properties": { - "issue": { - "description": "Resource name of the assigned issue.", - "type": "string" - }, - "score": { - "description": "Score indicating the likelihood of the issue assignment.\ncurrently bounded on [0,1].", - "type": "number", - "format": "double" - }, - "displayName": { - "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis\nand immutable since then.", - "x-google-immutable": true, - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainEntity": { - "description": "The data for an entity annotation.\nRepresents a phrase in the conversation that is a known entity, such\nas a person, an organization, or location.", - "type": "object", - "properties": { - "displayName": { - "description": "The representative name for the entity.", - "type": "string" - }, - "type": { - "description": "The entity type.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified.", - "Person.", - "Location.", - "Organization.", - "Event.", - "Artwork.", - "Consumer product.", - "Other types of entities.", - "Phone number.\n\nThe metadata lists the phone number (formatted according to local\nconvention), plus whichever additional elements appear in the text:\n\n* `number` - The actual number, broken down into sections according to\nlocal convention.\n* `national_prefix` - Country code, if detected.\n* `area_code` - Region or area code, if detected.\n* `extension` - Phone extension (to be dialed after connection), if\ndetected.", - "Address.\n\nThe metadata identifies the street number and locality plus whichever\nadditional elements appear in the text:\n\n* `street_number` - Street number.\n* `locality` - City or town.\n* `street_name` - Street/route name, if detected.\n* `postal_code` - Postal code, if detected.\n* `country` - Country, if detected.\n* `broad_region` - Administrative area, such as the state, if detected.\n* `narrow_region` - Smaller administrative area, such as county, if\ndetected.\n* `sublocality` - Used in Asian addresses to demark a district within a\ncity, if detected.", - "Date.\n\nThe metadata identifies the components of the date:\n\n* `year` - Four digit year, if detected.\n* `month` - Two digit month number, if detected.\n* `day` - Two digit day number, if detected.", - "Number.\n\nThe metadata is the number itself.", - "Price.\n\nThe metadata identifies the `value` and `currency`." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "PERSON", - "LOCATION", - "ORGANIZATION", - "EVENT", - "WORK_OF_ART", - "CONSUMER_GOOD", - "OTHER", - "PHONE_NUMBER", - "ADDRESS", - "DATE", - "NUMBER", - "PRICE" - ] - }, - "metadata": { - "description": "Metadata associated with the entity.\n\nFor most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)\nand Knowledge Graph MID (`mid`), if they are available. For the metadata\nassociated with other entity types, see the Type table below.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "salience": { - "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.", - "type": "number", - "format": "float" - }, - "sentiment": { - "description": "The aggregate sentiment expressed for this entity in the conversation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment": { - "description": "One channel of conversation-level sentiment data.", - "type": "object", - "properties": { - "channelTag": { - "description": "The channel of the audio that the data applies to.", - "type": "integer", - "format": "int32" - }, - "sentimentData": { - "description": "Data specifying sentiment.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSentimentData" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence": { - "description": "Conversation-level silence data.", - "type": "object", - "properties": { - "silenceDuration": { - "description": "Amount of time calculated to be in silence.", - "type": "string", - "format": "google-duration" - }, - "silencePercentage": { - "description": "Percentage of the total conversation spent in silence.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIntent": { - "description": "The data for an intent.\nRepresents a detected intent in the conversation, for example MAKES_PROMISE.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the intent.", - "type": "string" - }, - "displayName": { - "description": "The human-readable name of the intent.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainIssueModelResult": { - "description": "Issue Modeling result on a conversation.", - "type": "object", - "properties": { - "issueModel": { - "description": "Issue model that generates the result.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", - "type": "string" - }, - "issues": { - "description": "All the matched issues.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainIssueAssignment" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainSemanticMatchMetadata": { - "description": "Semantic match metadata used in an analysis.", - "type": "object", - "properties": { - "issueModel": { - "description": "Issue model that's used in the semantic match.\nFormat: projects/{project}/locations/{location}/issueModels/{issue_model}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaScorecardResult": { - "description": "The results of scoring a single conversation against a QaScorecard. Contains\na collection of QaAnswers and aggregate score.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The name of the scorecard result.\nFormat:\nprojects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", - "x-google-identifier": true, - "type": "string" - }, - "qaScorecardRevision": { - "description": "The QaScorecardRevision scored by this result.", - "type": "string" - }, - "conversation": { - "description": "The conversation scored by this result.", - "type": "string" - }, - "createTime": { - "description": "Output only. The timestamp that the revision was created.", - "readOnly": true, - "type": "string", - "format": "date-time" - }, - "agentId": { - "description": "ID of the agent that handled the conversation.", - "type": "string" - }, - "qaAnswers": { - "description": "Set of QaAnswers represented in the result.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswer" - } - }, - "score": { - "description": "The overall numerical score of the result, incorporating any manual edits\nif they exist.", - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "The normalized score, which is the score divided by the potential score.\nAny manual edits are included if they exist.", - "type": "number", - "format": "double" - }, - "qaTagResults": { - "description": "Collection of tags and their scores.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" - } - }, - "scoreSources": { - "description": "List of all individual score sets.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaAnswer": { - "description": "An answer to a QaQuestion.", - "type": "object", - "properties": { - "qaQuestion": { - "description": "The QaQuestion answered by this answer.", - "type": "string" - }, - "conversation": { - "description": "The conversation the answer applies to.", - "type": "string" - }, - "questionBody": { - "description": "Question text. E.g., \"Did the agent greet the customer?\"", - "type": "string" - }, - "answerValue": { - "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" - }] - }, - "tags": { - "description": "User-defined list of arbitrary tags. Matches the value from\nQaScorecard.ScorecardQuestion.tags. Used for grouping/organization and\nfor weighting the score of each answer.", - "type": "array", - "items": { - "type": "string" - } - }, - "answerSources": { - "description": "Lists all answer sources containing one or more answer values of a\nspecific source type, e.g., all system-generated answer sources, or all\nmanual edit answer sources.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource": { - "description": "A question may have multiple answers from varying sources, one of which\nbecomes the \"main\" answer above. AnswerSource represents each individual\nanswer.", - "type": "object", - "properties": { - "sourceType": { - "description": "What created the answer.", - "type": "string", - "x-google-enum-descriptions": [ - "Source type is unspecified.", - "Answer was system-generated; created during an Insights analysis.", - "Answer was created by a human via manual edit." - ], - "enum": [ - "SOURCE_TYPE_UNSPECIFIED", - "SYSTEM_GENERATED", - "MANUAL_EDIT" - ] - }, - "answerValue": { - "description": "The answer value from this source. This field is populated by default,\nunless the question has a selection strategy configured to return\nmultiple answer values, in which case `answer_values` will be populated\ninstead.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult": { - "description": "Tags and their corresponding results.", - "type": "object", - "properties": { - "tag": { - "description": "The tag the score applies to.", - "type": "string" - }, - "score": { - "description": "The score the tag applies to.", - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "The potential score the tag applies to.", - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "The normalized score the tag applies to.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource": { - "description": "A scorecard result may have multiple sets of scores from varying sources,\none of which becomes the \"main\" answer above. A ScoreSource represents\neach individual set of scores.", - "type": "object", - "properties": { - "sourceType": { - "description": "What created the score.", - "type": "string", - "x-google-enum-descriptions": [ - "Source type is unspecified.", - "Score is derived only from system-generated answers.", - "Score is derived from both system-generated answers, and includes\nany manual edits if they exist." - ], - "enum": [ - "SOURCE_TYPE_UNSPECIFIED", - "SYSTEM_GENERATED_ONLY", - "INCLUDES_MANUAL_EDITS" - ] - }, - "score": { - "description": "The overall numerical score of the result.", - "type": "number", - "format": "double" - }, - "potentialScore": { - "description": "The maximum potential overall score of the scorecard. Any questions\nanswered using `na_value` are excluded from this calculation.", - "type": "number", - "format": "double" - }, - "normalizedScore": { - "description": "The normalized score, which is the score divided by the potential score.", - "type": "number", - "format": "double" - }, - "qaTagResults": { - "description": "Collection of tags and their scores.", - "type": "array", - "items": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" - } - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData": { - "description": "Conversation summarization suggestion data.", - "type": "object", - "properties": { - "text": { - "description": "The summarization content that is concatenated into one string.", - "type": "string" - }, - "textSections": { - "description": "The summarization content that is divided into sections. The key is the\nsection's name and the value is the section's content. There is no\nspecific format for the key or value.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "confidence": { - "description": "The confidence score of the summarization.", - "type": "number", - "format": "float" - }, - "metadata": { - "description": "A map that contains metadata about the summarization and the document\nfrom which it originates.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "answerRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - }, - "conversationModel": { - "description": "The name of the model that generates this summary.\nFormat:\nprojects/{project}/locations/{location}/conversationModels/{conversation_model}", - "type": "string" - }, - "generatorId": { - "description": "Agent Assist generator ID.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation": { - "description": "An annotation that was generated during the customer and agent interaction.", - "type": "object", - "properties": { - "annotationId": { - "description": "The unique identifier of the annotation.\nFormat:\nprojects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", - "type": "string" - }, - "createTime": { - "description": "The time at which this annotation was created.", - "type": "string", - "format": "date-time" - }, - "startBoundary": { - "description": "The boundary in the conversation where the annotation starts, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" - }] - }, - "endBoundary": { - "description": "The boundary in the conversation where the annotation ends, inclusive.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" - }] - }, - "answerFeedback": { - "description": "The feedback that the customer has about the answer in `data`.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainAnswerFeedback" - }] - }, - "articleSuggestion": { - "description": "Agent Assist Article Suggestion data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainArticleSuggestionData" - }] - }, - "faqAnswer": { - "description": "Agent Assist FAQ answer data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainFaqAnswerData" - }] - }, - "smartReply": { - "description": "Agent Assist Smart Reply data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSmartReplyData" - }] - }, - "smartComposeSuggestion": { - "description": "Agent Assist Smart Compose suggestion data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData" - }] - }, - "dialogflowInteraction": { - "description": "Dialogflow interaction data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData" - }] - }, - "conversationSummarizationSuggestion": { - "description": "Conversation summarization suggestion data.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" - }] - }, - "userInput": { - "description": "Explicit input used for generating the answer", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainAnswerFeedback": { - "description": "The feedback that the customer has about a certain answer in the\nconversation.", - "type": "object", - "properties": { - "correctnessLevel": { - "description": "The correctness level of an answer.", - "type": "string", - "x-google-enum-descriptions": [ - "Correctness level unspecified.", - "Answer is totally wrong.", - "Answer is partially correct.", - "Answer is fully correct." - ], - "enum": [ - "CORRECTNESS_LEVEL_UNSPECIFIED", - "NOT_CORRECT", - "PARTIALLY_CORRECT", - "FULLY_CORRECT" - ] - }, - "clicked": { - "description": "Indicates whether an answer or item was clicked by the human agent.", - "type": "boolean" - }, - "displayed": { - "description": "Indicates whether an answer or item was displayed to the human agent in the\nagent desktop UI.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData": { - "description": "Agent Assist Article Suggestion data.", - "type": "object", - "properties": { - "title": { - "description": "Article title.", - "type": "string" - }, - "uri": { - "description": "Article URI.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this article is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "float" - }, - "metadata": { - "description": "Map that contains metadata about the Article Suggestion and the document\nthat it originates from.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - }, - "source": { - "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainFaqAnswerData": { - "description": "Agent Assist frequently-asked-question answer data.", - "type": "object", - "properties": { - "answer": { - "description": "The piece of text from the `source` knowledge base document.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this answer is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "float" - }, - "question": { - "description": "The corresponding FAQ question.", - "type": "string" - }, - "metadata": { - "description": "Map that contains metadata about the FAQ answer and the document that\nit originates from.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - }, - "source": { - "description": "The knowledge document that this answer was extracted from.\nFormat:\nprojects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainSmartReplyData": { - "description": "Agent Assist Smart Reply data.", - "type": "object", - "properties": { - "reply": { - "description": "The content of the reply.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this reply is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "double" - }, - "metadata": { - "description": "Map that contains metadata about the Smart Reply and the document from\nwhich it originates.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData": { - "description": "Agent Assist Smart Compose suggestion data.", - "type": "object", - "properties": { - "suggestion": { - "description": "The content of the suggestion.", - "type": "string" - }, - "confidenceScore": { - "description": "The system's confidence score that this suggestion is a good match for this\nconversation, ranging from 0.0 (completely uncertain) to 1.0 (completely\ncertain).", - "type": "number", - "format": "double" - }, - "metadata": { - "description": "Map that contains metadata about the Smart Compose suggestion and the\ndocument from which it originates.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryRecord": { - "description": "The name of the answer record.\nFormat:\nprojects/{project}/locations/{location}/answerRecords/{answer_record}", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData": { - "description": "Dialogflow interaction data.", - "type": "object", - "properties": { - "dialogflowIntentId": { - "description": "The Dialogflow intent resource path. Format:\nprojects/{project}/agent/{agent}/intents/{intent}", - "type": "string" - }, - "confidence": { - "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0\n(completely certain).", - "type": "number", - "format": "float" - }, - "detectIntentRequest": { - "description": "The Dialogflow conversation DetectIntentRequest raw data of this turn. This\nfield will only be populated in the GetConversation response and its data\nformat should be same as Dialogflow [DetectIntentRequest] of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL." - } - }, - "detectIntentResponse": { - "description": "The Dialogflow conversation DetectIntentResponse raw data of this turn.\nThis field will only be populated in the GetConversation response and its\ndata format should be same as Dialogflow DetectIntentResponse of\n[Sessions](https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/cx/v3/session.proto).", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL." - } - }, - "flowId": { - "description": "The Dialogflow flow id.", - "type": "string" - }, - "flowDisplayName": { - "description": "The Dialogflow flow display name.\nThe Dialogflow environment display name.", - "type": "string" - }, - "pageId": { - "description": "The Dialogflow page ID.", - "type": "string" - }, - "pageDisplayName": { - "description": "The Dialogflow page display name.\nThe Dialogflow environment display name.", - "type": "string" - }, - "intentId": { - "description": "The Dialogflow intent ID.", - "type": "string" - }, - "intentDisplayName": { - "description": "The Dialogflow intent display name.\nThe Dialogflow environment display name.", - "type": "string" - }, - "endFlowOrSession": { - "description": "The turn reaches END_FLOW or END_SESSION.", - "type": "boolean" - }, - "liveAgentHandoff": { - "description": "Whether the turn was handed off to a human agent.", - "type": "boolean" - }, - "inputType": { - "description": "The input type in this turn.", - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified. Should never be used.", - "Text input.", - "Intent input.", - "Audio input.", - "Event input.", - "DTMF input." - ], - "enum": [ - "INPUT_TYPE_UNSPECIFIED", - "INPUT_TYPE_TEXT", - "INPUT_TYPE_INTENT", - "INPUT_TYPE_AUDIO", - "INPUT_TYPE_EVENT", - "INPUT_TYPE_DTMF" - ] - }, - "matchType": { - "description": "The match type in this turn.", - "type": "string", - "x-google-enum-descriptions": [ - "Not specified. Should never be used.", - "An intent is matched.", - "The input is an intent.", - "The input is for parameter filling.", - "No intent match for the input.", - "Indicates an empty input.", - "The input is an event." - ], - "enum": [ - "MATCH_TYPE_UNSPECIFIED", - "MATCH_TYPE_INTENT", - "MATCH_TYPE_DIRECT_INTENT", - "MATCH_TYPE_PARAMETER_FILLING", - "MATCH_TYPE_NO_MATCH", - "MATCH_TYPE_NO_INPUT", - "MATCH_TYPE_EVENT" - ] - }, - "detectIntentResponseV3": { - "description": "The Dialogflow v3 DetectIntentResponse raw data of this turn.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudDialogflowV3alpha1DetectIntentResponse" - }] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput": { - "description": "Explicit input used for generating the answer", - "type": "object", - "properties": { - "query": { - "description": "Query text. Article Search uses this to store the input query used\nto generate the search results.", - "type": "string" - }, - "generatorName": { - "description": "The resource name of associated generator. Format:\n`projects//locations//generators/`", - "type": "string" - }, - "querySource": { - "description": "Query source for the answer.", - "type": "string", - "x-google-enum-descriptions": [ - "Unknown query source.", - "The query is from agents.", - "The query is a query from previous suggestions, e.g. from a preceding\nSuggestKnowledgeAssist response.", - "The query is from the end user." - ], - "enum": [ - "QUERY_SOURCE_UNSPECIFIED", - "AGENT_QUERY", - "SUGGESTED_QUERY", - "END_USER_QUERY" - ] - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDialogflowIntent": { - "description": "The data for a Dialogflow intent.\nRepresents a detected intent in the conversation, e.g. MAKES_PROMISE.", - "type": "object", - "properties": { - "displayName": { - "description": "The human-readable name of the intent.", - "type": "string" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationData": { - "description": "The metadata for a Dialogflow CX conversation.", - "type": "object", - "properties": { - "virtualAgentId": { - "description": "The virtual agent id of this conversation.", - "type": "string" - }, - "flowIds": { - "description": "The deduped flow UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "flowDisplayNames": { - "description": "The deduped flow display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "pageIds": { - "description": "The deduped page UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "pageDisplayNames": { - "description": "The deduped page display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "intentIds": { - "description": "The deduped intent UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "intentDisplayNames": { - "description": "The deduped intent display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "experimentIds": { - "description": "The deduped experiment UUIDs set.", - "type": "array", - "items": { - "type": "string" - } - }, - "experimentDisplayNames": { - "description": "The deduped experiment display names set.", - "type": "array", - "items": { - "type": "string" - } - }, - "inputAudioDuration": { - "description": "The total duration of the user input audio in this conversation.", - "type": "string", - "format": "google-duration" - }, - "outputAudioDuration": { - "description": "The total duration of the agent output audio in this conversation.", - "type": "string", - "format": "google-duration" - }, - "queryInputStats": { - "description": "Query input stats", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationDataQueryInputStats" - }] - }, - "matchTypeStats": { - "description": "Match type stats.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationDataMatchTypeStats" - }] - }, - "averageMatchConfidence": { - "description": "Average match confidence for all the initent matches in this conversation.", - "type": "number", - "format": "float" - }, - "endSessionExit": { - "description": "Whether the conversation reaches END_FLOW or END_SESSION.", - "type": "boolean" - }, - "maxWebhookLatency": { - "description": "The maximum webhook latency for an individual webhook call in this\nconversation.", - "type": "string", - "format": "google-duration" - }, - "liveAgentHandoff": { - "description": "Whether the conversation was handed off to a human agent.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationDataQueryInputStats": { - "description": "Count by input types in this conversation", - "type": "object", - "properties": { - "textCount": { - "description": "The number of requests with text input.", - "type": "integer", - "format": "int32" - }, - "intentCount": { - "description": "The number of requests with intent input.", - "type": "integer", - "format": "int32" - }, - "audioCount": { - "description": "The number of requests with audio input.", - "type": "integer", - "format": "int32" - }, - "eventCount": { - "description": "The number of requests with event input.", - "type": "integer", - "format": "int32" - }, - "dtmfCount": { - "description": "The number of requests with DTMF input.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainDialogflowCxConversationDataMatchTypeStats": { - "description": "Count by match types in this conversation .", - "type": "object", - "properties": { - "intentCount": { - "description": "The number of responses with match type INTENT.", - "type": "integer", - "format": "int32" - }, - "directIntentCount": { - "description": "The number of responses with match type DIRECT_INTENT.", - "type": "integer", - "format": "int32" - }, - "parameterFillingCount": { - "description": "The number of responses with match type PARAMETER_FILLING.", - "type": "integer", - "format": "int32" - }, - "noMatchCount": { - "description": "The number of responses with match type NO_MATCH.", - "type": "integer", - "format": "int32" - }, - "noInputCount": { - "description": "The number of responses with match type NO_INPUT.", - "type": "integer", - "format": "int32" - }, - "eventCount": { - "description": "The number of responses with match type EVENT.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationAgentAssistSupervisorMonitoringStatus": { - "description": "Tracks the status of an AA supervisor monitoring a conversation.", - "type": "object", - "properties": { - "monitored": { - "description": "The conversation was monitored by an AA supervisor.", - "type": "boolean" - }, - "escalatedToSupervisor": { - "description": "The conversation was escalated to an AA supervisor for intervention.", - "type": "boolean" - }, - "assignedSupervisor": { - "description": "The ID of the assigned AA supervisor.", - "type": "string" - }, - "transferredToHumanAgent": { - "description": "The conversation was transferred to a human agent by the AA supervisor.", - "type": "boolean" - } - } - }, - "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo": { - "description": "Info for correlating across conversations.", - "type": "object", - "properties": { - "fullConversationCorrelationId": { - "description": "Output only. The full conversation correlation id this conversation is a segment of.", - "readOnly": true, - "type": "string" - }, - "mergedFullConversationCorrelationId": { - "description": "Output only. The full conversation correlation id this conversation is a merged\nconversation of.", - "readOnly": true, - "type": "string" - }, - "correlationTypes": { - "description": "Output only. The correlation types of this conversation. A single conversation can\nhave multiple correlation types. For example a conversation that only has\na single segment is both a SEGMENT and a FULL_CONVERSATION.", - "readOnly": true, - "type": "array", - "items": { - "type": "string", - "x-google-enum-descriptions": [ - "Default value for unspecified.", - "This conversation represents a segment of a full conversation. The\nlowest level of granularity.", - "This conversation represents a partial conversation of potentially\nmultiple segments but is not a full conversation.", - "This conversation represents a full conversation of potentially\nmultiple segments.", - "This conversation represents a synthetic conversation." - ], - "enum": [ - "CORRELATION_TYPE_UNSPECIFIED", - "SEGMENT", - "PARTIAL", - "FULL", - "SYNTHETIC" - ] - } - } - } - }, - "BaseOperation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object", - "properties": { - "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", - "type": "boolean" - }, - "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "allOf": [{ - "$ref": "#/components/schemas/GoogleRpcStatus" - }] - } - } - }, - "GoogleLongrunningOperation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL." - } - }, - "response": { - "description": "The normal, successful response of the operation. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL." - } - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1UploadConversationOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1DeleteDatasetOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteDatasetMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1SampleConversationsOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1CreateAnalysisOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1IngestConversationsOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1ExportInsightsDataOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1CreateIssueModelOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1DeleteIssueModelOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1DeployIssueModelOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1UndeployIssueModelOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1ExportIssueModelOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1ImportIssueModelOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1CreateIssueOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1MergeIssuesOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1MergeIssuesMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1Issue" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1CreateFaqModelOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateFaqModelMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1FaqModel" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1DeleteFaqModelOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteFaqModelMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1TestCorrelationConfigOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1QueryMetricsOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1GenerativeInsightsOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleProtobufEmpty" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUpdateQaQuestionsResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1GenerateDiscoveryOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1GenerateDiscoveryResponse" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionOperation": { - "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseOperation" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1CreateDiscoveryRevisionMetadata" - }, - "response": { - "$ref": "#/components/schemas/GoogleCloudContactcenterinsightsV1DiscoveryRevision" - } - } - } - ] - }, - "GoogleCloudContactcenterinsightsV1PredefinedQaScorecardType": { - "type": "string", - "x-google-enum-descriptions": [ - "The type of the predefined scorecard is unspecified.", - "The scorecard for conversation classification, which includes\nquestions like conversation_outcome_classification,\nagent_helpful_classification, user_unsatisfied_classification, and\nwho_escalated_classification." - ], - "enum": [ - "PREDEFINED_QA_SCORECARD_TYPE_UNSPECIFIED", - "CONVERSATION_CLASSIFICATION" - ] - }, - "GoogleCloudDialogflowV3alpha1DataStoreType": { - "type": "string", - "x-google-enum-descriptions": [ - "Not specified. This value indicates that the data store type is not\nspecified, so it will not be used during search.", - "A data store that contains public web content.", - "A data store that contains unstructured private data.", - "A data store that contains structured data used as FAQ.", - "A data store that contains structured data used as Connector." - ], - "enum": [ - "DATA_STORE_TYPE_UNSPECIFIED", - "PUBLIC_WEB", - "UNSTRUCTURED", - "STRUCTURED", - "CONNECTOR" - ] - }, - "GoogleCloudDialogflowV3alpha1DocumentProcessingMode": { - "type": "string", - "x-google-enum-descriptions": [ - "Not specified. This should be set for STRUCTURED type data stores. Due to\nlegacy reasons this is considered as DOCUMENTS for STRUCTURED and\nPUBLIC_WEB data stores.", - "Documents are processed as documents.", - "Documents are converted to chunks." - ], - "enum": [ - "DOCUMENT_PROCESSING_MODE_UNSPECIFIED", - "DOCUMENTS", - "CHUNKS" - ] - }, - "GoogleCloudDialogflowV3alpha1EngineType": { - "type": "string", - "x-google-enum-descriptions": [ - "Not specified. Will default to CHAT_ENGINE.", - "Agent builder chat app.", - "Agent builder search app." - ], - "enum": [ - "ENGINE_TYPE_UNSPECIFIED", - "CHAT_ENGINE", - "SEARCH_ENGINE" - ] - }, - "GoogleCloudDialogflowV3alpha1DataType": { - "type": "string", - "x-google-enum-descriptions": [ - "Not specified.", - "Represents any string value.", - "Represents any number value.", - "Represents a boolean value.", - "Represents a repeated value." - ], - "enum": [ - "DATA_TYPE_UNSPECIFIED", - "STRING", - "NUMBER", - "BOOLEAN", - "ARRAY" - ] - }, - "GoogleCloudDialogflowV3alpha1RetrievalStrategy": { - "type": "string", - "x-google-enum-descriptions": [ - "Not specified. `DEFAULT` will be used.", - "Default retrieval strategy.", - "Static example will always be inserted to the prompt.", - "Example will never be inserted into the prompt." - ], - "enum": [ - "RETRIEVAL_STRATEGY_UNSPECIFIED", - "DEFAULT", - "STATIC", - "NEVER" - ] - }, - "GoogleCloudDialogflowV3alpha1OutputState": { - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified output.", - "Succeeded.", - "Cancelled.", - "Failed.", - "Escalated.", - "Pending." - ], - "enum": [ - "OUTPUT_STATE_UNSPECIFIED", - "OUTPUT_STATE_OK", - "OUTPUT_STATE_CANCELLED", - "OUTPUT_STATE_FAILED", - "OUTPUT_STATE_ESCALATED", - "OUTPUT_STATE_PENDING" - ] - }, - "GoogleCloudDialogflowV3alpha1OutputAudioEncoding": { - "type": "string", - "x-google-enum-descriptions": [ - "Not specified.", - "Uncompressed 16-bit signed little-endian samples (Linear PCM).\nAudio content returned as LINEAR16 also contains a WAV header.", - "MP3 audio at 32kbps.", - "MP3 audio at 64kbps.", - "Opus encoded audio wrapped in an ogg container. The result will be a\nfile which can be played natively on Android, and in browsers (at least\nChrome and Firefox). The quality of the encoding is considerably higher\nthan MP3 while using approximately the same bitrate.", - "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", - "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." - ], - "enum": [ - "OUTPUT_AUDIO_ENCODING_UNSPECIFIED", - "OUTPUT_AUDIO_ENCODING_LINEAR_16", - "OUTPUT_AUDIO_ENCODING_MP3", - "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", - "OUTPUT_AUDIO_ENCODING_OGG_OPUS", - "OUTPUT_AUDIO_ENCODING_MULAW", - "OUTPUT_AUDIO_ENCODING_ALAW" - ] - }, - "GoogleCloudDialogflowV3alpha1SsmlVoiceGender": { - "type": "string", - "x-google-enum-descriptions": [ - "An unspecified gender, which means that the client doesn't care which\ngender the selected voice will have.", - "A male voice.", - "A female voice.", - "A gender-neutral voice." - ], - "enum": [ - "SSML_VOICE_GENDER_UNSPECIFIED", - "SSML_VOICE_GENDER_MALE", - "SSML_VOICE_GENDER_FEMALE", - "SSML_VOICE_GENDER_NEUTRAL" - ] - }, - "GoogleCloudContactcenterinsightsV1DatasetValidationWarning": { - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified data validation warning.", - "A non-trivial percentage of the feedback labels are invalid.", - "The quantity of valid feedback labels provided is less than the\nrecommended minimum.", - "One or more of the answers have less than the recommended minimum of\nfeedback labels.", - "All the labels in the dataset come from a single answer choice." - ], - "enum": [ - "DATASET_VALIDATION_WARNING_UNSPECIFIED", - "TOO_MANY_INVALID_FEEDBACK_LABELS", - "INSUFFICIENT_FEEDBACK_LABELS", - "INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER", - "ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER" - ] - }, - "GoogleCloudContactcenterinsightsV1QaScorecardSource": { - "type": "string", - "x-google-enum-descriptions": [ - "The source of the scorecard is unspecified. Default to\nQA_SCORECARD_SOURCE_CUSTOMER_DEFINED.", - "The scorecard is a custom scorecard created by the user.", - "The scorecard is a scorecard created through discovery engine deployment.", - "The scorecard is a predefined scorecard and is defined via a configuration." - ], - "enum": [ - "QA_SCORECARD_SOURCE_UNSPECIFIED", - "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", - "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE", - "QA_SCORECARD_SOURCE_PREDEFINED" - ] - }, - "GoogleCloudContactcenterinsightsV1ChartVisualizationType": { - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified chart visualization type.", - "Bar chart.", - "Line chart.", - "Area chart.", - "Pie chart.", - "Scatter chart.", - "Table chart.", - "Score card chart.", - "Sunburst chart.", - "Gauge chart.", - "Sankey chart." - ], - "enum": [ - "CHART_VISUALIZATION_TYPE_UNSPECIFIED", - "BAR", - "LINE", - "AREA", - "PIE", - "SCATTER", - "TABLE", - "SCORE_CARD", - "SUNBURST", - "GAUGE", - "SANKEY" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1PredefinedQaScorecardType": { - "type": "string", - "x-google-enum-descriptions": [ - "The type of the predefined scorecard is unspecified.", - "The scorecard for conversation classification, which includes\nquestions like conversation_outcome_classification,\nagent_helpful_classification, user_unsatisfied_classification, and\nwho_escalated_classification." - ], - "enum": [ - "PREDEFINED_QA_SCORECARD_TYPE_UNSPECIFIED", - "CONVERSATION_CLASSIFICATION" - ] - }, - "GoogleCloudContactcenterinsightsV1alpha1DatasetValidationWarning": { - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified data validation warning.", - "A non-trivial percentage of the feedback labels are invalid.", - "The quantity of valid feedback labels provided is less than the\nrecommended minimum.", - "One or more of the answers have less than the recommended minimum of\nfeedback labels.", - "All the labels in the dataset come from a single answer choice." - ], - "enum": [ - "DATASET_VALIDATION_WARNING_UNSPECIFIED", - "TOO_MANY_INVALID_FEEDBACK_LABELS", - "INSUFFICIENT_FEEDBACK_LABELS", - "INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER", - "ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER" - ] - }, - "GoogleCloudContactcenterinsightsV1mainPredefinedQaScorecardType": { - "type": "string", - "x-google-enum-descriptions": [ - "The type of the predefined scorecard is unspecified.", - "The scorecard for conversation classification, which includes\nquestions like conversation_outcome_classification,\nagent_helpful_classification, user_unsatisfied_classification, and\nwho_escalated_classification." - ], - "enum": [ - "PREDEFINED_QA_SCORECARD_TYPE_UNSPECIFIED", - "CONVERSATION_CLASSIFICATION" - ] - }, - "GoogleCloudContactcenterinsightsV1mainDatasetValidationWarning": { - "type": "string", - "x-google-enum-descriptions": [ - "Unspecified data validation warning.", - "A non-trivial percentage of the feedback labels are invalid.", - "The quantity of valid feedback labels provided is less than the\nrecommended minimum.", - "One or more of the answers have less than the recommended minimum of\nfeedback labels.", - "All the labels in the dataset come from a single answer choice." - ], - "enum": [ - "DATASET_VALIDATION_WARNING_UNSPECIFIED", - "TOO_MANY_INVALID_FEEDBACK_LABELS", - "INSUFFICIENT_FEEDBACK_LABELS", - "INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER", - "ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER" - ] - } - } - } - , - "externalDocs": { - "description": "Find more info here.", - "url": "https://cloud.google.com/contact-center/insights/docs" - } -} \ No newline at end of file From 95553f2ec0388cfbbb52b5297bdc43e3ac657100 Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 24 Feb 2026 20:10:46 +0000 Subject: [PATCH 05/25] Fix HCL quoting in AutoLabelingRule basic example --- .../contact_center_insights_auto_labeling_rule_basic.tf.tmpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl index fd692b2c3b8b..4e82c84696a7 100644 --- a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -5,7 +5,7 @@ resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourc label_key = "{{index $.Vars "resource_name"}}" conditions { condition = "true" - value = ""label_value"" + value = "\"label_value\"" } active = true } From 8137d658d74984c74ff5762550407b2ffe997ef1 Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 24 Feb 2026 20:12:12 +0000 Subject: [PATCH 06/25] Add auto_labeling_rule_id to examples --- .../contact_center_insights_auto_labeling_rule_basic.tf.tmpl | 1 + 1 file changed, 1 insertion(+) diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl index 4e82c84696a7..59d7c38e2eed 100644 --- a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -1,5 +1,6 @@ resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourceId}}" { display_name = "{{index $.Vars "resource_name"}}" + auto_labeling_rule_id = "{{index $.Vars "resource_name"}}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" label_key = "{{index $.Vars "resource_name"}}" From 7deba00da4b3853723160d7b58ed1e5badee7fbd Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 24 Feb 2026 20:13:23 +0000 Subject: [PATCH 07/25] Fix HCL quoting and add auto_labeling_rule_id to tests --- ...ct_center_insights_auto_labeling_rule_test.go | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go index 7ba9d9ab21f5..d721891fd2f4 100644 --- a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go +++ b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go @@ -15,7 +15,7 @@ func TestAccContactCenterInsightsAutoLabelingRule_update(t *testing.T) { context := map[string]interface{}{ "random_suffix": acctest.RandString(t, 10), "project_number": envvar.GetTestProjectNumberFromEnv(), - "resource_name": "tf-test-rule-" + acctest.RandString(t, 10), + "resource_name": "tf-test-rule-" + acctest.RandString(t, 10), } acctest.VcrTest(t, resource.TestCase{ @@ -26,10 +26,10 @@ func TestAccContactCenterInsightsAutoLabelingRule_update(t *testing.T) { Config: testAccContactCenterInsightsAutoLabelingRule_basic(context), }, { - ResourceName: "google_contact_center_insights_auto_labeling_rule.auto_labeling_rule_basic", - ImportState: true, - ImportStateVerify: true, - ImportStateVerifyIgnore: []string{"location", "auto_labeling_rule_id"}, + ResourceName: "google_contact_center_insights_auto_labeling_rule.auto_labeling_rule_basic", + ImportState: true, + ImportStateVerify: true, + ImportStateVerifyIgnore: []string{"location", "auto_labeling_rule_id"}, }, { Config: testAccContactCenterInsightsAutoLabelingRule_update(context), @@ -53,12 +53,13 @@ func testAccContactCenterInsightsAutoLabelingRule_basic(context map[string]inter return acctest.Nprintf(` resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { display_name = "auto-labeling-rule-display-name-%{random_suffix}" + auto_labeling_rule_id = "auto-labeling-rule-id-%{random_suffix}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" label_key = "%{resource_name}" conditions { condition = "true" - value = ""label_value"" + value = "\"label_value\"" } active = true } @@ -69,12 +70,13 @@ func testAccContactCenterInsightsAutoLabelingRule_update(context map[string]inte return acctest.Nprintf(` resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { display_name = "auto-labeling-rule-display-name-%{random_suffix}-updated" + auto_labeling_rule_id = "auto-labeling-rule-id-%{random_suffix}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" label_key = "%{resource_name}" conditions { condition = "true" - value = ""label_value_updated"" + value = "\"label_value_updated\"" } active = false } From 32e2506bfe85ecec24809478572f6a10dbb33a11 Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 24 Feb 2026 20:20:35 +0000 Subject: [PATCH 08/25] Fix ID pattern in AutoLabelingRule tests and examples --- ...esource_contact_center_insights_auto_labeling_rule_test.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go index d721891fd2f4..13c3cc3fb921 100644 --- a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go +++ b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go @@ -53,7 +53,7 @@ func testAccContactCenterInsightsAutoLabelingRule_basic(context map[string]inter return acctest.Nprintf(` resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { display_name = "auto-labeling-rule-display-name-%{random_suffix}" - auto_labeling_rule_id = "auto-labeling-rule-id-%{random_suffix}" + auto_labeling_rule_id = "autolabelingruleid%{random_suffix}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" label_key = "%{resource_name}" @@ -70,7 +70,7 @@ func testAccContactCenterInsightsAutoLabelingRule_update(context map[string]inte return acctest.Nprintf(` resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { display_name = "auto-labeling-rule-display-name-%{random_suffix}-updated" - auto_labeling_rule_id = "auto-labeling-rule-id-%{random_suffix}" + auto_labeling_rule_id = "autolabelingruleid%{random_suffix}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" label_key = "%{resource_name}" From 0b94be40ffa0ad9c1f92f4a767964648e365f172 Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 24 Feb 2026 20:20:53 +0000 Subject: [PATCH 09/25] Remove auto_labeling_rule_id from examples to avoid hyphen issues --- .../contact_center_insights_auto_labeling_rule_basic.tf.tmpl | 1 - 1 file changed, 1 deletion(-) diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl index 59d7c38e2eed..4e82c84696a7 100644 --- a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -1,6 +1,5 @@ resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourceId}}" { display_name = "{{index $.Vars "resource_name"}}" - auto_labeling_rule_id = "{{index $.Vars "resource_name"}}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" label_key = "{{index $.Vars "resource_name"}}" From 95dd1bdffc6fdd48ba8a21915a0b0cb242f6a725 Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 24 Feb 2026 21:57:49 +0000 Subject: [PATCH 10/25] Change ID prefix to rule- --- ...esource_contact_center_insights_auto_labeling_rule_test.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go index 13c3cc3fb921..3c409adb8802 100644 --- a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go +++ b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go @@ -53,7 +53,7 @@ func testAccContactCenterInsightsAutoLabelingRule_basic(context map[string]inter return acctest.Nprintf(` resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { display_name = "auto-labeling-rule-display-name-%{random_suffix}" - auto_labeling_rule_id = "autolabelingruleid%{random_suffix}" + auto_labeling_rule_id = "rule-%{random_suffix}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" label_key = "%{resource_name}" @@ -70,7 +70,7 @@ func testAccContactCenterInsightsAutoLabelingRule_update(context map[string]inte return acctest.Nprintf(` resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { display_name = "auto-labeling-rule-display-name-%{random_suffix}-updated" - auto_labeling_rule_id = "autolabelingruleid%{random_suffix}" + auto_labeling_rule_id = "rule-%{random_suffix}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" label_key = "%{resource_name}" From 0f3154986ee2da4b7adf27d2f9b4f6d4f7e8a314 Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 24 Feb 2026 21:58:01 +0000 Subject: [PATCH 11/25] Simplify CEL expression value --- .../contact_center_insights_auto_labeling_rule_basic.tf.tmpl | 2 +- ...esource_contact_center_insights_auto_labeling_rule_test.go | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl index 4e82c84696a7..6b189ca36533 100644 --- a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -5,7 +5,7 @@ resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourc label_key = "{{index $.Vars "resource_name"}}" conditions { condition = "true" - value = "\"label_value\"" + value = "label_value" } active = true } diff --git a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go index 3c409adb8802..068fba218ea9 100644 --- a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go +++ b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go @@ -59,7 +59,7 @@ resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule label_key = "%{resource_name}" conditions { condition = "true" - value = "\"label_value\"" + value = "label_value" } active = true } @@ -76,7 +76,7 @@ resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule label_key = "%{resource_name}" conditions { condition = "true" - value = "\"label_value_updated\"" + value = "label_value_updated" } active = false } From eae7d46e3681b74c8f8e47f7e371bb0e6f767f3b Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 24 Feb 2026 22:48:19 +0000 Subject: [PATCH 12/25] Add missing description field to fix missing test report --- .../contact_center_insights_auto_labeling_rule_basic.tf.tmpl | 1 + .../resource_contact_center_insights_auto_labeling_rule_test.go | 2 ++ 2 files changed, 3 insertions(+) diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl index 6b189ca36533..e4742c1c22ce 100644 --- a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -1,5 +1,6 @@ resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourceId}}" { display_name = "{{index $.Vars "resource_name"}}" + description = "Example auto labeling rule" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" label_key = "{{index $.Vars "resource_name"}}" diff --git a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go index 068fba218ea9..858931314865 100644 --- a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go +++ b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go @@ -53,6 +53,7 @@ func testAccContactCenterInsightsAutoLabelingRule_basic(context map[string]inter return acctest.Nprintf(` resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { display_name = "auto-labeling-rule-display-name-%{random_suffix}" + description = "Example auto labeling rule" auto_labeling_rule_id = "rule-%{random_suffix}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" @@ -70,6 +71,7 @@ func testAccContactCenterInsightsAutoLabelingRule_update(context map[string]inte return acctest.Nprintf(` resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { display_name = "auto-labeling-rule-display-name-%{random_suffix}-updated" + description = "Example auto labeling rule" auto_labeling_rule_id = "rule-%{random_suffix}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" From 58d94e4d996b60547d1ebddc27b7c8fc31fa87d7 Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 24 Feb 2026 23:01:49 +0000 Subject: [PATCH 13/25] Fix CEL expression quoting to pass backend validation --- .../contact_center_insights_auto_labeling_rule_basic.tf.tmpl | 2 +- ...esource_contact_center_insights_auto_labeling_rule_test.go | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl index e4742c1c22ce..3f499ab27e8a 100644 --- a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -6,7 +6,7 @@ resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourc label_key = "{{index $.Vars "resource_name"}}" conditions { condition = "true" - value = "label_value" + value = "\"label_value\"" } active = true } diff --git a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go index 858931314865..c3610e69cb57 100644 --- a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go +++ b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go @@ -60,7 +60,7 @@ resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule label_key = "%{resource_name}" conditions { condition = "true" - value = "label_value" + value = "\"label_value\"" } active = true } @@ -78,7 +78,7 @@ resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule label_key = "%{resource_name}" conditions { condition = "true" - value = "label_value_updated" + value = "\"label_value_updated\"" } active = false } From f0250149b460b0196cee343e07e583ec39cacdf9 Mon Sep 17 00:00:00 2001 From: scawful Date: Wed, 25 Feb 2026 00:19:23 +0000 Subject: [PATCH 14/25] Fix CEL string quoting to use single quotes --- .../contact_center_insights_auto_labeling_rule_basic.tf.tmpl | 2 +- ...esource_contact_center_insights_auto_labeling_rule_test.go | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl index 3f499ab27e8a..ba7d198c25ea 100644 --- a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -6,7 +6,7 @@ resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourc label_key = "{{index $.Vars "resource_name"}}" conditions { condition = "true" - value = "\"label_value\"" + value = "'label_value'" } active = true } diff --git a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go index c3610e69cb57..fd70691c1770 100644 --- a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go +++ b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go @@ -60,7 +60,7 @@ resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule label_key = "%{resource_name}" conditions { condition = "true" - value = "\"label_value\"" + value = "'label_value'" } active = true } @@ -78,7 +78,7 @@ resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule label_key = "%{resource_name}" conditions { condition = "true" - value = "\"label_value_updated\"" + value = "'label_value_updated'" } active = false } From a1ed2d6d3570b2981929260bd94c16666cc90af9 Mon Sep 17 00:00:00 2001 From: scawful Date: Mon, 2 Mar 2026 17:24:31 +0000 Subject: [PATCH 15/25] Increase async operation timeouts to 60m --- mmv1/products/contactcenterinsights/AutoLabelingRule.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml index 440972e4ac87..dfc6c90e50ed 100644 --- a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml +++ b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml @@ -37,9 +37,9 @@ autogen_async: true async: operation: timeouts: - insert_minutes: 20 - update_minutes: 20 - delete_minutes: 20 + insert_minutes: 60 + update_minutes: 60 + delete_minutes: 60 base_url: '{{op_id}}' result: resource_inside_response: true From 31086a0eb55ad9ee1ceb97b1b94bd79a9cc87f74 Mon Sep 17 00:00:00 2001 From: scawful Date: Mon, 2 Mar 2026 17:25:32 +0000 Subject: [PATCH 16/25] Remove hyphen from auto_labeling_rule_id in test --- ...esource_contact_center_insights_auto_labeling_rule_test.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go index fd70691c1770..a3e2eb22d5b2 100644 --- a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go +++ b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go @@ -54,7 +54,7 @@ func testAccContactCenterInsightsAutoLabelingRule_basic(context map[string]inter resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { display_name = "auto-labeling-rule-display-name-%{random_suffix}" description = "Example auto labeling rule" - auto_labeling_rule_id = "rule-%{random_suffix}" + auto_labeling_rule_id = "rule%{random_suffix}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" label_key = "%{resource_name}" @@ -72,7 +72,7 @@ func testAccContactCenterInsightsAutoLabelingRule_update(context map[string]inte resource "google_contact_center_insights_auto_labeling_rule" "auto_labeling_rule_basic" { display_name = "auto-labeling-rule-display-name-%{random_suffix}-updated" description = "Example auto labeling rule" - auto_labeling_rule_id = "rule-%{random_suffix}" + auto_labeling_rule_id = "rule%{random_suffix}" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" label_key = "%{resource_name}" From 142354f0b72b023620e04206e1d8e23b5cf9def5 Mon Sep 17 00:00:00 2001 From: scawful Date: Mon, 2 Mar 2026 20:54:13 +0000 Subject: [PATCH 17/25] Triggering CI From ddc85a5aac61e56d03502f32fc2ce6e3a596d831 Mon Sep 17 00:00:00 2001 From: scawful Date: Mon, 2 Mar 2026 22:42:29 +0000 Subject: [PATCH 18/25] Remove async configuration because the resource creation is synchronous --- .../contactcenterinsights/AutoLabelingRule.yaml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml index dfc6c90e50ed..66e6604f9f88 100644 --- a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml +++ b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml @@ -33,16 +33,6 @@ examples: primary_resource_id: 'auto_labeling_rule_basic' vars: resource_name: 'auto-labeling-rule-basic' -autogen_async: true -async: - operation: - timeouts: - insert_minutes: 60 - update_minutes: 60 - delete_minutes: 60 - base_url: '{{op_id}}' - result: - resource_inside_response: true autogen_status: QXV0b0xhYmVsaW5nUnVsZQ== parameters: - name: location From 4e79e53263da0c2811509984357039794d255740 Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 3 Mar 2026 01:06:21 +0000 Subject: [PATCH 19/25] Fix auto_labeling_rule_id pattern in examples --- .../contact_center_insights_auto_labeling_rule_basic.tf.tmpl | 1 + 1 file changed, 1 insertion(+) diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl index ba7d198c25ea..7ba46653f3f5 100644 --- a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -1,5 +1,6 @@ resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourceId}}" { display_name = "{{index $.Vars "resource_name"}}" + auto_labeling_rule_id = "auto-labeling-rule-basic-{{index $.Vars "random_suffix"}}" description = "Example auto labeling rule" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" From 6c5f2da4a2e1185e4663b768676d22ebbe9fc01f Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 3 Mar 2026 01:11:14 +0000 Subject: [PATCH 20/25] Fix template syntax for auto_labeling_rule_id --- .../contact_center_insights_auto_labeling_rule_basic.tf.tmpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl index 7ba46653f3f5..e8edc78b768b 100644 --- a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -1,6 +1,6 @@ resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourceId}}" { display_name = "{{index $.Vars "resource_name"}}" - auto_labeling_rule_id = "auto-labeling-rule-basic-{{index $.Vars "random_suffix"}}" + auto_labeling_rule_id = "auto-labeling-rule-basic-%{random_suffix}" description = "Example auto labeling rule" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" From 4c62c2b63d17cc904dfd2e76e08c8971569f9d00 Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 3 Mar 2026 02:18:08 +0000 Subject: [PATCH 21/25] Ensure auto_labeling_rule_id is lowercase to satisfy API regex --- ...source_contact_center_insights_auto_labeling_rule_test.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go index a3e2eb22d5b2..d7f99fe90001 100644 --- a/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go +++ b/mmv1/third_party/terraform/services/contactcenterinsights/resource_contact_center_insights_auto_labeling_rule_test.go @@ -1,6 +1,7 @@ package contactcenterinsights_test import ( + "strings" "testing" "github.com/hashicorp/terraform-plugin-testing/helper/resource" @@ -13,9 +14,9 @@ func TestAccContactCenterInsightsAutoLabelingRule_update(t *testing.T) { t.Parallel() context := map[string]interface{}{ - "random_suffix": acctest.RandString(t, 10), + "random_suffix": strings.ToLower(acctest.RandString(t, 10)), "project_number": envvar.GetTestProjectNumberFromEnv(), - "resource_name": "tf-test-rule-" + acctest.RandString(t, 10), + "resource_name": "tf-test-rule-" + strings.ToLower(acctest.RandString(t, 10)), } acctest.VcrTest(t, resource.TestCase{ From 4083b86d520b7e4d009856525cfeaa6860759ecf Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 3 Mar 2026 08:13:08 +0000 Subject: [PATCH 22/25] Ensure random_suffix is lowercase in generated AutoLabelingRule tests --- mmv1/products/contactcenterinsights/AutoLabelingRule.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml index 66e6604f9f88..a993f5678770 100644 --- a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml +++ b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml @@ -33,6 +33,8 @@ examples: primary_resource_id: 'auto_labeling_rule_basic' vars: resource_name: 'auto-labeling-rule-basic' + test_vars_overrides: + 'random_suffix': 'strings.ToLower(acctest.RandString(t, 10))' autogen_status: QXV0b0xhYmVsaW5nUnVsZQ== parameters: - name: location From 4a61ec6c9a71030c632cf4f56040bee03c5663d1 Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 3 Mar 2026 08:36:38 +0000 Subject: [PATCH 23/25] Revert "Ensure random_suffix is lowercase in generated AutoLabelingRule tests" This reverts commit 4083b86d520b7e4d009856525cfeaa6860759ecf. --- mmv1/products/contactcenterinsights/AutoLabelingRule.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml index a993f5678770..66e6604f9f88 100644 --- a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml +++ b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml @@ -33,8 +33,6 @@ examples: primary_resource_id: 'auto_labeling_rule_basic' vars: resource_name: 'auto-labeling-rule-basic' - test_vars_overrides: - 'random_suffix': 'strings.ToLower(acctest.RandString(t, 10))' autogen_status: QXV0b0xhYmVsaW5nUnVsZQ== parameters: - name: location From 2a3fa861c1c0a1d5e19bb8dca1e55829c094290f Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 3 Mar 2026 08:37:22 +0000 Subject: [PATCH 24/25] Fix random_suffix conflict by using id_suffix override --- mmv1/products/contactcenterinsights/AutoLabelingRule.yaml | 2 ++ .../contact_center_insights_auto_labeling_rule_basic.tf.tmpl | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml index 66e6604f9f88..11bf40bf3e2e 100644 --- a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml +++ b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml @@ -33,6 +33,8 @@ examples: primary_resource_id: 'auto_labeling_rule_basic' vars: resource_name: 'auto-labeling-rule-basic' + test_vars_overrides: + 'id_suffix': 'strings.ToLower(acctest.RandString(t, 10))' autogen_status: QXV0b0xhYmVsaW5nUnVsZQ== parameters: - name: location diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl index e8edc78b768b..53ee6e0ffc60 100644 --- a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -1,6 +1,6 @@ resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourceId}}" { display_name = "{{index $.Vars "resource_name"}}" - auto_labeling_rule_id = "auto-labeling-rule-basic-%{random_suffix}" + auto_labeling_rule_id = "auto-labeling-rule-basic-%{id_suffix}" description = "Example auto labeling rule" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM" From 57b1c96c1c5316643222234634f0cad19ec86455 Mon Sep 17 00:00:00 2001 From: scawful Date: Sat, 7 Mar 2026 05:44:37 +0000 Subject: [PATCH 25/25] Fix AutoLabelingRule ID pattern to be alphanumeric --- mmv1/products/contactcenterinsights/AutoLabelingRule.yaml | 4 ++-- .../contact_center_insights_auto_labeling_rule_basic.tf.tmpl | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml index 11bf40bf3e2e..b9a3a90c3c40 100644 --- a/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml +++ b/mmv1/products/contactcenterinsights/AutoLabelingRule.yaml @@ -32,7 +32,7 @@ examples: - name: 'contact_center_insights_auto_labeling_rule_basic' primary_resource_id: 'auto_labeling_rule_basic' vars: - resource_name: 'auto-labeling-rule-basic' + resource_name: 'autolabelingrulebasic' test_vars_overrides: 'id_suffix': 'strings.ToLower(acctest.RandString(t, 10))' autogen_status: QXV0b0xhYmVsaW5nUnVsZQ== @@ -51,7 +51,7 @@ parameters: a server-generated ID will be used. This value should be 4-64 characters and must match the regular - expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + expression `^[A-Za-z0-9]{4,64}$`. immutable: true url_param_only: true properties: diff --git a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl index 53ee6e0ffc60..ac4d2070073e 100644 --- a/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl +++ b/mmv1/templates/terraform/examples/contact_center_insights_auto_labeling_rule_basic.tf.tmpl @@ -1,6 +1,6 @@ resource "google_contact_center_insights_auto_labeling_rule" "{{$.PrimaryResourceId}}" { display_name = "{{index $.Vars "resource_name"}}" - auto_labeling_rule_id = "auto-labeling-rule-basic-%{id_suffix}" + auto_labeling_rule_id = "autolabelingrulebasic%{id_suffix}" description = "Example auto labeling rule" location = "us-central1" label_key_type = "LABEL_KEY_TYPE_CUSTOM"