com.google.api.services.contactcenterinsights.v1.model.GoogleCloudContactcenterinsightsV1Entity Maven / Gradle / Ivy

Go to download
/*
 * 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
 *
 * http://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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.contactcenterinsights.v1.model;

/**
 * The data for an entity annotation. Represents a phrase in the conversation that is a known
 * entity, such as a person, an organization, or location.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Contact Center AI Insights API. For a detailed
 * explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudContactcenterinsightsV1Entity extends com.google.api.client.json.GenericJson {

  /**
   * The representative name for the entity.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String displayName;

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map metadata;

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float salience;

  /**
   * The aggregate sentiment expressed for this entity in the conversation.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudContactcenterinsightsV1SentimentData sentiment;

  /**
   * The entity type.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String type;

  /**
   * The representative name for the entity.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * The representative name for the entity.
   * @param displayName displayName or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1Entity setDisplayName(java.lang.String displayName) {
    this.displayName = displayName;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.util.Map getMetadata() {
    return metadata;
  }

  /**
   * 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.
   * @param metadata metadata or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1Entity setMetadata(java.util.Map metadata) {
    this.metadata = metadata;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.Float getSalience() {
    return salience;
  }

  /**
   * 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.
   * @param salience salience or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1Entity setSalience(java.lang.Float salience) {
    this.salience = salience;
    return this;
  }

  /**
   * The aggregate sentiment expressed for this entity in the conversation.
   * @return value or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1SentimentData getSentiment() {
    return sentiment;
  }

  /**
   * The aggregate sentiment expressed for this entity in the conversation.
   * @param sentiment sentiment or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1Entity setSentiment(GoogleCloudContactcenterinsightsV1SentimentData sentiment) {
    this.sentiment = sentiment;
    return this;
  }

  /**
   * The entity type.
   * @return value or {@code null} for none
   */
  public java.lang.String getType() {
    return type;
  }

  /**
   * The entity type.
   * @param type type or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1Entity setType(java.lang.String type) {
    this.type = type;
    return this;
  }

  @Override
  public GoogleCloudContactcenterinsightsV1Entity set(String fieldName, Object value) {
    return (GoogleCloudContactcenterinsightsV1Entity) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudContactcenterinsightsV1Entity clone() {
    return (GoogleCloudContactcenterinsightsV1Entity) super.clone();
  }

}