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

/**
 * Represents a SearchKnowledge answer.
 *
 *  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 GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer extends com.google.api.client.json.GenericJson {

  /**
   * The piece of text from the knowledge base documents that answers the search query
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String answer;

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

  /**
   * All sources used to generate the answer.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List answerSources;

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

  /**
   * The confidence score in [0.0, 1.0] range.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float confidenceScore;

  /**
   * The piece of text from the knowledge base documents that answers the search query
   * @return value or {@code null} for none
   */
  public java.lang.String getAnswer() {
    return answer;
  }

  /**
   * The piece of text from the knowledge base documents that answers the search query
   * @param answer answer or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer setAnswer(java.lang.String answer) {
    this.answer = answer;
    return this;
  }

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

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

  /**
   * All sources used to generate the answer.
   * @return value or {@code null} for none
   */
  public java.util.List getAnswerSources() {
    return answerSources;
  }

  /**
   * All sources used to generate the answer.
   * @param answerSources answerSources or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer setAnswerSources(java.util.List answerSources) {
    this.answerSources = answerSources;
    return this;
  }

  /**
   * The type of the answer.
   * @return value or {@code null} for none
   */
  public java.lang.String getAnswerType() {
    return answerType;
  }

  /**
   * The type of the answer.
   * @param answerType answerType or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer setAnswerType(java.lang.String answerType) {
    this.answerType = answerType;
    return this;
  }

  /**
   * The confidence score in [0.0, 1.0] range.
   * @return value or {@code null} for none
   */
  public java.lang.Float getConfidenceScore() {
    return confidenceScore;
  }

  /**
   * The confidence score in [0.0, 1.0] range.
   * @param confidenceScore confidenceScore or {@code null} for none
   */
  public GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer setConfidenceScore(java.lang.Float confidenceScore) {
    this.confidenceScore = confidenceScore;
    return this;
  }

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

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

}