|
| 1 | +/* |
| 2 | + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except |
| 3 | + * in compliance with the License. You may obtain a copy of the License at |
| 4 | + * |
| 5 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 6 | + * |
| 7 | + * Unless required by applicable law or agreed to in writing, software distributed under the License |
| 8 | + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express |
| 9 | + * or implied. See the License for the specific language governing permissions and limitations under |
| 10 | + * the License. |
| 11 | + */ |
| 12 | +/* |
| 13 | + * This code was generated by https://github.com/googleapis/google-api-java-client-services/ |
| 14 | + * Modify at your own risk. |
| 15 | + */ |
| 16 | + |
| 17 | +package com.google.api.services.retail.v2.model; |
| 18 | + |
| 19 | +/** |
| 20 | + * Configuration for a single generated question. |
| 21 | + * |
| 22 | + * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is |
| 23 | + * transmitted over HTTP when working with the Vertex AI Search for Retail API. For a detailed |
| 24 | + * explanation see: |
| 25 | + * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a> |
| 26 | + * </p> |
| 27 | + * |
| 28 | + * @author Google, Inc. |
| 29 | + */ |
| 30 | +@SuppressWarnings("javadoc") |
| 31 | +public final class GoogleCloudRetailV2GenerativeQuestionConfig extends com.google.api.client.json.GenericJson { |
| 32 | + |
| 33 | + /** |
| 34 | + * Optional. Whether the question is asked at serving time. |
| 35 | + * The value may be {@code null}. |
| 36 | + */ |
| 37 | + @com.google.api.client.util.Key |
| 38 | + private java.lang.Boolean allowedInConversation; |
| 39 | + |
| 40 | + /** |
| 41 | + * Required. Resource name of the catalog. Format: |
| 42 | + * projects/{project}/locations/{location}/catalogs/{catalog} |
| 43 | + * The value may be {@code null}. |
| 44 | + */ |
| 45 | + @com.google.api.client.util.Key |
| 46 | + private java.lang.String catalog; |
| 47 | + |
| 48 | + /** |
| 49 | + * Output only. Values that can be used to answer the question. |
| 50 | + * The value may be {@code null}. |
| 51 | + */ |
| 52 | + @com.google.api.client.util.Key |
| 53 | + private java.util.List<java.lang.String> exampleValues; |
| 54 | + |
| 55 | + /** |
| 56 | + * Required. The facet to which the question is associated. |
| 57 | + * The value may be {@code null}. |
| 58 | + */ |
| 59 | + @com.google.api.client.util.Key |
| 60 | + private java.lang.String facet; |
| 61 | + |
| 62 | + /** |
| 63 | + * Optional. The question that will be used at serving time. Question can have a max length of 300 |
| 64 | + * bytes. When not populated, generated_question should be used. |
| 65 | + * The value may be {@code null}. |
| 66 | + */ |
| 67 | + @com.google.api.client.util.Key |
| 68 | + private java.lang.String finalQuestion; |
| 69 | + |
| 70 | + /** |
| 71 | + * Output only. The ratio of how often a question was asked. |
| 72 | + * The value may be {@code null}. |
| 73 | + */ |
| 74 | + @com.google.api.client.util.Key |
| 75 | + private java.lang.Float frequency; |
| 76 | + |
| 77 | + /** |
| 78 | + * Output only. The LLM generated question. |
| 79 | + * The value may be {@code null}. |
| 80 | + */ |
| 81 | + @com.google.api.client.util.Key |
| 82 | + private java.lang.String generatedQuestion; |
| 83 | + |
| 84 | + /** |
| 85 | + * Optional. Whether the question is asked at serving time. |
| 86 | + * @return value or {@code null} for none |
| 87 | + */ |
| 88 | + public java.lang.Boolean getAllowedInConversation() { |
| 89 | + return allowedInConversation; |
| 90 | + } |
| 91 | + |
| 92 | + /** |
| 93 | + * Optional. Whether the question is asked at serving time. |
| 94 | + * @param allowedInConversation allowedInConversation or {@code null} for none |
| 95 | + */ |
| 96 | + public GoogleCloudRetailV2GenerativeQuestionConfig setAllowedInConversation(java.lang.Boolean allowedInConversation) { |
| 97 | + this.allowedInConversation = allowedInConversation; |
| 98 | + return this; |
| 99 | + } |
| 100 | + |
| 101 | + /** |
| 102 | + * Required. Resource name of the catalog. Format: |
| 103 | + * projects/{project}/locations/{location}/catalogs/{catalog} |
| 104 | + * @return value or {@code null} for none |
| 105 | + */ |
| 106 | + public java.lang.String getCatalog() { |
| 107 | + return catalog; |
| 108 | + } |
| 109 | + |
| 110 | + /** |
| 111 | + * Required. Resource name of the catalog. Format: |
| 112 | + * projects/{project}/locations/{location}/catalogs/{catalog} |
| 113 | + * @param catalog catalog or {@code null} for none |
| 114 | + */ |
| 115 | + public GoogleCloudRetailV2GenerativeQuestionConfig setCatalog(java.lang.String catalog) { |
| 116 | + this.catalog = catalog; |
| 117 | + return this; |
| 118 | + } |
| 119 | + |
| 120 | + /** |
| 121 | + * Output only. Values that can be used to answer the question. |
| 122 | + * @return value or {@code null} for none |
| 123 | + */ |
| 124 | + public java.util.List<java.lang.String> getExampleValues() { |
| 125 | + return exampleValues; |
| 126 | + } |
| 127 | + |
| 128 | + /** |
| 129 | + * Output only. Values that can be used to answer the question. |
| 130 | + * @param exampleValues exampleValues or {@code null} for none |
| 131 | + */ |
| 132 | + public GoogleCloudRetailV2GenerativeQuestionConfig setExampleValues(java.util.List<java.lang.String> exampleValues) { |
| 133 | + this.exampleValues = exampleValues; |
| 134 | + return this; |
| 135 | + } |
| 136 | + |
| 137 | + /** |
| 138 | + * Required. The facet to which the question is associated. |
| 139 | + * @return value or {@code null} for none |
| 140 | + */ |
| 141 | + public java.lang.String getFacet() { |
| 142 | + return facet; |
| 143 | + } |
| 144 | + |
| 145 | + /** |
| 146 | + * Required. The facet to which the question is associated. |
| 147 | + * @param facet facet or {@code null} for none |
| 148 | + */ |
| 149 | + public GoogleCloudRetailV2GenerativeQuestionConfig setFacet(java.lang.String facet) { |
| 150 | + this.facet = facet; |
| 151 | + return this; |
| 152 | + } |
| 153 | + |
| 154 | + /** |
| 155 | + * Optional. The question that will be used at serving time. Question can have a max length of 300 |
| 156 | + * bytes. When not populated, generated_question should be used. |
| 157 | + * @return value or {@code null} for none |
| 158 | + */ |
| 159 | + public java.lang.String getFinalQuestion() { |
| 160 | + return finalQuestion; |
| 161 | + } |
| 162 | + |
| 163 | + /** |
| 164 | + * Optional. The question that will be used at serving time. Question can have a max length of 300 |
| 165 | + * bytes. When not populated, generated_question should be used. |
| 166 | + * @param finalQuestion finalQuestion or {@code null} for none |
| 167 | + */ |
| 168 | + public GoogleCloudRetailV2GenerativeQuestionConfig setFinalQuestion(java.lang.String finalQuestion) { |
| 169 | + this.finalQuestion = finalQuestion; |
| 170 | + return this; |
| 171 | + } |
| 172 | + |
| 173 | + /** |
| 174 | + * Output only. The ratio of how often a question was asked. |
| 175 | + * @return value or {@code null} for none |
| 176 | + */ |
| 177 | + public java.lang.Float getFrequency() { |
| 178 | + return frequency; |
| 179 | + } |
| 180 | + |
| 181 | + /** |
| 182 | + * Output only. The ratio of how often a question was asked. |
| 183 | + * @param frequency frequency or {@code null} for none |
| 184 | + */ |
| 185 | + public GoogleCloudRetailV2GenerativeQuestionConfig setFrequency(java.lang.Float frequency) { |
| 186 | + this.frequency = frequency; |
| 187 | + return this; |
| 188 | + } |
| 189 | + |
| 190 | + /** |
| 191 | + * Output only. The LLM generated question. |
| 192 | + * @return value or {@code null} for none |
| 193 | + */ |
| 194 | + public java.lang.String getGeneratedQuestion() { |
| 195 | + return generatedQuestion; |
| 196 | + } |
| 197 | + |
| 198 | + /** |
| 199 | + * Output only. The LLM generated question. |
| 200 | + * @param generatedQuestion generatedQuestion or {@code null} for none |
| 201 | + */ |
| 202 | + public GoogleCloudRetailV2GenerativeQuestionConfig setGeneratedQuestion(java.lang.String generatedQuestion) { |
| 203 | + this.generatedQuestion = generatedQuestion; |
| 204 | + return this; |
| 205 | + } |
| 206 | + |
| 207 | + @Override |
| 208 | + public GoogleCloudRetailV2GenerativeQuestionConfig set(String fieldName, Object value) { |
| 209 | + return (GoogleCloudRetailV2GenerativeQuestionConfig) super.set(fieldName, value); |
| 210 | + } |
| 211 | + |
| 212 | + @Override |
| 213 | + public GoogleCloudRetailV2GenerativeQuestionConfig clone() { |
| 214 | + return (GoogleCloudRetailV2GenerativeQuestionConfig) super.clone(); |
| 215 | + } |
| 216 | + |
| 217 | +} |
0 commit comments