2024-10-18
▼ ▲ contactcenterinsights.projects.locations.analysisRules.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/analysisRules
Parameter Order: parent
HTTP Method: POST
Path: v1/{+parent}/analysisRules
Description: Creates a analysis rule.
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent resource of the analysis rule. Required. The location to create a analysis rule for. Format: `projects//locations/` or `projects//locations/`
Location: path
Type: string
Required: Yes
▼ ▲ contactcenterinsights.projects.locations.analysisRules.list
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/analysisRules
HTTP Method: GET
Description: Lists analysis rules.
Path: v1/{+parent}/analysisRules
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Format: int32
Location: query
Type: integer
Description: Optional. The maximum number of analysis rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
pageToken
Location: query
Description: Optional. The value returned by the last `ListAnalysisRulesResponse`; indicates that this is a continuation of a prior `ListAnalysisRules` call and the system should return the next page of data.
Type: string
parent
Location: path
Required: Yes
Type: string
Description: Required. The parent resource of the analysis rules.
Pattern: ^projects/[^/]+/locations/[^/]+$
▼ ▲ contactcenterinsights.projects.locations.analysisRules.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$
Location: path
Type: string
Description: Required. The name of the analysis rule to delete.
Path: v1/{+name}
Description: Deletes a analysis rule.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}
HTTP Method: DELETE
Parameter Order: name
▼ ▲ contactcenterinsights.projects.locations.analysisRules.patch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Path: v1/{+name}
Parameters:
updateMask
Location: query
Format: google-fieldmask
Description: Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$
Type: string
Description: Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
Required: Yes
Location: path
Description: Updates a analysis rule.
Parameter Order: name
▼ ▲ contactcenterinsights.projects.locations.analysisRules.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}
HTTP Method: GET
Description: Get a analysis rule.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}
Parameters:
name
Required: Yes
Location: path
Type: string
Description: Required. The name of the AnalysisRule to get.
Pattern: ^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Path: v1/{+resource}:getIamPolicy
Parameters:
options.requestedPolicyVersion
Location: query
Type: integer
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Type: string
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Required: Yes
Parameter Order: resource
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameter Order: resource
Path: v1/{+resource}:setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy
Parameters:
resource
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions
Parameters:
resource
Type: string
Location: path
Required: Yes
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Path: v1/{+resource}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.upload
Description: Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.
Parameters:
conversationId
Type: string
Description: Optional. A unique ID for the new conversation. This ID will become the final component of the conversation'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-z0-9-]{4,64}$`. Valid characters are `a-z-`
Location: query
parent
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Description: Required. The parent resource of the conversation.
redactionConfig.inspectTemplate
Type: string
Description: The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
Location: query
redactionConfig.deidentifyTemplate
Description: The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
Location: query
Type: string
speechConfig.speechRecognizer
Description: The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:upload
Path: v1/{+parent}/conversations:upload
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Type: string
Location: path
Description: Required. The name of the conversation to get.
Required: Yes
view
Location: query
Description: The level of details of the conversation. Default is `FULL`.
Enum:
Type: string
Enum Descriptions:
Description: Gets a conversation.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+name}
Parameter Order: name
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list
HTTP Method: GET
Parameters:
view
Type: string
Enum Descriptions:
Description: The level of details of the conversation. Default is `BASIC`.
Enum:
Location: query
parent
Type: string
Description: Required. The parent resource of the conversation.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
orderBy
Description: Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).
Type: string
Location: query
pageSize
Type: integer
Format: int32
Description: The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
Location: query
filter
Location: query
Description: A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
Type: string
pageToken
Description: The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.
Type: string
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations
Path: v1/{+parent}/conversations
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists conversations.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the conversation to delete.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Required: Yes
force
Type: boolean
Description: If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.
Location: query
Path: v1/{+name}
Description: Deletes a conversation.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.create
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Location: path
Description: Required. The parent resource of the conversation.
Type: string
Required: Yes
conversationId
Description: A unique ID for the new conversation. This ID will become the final component of the conversation'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-z0-9-]{4,64}$`. Valid characters are `a-z-`
Type: string
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations
HTTP Method: POST
Path: v1/{+parent}/conversations
Parameter Order: parent
Description: Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.patch
Parameters:
updateMask
Description: The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri`
Type: string
Format: google-fieldmask
Location: query
name
Location: path
Required: Yes
Description: Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a conversation.
Parameter Order: name
HTTP Method: PATCH
Path: v1/{+name}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.list
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Description: The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.
Type: string
Location: query
filter
Type: string
Location: query
Description: A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
parent
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. The parent resource of the analyses.
pageSize
Location: query
Format: int32
Type: integer
Description: The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses
Path: v1/{+parent}/analyses
Description: Lists analyses.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.create
Parameter Order: parent
Parameters:
parent
Location: path
Type: string
Required: Yes
Description: Required. The parent resource of the analysis.
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses
Description: Creates an analysis. The long running operation is done when the analysis has completed.
HTTP Method: POST
Path: v1/{+parent}/analyses
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes an analysis.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}
HTTP Method: DELETE
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$
Location: path
Description: Required. The name of the analysis to delete.
Type: string
Parameter Order: name
Path: v1/{+name}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.get
Description: Gets an analysis.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Required: Yes
Type: string
Description: Required. The name of the analysis to get.
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$
Path: v1/{+name}
HTTP Method: GET
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list
Parameters:
pageToken
Type: string
Location: query
Description: The standard list page token.
name
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Type: string
Location: path
Required: Yes
Description: The name of the operation's parent resource.
pageSize
Format: int32
Description: The standard list page size.
Location: query
Type: integer
filter
Location: query
Description: The standard list filter.
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations
Parameter Order: name
HTTP Method: GET
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1/{+name}/operations
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel
Path: v1/{+name}:cancel
HTTP Method: POST
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$
Type: string
Location: path
Description: The name of the operation resource to be cancelled.
Required: Yes
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameter Order: name
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Type: string
Location: path
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.tuneQaScorecardRevision
Parameter Order: parent
HTTP Method: POST
Path: v1/{+parent}:tuneQaScorecardRevision
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:tuneQaScorecardRevision
Description: Fine tune one or more QaModels.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Location: path
Description: Required. The parent resource for new fine tuning job instance.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.get
Path: v1/{+name}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the QaScorecardRevision to get.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}
Description: Gets a QaScorecardRevision.
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Lists all revisions under the parent QaScorecard.
Parameters:
pageSize
Location: query
Description: Optional. The maximum number of scorecard revisions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
Type: integer
Format: int32
pageToken
Type: string
Location: query
Description: Optional. The value returned by the last `ListQaScorecardRevisionsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecardRevisions` call and that the system should return the next page of data.
parent
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$
Required: Yes
Type: string
Description: Required. The parent resource of the scorecard revisions. To list all revisions of all scorecards, substitute the QaScorecard ID with a '-' character.
Location: path
filter
Type: string
Location: query
Description: Optional. A filter to reduce results to a specific subset. Useful for querying scorecard revisions with specific properties.
Path: v1/{+parent}/revisions
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/revisions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions
Parameters:
qaScorecardRevisionId
Description: Optional. A unique ID for the new QaScorecardRevision. This ID will become the final component of the QaScorecardRevision'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-z0-9-]{4,64}$`. Valid characters are `a-z-`.
Type: string
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The parent resource of the QaScorecardRevision.
Description: Creates a QaScorecardRevision.
HTTP Method: POST
Parameter Order: parent
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.deploy
Path: v1/{+name}:deploy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. The name of the QaScorecardRevision to deploy.
Parameter Order: name
Description: Deploy a QaScorecardRevision.
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:deploy
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.undeploy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:undeploy
Description: Undeploy a QaScorecardRevision.
Parameters:
name
Required: Yes
Location: path
Type: string
Description: Required. The name of the QaScorecardRevision to undeploy.
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$
Path: v1/{+name}:undeploy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: POST
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.delete
Parameter Order: name
Parameters:
name
Type: string
Description: Required. The name of the QaScorecardRevision to delete.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$
Location: path
force
Location: query
Description: Optional. If set to true, all of this QaScorecardRevision's child resources will also be deleted. Otherwise, the request will only succeed if it has none.
Type: boolean
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a QaScorecardRevision.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}
HTTP Method: DELETE
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.create
Description: Create a QaQuestion.
Parameters:
parent
Description: Required. The parent resource of the QaQuestion.
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$
Location: path
Required: Yes
Type: string
qaQuestionId
Description: Optional. A unique ID for the new question. This ID will become the final component of the question'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-z0-9-]{4,64}$`. Valid characters are `a-z-`.
Location: query
Type: string
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/qaQuestions
HTTP Method: POST
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.list
Path: v1/{+parent}/qaQuestions
HTTP Method: GET
Parameter Order: parent
Parameters:
pageSize
Type: integer
Description: Optional. The maximum number of questions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
Location: query
Format: int32
pageToken
Type: string
Description: Optional. The value returned by the last `ListQaQuestionsResponse`. This value indicates that this is a continuation of a prior `ListQaQuestions` call and that the system should return the next page of data.
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$
Required: Yes
Location: path
Description: Required. The parent resource of the questions.
Type: string
Description: Lists QaQuestions.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.delete
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Description: Required. The name of the QaQuestion to delete.
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$
Required: Yes
Location: path
Parameter Order: name
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}
Description: Deletes a QaQuestion.
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.get
HTTP Method: GET
Description: Gets a QaQuestion.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}
Parameters:
name
Type: string
Required: Yes
Description: Required. The name of the QaQuestion to get.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.patch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}
Parameters:
updateMask
Description: Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `abbreviation` * `answer_choices` * `answer_instructions` * `order` * `question_body` * `tags`
Location: query
Type: string
Format: google-fieldmask
name
Type: string
Location: path
Description: Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$
Required: Yes
Path: v1/{+name}
HTTP Method: PATCH
Description: Updates a QaQuestion.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}
Description: Updates a QaScorecard.
Parameter Order: name
Path: v1/{+name}
Parameters:
updateMask
Location: query
Description: Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `description` * `display_name`
Type: string
Format: google-fieldmask
name
Required: Yes
Type: string
Description: Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$
Location: path
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.delete
Parameter Order: name
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
force
Description: Optional. If set to true, all of this QaScorecard's child resources will also be deleted. Otherwise, the request will only succeed if it has none.
Type: boolean
Location: query
name
Required: Yes
Type: string
Location: path
Description: Required. The name of the QaScorecard to delete.
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}
Description: Deletes a QaScorecard.
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.list
Parameters:
pageToken
Description: Optional. The value returned by the last `ListQaScorecardsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecards` call and that the system should return the next page of data.
Location: query
Type: string
pageSize
Location: query
Format: int32
Description: Optional. The maximum number of scorecards to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
Type: integer
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent resource of the scorecards.
Type: string
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/qaScorecards
Parameter Order: parent
Description: Lists QaScorecards.
HTTP Method: GET
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.get
Path: v1/{+name}
HTTP Method: GET
Parameter Order: name
Description: Gets a QaScorecard.
Parameters:
name
Description: Required. The name of the QaScorecard to get.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}
▼ ▲ contactcenterinsights.projects.locations.qaScorecards.create
Description: Create a QaScorecard.
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/qaScorecards
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/qaScorecards
HTTP Method: POST
Parameters:
qaScorecardId
Location: query
Type: string
Description: Optional. A unique ID for the new QaScorecard. This ID will become the final component of the QaScorecard'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-z0-9-]{4,64}$`. Valid characters are `a-z-`.
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Required. The parent resource of the QaScorecard.
▼ ▲ contactcenterinsights.projects.locations.conversations.feedbackLabels.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
Parameters:
name
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Description: Required. The name of the feedback label to delete.
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Delete feedback label.
HTTP Method: DELETE
Path: v1/{+name}
Parameter Order: name
▼ ▲ contactcenterinsights.projects.locations.conversations.feedbackLabels.create
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels
Parameter Order: parent
HTTP Method: POST
Description: Create feedback label.
Parameters:
feedbackLabelId
Description: Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.
Type: string
Location: query
parent
Required: Yes
Description: Required. The parent resource of the feedback label.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/conversations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/feedbackLabels
▼ ▲ contactcenterinsights.projects.locations.conversations.feedbackLabels.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
Description: Update feedback label.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Description: Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
updateMask
Type: string
Format: google-fieldmask
Description: Required. The list of fields to be updated.
Location: query
HTTP Method: PATCH
▼ ▲ contactcenterinsights.projects.locations.conversations.feedbackLabels.get
Description: Get feedback label.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Required: Yes
Location: path
Description: Required. The name of the feedback label to get.
Type: string
▼ ▲ contactcenterinsights.projects.locations.conversations.feedbackLabels.list
Parameter Order: parent
Path: v1/{+parent}/feedbackLabels
Description: List feedback labels.
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/conversations/[^/]+$
Description: Required. The parent resource of the feedback labels.
pageSize
Format: int32
Location: query
Type: integer
Description: Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
pageToken
Type: string
Description: Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.
Location: query
filter
Type: string
Location: query
Description: Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.calculateStats
Path: v1/{+location}:calculateStats
Parameter Order: location
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:calculateStats
Description: Gets conversation statistics.
Parameters:
filter
Location: query
Description: A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.
Type: string
location
Required: Yes
Description: Required. The location of the conversations.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedView/[^/]+$
Location: path
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.queryMetrics
Parameter Order: location
Path: v1/{+location}:queryMetrics
Description: Query metrics.
Parameters:
location
Required: Yes
Description: Required. The location of the data. "projects/{project}/locations/{location}"
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedView/[^/]+$
Type: string
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:queryMetrics
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.create
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels
Description: Create feedback label.
HTTP Method: POST
Path: v1/{+parent}/feedbackLabels
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
feedbackLabelId
Description: Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.
Location: query
Type: string
parent
Location: path
Description: Required. The parent resource of the feedback label.
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Required: Yes
Type: string
Parameter Order: parent
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.patch
Parameter Order: name
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
HTTP Method: PATCH
Parameters:
name
Location: path
Description: Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Required: Yes
Type: string
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. The list of fields to be updated.
Description: Update feedback label.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.get
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The name of the feedback label to get.
Description: Get feedback label.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
HTTP Method: GET
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.list
Path: v1/{+parent}/feedbackLabels
Parameters:
filter
Type: string
Location: query
Description: Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
parent
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Description: Required. The parent resource of the feedback labels.
pageSize
Type: integer
Description: Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
Location: query
Format: int32
pageToken
Location: query
Type: string
Description: Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.
Parameter Order: parent
Description: List feedback labels.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.delete
HTTP Method: DELETE
Description: Delete feedback label.
Path: v1/{+name}
Parameters:
name
Type: string
Location: path
Required: Yes
Description: Required. The name of the feedback label to delete.
Pattern: ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
▼ ▲ contactcenterinsights.projects.locations.listAllFeedbackLabels
HTTP Method: GET
Parameter Order: parent
Path: v1/{+parent}:listAllFeedbackLabels
Flat Path: v1/projects/{projectsId}/locations/{locationsId}:listAllFeedbackLabels
Parameters:
filter
Type: string
Description: Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
Location: query
pageSize
Location: query
Format: int32
Description: Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
Type: integer
pageToken
Location: query
Type: string
Description: Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.
parent
Type: string
Location: path
Description: Required. The parent resource of all feedback labels per project.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: List all feedback labels by project number.
▼ ▲ contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels
Flat Path: v1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource for new feedback labels.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Download feedback labels in bulk.
Parameter Order: parent
Path: v1/{+parent}:bulkDownloadFeedbackLabels
▼ ▲ contactcenterinsights.projects.locations.bulkUploadFeedbackLabels
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Location: path
Description: Required. The parent resource for new feedback labels.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Path: v1/{+parent}:bulkUploadFeedbackLabels
Description: Upload feedback labels in bulk.
Parameter Order: parent
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels
▼ ▲ contactcenterinsights.projects.locations.queryMetrics
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}:queryMetrics
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: location
Parameters:
location
Location: path
Description: Required. The location of the data. "projects/{project}/locations/{location}"
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Query metrics.
Path: v1/{+location}:queryMetrics