Class: Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest

Inherits:

Object

• Object
• Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb

Overview

Request for the BulkDownloadFeedbackLabel endpoint.

Defined Under Namespace

Modules: FeedbackLabelType Classes: GcsDestination

Instance Attribute Summary

• #conversation_filter ⇒ ::String

  Optional.

• #feedback_label_type ⇒ ::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::FeedbackLabelType

  Optional.

• #filter ⇒ ::String

  Optional.

• #gcs_destination ⇒ ::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination

  A cloud storage bucket destination.

• #max_download_count ⇒ ::Integer

  Optional.

• #parent ⇒ ::String

  Required.

• #template_qa_scorecard_id ⇒ ::Array<::String>

  Optional.

Instance Attribute Details

#conversation_filter ⇒ ::String

Returns 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:

• (::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.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 2329

class BulkDownloadFeedbackLabelsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Google Cloud Storage Object details to write the feedback labels to.
  # @!attribute [rw] format
  #   @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination::Format]
  #     Required. File format in which the labels will be exported.
  # @!attribute [rw] object_uri
  #   @return [::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`
  # @!attribute [rw] add_whitespace
  #   @return [::Boolean]
  #     Optional. Add whitespace to the JSON file. Makes easier to read, but
  #     increases file size. Only applicable for JSON format.
  # @!attribute [rw] always_print_empty_fields
  #   @return [::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.
  # @!attribute [rw] records_per_file_count
  #   @return [::Integer]
  #     Optional. The number of records per file. Applicable for either format.
  class GcsDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All permissible file formats.
    # See `records_per_file_count` to override the default number of records
    # per file.
    module Format
      # Unspecified format.
      FORMAT_UNSPECIFIED = 0

      # CSV format.
      # 1,000 labels are stored per CSV file by default.
      CSV = 1

      # JSON format.
      # 1 label stored per JSON file by default.
      JSON = 2
    end
  end

  # Possible feedback label types that will be downloaded.
  module FeedbackLabelType
    # Unspecified format
    FEEDBACK_LABEL_TYPE_UNSPECIFIED = 0

    # Downloaded file will contain all Quality AI labels from the latest
    # scorecard revision.
    QUALITY_AI = 1

    # Downloaded file will contain only Topic Modeling labels.
    TOPIC_MODELING = 2
  end
end

#feedback_label_type ⇒ ::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::FeedbackLabelType

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

Returns:

• (::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::FeedbackLabelType) —

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

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 2329

class BulkDownloadFeedbackLabelsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Google Cloud Storage Object details to write the feedback labels to.
  # @!attribute [rw] format
  #   @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination::Format]
  #     Required. File format in which the labels will be exported.
  # @!attribute [rw] object_uri
  #   @return [::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`
  # @!attribute [rw] add_whitespace
  #   @return [::Boolean]
  #     Optional. Add whitespace to the JSON file. Makes easier to read, but
  #     increases file size. Only applicable for JSON format.
  # @!attribute [rw] always_print_empty_fields
  #   @return [::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.
  # @!attribute [rw] records_per_file_count
  #   @return [::Integer]
  #     Optional. The number of records per file. Applicable for either format.
  class GcsDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All permissible file formats.
    # See `records_per_file_count` to override the default number of records
    # per file.
    module Format
      # Unspecified format.
      FORMAT_UNSPECIFIED = 0

      # CSV format.
      # 1,000 labels are stored per CSV file by default.
      CSV = 1

      # JSON format.
      # 1 label stored per JSON file by default.
      JSON = 2
    end
  end

  # Possible feedback label types that will be downloaded.
  module FeedbackLabelType
    # Unspecified format
    FEEDBACK_LABEL_TYPE_UNSPECIFIED = 0

    # Downloaded file will contain all Quality AI labels from the latest
    # scorecard revision.
    QUALITY_AI = 1

    # Downloaded file will contain only Topic Modeling labels.
    TOPIC_MODELING = 2
  end
end

#filter ⇒ ::String

Returns 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:

• (::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

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 2329

class BulkDownloadFeedbackLabelsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Google Cloud Storage Object details to write the feedback labels to.
  # @!attribute [rw] format
  #   @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination::Format]
  #     Required. File format in which the labels will be exported.
  # @!attribute [rw] object_uri
  #   @return [::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`
  # @!attribute [rw] add_whitespace
  #   @return [::Boolean]
  #     Optional. Add whitespace to the JSON file. Makes easier to read, but
  #     increases file size. Only applicable for JSON format.
  # @!attribute [rw] always_print_empty_fields
  #   @return [::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.
  # @!attribute [rw] records_per_file_count
  #   @return [::Integer]
  #     Optional. The number of records per file. Applicable for either format.
  class GcsDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All permissible file formats.
    # See `records_per_file_count` to override the default number of records
    # per file.
    module Format
      # Unspecified format.
      FORMAT_UNSPECIFIED = 0

      # CSV format.
      # 1,000 labels are stored per CSV file by default.
      CSV = 1

      # JSON format.
      # 1 label stored per JSON file by default.
      JSON = 2
    end
  end

  # Possible feedback label types that will be downloaded.
  module FeedbackLabelType
    # Unspecified format
    FEEDBACK_LABEL_TYPE_UNSPECIFIED = 0

    # Downloaded file will contain all Quality AI labels from the latest
    # scorecard revision.
    QUALITY_AI = 1

    # Downloaded file will contain only Topic Modeling labels.
    TOPIC_MODELING = 2
  end
end

#gcs_destination ⇒ ::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination

Returns A cloud storage bucket destination.

Returns:

• (::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination) —

  A cloud storage bucket destination.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 2329

class BulkDownloadFeedbackLabelsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Google Cloud Storage Object details to write the feedback labels to.
  # @!attribute [rw] format
  #   @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination::Format]
  #     Required. File format in which the labels will be exported.
  # @!attribute [rw] object_uri
  #   @return [::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`
  # @!attribute [rw] add_whitespace
  #   @return [::Boolean]
  #     Optional. Add whitespace to the JSON file. Makes easier to read, but
  #     increases file size. Only applicable for JSON format.
  # @!attribute [rw] always_print_empty_fields
  #   @return [::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.
  # @!attribute [rw] records_per_file_count
  #   @return [::Integer]
  #     Optional. The number of records per file. Applicable for either format.
  class GcsDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All permissible file formats.
    # See `records_per_file_count` to override the default number of records
    # per file.
    module Format
      # Unspecified format.
      FORMAT_UNSPECIFIED = 0

      # CSV format.
      # 1,000 labels are stored per CSV file by default.
      CSV = 1

      # JSON format.
      # 1 label stored per JSON file by default.
      JSON = 2
    end
  end

  # Possible feedback label types that will be downloaded.
  module FeedbackLabelType
    # Unspecified format
    FEEDBACK_LABEL_TYPE_UNSPECIFIED = 0

    # Downloaded file will contain all Quality AI labels from the latest
    # scorecard revision.
    QUALITY_AI = 1

    # Downloaded file will contain only Topic Modeling labels.
    TOPIC_MODELING = 2
  end
end

#max_download_count ⇒ ::Integer

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

Returns:

• (::Integer) —

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

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 2329

class BulkDownloadFeedbackLabelsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Google Cloud Storage Object details to write the feedback labels to.
  # @!attribute [rw] format
  #   @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination::Format]
  #     Required. File format in which the labels will be exported.
  # @!attribute [rw] object_uri
  #   @return [::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`
  # @!attribute [rw] add_whitespace
  #   @return [::Boolean]
  #     Optional. Add whitespace to the JSON file. Makes easier to read, but
  #     increases file size. Only applicable for JSON format.
  # @!attribute [rw] always_print_empty_fields
  #   @return [::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.
  # @!attribute [rw] records_per_file_count
  #   @return [::Integer]
  #     Optional. The number of records per file. Applicable for either format.
  class GcsDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All permissible file formats.
    # See `records_per_file_count` to override the default number of records
    # per file.
    module Format
      # Unspecified format.
      FORMAT_UNSPECIFIED = 0

      # CSV format.
      # 1,000 labels are stored per CSV file by default.
      CSV = 1

      # JSON format.
      # 1 label stored per JSON file by default.
      JSON = 2
    end
  end

  # Possible feedback label types that will be downloaded.
  module FeedbackLabelType
    # Unspecified format
    FEEDBACK_LABEL_TYPE_UNSPECIFIED = 0

    # Downloaded file will contain all Quality AI labels from the latest
    # scorecard revision.
    QUALITY_AI = 1

    # Downloaded file will contain only Topic Modeling labels.
    TOPIC_MODELING = 2
  end
end

#parent ⇒ ::String

Returns Required. The parent resource for new feedback labels.

Returns:

• (::String) —

  Required. The parent resource for new feedback labels.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 2329

class BulkDownloadFeedbackLabelsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Google Cloud Storage Object details to write the feedback labels to.
  # @!attribute [rw] format
  #   @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination::Format]
  #     Required. File format in which the labels will be exported.
  # @!attribute [rw] object_uri
  #   @return [::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`
  # @!attribute [rw] add_whitespace
  #   @return [::Boolean]
  #     Optional. Add whitespace to the JSON file. Makes easier to read, but
  #     increases file size. Only applicable for JSON format.
  # @!attribute [rw] always_print_empty_fields
  #   @return [::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.
  # @!attribute [rw] records_per_file_count
  #   @return [::Integer]
  #     Optional. The number of records per file. Applicable for either format.
  class GcsDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All permissible file formats.
    # See `records_per_file_count` to override the default number of records
    # per file.
    module Format
      # Unspecified format.
      FORMAT_UNSPECIFIED = 0

      # CSV format.
      # 1,000 labels are stored per CSV file by default.
      CSV = 1

      # JSON format.
      # 1 label stored per JSON file by default.
      JSON = 2
    end
  end

  # Possible feedback label types that will be downloaded.
  module FeedbackLabelType
    # Unspecified format
    FEEDBACK_LABEL_TYPE_UNSPECIFIED = 0

    # Downloaded file will contain all Quality AI labels from the latest
    # scorecard revision.
    QUALITY_AI = 1

    # Downloaded file will contain only Topic Modeling labels.
    TOPIC_MODELING = 2
  end
end

#template_qa_scorecard_id ⇒ ::Array<::String>

Returns 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:

• (::Array<::String>) —

  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.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 2329

class BulkDownloadFeedbackLabelsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Google Cloud Storage Object details to write the feedback labels to.
  # @!attribute [rw] format
  #   @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination::Format]
  #     Required. File format in which the labels will be exported.
  # @!attribute [rw] object_uri
  #   @return [::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`
  # @!attribute [rw] add_whitespace
  #   @return [::Boolean]
  #     Optional. Add whitespace to the JSON file. Makes easier to read, but
  #     increases file size. Only applicable for JSON format.
  # @!attribute [rw] always_print_empty_fields
  #   @return [::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.
  # @!attribute [rw] records_per_file_count
  #   @return [::Integer]
  #     Optional. The number of records per file. Applicable for either format.
  class GcsDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All permissible file formats.
    # See `records_per_file_count` to override the default number of records
    # per file.
    module Format
      # Unspecified format.
      FORMAT_UNSPECIFIED = 0

      # CSV format.
      # 1,000 labels are stored per CSV file by default.
      CSV = 1

      # JSON format.
      # 1 label stored per JSON file by default.
      JSON = 2
    end
  end

  # Possible feedback label types that will be downloaded.
  module FeedbackLabelType
    # Unspecified format
    FEEDBACK_LABEL_TYPE_UNSPECIFIED = 0

    # Downloaded file will contain all Quality AI labels from the latest
    # scorecard revision.
    QUALITY_AI = 1

    # Downloaded file will contain only Topic Modeling labels.
    TOPIC_MODELING = 2
  end
end