com.google.api.services.contactcenterinsights.v1.model.GoogleCloudContactcenterinsightsV1FaqAnswerData 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;

/**
 * Agent Assist frequently-asked-question answer 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 GoogleCloudContactcenterinsightsV1FaqAnswerData extends com.google.api.client.json.GenericJson {

  /**
   * The piece of text from the `source` knowledge base document.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String answer;

  /**
   * The system's confidence score that this answer is a good match for this conversation, ranging
   * from 0.0 (completely uncertain) to 1.0 (completely certain).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float confidenceScore;

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

  /**
   * 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 queryRecord;

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

  /**
   * The knowledge document that this answer was extracted from. Format:
   * projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String source;

  /**
   * The piece of text from the `source` knowledge base document.
   * @return value or {@code null} for none
   */
  public java.lang.String getAnswer() {
    return answer;
  }

  /**
   * The piece of text from the `source` knowledge base document.
   * @param answer answer or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1FaqAnswerData setAnswer(java.lang.String answer) {
    this.answer = answer;
    return this;
  }

  /**
   * The system's confidence score that this answer is a good match for this conversation, ranging
   * from 0.0 (completely uncertain) to 1.0 (completely certain).
   * @return value or {@code null} for none
   */
  public java.lang.Float getConfidenceScore() {
    return confidenceScore;
  }

  /**
   * The system's confidence score that this answer is a good match for this conversation, ranging
   * from 0.0 (completely uncertain) to 1.0 (completely certain).
   * @param confidenceScore confidenceScore or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1FaqAnswerData setConfidenceScore(java.lang.Float confidenceScore) {
    this.confidenceScore = confidenceScore;
    return this;
  }

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

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

  /**
   * 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 getQueryRecord() {
    return queryRecord;
  }

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

  /**
   * The corresponding FAQ question.
   * @return value or {@code null} for none
   */
  public java.lang.String getQuestion() {
    return question;
  }

  /**
   * The corresponding FAQ question.
   * @param question question or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1FaqAnswerData setQuestion(java.lang.String question) {
    this.question = question;
    return this;
  }

  /**
   * The knowledge document that this answer was extracted from. Format:
   * projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
   * @return value or {@code null} for none
   */
  public java.lang.String getSource() {
    return source;
  }

  /**
   * The knowledge document that this answer was extracted from. Format:
   * projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
   * @param source source or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1FaqAnswerData setSource(java.lang.String source) {
    this.source = source;
    return this;
  }

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

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

}