Package co.elastic.clients.elasticsearch._types.mapping

Class SemanticTextProperty.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<SemanticTextProperty.Builder>

co.elastic.clients.elasticsearch._types.mapping.SemanticTextProperty.Builder

All Implemented Interfaces:

WithJson<SemanticTextProperty.Builder>, ObjectBuilder<SemanticTextProperty>

Enclosing class:

SemanticTextProperty

public static class SemanticTextProperty.Builder
extends WithJsonObjectBuilderBase<SemanticTextProperty.Builder>
implements ObjectBuilder<SemanticTextProperty>

Builder for SemanticTextProperty.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SemanticTextProperty	build()	Builds a SemanticTextProperty.
final SemanticTextProperty.Builder	chunkingSettings(ChunkingSettings value)	Settings for chunking text into smaller passages.
final SemanticTextProperty.Builder	chunkingSettings(Function<ChunkingSettings.Builder,ObjectBuilder<ChunkingSettings>> fn)	Settings for chunking text into smaller passages.
final SemanticTextProperty.Builder	inferenceId(String value)	Inference endpoint that will be used to generate embeddings for the field.
final SemanticTextProperty.Builder	meta(String key, String value)	API name: meta
final SemanticTextProperty.Builder	meta(Map<String,String> map)	API name: meta
final SemanticTextProperty.Builder	searchInferenceId(String value)	Inference endpoint that will be used to generate embeddings at query time.
protected SemanticTextProperty.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

meta

public final SemanticTextProperty.Builder meta(Map<String,String> map)

API name: meta

Adds all entries of map to meta.

meta

public final SemanticTextProperty.Builder meta(String key,
 String value)

API name: meta

Adds an entry to meta.

inferenceId

public final SemanticTextProperty.Builder inferenceId(@Nullable
 String value)

Inference endpoint that will be used to generate embeddings for the field. This parameter cannot be updated. Use the Create inference API to create the endpoint. If search_inference_id is specified, the inference endpoint will only be used at index time.

API name: inference_id

searchInferenceId

public final SemanticTextProperty.Builder searchInferenceId(@Nullable
 String value)

Inference endpoint that will be used to generate embeddings at query time. You can update this parameter by using the Update mapping API. Use the Create inference API to create the endpoint. If not specified, the inference endpoint defined by inference_id will be used at both index and query time.

API name: search_inference_id

chunkingSettings

public final SemanticTextProperty.Builder chunkingSettings(@Nullable
 ChunkingSettings value)

Settings for chunking text into smaller passages. If specified, these will override the chunking settings sent in the inference endpoint associated with inference_id. If chunking settings are updated, they will not be applied to existing documents until they are reindexed.

API name: chunking_settings

chunkingSettings

public final SemanticTextProperty.Builder chunkingSettings(Function<ChunkingSettings.Builder,ObjectBuilder<ChunkingSettings>> fn)

Settings for chunking text into smaller passages. If specified, these will override the chunking settings sent in the inference endpoint associated with inference_id. If chunking settings are updated, they will not be applied to existing documents until they are reindexed.

API name: chunking_settings

self

protected SemanticTextProperty.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<SemanticTextProperty.Builder>

build

public SemanticTextProperty build()

Builds a SemanticTextProperty.

Specified by:

build in interface ObjectBuilder<SemanticTextProperty>

Throws:

NullPointerException - if some of the required fields are null.