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



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1462

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}
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  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
    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}



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1462

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}
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  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
    end
  end
end

#run_entity_annotator ⇒ ::Boolean

Returns Whether to run the entity annotator.

Returns:

  • (::Boolean) —

    Whether to run the entity annotator.



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1462

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}
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  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
    end
  end
end

#run_intent_annotator ⇒ ::Boolean

Returns Whether to run the intent annotator.

Returns:

  • (::Boolean) —

    Whether to run the intent annotator.



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1462

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}
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  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
    end
  end
end

#run_interruption_annotator ⇒ ::Boolean

Returns Whether to run the interruption annotator.

Returns:

  • (::Boolean) —

    Whether to run the interruption annotator.



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1462

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}
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  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
    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.



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1462

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}
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  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
    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).



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1462

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}
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  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
    end
  end
end

#run_sentiment_annotator ⇒ ::Boolean

Returns Whether to run the sentiment annotator.

Returns:

  • (::Boolean) —

    Whether to run the sentiment annotator.



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1462

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}
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  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
    end
  end
end

#run_silence_annotator ⇒ ::Boolean

Returns Whether to run the silence annotator.

Returns:

  • (::Boolean) —

    Whether to run the silence annotator.



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1462

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}
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  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
    end
  end
end

#run_summarization_annotator ⇒ ::Boolean

Returns Whether to run the summarization annotator.

Returns:

  • (::Boolean) —

    Whether to run the summarization annotator.



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1462

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}
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  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
    end
  end
end

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

Returns Configuration for the summarization annotator.

Returns:



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1462

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}
  # @!attribute [rw] summarization_model
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig::SummarizationModel]
  #     Default summarization model to be used.
  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
    end
  end
end