Google Cloud Contact Center Insights V1 Client - Class BulkDownloadFeedbackLabelsRequest (2.2.0)

Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class BulkDownloadFeedbackLabelsRequest.

Request for the BulkDownloadFeedbackLabel endpoint.

Generated from protobuf message google.cloud.contactcenterinsights.v1.BulkDownloadFeedbackLabelsRequest

Namespace

Google \ Cloud \ ContactCenterInsights \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ gcs_destination BulkDownloadFeedbackLabelsRequest\GcsDestination

A cloud storage bucket destination.
↳ 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: * * 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
↳ max_download_count int

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

Optional. The type of feedback labels that will be downloaded.
↳ conversation_filter 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 template_qa_scorecard_id is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.
↳ template_qa_scorecard_id array

Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label filter will be ignored.

getGcsDestination

A cloud storage bucket destination.

Returns
Type Description
BulkDownloadFeedbackLabelsRequest\GcsDestination|null

hasGcsDestination

setGcsDestination

A cloud storage bucket destination.

Parameter
Name Description
var BulkDownloadFeedbackLabelsRequest\GcsDestination
Returns
Type Description
$this

getParent

Required. The parent resource for new feedback labels.

Returns
Type Description
string

setParent

Required. The parent resource for new feedback labels.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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

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
Returns
Type Description
string

setFilter

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

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
Parameter
Name Description
var string
Returns
Type Description
$this

getMaxDownloadCount

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

Returns
Type Description
int

setMaxDownloadCount

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

Parameter
Name Description
var int
Returns
Type Description
$this

getFeedbackLabelType

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

Returns
Type Description
int

setFeedbackLabelType

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

Parameter
Name Description
var int
Returns
Type Description
$this

getConversationFilter

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

Returns
Type Description
string

setConversationFilter

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

Parameter
Name Description
var string
Returns
Type Description
$this

getTemplateQaScorecardId

Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label filter will be ignored.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTemplateQaScorecardId

Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label filter will be ignored.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getDestination

Returns
Type Description
string

static::build

Parameter
Name Description
parent string

Required. The parent resource for new feedback labels. Please see ContactCenterInsightsClient::locationName() for help formatting this field.
Returns
Type Description
BulkDownloadFeedbackLabelsRequest