com.google.cloud.contactcenterinsights.v1.EntityOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-contact-center-insights-v1 Show documentation
Show all versions of proto-google-cloud-contact-center-insights-v1 Show documentation
Proto library for google-cloud-contact-center-insights
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/contactcenterinsights/v1/resources.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.contactcenterinsights.v1;
public interface EntityOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.contactcenterinsights.v1.Entity)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The representative name for the entity.
*
*
* string display_name = 1;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* The representative name for the entity.
*
*
* string display_name = 1;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* The entity type.
*
*
* .google.cloud.contactcenterinsights.v1.Entity.Type type = 2;
*
* @return The enum numeric value on the wire for type.
*/
int getTypeValue();
/**
*
*
*
* The entity type.
*
*
* .google.cloud.contactcenterinsights.v1.Entity.Type type = 2;
*
* @return The type.
*/
com.google.cloud.contactcenterinsights.v1.Entity.Type getType();
/**
*
*
*
* 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;
*/
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;
*/
boolean containsMetadata(java.lang.String key);
/** Use {@link #getMetadataMap()} instead. */
@java.lang.Deprecated
java.util.Map getMetadata();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
java.lang.String getMetadataOrDefault(
java.lang.String key,
/* nullable */
java.lang.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;
*/
java.lang.String getMetadataOrThrow(java.lang.String key);
/**
*
*
*
* 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;
*
* @return The salience.
*/
float getSalience();
/**
*
*
*
* The aggregate sentiment expressed for this entity in the conversation.
*
*
* .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
*
* @return Whether the sentiment field is set.
*/
boolean hasSentiment();
/**
*
*
*
* The aggregate sentiment expressed for this entity in the conversation.
*
*
* .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
*
* @return The sentiment.
*/
com.google.cloud.contactcenterinsights.v1.SentimentData getSentiment();
/**
*
*
*
* The aggregate sentiment expressed for this entity in the conversation.
*
*
* .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
*/
com.google.cloud.contactcenterinsights.v1.SentimentDataOrBuilder getSentimentOrBuilder();
}