- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- GcsDestination
- Format
- FeedbackLabelType
- Try it!
Download feedback labels in bulk.
HTTP request
POST https://{endpoint}/v1alpha1/{parent=projects/*/locations/*}:bulkDownloadFeedbackLabels
Where {endpoint}
is one of the supported service endpoints.
The URLs use gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent resource for new feedback labels. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "filter": string, "maxDownloadCount": integer, "feedbackLabelType": enum ( |
Fields | |
---|---|
filter |
Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields:
|
max |
Optional. Limits the maximum number of feedback labels that will be downloaded. The first |
feedback |
Optional. The type of feedback labels that will be downloaded. |
conversation |
Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If |
template |
Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversationFilter and the questions under the scorecard(s). The feedback label |
Union field destination . Configuration for an external data store to which the feedback labels will be written to. destination can be only one of the following: |
|
gcs |
A cloud storage bucket destination. |
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
contactcenterinsights.feedbackLabels.download
For more information, see the IAM documentation.
GcsDestination
Google Cloud Storage Object details to write the feedback labels to.
JSON representation |
---|
{
"format": enum ( |
Fields | |
---|---|
format |
Required. File format in which the labels will be exported. |
object |
Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. |
add |
Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format. |
always |
Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format. |
records |
Optional. The number of records per file. Applicable for either format. |
Format
All permissible file formats. See recordsPerFileCount
to override the default number of records per file.
Enums | |
---|---|
FORMAT_UNSPECIFIED |
Unspecified format. |
CSV |
CSV format. 1,000 labels are stored per CSV file by default. |
JSON |
JSON format. 1 label stored per JSON file by default. |
FeedbackLabelType
Possible feedback label types that will be downloaded.
Enums | |
---|---|
FEEDBACK_LABEL_TYPE_UNSPECIFIED |
Unspecified format |
QUALITY_AI |
Downloaded file will contain all Quality AI labels from the latest scorecard revision. |
TOPIC_MODELING |
Downloaded file will contain only Topic Modeling labels. |