BulkDownloadFeedbackLabelsMetadata

Metadata for the BulkDownloadFeedbackLabel endpoint.

JSON representation 
{
  "createTime": string,
  "endTime": string,
  "request": {
    object (BulkDownloadFeedbackLabelsRequest)
  },
  "partialErrors": [
    {
      object (Status)
    }
  ],
  "downloadStats": {
    object (DownloadStats)
  }
}
Fields
createTime

string (Timestamp format)

Output only. The time the operation was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Output only. The time the operation finished running.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
request

object (BulkDownloadFeedbackLabelsRequest)

Output only. The original request for download.
partialErrors[]

object (Status)

Partial errors during ingest operation that might cause the operation output to be incomplete.
downloadStats

object (DownloadStats)

Output only. Statistics for BulkDownloadFeedbackLabels operation.

BulkDownloadFeedbackLabelsRequest

Request for the BulkDownloadFeedbackLabel endpoint.

JSON representation 
{
  "parent": string,
  "filter": string,
  "maxDownloadCount": integer,
  "feedbackLabelType": enum (FeedbackLabelType),
  "conversationFilter": string,
  "templateQaScorecardId": [
    string
  ],

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

string

Required. The parent resource for new feedback labels.
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.
sheetsDestination

object (SheetsDestination)

A sheets document destination.

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.

SheetsDestination

Google Sheets document details to write the feedback labels to.

JSON representation 
{
  "spreadsheetUri": string,
  "sheetTitle": string
}
Fields
spreadsheetUri

string

Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. https://docs.google.com/spreadsheets/d/1234567890 The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as fileNames in the BulkDownloadFeedbackLabelsMetadata.
sheetTitle

string

Optional. The title of the new sheet to write the feedback labels to.

DownloadStats

Statistics for BulkDownloadFeedbackLabels operation.

JSON representation 
{
  "processedObjectCount": integer,
  "successfulDownloadCount": integer,
  "totalFilesWritten": integer,
  "fileNames": [
    string
  ]
}
Fields
processedObjectCount

integer

The number of objects processed during the download operation.
successfulDownloadCount

integer

The number of new feedback labels downloaded during this operation. Different from "processed" because some labels might not be downloaded because an error.
totalFilesWritten

integer

Total number of files written to the provided Cloud Storage bucket.
fileNames[]

string

Output only. Full name of the files written to Cloud storage.