- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.10
- 2.2.7
public static final class Entity.Builder extends GeneratedMessageV3.Builder<Entity.Builder> implements EntityOrBuilderThe data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
Protobuf type google.cloud.contactcenterinsights.v1.Entity
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Entity.BuilderImplements
EntityOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Entity.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
build()
public Entity build()| Returns | |
|---|---|
| Type | Description |
Entity | |
buildPartial()
public Entity buildPartial()| Returns | |
|---|---|
| Type | Description |
Entity | |
clear()
public Entity.Builder clear()| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
clearDisplayName()
public Entity.Builder clearDisplayName()The representative name for the entity.
string display_name = 1;
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Entity.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
clearMetadata()
public Entity.Builder clearMetadata()| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public Entity.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
clearSalience()
public Entity.Builder clearSalience()The salience score associated with the entity in the [0, 1.0] range.
The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
float salience = 4;
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | This builder for chaining. |
clearSentiment()
public Entity.Builder clearSentiment()The aggregate sentiment expressed for this entity in the conversation.
.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
clearType()
public Entity.Builder clearType()The entity type.
.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | This builder for chaining. |
clone()
public Entity.Builder clone()| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
containsMetadata(String key)
public boolean containsMetadata(String key)Metadata associated with the entity.
For most entity types, the metadata is a Wikipedia URL (wikipedia_url)
and Knowledge Graph MID (mid), if they are available. For the metadata
associated with other entity types, see the Type table below.
map<string, string> metadata = 3;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getDefaultInstanceForType()
public Entity getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Entity | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDisplayName()
public String getDisplayName()The representative name for the entity.
string display_name = 1;
| Returns | |
|---|---|
| Type | Description |
String | The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()The representative name for the entity.
string display_name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for displayName. |
getMetadata() (deprecated)
public Map<String,String> getMetadata()Use #getMetadataMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getMetadataCount()
public int getMetadataCount()Metadata associated with the entity.
For most entity types, the metadata is a Wikipedia URL (wikipedia_url)
and Knowledge Graph MID (mid), if they are available. For the metadata
associated with other entity types, see the Type table below.
map<string, string> metadata = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
getMetadataMap()
public Map<String,String> getMetadataMap()Metadata associated with the entity.
For most entity types, the metadata is a Wikipedia URL (wikipedia_url)
and Knowledge Graph MID (mid), if they are available. For the metadata
associated with other entity types, see the Type table below.
map<string, string> metadata = 3;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getMetadataOrDefault(String key, String defaultValue)
public String getMetadataOrDefault(String key, String defaultValue)Metadata associated with the entity.
For most entity types, the metadata is a Wikipedia URL (wikipedia_url)
and Knowledge Graph MID (mid), if they are available. For the metadata
associated with other entity types, see the Type table below.
map<string, string> metadata = 3;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getMetadataOrThrow(String key)
public String getMetadataOrThrow(String key)Metadata associated with the entity.
For most entity types, the metadata is a Wikipedia URL (wikipedia_url)
and Knowledge Graph MID (mid), if they are available. For the metadata
associated with other entity types, see the Type table below.
map<string, string> metadata = 3;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getMutableMetadata() (deprecated)
public Map<String,String> getMutableMetadata()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getSalience()
public float getSalience()The salience score associated with the entity in the [0, 1.0] range.
The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
float salience = 4;
| Returns | |
|---|---|
| Type | Description |
float | The salience. |
getSentiment()
public SentimentData getSentiment()The aggregate sentiment expressed for this entity in the conversation.
.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
| Returns | |
|---|---|
| Type | Description |
SentimentData | The sentiment. |
getSentimentBuilder()
public SentimentData.Builder getSentimentBuilder()The aggregate sentiment expressed for this entity in the conversation.
.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
| Returns | |
|---|---|
| Type | Description |
SentimentData.Builder | |
getSentimentOrBuilder()
public SentimentDataOrBuilder getSentimentOrBuilder()The aggregate sentiment expressed for this entity in the conversation.
.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
| Returns | |
|---|---|
| Type | Description |
SentimentDataOrBuilder | |
getType()
public Entity.Type getType()The entity type.
.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;
| Returns | |
|---|---|
| Type | Description |
Entity.Type | The type. |
getTypeValue()
public int getTypeValue()The entity type.
.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for type. |
hasSentiment()
public boolean hasSentiment()The aggregate sentiment expressed for this entity in the conversation.
.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sentiment field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(Entity other)
public Entity.Builder mergeFrom(Entity other)| Parameter | |
|---|---|
| Name | Description |
other | Entity |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Entity.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Entity.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
mergeSentiment(SentimentData value)
public Entity.Builder mergeSentiment(SentimentData value)The aggregate sentiment expressed for this entity in the conversation.
.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
| Parameter | |
|---|---|
| Name | Description |
value | SentimentData |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Entity.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
putAllMetadata(Map<String,String> values)
public Entity.Builder putAllMetadata(Map<String,String> values)Metadata associated with the entity.
For most entity types, the metadata is a Wikipedia URL (wikipedia_url)
and Knowledge Graph MID (mid), if they are available. For the metadata
associated with other entity types, see the Type table below.
map<string, string> metadata = 3;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
putMetadata(String key, String value)
public Entity.Builder putMetadata(String key, String value)Metadata associated with the entity.
For most entity types, the metadata is a Wikipedia URL (wikipedia_url)
and Knowledge Graph MID (mid), if they are available. For the metadata
associated with other entity types, see the Type table below.
map<string, string> metadata = 3;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
removeMetadata(String key)
public Entity.Builder removeMetadata(String key)Metadata associated with the entity.
For most entity types, the metadata is a Wikipedia URL (wikipedia_url)
and Knowledge Graph MID (mid), if they are available. For the metadata
associated with other entity types, see the Type table below.
map<string, string> metadata = 3;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
setDisplayName(String value)
public Entity.Builder setDisplayName(String value)The representative name for the entity.
string display_name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Entity.Builder setDisplayNameBytes(ByteString value)The representative name for the entity.
string display_name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Entity.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Entity.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
setSalience(float value)
public Entity.Builder setSalience(float value)The salience score associated with the entity in the [0, 1.0] range.
The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
float salience = 4;
| Parameter | |
|---|---|
| Name | Description |
value | floatThe salience to set. |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | This builder for chaining. |
setSentiment(SentimentData value)
public Entity.Builder setSentiment(SentimentData value)The aggregate sentiment expressed for this entity in the conversation.
.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
| Parameter | |
|---|---|
| Name | Description |
value | SentimentData |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
setSentiment(SentimentData.Builder builderForValue)
public Entity.Builder setSentiment(SentimentData.Builder builderForValue)The aggregate sentiment expressed for this entity in the conversation.
.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | SentimentData.Builder |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |
setType(Entity.Type value)
public Entity.Builder setType(Entity.Type value)The entity type.
.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;
| Parameter | |
|---|---|
| Name | Description |
value | Entity.TypeThe type to set. |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | This builder for chaining. |
setTypeValue(int value)
public Entity.Builder setTypeValue(int value)The entity type.
.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for type to set. |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Entity.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Entity.Builder | |