Method: projects.locations.bulkDownloadFeedbackLabels

Download feedback labels in bulk.

HTTP request

POST https://{endpoint}/v1/{parent=projects/*/locations/*}:bulkDownloadFeedbackLabels

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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 (FeedbackLabelType),
  "conversationFilter": string,
  "templateQaScorecardId": [
    string
  ],

  // Union field destination can be only one of the following:
  "gcsDestination": {
    object (GcsDestination)
  }
  // End of list of possible types for union field destination.
}
Fields
filter

string

Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND).

Supported fields:

  • issueModelId
  • qaQuestionId
  • qaScorecardId
  • min_create_time
  • max_create_time
  • min_update_time
  • max_update_time
  • feedbackLabelType: QUALITY_AI, TOPIC_MODELING
maxDownloadCount

integer

Optional. Limits the maximum number of feedback labels that will be downloaded. The first N feedback labels will be downloaded.
feedbackLabelType

enum (FeedbackLabelType)

Optional. The type of feedback labels that will be downloaded.
conversationFilter

string

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 templateQaScorecardId is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.
templateQaScorecardId[]

string

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 filter will be ignored.
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:
gcsDestination

object (GcsDestination)

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 (Format),
  "objectUri": string,
  "addWhitespace": boolean,
  "alwaysPrintEmptyFields": boolean,
  "recordsPerFileCount": string
}
Fields
format

enum (Format)

Required. File format in which the labels will be exported.
objectUri

string

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. gs://bucket_name/object_uri_prefix
addWhitespace

boolean

Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.
alwaysPrintEmptyFields

boolean

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.
recordsPerFileCount

string (int64 format)

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.