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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-contactcenterinsights Show documentation
There is a newer version: v1-rev20240701-2.0.0
Show newest version
/*
 * 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;

/**
 * Conversation summarization suggestion data.
 *
 *  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 GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData extends com.google.api.client.json.GenericJson {

  /**
   * The name of the answer record. Format:
   * projects/{project}/locations/{location}/answerRecords/{answer_record}
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String answerRecord;

  /**
   * The confidence score of the summarization.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float confidence;

  /**
   * The name of the model that generates this summary. Format:
   * projects/{project}/locations/{location}/conversationModels/{conversation_model}
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String conversationModel;

  /**
   * A map that contains metadata about the summarization and the document from which it originates.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map metadata;

  /**
   * The summarization content that is concatenated into one string.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String text;

  /**
   * The summarization content that is divided into sections. The key is the section's name and the
   * value is the section's content. There is no specific format for the key or value.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map textSections;

  /**
   * The name of the answer record. Format:
   * projects/{project}/locations/{location}/answerRecords/{answer_record}
   * @return value or {@code null} for none
   */
  public java.lang.String getAnswerRecord() {
    return answerRecord;
  }

  /**
   * The name of the answer record. Format:
   * projects/{project}/locations/{location}/answerRecords/{answer_record}
   * @param answerRecord answerRecord or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData setAnswerRecord(java.lang.String answerRecord) {
    this.answerRecord = answerRecord;
    return this;
  }

  /**
   * The confidence score of the summarization.
   * @return value or {@code null} for none
   */
  public java.lang.Float getConfidence() {
    return confidence;
  }

  /**
   * The confidence score of the summarization.
   * @param confidence confidence or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData setConfidence(java.lang.Float confidence) {
    this.confidence = confidence;
    return this;
  }

  /**
   * The name of the model that generates this summary. Format:
   * projects/{project}/locations/{location}/conversationModels/{conversation_model}
   * @return value or {@code null} for none
   */
  public java.lang.String getConversationModel() {
    return conversationModel;
  }

  /**
   * The name of the model that generates this summary. Format:
   * projects/{project}/locations/{location}/conversationModels/{conversation_model}
   * @param conversationModel conversationModel or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData setConversationModel(java.lang.String conversationModel) {
    this.conversationModel = conversationModel;
    return this;
  }

  /**
   * A map that contains metadata about the summarization and the document from which it originates.
   * @return value or {@code null} for none
   */
  public java.util.Map getMetadata() {
    return metadata;
  }

  /**
   * A map that contains metadata about the summarization and the document from which it originates.
   * @param metadata metadata or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData setMetadata(java.util.Map metadata) {
    this.metadata = metadata;
    return this;
  }

  /**
   * The summarization content that is concatenated into one string.
   * @return value or {@code null} for none
   */
  public java.lang.String getText() {
    return text;
  }

  /**
   * The summarization content that is concatenated into one string.
   * @param text text or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData setText(java.lang.String text) {
    this.text = text;
    return this;
  }

  /**
   * The summarization content that is divided into sections. The key is the section's name and the
   * value is the section's content. There is no specific format for the key or value.
   * @return value or {@code null} for none
   */
  public java.util.Map getTextSections() {
    return textSections;
  }

  /**
   * The summarization content that is divided into sections. The key is the section's name and the
   * value is the section's content. There is no specific format for the key or value.
   * @param textSections textSections or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData setTextSections(java.util.Map textSections) {
    this.textSections = textSections;
    return this;
  }

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

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

}