Package org.opensearch.client.opensearch._types.mapping

Class SemanticProperty.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.mapping.SemanticProperty.Builder

All Implemented Interfaces:

CopyableBuilder<SemanticProperty.Builder,SemanticProperty>, MutableBuilder<SemanticProperty.Builder,SemanticProperty>, ObjectBuilder<SemanticProperty>

Enclosing class:

SemanticProperty

public static class SemanticProperty.Builder
extends ObjectBuilderBase
implements CopyableBuilder<SemanticProperty.Builder,SemanticProperty>

Builder for SemanticProperty.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SemanticProperty	build()	Builds a SemanticProperty.
final SemanticProperty.Builder	chunking(JsonData value)	API name: chunking
SemanticProperty.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SemanticProperty.Builder	denseEmbeddingConfig(Function<SemanticDenseEmbeddingConfig.Builder,ObjectBuilder<SemanticDenseEmbeddingConfig>> fn)	API name: dense_embedding_config
final SemanticProperty.Builder	denseEmbeddingConfig(SemanticDenseEmbeddingConfig value)	API name: dense_embedding_config
final SemanticProperty.Builder	modelId(String value)	Required - API name: model_id
final SemanticProperty.Builder	rawFieldType(String value)	API name: raw_field_type
final SemanticProperty.Builder	searchModelId(String value)	API name: search_model_id
final SemanticProperty.Builder	semanticFieldSearchAnalyzer(String value)	API name: semantic_field_search_analyzer
final SemanticProperty.Builder	semanticInfoFieldName(String value)	API name: semantic_info_field_name
final SemanticProperty.Builder	skipExistingEmbedding(Boolean value)	API name: skip_existing_embedding
final SemanticProperty.Builder	sparseEncodingConfig(Function<SemanticSparseEncodingConfig.Builder,ObjectBuilder<SemanticSparseEncodingConfig>> fn)	API name: sparse_encoding_config
final SemanticProperty.Builder	sparseEncodingConfig(SemanticSparseEncodingConfig value)	API name: sparse_encoding_config

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public SemanticProperty.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<SemanticProperty.Builder,SemanticProperty>

Returns:

a new builder instance.

chunking

@Nonnull
public final SemanticProperty.Builder chunking(@Nullable
 JsonData value)

API name: chunking

denseEmbeddingConfig

@Nonnull
public final SemanticProperty.Builder denseEmbeddingConfig(@Nullable
 SemanticDenseEmbeddingConfig value)

API name: dense_embedding_config

denseEmbeddingConfig

@Nonnull
public final SemanticProperty.Builder denseEmbeddingConfig(Function<SemanticDenseEmbeddingConfig.Builder,ObjectBuilder<SemanticDenseEmbeddingConfig>> fn)

API name: dense_embedding_config

modelId

@Nonnull
public final SemanticProperty.Builder modelId(String value)

Required - API name: model_id

rawFieldType

@Nonnull
public final SemanticProperty.Builder rawFieldType(@Nullable
 String value)

API name: raw_field_type

searchModelId

@Nonnull
public final SemanticProperty.Builder searchModelId(@Nullable
 String value)

API name: search_model_id

semanticFieldSearchAnalyzer

@Nonnull
public final SemanticProperty.Builder semanticFieldSearchAnalyzer(@Nullable
 String value)

API name: semantic_field_search_analyzer

semanticInfoFieldName

@Nonnull
public final SemanticProperty.Builder semanticInfoFieldName(@Nullable
 String value)

API name: semantic_info_field_name

skipExistingEmbedding

@Nonnull
public final SemanticProperty.Builder skipExistingEmbedding(@Nullable
 Boolean value)

API name: skip_existing_embedding

sparseEncodingConfig

@Nonnull
public final SemanticProperty.Builder sparseEncodingConfig(@Nullable
 SemanticSparseEncodingConfig value)

API name: sparse_encoding_config

sparseEncodingConfig

@Nonnull
public final SemanticProperty.Builder sparseEncodingConfig(Function<SemanticSparseEncodingConfig.Builder,ObjectBuilder<SemanticSparseEncodingConfig>> fn)

API name: sparse_encoding_config

build

@Nonnull
public SemanticProperty build()

Builds a SemanticProperty.

Specified by:

build in interface ObjectBuilder<SemanticProperty>

Throws:

NullPointerException - if some of the required fields are null.