Class AnnotatorSelector (2.42.0)

public final class AnnotatorSelector extends GeneratedMessageV3 implements AnnotatorSelectorOrBuilder

Selector of all available annotators and phrase matchers to run.

Protobuf type google.cloud.contactcenterinsights.v1.AnnotatorSelector

Static Fields

ISSUE_MODELS_FIELD_NUMBER

public static final int ISSUE_MODELS_FIELD_NUMBER
Field Value
Type Description
int

PHRASE_MATCHERS_FIELD_NUMBER

public static final int PHRASE_MATCHERS_FIELD_NUMBER
Field Value
Type Description
int

RUN_ENTITY_ANNOTATOR_FIELD_NUMBER

public static final int RUN_ENTITY_ANNOTATOR_FIELD_NUMBER
Field Value
Type Description
int

RUN_INTENT_ANNOTATOR_FIELD_NUMBER

public static final int RUN_INTENT_ANNOTATOR_FIELD_NUMBER
Field Value
Type Description
int

RUN_INTERRUPTION_ANNOTATOR_FIELD_NUMBER

public static final int RUN_INTERRUPTION_ANNOTATOR_FIELD_NUMBER
Field Value
Type Description
int

RUN_ISSUE_MODEL_ANNOTATOR_FIELD_NUMBER

public static final int RUN_ISSUE_MODEL_ANNOTATOR_FIELD_NUMBER
Field Value
Type Description
int

RUN_PHRASE_MATCHER_ANNOTATOR_FIELD_NUMBER

public static final int RUN_PHRASE_MATCHER_ANNOTATOR_FIELD_NUMBER
Field Value
Type Description
int

RUN_SENTIMENT_ANNOTATOR_FIELD_NUMBER

public static final int RUN_SENTIMENT_ANNOTATOR_FIELD_NUMBER
Field Value
Type Description
int

RUN_SILENCE_ANNOTATOR_FIELD_NUMBER

public static final int RUN_SILENCE_ANNOTATOR_FIELD_NUMBER
Field Value
Type Description
int

RUN_SUMMARIZATION_ANNOTATOR_FIELD_NUMBER

public static final int RUN_SUMMARIZATION_ANNOTATOR_FIELD_NUMBER
Field Value
Type Description
int

SUMMARIZATION_CONFIG_FIELD_NUMBER

public static final int SUMMARIZATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnnotatorSelector getDefaultInstance()
Returns
Type Description
AnnotatorSelector

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AnnotatorSelector.Builder newBuilder()
Returns
Type Description
AnnotatorSelector.Builder

newBuilder(AnnotatorSelector prototype)

public static AnnotatorSelector.Builder newBuilder(AnnotatorSelector prototype)
Parameter
Name Description
prototype AnnotatorSelector
Returns
Type Description
AnnotatorSelector.Builder

parseDelimitedFrom(InputStream input)

public static AnnotatorSelector parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotatorSelector parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnnotatorSelector parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotatorSelector parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotatorSelector parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotatorSelector parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotatorSelector parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotatorSelector parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnnotatorSelector parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotatorSelector parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnnotatorSelector parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotatorSelector parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatorSelector
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnnotatorSelector> parser()
Returns
Type Description
Parser<AnnotatorSelector>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public AnnotatorSelector getDefaultInstanceForType()
Returns
Type Description
AnnotatorSelector

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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the issueModels.

getParserForType()

public Parser<AnnotatorSelector> getParserForType()
Returns
Type Description
Parser<AnnotatorSelector>
Overrides

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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the phraseMatchers.

getRunEntityAnnotator()

public boolean getRunEntityAnnotator()

Whether to run the entity annotator.

bool run_entity_annotator = 6;

Returns
Type Description
boolean

The runEntityAnnotator.

getRunIntentAnnotator()

public boolean getRunIntentAnnotator()

Whether to run the intent annotator.

bool run_intent_annotator = 7;

Returns
Type Description
boolean

The runIntentAnnotator.

getRunInterruptionAnnotator()

public boolean getRunInterruptionAnnotator()

Whether to run the interruption annotator.

bool run_interruption_annotator = 1;

Returns
Type Description
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
Type Description
boolean

The runIssueModelAnnotator.

getRunPhraseMatcherAnnotator()

public boolean getRunPhraseMatcherAnnotator()

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

bool run_phrase_matcher_annotator = 3;

Returns
Type Description
boolean

The runPhraseMatcherAnnotator.

getRunSentimentAnnotator()

public boolean getRunSentimentAnnotator()

Whether to run the sentiment annotator.

bool run_sentiment_annotator = 5;

Returns
Type Description
boolean

The runSentimentAnnotator.

getRunSilenceAnnotator()

public boolean getRunSilenceAnnotator()

Whether to run the silence annotator.

bool run_silence_annotator = 2;

Returns
Type Description
boolean

The runSilenceAnnotator.

getRunSummarizationAnnotator()

public boolean getRunSummarizationAnnotator()

Whether to run the summarization annotator.

bool run_summarization_annotator = 9;

Returns
Type Description
boolean

The runSummarizationAnnotator.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSummarizationConfig()

public AnnotatorSelector.SummarizationConfig getSummarizationConfig()

Configuration for the summarization annotator.

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

Returns
Type Description
AnnotatorSelector.SummarizationConfig

The summarizationConfig.

getSummarizationConfigOrBuilder()

public AnnotatorSelector.SummarizationConfigOrBuilder getSummarizationConfigOrBuilder()

Configuration for the summarization annotator.

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

Returns
Type Description
AnnotatorSelector.SummarizationConfigOrBuilder

hasSummarizationConfig()

public boolean hasSummarizationConfig()

Configuration for the summarization annotator.

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

Returns
Type Description
boolean

Whether the summarizationConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AnnotatorSelector.Builder newBuilderForType()
Returns
Type Description
AnnotatorSelector.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotatorSelector.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnnotatorSelector.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AnnotatorSelector.Builder toBuilder()
Returns
Type Description
AnnotatorSelector.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException