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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-retail Show documentation
There is a newer version: v2-rev20241220-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.retail.v2.model;

/**
 * Response of the autocomplete query.
 *
 *  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 GoogleCloudRetailV2CompleteQueryResponse extends com.google.api.client.json.GenericJson {

  /**
   * A map of matched attribute suggestions. This field is only available for "cloud-retail"
   * dataset. Current supported keys: * `brands` * `categories`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map attributeResults;

  /**
   * A unique complete token. This should be included in the UserEvent.completion_detail for search
   * events resulting from this completion, which enables accurate attribution of complete model
   * performance.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String attributionToken;

  /**
   * Results of the matching suggestions. The result list is ordered and the first result is top
   * suggestion.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List completionResults;

  /**
   * Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10.
   * This field is a restricted feature. If you want to enable it, contact Retail Search support.
   * This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent
   * is imported. The recent searches satisfy the follow rules: * They are ordered from latest to
   * oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are
   * transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent
   * searches will be reserved when duplication happens.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List recentSearchResults;

  /**
   * A map of matched attribute suggestions. This field is only available for "cloud-retail"
   * dataset. Current supported keys: * `brands` * `categories`
   * @return value or {@code null} for none
   */
  public java.util.Map getAttributeResults() {
    return attributeResults;
  }

  /**
   * A map of matched attribute suggestions. This field is only available for "cloud-retail"
   * dataset. Current supported keys: * `brands` * `categories`
   * @param attributeResults attributeResults or {@code null} for none
   */
  public GoogleCloudRetailV2CompleteQueryResponse setAttributeResults(java.util.Map attributeResults) {
    this.attributeResults = attributeResults;
    return this;
  }

  /**
   * A unique complete token. This should be included in the UserEvent.completion_detail for search
   * events resulting from this completion, which enables accurate attribution of complete model
   * performance.
   * @return value or {@code null} for none
   */
  public java.lang.String getAttributionToken() {
    return attributionToken;
  }

  /**
   * A unique complete token. This should be included in the UserEvent.completion_detail for search
   * events resulting from this completion, which enables accurate attribution of complete model
   * performance.
   * @param attributionToken attributionToken or {@code null} for none
   */
  public GoogleCloudRetailV2CompleteQueryResponse setAttributionToken(java.lang.String attributionToken) {
    this.attributionToken = attributionToken;
    return this;
  }

  /**
   * Results of the matching suggestions. The result list is ordered and the first result is top
   * suggestion.
   * @return value or {@code null} for none
   */
  public java.util.List getCompletionResults() {
    return completionResults;
  }

  /**
   * Results of the matching suggestions. The result list is ordered and the first result is top
   * suggestion.
   * @param completionResults completionResults or {@code null} for none
   */
  public GoogleCloudRetailV2CompleteQueryResponse setCompletionResults(java.util.List completionResults) {
    this.completionResults = completionResults;
    return this;
  }

  /**
   * Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10.
   * This field is a restricted feature. If you want to enable it, contact Retail Search support.
   * This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent
   * is imported. The recent searches satisfy the follow rules: * They are ordered from latest to
   * oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are
   * transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent
   * searches will be reserved when duplication happens.
   * @return value or {@code null} for none
   */
  public java.util.List getRecentSearchResults() {
    return recentSearchResults;
  }

  /**
   * Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10.
   * This field is a restricted feature. If you want to enable it, contact Retail Search support.
   * This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent
   * is imported. The recent searches satisfy the follow rules: * They are ordered from latest to
   * oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are
   * transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent
   * searches will be reserved when duplication happens.
   * @param recentSearchResults recentSearchResults or {@code null} for none
   */
  public GoogleCloudRetailV2CompleteQueryResponse setRecentSearchResults(java.util.List recentSearchResults) {
    this.recentSearchResults = recentSearchResults;
    return this;
  }

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

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

}