• Home
• com.google.apis
• google-api-services-retail
• v2-rev20241220-2.0.0
• source code
• GoogleCloudRetailV2SearchResponseConversationalSearchResult.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.api.services.retail.v2.model.GoogleCloudRetailV2SearchResponseConversationalSearchResult Maven / Gradle / Ivy

/*
 * 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.retail.v2.model;

/**
 * This field specifies all related information that is needed on client side for UI rendering of
 * conversational retail search.
 *
 * 
 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 Vertex AI Search for Retail 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 GoogleCloudRetailV2SearchResponseConversationalSearchResult extends com.google.api.client.json.GenericJson {

  /**
   * This is the incremental additional filters implied from the current user answer. User should
   * add the suggested addition filters to the previous SearchRequest.filter, and use the merged
   * filter in the follow up search request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter additionalFilter;

  /**
   * This field is deprecated but will be kept for backward compatibility. There is expected to have
   * only one additional filter and the value will be the same to the same as field
   * `additional_filter`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List additionalFilters;

  /**
   * Conversation UUID. This field will be stored in client side storage to maintain the
   * conversation session with server and will be used for next search request's
   * SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String conversationId;

  /**
   * The follow-up question. e.g., `What is the color?`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String followupQuestion;

  /**
   * The current refined query for the conversational search. This field will be used in customer UI
   * that the query in the search bar should be replaced with the refined query. For example, if
   * SearchRequest.query is `dress` and next
   * SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`, which does not
   * match any product attribute value filters, the refined query will be `dress, red color`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String refinedQuery;

  /**
   * The answer options provided to client for the follow-up question.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List suggestedAnswers;

  /**
   * This is the incremental additional filters implied from the current user answer. User should
   * add the suggested addition filters to the previous SearchRequest.filter, and use the merged
   * filter in the follow up search request.
   * @return value or {@code null} for none
   */
  public GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter getAdditionalFilter() {
    return additionalFilter;
  }

  /**
   * This is the incremental additional filters implied from the current user answer. User should
   * add the suggested addition filters to the previous SearchRequest.filter, and use the merged
   * filter in the follow up search request.
   * @param additionalFilter additionalFilter or {@code null} for none
   */
  public GoogleCloudRetailV2SearchResponseConversationalSearchResult setAdditionalFilter(GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter additionalFilter) {
    this.additionalFilter = additionalFilter;
    return this;
  }

  /**
   * This field is deprecated but will be kept for backward compatibility. There is expected to have
   * only one additional filter and the value will be the same to the same as field
   * `additional_filter`.
   * @return value or {@code null} for none
   */
  public java.util.List getAdditionalFilters() {
    return additionalFilters;
  }

  /**
   * This field is deprecated but will be kept for backward compatibility. There is expected to have
   * only one additional filter and the value will be the same to the same as field
   * `additional_filter`.
   * @param additionalFilters additionalFilters or {@code null} for none
   */
  public GoogleCloudRetailV2SearchResponseConversationalSearchResult setAdditionalFilters(java.util.List additionalFilters) {
    this.additionalFilters = additionalFilters;
    return this;
  }

  /**
   * Conversation UUID. This field will be stored in client side storage to maintain the
   * conversation session with server and will be used for next search request's
   * SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.
   * @return value or {@code null} for none
   */
  public java.lang.String getConversationId() {
    return conversationId;
  }

  /**
   * Conversation UUID. This field will be stored in client side storage to maintain the
   * conversation session with server and will be used for next search request's
   * SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.
   * @param conversationId conversationId or {@code null} for none
   */
  public GoogleCloudRetailV2SearchResponseConversationalSearchResult setConversationId(java.lang.String conversationId) {
    this.conversationId = conversationId;
    return this;
  }

  /**
   * The follow-up question. e.g., `What is the color?`
   * @return value or {@code null} for none
   */
  public java.lang.String getFollowupQuestion() {
    return followupQuestion;
  }

  /**
   * The follow-up question. e.g., `What is the color?`
   * @param followupQuestion followupQuestion or {@code null} for none
   */
  public GoogleCloudRetailV2SearchResponseConversationalSearchResult setFollowupQuestion(java.lang.String followupQuestion) {
    this.followupQuestion = followupQuestion;
    return this;
  }

  /**
   * The current refined query for the conversational search. This field will be used in customer UI
   * that the query in the search bar should be replaced with the refined query. For example, if
   * SearchRequest.query is `dress` and next
   * SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`, which does not
   * match any product attribute value filters, the refined query will be `dress, red color`.
   * @return value or {@code null} for none
   */
  public java.lang.String getRefinedQuery() {
    return refinedQuery;
  }

  /**
   * The current refined query for the conversational search. This field will be used in customer UI
   * that the query in the search bar should be replaced with the refined query. For example, if
   * SearchRequest.query is `dress` and next
   * SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`, which does not
   * match any product attribute value filters, the refined query will be `dress, red color`.
   * @param refinedQuery refinedQuery or {@code null} for none
   */
  public GoogleCloudRetailV2SearchResponseConversationalSearchResult setRefinedQuery(java.lang.String refinedQuery) {
    this.refinedQuery = refinedQuery;
    return this;
  }

  /**
   * The answer options provided to client for the follow-up question.
   * @return value or {@code null} for none
   */
  public java.util.List getSuggestedAnswers() {
    return suggestedAnswers;
  }

  /**
   * The answer options provided to client for the follow-up question.
   * @param suggestedAnswers suggestedAnswers or {@code null} for none
   */
  public GoogleCloudRetailV2SearchResponseConversationalSearchResult setSuggestedAnswers(java.util.List suggestedAnswers) {
    this.suggestedAnswers = suggestedAnswers;
    return this;
  }

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

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

}