Class: Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/contactcenterinsights/v1/resources.rb

Overview

Selector of all available annotators and phrase matchers to run.

Defined Under Namespace

Classes: QaConfig, SummarizationConfig

Instance Attribute Summary collapse

Instance Attribute Details

#issue_models ⇒ ::Array<::String>

Returns The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.

Returns:

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

    The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#phrase_matchers ⇒ ::Array<::String>

Returns The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}.

Returns:

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

    The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#qa_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig

Returns Configuration for the QA annotator.

Returns:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#run_entity_annotator ⇒ ::Boolean

Returns Whether to run the entity annotator.

Returns:

  • (::Boolean) —

    Whether to run the entity annotator.



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#run_intent_annotator ⇒ ::Boolean

Returns Whether to run the intent annotator.

Returns:

  • (::Boolean) —

    Whether to run the intent annotator.



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#run_interruption_annotator ⇒ ::Boolean

Returns Whether to run the interruption annotator.

Returns:

  • (::Boolean) —

    Whether to run the interruption annotator.



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#run_issue_model_annotator ⇒ ::Boolean

Returns Whether to run the issue model annotator. A model should have already been deployed for this to take effect.

Returns:

  • (::Boolean) —

    Whether to run the issue model annotator. A model should have already been deployed for this to take effect.



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#run_phrase_matcher_annotator ⇒ ::Boolean

Returns Whether to run the active phrase matcher annotator(s).

Returns:

  • (::Boolean) —

    Whether to run the active phrase matcher annotator(s).



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#run_qa_annotator ⇒ ::Boolean

Returns Whether to run the QA annotator.

Returns:

  • (::Boolean) —

    Whether to run the QA annotator.



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#run_sentiment_annotator ⇒ ::Boolean

Returns Whether to run the sentiment annotator.

Returns:

  • (::Boolean) —

    Whether to run the sentiment annotator.



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#run_silence_annotator ⇒ ::Boolean

Returns Whether to run the silence annotator.

Returns:

  • (::Boolean) —

    Whether to run the silence annotator.



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#run_summarization_annotator ⇒ ::Boolean

Returns Whether to run the summarization annotator.

Returns:

  • (::Boolean) —

    Whether to run the summarization annotator.



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#summarization_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig

Returns Configuration for the summarization annotator.

Returns:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1728

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

  # Configuration for summarization.
  # @!attribute [rw] conversation_profile
  #   @return [::String]
  #     Resource name of the Dialogflow conversation profile.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/conversationProfiles/\\{conversation_profile}
  #
  #     Note: The following fields are mutually exclusive: `conversation_profile`, `summarization_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  #
  #     Note: The following fields are mutually exclusive: `summarization_model`, `conversation_profile`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summarization model to use, if `conversation_profile` is not used.
    module SummarizationModel
      # Unspecified summarization model.
      SUMMARIZATION_MODEL_UNSPECIFIED = 0

      # The CCAI baseline model.
      BASELINE_MODEL = 1

      # The CCAI baseline model, V2.0.
      BASELINE_MODEL_V2_0 = 2
    end
  end

  # Configuration for the QA feature.
  # @!attribute [rw] scorecard_list
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
  #     A manual list of scorecards to score.
  class QaConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Container for a list of scorecards.
    # @!attribute [rw] qa_scorecard_revisions
    #   @return [::Array<::String>]
    #     List of QaScorecardRevisions.
    class ScorecardList
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end