Package com.google.cloud.contactcenterinsights.v1

Interface AnnotatorSelectorOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AnnotatorSelector, AnnotatorSelector.Builder
    public interface AnnotatorSelectorOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getRunInterruptionAnnotator

        boolean getRunInterruptionAnnotator()
         Whether to run the interruption annotator.
        bool run_interruption_annotator = 1;
        Returns:
        The runInterruptionAnnotator.

      • getRunSilenceAnnotator

        boolean getRunSilenceAnnotator()
         Whether to run the silence annotator.
        bool run_silence_annotator = 2;
        Returns:
        The runSilenceAnnotator.

      • getRunPhraseMatcherAnnotator

        boolean getRunPhraseMatcherAnnotator()
         Whether to run the active phrase matcher annotator(s).
        bool run_phrase_matcher_annotator = 3;
        Returns:
        The runPhraseMatcherAnnotator.

      • getPhraseMatchersList

        List<String> 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) = { ... }
        Returns:
        A list containing the phraseMatchers.

      • getPhraseMatchersCount

        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) = { ... }
        Returns:
        The count of phraseMatchers.

      • getPhraseMatchers

        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) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The phraseMatchers at the given index.

      • getPhraseMatchersBytes

        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) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the phraseMatchers at the given index.

      • getRunSentimentAnnotator

        boolean getRunSentimentAnnotator()
         Whether to run the sentiment annotator.
        bool run_sentiment_annotator = 5;
        Returns:
        The runSentimentAnnotator.

      • getRunEntityAnnotator

        boolean getRunEntityAnnotator()
         Whether to run the entity annotator.
        bool run_entity_annotator = 6;
        Returns:
        The runEntityAnnotator.

      • getRunIntentAnnotator

        boolean getRunIntentAnnotator()
         Whether to run the intent annotator.
        bool run_intent_annotator = 7;
        Returns:
        The runIntentAnnotator.

      • getRunIssueModelAnnotator

        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;
        Returns:
        The runIssueModelAnnotator.

      • getIssueModelsList

        List<String> 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) = { ... }
        Returns:
        A list containing the issueModels.

      • getIssueModelsCount

        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) = { ... }
        Returns:
        The count of issueModels.

      • getIssueModels

        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) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The issueModels at the given index.

      • getIssueModelsBytes

        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) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the issueModels at the given index.

      • getRunSummarizationAnnotator

        boolean getRunSummarizationAnnotator()
         Whether to run the summarization annotator.
        bool run_summarization_annotator = 9;
        Returns:
        The runSummarizationAnnotator.

      • hasSummarizationConfig

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

      • getSummarizationConfig

        AnnotatorSelector.SummarizationConfig getSummarizationConfig()
         Configuration for the summarization annotator.
        .google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig summarization_config = 11;
        Returns:
        The summarizationConfig.

      • getSummarizationConfigOrBuilder

        AnnotatorSelector.SummarizationConfigOrBuilder getSummarizationConfigOrBuilder()
         Configuration for the summarization annotator.
        .google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig summarization_config = 11;