Class AnnotatorSelector.Builder (2.18.0)

public static final class AnnotatorSelector.Builder extends GeneratedMessageV3.Builder<AnnotatorSelector.Builder> implements AnnotatorSelectorOrBuilder

Selector of all available annotators and phrase matchers to run.

Protobuf type google.cloud.contactcenterinsights.v1.AnnotatorSelector

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllIssueModels(Iterable<String> values)

public AnnotatorSelector.Builder addAllIssueModels(Iterable<String> values)

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) = { ... }

Parameter
NameDescription
valuesIterable<String>

The issueModels to add.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

addAllPhraseMatchers(Iterable<String> values)

public AnnotatorSelector.Builder addAllPhraseMatchers(Iterable<String> values)

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) = { ... }

Parameter
NameDescription
valuesIterable<String>

The phraseMatchers to add.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

addIssueModels(String value)

public AnnotatorSelector.Builder addIssueModels(String value)

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) = { ... }

Parameter
NameDescription
valueString

The issueModels to add.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

addIssueModelsBytes(ByteString value)

public AnnotatorSelector.Builder addIssueModelsBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes of the issueModels to add.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

addPhraseMatchers(String value)

public AnnotatorSelector.Builder addPhraseMatchers(String value)

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) = { ... }

Parameter
NameDescription
valueString

The phraseMatchers to add.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

addPhraseMatchersBytes(ByteString value)

public AnnotatorSelector.Builder addPhraseMatchersBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes of the phraseMatchers to add.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AnnotatorSelector.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AnnotatorSelector.Builder
Overrides

build()

public AnnotatorSelector build()
Returns
TypeDescription
AnnotatorSelector

buildPartial()

public AnnotatorSelector buildPartial()
Returns
TypeDescription
AnnotatorSelector

clear()

public AnnotatorSelector.Builder clear()
Returns
TypeDescription
AnnotatorSelector.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AnnotatorSelector.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AnnotatorSelector.Builder
Overrides

clearIssueModels()

public AnnotatorSelector.Builder clearIssueModels()

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
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AnnotatorSelector.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AnnotatorSelector.Builder
Overrides

clearPhraseMatchers()

public AnnotatorSelector.Builder clearPhraseMatchers()

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
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

clearRunEntityAnnotator()

public AnnotatorSelector.Builder clearRunEntityAnnotator()

Whether to run the entity annotator.

bool run_entity_annotator = 6;

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

clearRunIntentAnnotator()

public AnnotatorSelector.Builder clearRunIntentAnnotator()

Whether to run the intent annotator.

bool run_intent_annotator = 7;

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

clearRunInterruptionAnnotator()

public AnnotatorSelector.Builder clearRunInterruptionAnnotator()

Whether to run the interruption annotator.

bool run_interruption_annotator = 1;

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

clearRunIssueModelAnnotator()

public AnnotatorSelector.Builder clearRunIssueModelAnnotator()

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
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

clearRunPhraseMatcherAnnotator()

public AnnotatorSelector.Builder clearRunPhraseMatcherAnnotator()

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

bool run_phrase_matcher_annotator = 3;

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

clearRunSentimentAnnotator()

public AnnotatorSelector.Builder clearRunSentimentAnnotator()

Whether to run the sentiment annotator.

bool run_sentiment_annotator = 5;

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

clearRunSilenceAnnotator()

public AnnotatorSelector.Builder clearRunSilenceAnnotator()

Whether to run the silence annotator.

bool run_silence_annotator = 2;

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

clearRunSummarizationAnnotator()

public AnnotatorSelector.Builder clearRunSummarizationAnnotator()

Whether to run the summarization annotator.

bool run_summarization_annotator = 9;

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

clearSummarizationConfig()

public AnnotatorSelector.Builder clearSummarizationConfig()

Configuration for the summarization annotator.

.google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig summarization_config = 11;

Returns
TypeDescription
AnnotatorSelector.Builder

clone()

public AnnotatorSelector.Builder clone()
Returns
TypeDescription
AnnotatorSelector.Builder
Overrides

getDefaultInstanceForType()

public AnnotatorSelector getDefaultInstanceForType()
Returns
TypeDescription
AnnotatorSelector

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getIssueModels(int index)

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) = { ... }

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The issueModels at the given index.

getIssueModelsBytes(int index)

public 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) = { ... }

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the issueModels at the given index.

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) = { ... }

Returns
TypeDescription
int

The count of issueModels.

getIssueModelsList()

public 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) = { ... }

Returns
TypeDescription
ProtocolStringList

A list containing the issueModels.

getPhraseMatchers(int index)

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) = { ... }

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The phraseMatchers at the given index.

getPhraseMatchersBytes(int index)

public 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) = { ... }

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the phraseMatchers at the given index.

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) = { ... }

Returns
TypeDescription
int

The count of phraseMatchers.

getPhraseMatchersList()

public 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) = { ... }

Returns
TypeDescription
ProtocolStringList

A list containing the phraseMatchers.

getRunEntityAnnotator()

public boolean getRunEntityAnnotator()

Whether to run the entity annotator.

bool run_entity_annotator = 6;

Returns
TypeDescription
boolean

The runEntityAnnotator.

getRunIntentAnnotator()

public boolean getRunIntentAnnotator()

Whether to run the intent annotator.

bool run_intent_annotator = 7;

Returns
TypeDescription
boolean

The runIntentAnnotator.

getRunInterruptionAnnotator()

public boolean getRunInterruptionAnnotator()

Whether to run the interruption annotator.

bool run_interruption_annotator = 1;

Returns
TypeDescription
boolean

The runInterruptionAnnotator.

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;

Returns
TypeDescription
boolean

The runIssueModelAnnotator.

getRunPhraseMatcherAnnotator()

public boolean getRunPhraseMatcherAnnotator()

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

bool run_phrase_matcher_annotator = 3;

Returns
TypeDescription
boolean

The runPhraseMatcherAnnotator.

getRunSentimentAnnotator()

public boolean getRunSentimentAnnotator()

Whether to run the sentiment annotator.

bool run_sentiment_annotator = 5;

Returns
TypeDescription
boolean

The runSentimentAnnotator.

getRunSilenceAnnotator()

public boolean getRunSilenceAnnotator()

Whether to run the silence annotator.

bool run_silence_annotator = 2;

Returns
TypeDescription
boolean

The runSilenceAnnotator.

getRunSummarizationAnnotator()

public boolean getRunSummarizationAnnotator()

Whether to run the summarization annotator.

bool run_summarization_annotator = 9;

Returns
TypeDescription
boolean

The runSummarizationAnnotator.

getSummarizationConfig()

public AnnotatorSelector.SummarizationConfig getSummarizationConfig()

Configuration for the summarization annotator.

.google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig summarization_config = 11;

Returns
TypeDescription
AnnotatorSelector.SummarizationConfig

The summarizationConfig.

getSummarizationConfigBuilder()

public AnnotatorSelector.SummarizationConfig.Builder getSummarizationConfigBuilder()

Configuration for the summarization annotator.

.google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig summarization_config = 11;

Returns
TypeDescription
AnnotatorSelector.SummarizationConfig.Builder

getSummarizationConfigOrBuilder()

public AnnotatorSelector.SummarizationConfigOrBuilder getSummarizationConfigOrBuilder()

Configuration for the summarization annotator.

.google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig summarization_config = 11;

Returns
TypeDescription
AnnotatorSelector.SummarizationConfigOrBuilder

hasSummarizationConfig()

public boolean hasSummarizationConfig()

Configuration for the summarization annotator.

.google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig summarization_config = 11;

Returns
TypeDescription
boolean

Whether the summarizationConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AnnotatorSelector other)

public AnnotatorSelector.Builder mergeFrom(AnnotatorSelector other)
Parameter
NameDescription
otherAnnotatorSelector
Returns
TypeDescription
AnnotatorSelector.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AnnotatorSelector.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotatorSelector.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AnnotatorSelector.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AnnotatorSelector.Builder
Overrides

mergeSummarizationConfig(AnnotatorSelector.SummarizationConfig value)

public AnnotatorSelector.Builder mergeSummarizationConfig(AnnotatorSelector.SummarizationConfig value)

Configuration for the summarization annotator.

.google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig summarization_config = 11;

Parameter
NameDescription
valueAnnotatorSelector.SummarizationConfig
Returns
TypeDescription
AnnotatorSelector.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AnnotatorSelector.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AnnotatorSelector.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public AnnotatorSelector.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AnnotatorSelector.Builder
Overrides

setIssueModels(int index, String value)

public AnnotatorSelector.Builder setIssueModels(int index, String value)

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
NameDescription
indexint

The index to set the value at.

valueString

The issueModels to set.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

setPhraseMatchers(int index, String value)

public AnnotatorSelector.Builder setPhraseMatchers(int index, String value)

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
NameDescription
indexint

The index to set the value at.

valueString

The phraseMatchers to set.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AnnotatorSelector.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AnnotatorSelector.Builder
Overrides

setRunEntityAnnotator(boolean value)

public AnnotatorSelector.Builder setRunEntityAnnotator(boolean value)

Whether to run the entity annotator.

bool run_entity_annotator = 6;

Parameter
NameDescription
valueboolean

The runEntityAnnotator to set.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

setRunIntentAnnotator(boolean value)

public AnnotatorSelector.Builder setRunIntentAnnotator(boolean value)

Whether to run the intent annotator.

bool run_intent_annotator = 7;

Parameter
NameDescription
valueboolean

The runIntentAnnotator to set.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

setRunInterruptionAnnotator(boolean value)

public AnnotatorSelector.Builder setRunInterruptionAnnotator(boolean value)

Whether to run the interruption annotator.

bool run_interruption_annotator = 1;

Parameter
NameDescription
valueboolean

The runInterruptionAnnotator to set.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

setRunIssueModelAnnotator(boolean value)

public AnnotatorSelector.Builder setRunIssueModelAnnotator(boolean value)

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;

Parameter
NameDescription
valueboolean

The runIssueModelAnnotator to set.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

setRunPhraseMatcherAnnotator(boolean value)

public AnnotatorSelector.Builder setRunPhraseMatcherAnnotator(boolean value)

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

bool run_phrase_matcher_annotator = 3;

Parameter
NameDescription
valueboolean

The runPhraseMatcherAnnotator to set.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

setRunSentimentAnnotator(boolean value)

public AnnotatorSelector.Builder setRunSentimentAnnotator(boolean value)

Whether to run the sentiment annotator.

bool run_sentiment_annotator = 5;

Parameter
NameDescription
valueboolean

The runSentimentAnnotator to set.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

setRunSilenceAnnotator(boolean value)

public AnnotatorSelector.Builder setRunSilenceAnnotator(boolean value)

Whether to run the silence annotator.

bool run_silence_annotator = 2;

Parameter
NameDescription
valueboolean

The runSilenceAnnotator to set.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

setRunSummarizationAnnotator(boolean value)

public AnnotatorSelector.Builder setRunSummarizationAnnotator(boolean value)

Whether to run the summarization annotator.

bool run_summarization_annotator = 9;

Parameter
NameDescription
valueboolean

The runSummarizationAnnotator to set.

Returns
TypeDescription
AnnotatorSelector.Builder

This builder for chaining.

setSummarizationConfig(AnnotatorSelector.SummarizationConfig value)

public AnnotatorSelector.Builder setSummarizationConfig(AnnotatorSelector.SummarizationConfig value)

Configuration for the summarization annotator.

.google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig summarization_config = 11;

Parameter
NameDescription
valueAnnotatorSelector.SummarizationConfig
Returns
TypeDescription
AnnotatorSelector.Builder

setSummarizationConfig(AnnotatorSelector.SummarizationConfig.Builder builderForValue)

public AnnotatorSelector.Builder setSummarizationConfig(AnnotatorSelector.SummarizationConfig.Builder builderForValue)

Configuration for the summarization annotator.

.google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig summarization_config = 11;

Parameter
NameDescription
builderForValueAnnotatorSelector.SummarizationConfig.Builder
Returns
TypeDescription
AnnotatorSelector.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final AnnotatorSelector.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AnnotatorSelector.Builder
Overrides