|
| 1 | +/* |
| 2 | + * Licensed to Elasticsearch B.V. under one or more contributor |
| 3 | + * license agreements. See the NOTICE file distributed with |
| 4 | + * this work for additional information regarding copyright |
| 5 | + * ownership. Elasticsearch B.V. licenses this file to you under |
| 6 | + * the Apache License, Version 2.0 (the "License"); you may |
| 7 | + * not use this file except in compliance with the License. |
| 8 | + * You may obtain a copy of the License at |
| 9 | + * |
| 10 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | + * |
| 12 | + * Unless required by applicable law or agreed to in writing, |
| 13 | + * software distributed under the License is distributed on an |
| 14 | + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | + * KIND, either express or implied. See the License for the |
| 16 | + * specific language governing permissions and limitations |
| 17 | + * under the License. |
| 18 | + */ |
| 19 | + |
| 20 | +package co.elastic.clients.elasticsearch.inference; |
| 21 | + |
| 22 | +import co.elastic.clients.json.JsonpDeserializable; |
| 23 | +import co.elastic.clients.json.JsonpDeserializer; |
| 24 | +import co.elastic.clients.json.JsonpMapper; |
| 25 | +import co.elastic.clients.json.ObjectBuilderDeserializer; |
| 26 | +import co.elastic.clients.json.ObjectDeserializer; |
| 27 | +import co.elastic.clients.util.ObjectBuilder; |
| 28 | +import jakarta.json.stream.JsonGenerator; |
| 29 | +import java.lang.Integer; |
| 30 | +import java.lang.String; |
| 31 | +import java.util.Objects; |
| 32 | +import java.util.function.Function; |
| 33 | +import javax.annotation.Nullable; |
| 34 | + |
| 35 | +//---------------------------------------------------------------- |
| 36 | +// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. |
| 37 | +//---------------------------------------------------------------- |
| 38 | +// |
| 39 | +// This code is generated from the Elasticsearch API specification |
| 40 | +// at https://github.com/elastic/elasticsearch-specification |
| 41 | +// |
| 42 | +// Manual updates to this file will be lost when the code is |
| 43 | +// re-generated. |
| 44 | +// |
| 45 | +// If you find a property that is missing or wrongly typed, please |
| 46 | +// open an issue or a PR on the API specification repository. |
| 47 | +// |
| 48 | +//---------------------------------------------------------------- |
| 49 | + |
| 50 | +// typedef: inference._types.InferenceChunkingSettings |
| 51 | + |
| 52 | +/** |
| 53 | + * Chunking configuration object |
| 54 | + * |
| 55 | + * @see <a href= |
| 56 | + * "../doc-files/api-spec.html#inference._types.InferenceChunkingSettings">API |
| 57 | + * specification</a> |
| 58 | + */ |
| 59 | +@JsonpDeserializable |
| 60 | +public class InferenceChunkingSettings extends InferenceEndpoint { |
| 61 | + @Nullable |
| 62 | + private final Integer maxChunkSize; |
| 63 | + |
| 64 | + @Nullable |
| 65 | + private final Integer overlap; |
| 66 | + |
| 67 | + @Nullable |
| 68 | + private final Integer sentenceOverlap; |
| 69 | + |
| 70 | + @Nullable |
| 71 | + private final String strategy; |
| 72 | + |
| 73 | + // --------------------------------------------------------------------------------------------- |
| 74 | + |
| 75 | + private InferenceChunkingSettings(Builder builder) { |
| 76 | + super(builder); |
| 77 | + |
| 78 | + this.maxChunkSize = builder.maxChunkSize; |
| 79 | + this.overlap = builder.overlap; |
| 80 | + this.sentenceOverlap = builder.sentenceOverlap; |
| 81 | + this.strategy = builder.strategy; |
| 82 | + |
| 83 | + } |
| 84 | + |
| 85 | + public static InferenceChunkingSettings of(Function<Builder, ObjectBuilder<InferenceChunkingSettings>> fn) { |
| 86 | + return fn.apply(new Builder()).build(); |
| 87 | + } |
| 88 | + |
| 89 | + /** |
| 90 | + * Specifies the maximum size of a chunk in words This value cannot be higher |
| 91 | + * than <code>300</code> or lower than <code>20</code> (for |
| 92 | + * <code>sentence</code> strategy) or <code>10</code> (for <code>word</code> |
| 93 | + * strategy) |
| 94 | + * <p> |
| 95 | + * API name: {@code max_chunk_size} |
| 96 | + */ |
| 97 | + @Nullable |
| 98 | + public final Integer maxChunkSize() { |
| 99 | + return this.maxChunkSize; |
| 100 | + } |
| 101 | + |
| 102 | + /** |
| 103 | + * Specifies the number of overlapping words for chunks Only for |
| 104 | + * <code>word</code> chunking strategy This value cannot be higher than the half |
| 105 | + * of <code>max_chunk_size</code> |
| 106 | + * <p> |
| 107 | + * API name: {@code overlap} |
| 108 | + */ |
| 109 | + @Nullable |
| 110 | + public final Integer overlap() { |
| 111 | + return this.overlap; |
| 112 | + } |
| 113 | + |
| 114 | + /** |
| 115 | + * Specifies the number of overlapping sentences for chunks Only for |
| 116 | + * <code>sentence</code> chunking strategy It can be either <code>1</code> or |
| 117 | + * <code>0</code> |
| 118 | + * <p> |
| 119 | + * API name: {@code sentence_overlap} |
| 120 | + */ |
| 121 | + @Nullable |
| 122 | + public final Integer sentenceOverlap() { |
| 123 | + return this.sentenceOverlap; |
| 124 | + } |
| 125 | + |
| 126 | + /** |
| 127 | + * Specifies the chunking strategy It could be either <code>sentence</code> or |
| 128 | + * <code>word</code> |
| 129 | + * <p> |
| 130 | + * API name: {@code strategy} |
| 131 | + */ |
| 132 | + @Nullable |
| 133 | + public final String strategy() { |
| 134 | + return this.strategy; |
| 135 | + } |
| 136 | + |
| 137 | + protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { |
| 138 | + |
| 139 | + super.serializeInternal(generator, mapper); |
| 140 | + if (this.maxChunkSize != null) { |
| 141 | + generator.writeKey("max_chunk_size"); |
| 142 | + generator.write(this.maxChunkSize); |
| 143 | + |
| 144 | + } |
| 145 | + if (this.overlap != null) { |
| 146 | + generator.writeKey("overlap"); |
| 147 | + generator.write(this.overlap); |
| 148 | + |
| 149 | + } |
| 150 | + if (this.sentenceOverlap != null) { |
| 151 | + generator.writeKey("sentence_overlap"); |
| 152 | + generator.write(this.sentenceOverlap); |
| 153 | + |
| 154 | + } |
| 155 | + if (this.strategy != null) { |
| 156 | + generator.writeKey("strategy"); |
| 157 | + generator.write(this.strategy); |
| 158 | + |
| 159 | + } |
| 160 | + |
| 161 | + } |
| 162 | + |
| 163 | + // --------------------------------------------------------------------------------------------- |
| 164 | + |
| 165 | + /** |
| 166 | + * Builder for {@link InferenceChunkingSettings}. |
| 167 | + */ |
| 168 | + |
| 169 | + public static class Builder extends InferenceEndpoint.AbstractBuilder<Builder> |
| 170 | + implements |
| 171 | + ObjectBuilder<InferenceChunkingSettings> { |
| 172 | + @Nullable |
| 173 | + private Integer maxChunkSize; |
| 174 | + |
| 175 | + @Nullable |
| 176 | + private Integer overlap; |
| 177 | + |
| 178 | + @Nullable |
| 179 | + private Integer sentenceOverlap; |
| 180 | + |
| 181 | + @Nullable |
| 182 | + private String strategy; |
| 183 | + |
| 184 | + /** |
| 185 | + * Specifies the maximum size of a chunk in words This value cannot be higher |
| 186 | + * than <code>300</code> or lower than <code>20</code> (for |
| 187 | + * <code>sentence</code> strategy) or <code>10</code> (for <code>word</code> |
| 188 | + * strategy) |
| 189 | + * <p> |
| 190 | + * API name: {@code max_chunk_size} |
| 191 | + */ |
| 192 | + public final Builder maxChunkSize(@Nullable Integer value) { |
| 193 | + this.maxChunkSize = value; |
| 194 | + return this; |
| 195 | + } |
| 196 | + |
| 197 | + /** |
| 198 | + * Specifies the number of overlapping words for chunks Only for |
| 199 | + * <code>word</code> chunking strategy This value cannot be higher than the half |
| 200 | + * of <code>max_chunk_size</code> |
| 201 | + * <p> |
| 202 | + * API name: {@code overlap} |
| 203 | + */ |
| 204 | + public final Builder overlap(@Nullable Integer value) { |
| 205 | + this.overlap = value; |
| 206 | + return this; |
| 207 | + } |
| 208 | + |
| 209 | + /** |
| 210 | + * Specifies the number of overlapping sentences for chunks Only for |
| 211 | + * <code>sentence</code> chunking strategy It can be either <code>1</code> or |
| 212 | + * <code>0</code> |
| 213 | + * <p> |
| 214 | + * API name: {@code sentence_overlap} |
| 215 | + */ |
| 216 | + public final Builder sentenceOverlap(@Nullable Integer value) { |
| 217 | + this.sentenceOverlap = value; |
| 218 | + return this; |
| 219 | + } |
| 220 | + |
| 221 | + /** |
| 222 | + * Specifies the chunking strategy It could be either <code>sentence</code> or |
| 223 | + * <code>word</code> |
| 224 | + * <p> |
| 225 | + * API name: {@code strategy} |
| 226 | + */ |
| 227 | + public final Builder strategy(@Nullable String value) { |
| 228 | + this.strategy = value; |
| 229 | + return this; |
| 230 | + } |
| 231 | + |
| 232 | + @Override |
| 233 | + protected Builder self() { |
| 234 | + return this; |
| 235 | + } |
| 236 | + |
| 237 | + /** |
| 238 | + * Builds a {@link InferenceChunkingSettings}. |
| 239 | + * |
| 240 | + * @throws NullPointerException |
| 241 | + * if some of the required fields are null. |
| 242 | + */ |
| 243 | + public InferenceChunkingSettings build() { |
| 244 | + _checkSingleUse(); |
| 245 | + |
| 246 | + return new InferenceChunkingSettings(this); |
| 247 | + } |
| 248 | + } |
| 249 | + |
| 250 | + // --------------------------------------------------------------------------------------------- |
| 251 | + |
| 252 | + /** |
| 253 | + * Json deserializer for {@link InferenceChunkingSettings} |
| 254 | + */ |
| 255 | + public static final JsonpDeserializer<InferenceChunkingSettings> _DESERIALIZER = ObjectBuilderDeserializer |
| 256 | + .lazy(Builder::new, InferenceChunkingSettings::setupInferenceChunkingSettingsDeserializer); |
| 257 | + |
| 258 | + protected static void setupInferenceChunkingSettingsDeserializer( |
| 259 | + ObjectDeserializer<InferenceChunkingSettings.Builder> op) { |
| 260 | + InferenceEndpoint.setupInferenceEndpointDeserializer(op); |
| 261 | + op.add(Builder::maxChunkSize, JsonpDeserializer.integerDeserializer(), "max_chunk_size"); |
| 262 | + op.add(Builder::overlap, JsonpDeserializer.integerDeserializer(), "overlap"); |
| 263 | + op.add(Builder::sentenceOverlap, JsonpDeserializer.integerDeserializer(), "sentence_overlap"); |
| 264 | + op.add(Builder::strategy, JsonpDeserializer.stringDeserializer(), "strategy"); |
| 265 | + |
| 266 | + } |
| 267 | + |
| 268 | +} |
0 commit comments