Package com.google.cloud.contactcenterinsights.v1

Class AnnotatorSelector

  • All Implemented Interfaces:
    AnnotatorSelectorOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AnnotatorSelector
extends com.google.protobuf.GeneratedMessageV3
implements AnnotatorSelectorOrBuilder
     Selector of all available annotators and phrase matchers to run.
    Protobuf type google.cloud.contactcenterinsights.v1.AnnotatorSelector
    See Also:
    Serialized Form

    • Field Detail

      • RUN_INTERRUPTION_ANNOTATOR_FIELD_NUMBER

        public static final int RUN_INTERRUPTION_ANNOTATOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUN_SILENCE_ANNOTATOR_FIELD_NUMBER

        public static final int RUN_SILENCE_ANNOTATOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUN_PHRASE_MATCHER_ANNOTATOR_FIELD_NUMBER

        public static final int RUN_PHRASE_MATCHER_ANNOTATOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PHRASE_MATCHERS_FIELD_NUMBER

        public static final int PHRASE_MATCHERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUN_SENTIMENT_ANNOTATOR_FIELD_NUMBER

        public static final int RUN_SENTIMENT_ANNOTATOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUN_ENTITY_ANNOTATOR_FIELD_NUMBER

        public static final int RUN_ENTITY_ANNOTATOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUN_INTENT_ANNOTATOR_FIELD_NUMBER

        public static final int RUN_INTENT_ANNOTATOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUN_ISSUE_MODEL_ANNOTATOR_FIELD_NUMBER

        public static final int RUN_ISSUE_MODEL_ANNOTATOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ISSUE_MODELS_FIELD_NUMBER

        public static final int ISSUE_MODELS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUN_SUMMARIZATION_ANNOTATOR_FIELD_NUMBER

        public static final int RUN_SUMMARIZATION_ANNOTATOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUMMARIZATION_CONFIG_FIELD_NUMBER

        public static final int SUMMARIZATION_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getRunInterruptionAnnotator

        public boolean getRunInterruptionAnnotator()
         Whether to run the interruption annotator.
        bool run_interruption_annotator = 1;
        Specified by:
        getRunInterruptionAnnotator in interface AnnotatorSelectorOrBuilder
        Returns:
        The runInterruptionAnnotator.

      • getRunSilenceAnnotator

        public boolean getRunSilenceAnnotator()
         Whether to run the silence annotator.
        bool run_silence_annotator = 2;
        Specified by:
        getRunSilenceAnnotator in interface AnnotatorSelectorOrBuilder
        Returns:
        The runSilenceAnnotator.

      • getRunPhraseMatcherAnnotator

        public boolean getRunPhraseMatcherAnnotator()
         Whether to run the active phrase matcher annotator(s).
        bool run_phrase_matcher_annotator = 3;
        Specified by:
        getRunPhraseMatcherAnnotator in interface AnnotatorSelectorOrBuilder
        Returns:
        The runPhraseMatcherAnnotator.

      • getPhraseMatchersList

        public com.google.protobuf.ProtocolStringList getPhraseMatchersList()
         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}
        repeated string phrase_matchers = 4 [(.google.api.resource_reference) = { ... }
        Specified by:
        getPhraseMatchersList in interface AnnotatorSelectorOrBuilder
        Returns:
        A list containing the phraseMatchers.

      • getPhraseMatchersCount

        public int getPhraseMatchersCount()
         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}
        repeated string phrase_matchers = 4 [(.google.api.resource_reference) = { ... }
        Specified by:
        getPhraseMatchersCount in interface AnnotatorSelectorOrBuilder
        Returns:
        The count of phraseMatchers.

      • getPhraseMatchers

        public String getPhraseMatchers​(int index)
         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}
        repeated string phrase_matchers = 4 [(.google.api.resource_reference) = { ... }
        Specified by:
        getPhraseMatchers in interface AnnotatorSelectorOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The phraseMatchers at the given index.

      • getPhraseMatchersBytes

        public com.google.protobuf.ByteString getPhraseMatchersBytes​(int index)
         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}
        repeated string phrase_matchers = 4 [(.google.api.resource_reference) = { ... }
        Specified by:
        getPhraseMatchersBytes in interface AnnotatorSelectorOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the phraseMatchers at the given index.

      • getRunSentimentAnnotator

        public boolean getRunSentimentAnnotator()
         Whether to run the sentiment annotator.
        bool run_sentiment_annotator = 5;
        Specified by:
        getRunSentimentAnnotator in interface AnnotatorSelectorOrBuilder
        Returns:
        The runSentimentAnnotator.

      • getRunEntityAnnotator

        public boolean getRunEntityAnnotator()
         Whether to run the entity annotator.
        bool run_entity_annotator = 6;
        Specified by:
        getRunEntityAnnotator in interface AnnotatorSelectorOrBuilder
        Returns:
        The runEntityAnnotator.

      • getRunIntentAnnotator

        public boolean getRunIntentAnnotator()
         Whether to run the intent annotator.
        bool run_intent_annotator = 7;
        Specified by:
        getRunIntentAnnotator in interface AnnotatorSelectorOrBuilder
        Returns:
        The runIntentAnnotator.

      • getRunIssueModelAnnotator

        public boolean getRunIssueModelAnnotator()
         Whether to run the issue model annotator. A model should have already been
 deployed for this to take effect.
        bool run_issue_model_annotator = 8;
        Specified by:
        getRunIssueModelAnnotator in interface AnnotatorSelectorOrBuilder
        Returns:
        The runIssueModelAnnotator.

      • getIssueModelsList

        public com.google.protobuf.ProtocolStringList getIssueModelsList()
         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.
        repeated string issue_models = 10 [(.google.api.resource_reference) = { ... }
        Specified by:
        getIssueModelsList in interface AnnotatorSelectorOrBuilder
        Returns:
        A list containing the issueModels.

      • getIssueModelsCount

        public int getIssueModelsCount()
         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.
        repeated string issue_models = 10 [(.google.api.resource_reference) = { ... }
        Specified by:
        getIssueModelsCount in interface AnnotatorSelectorOrBuilder
        Returns:
        The count of issueModels.

      • getIssueModels

        public String getIssueModels​(int index)
         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.
        repeated string issue_models = 10 [(.google.api.resource_reference) = { ... }
        Specified by:
        getIssueModels in interface AnnotatorSelectorOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The issueModels at the given index.

      • getIssueModelsBytes

        public com.google.protobuf.ByteString getIssueModelsBytes​(int index)
         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.
        repeated string issue_models = 10 [(.google.api.resource_reference) = { ... }
        Specified by:
        getIssueModelsBytes in interface AnnotatorSelectorOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the issueModels at the given index.

      • getRunSummarizationAnnotator

        public boolean getRunSummarizationAnnotator()
         Whether to run the summarization annotator.
        bool run_summarization_annotator = 9;
        Specified by:
        getRunSummarizationAnnotator in interface AnnotatorSelectorOrBuilder
        Returns:
        The runSummarizationAnnotator.

      • hasSummarizationConfig

        public boolean hasSummarizationConfig()
         Configuration for the summarization annotator.
        .google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig summarization_config = 11;
        Specified by:
        hasSummarizationConfig in interface AnnotatorSelectorOrBuilder
        Returns:
        Whether the summarizationConfig field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AnnotatorSelector parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnnotatorSelector parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnnotatorSelector parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnnotatorSelector parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnnotatorSelector parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnnotatorSelector parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AnnotatorSelector parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public AnnotatorSelector.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AnnotatorSelector.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AnnotatorSelector.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AnnotatorSelector> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AnnotatorSelector getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder