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

Class SemanticProperty

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, PropertyVariant, ToCopyableBuilder<SemanticProperty.Builder,SemanticProperty>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class SemanticProperty
extends Object
implements PropertyVariant, PlainJsonSerializable, ToCopyableBuilder<SemanticProperty.Builder,SemanticProperty>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SemanticProperty.Builder	Builder for SemanticProperty.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<SemanticProperty>	_DESERIALIZER	Json deserializer for SemanticProperty

Method Summary

Modifier and Type	Method	Description
Property.Kind	_propertyKind()	Property variant kind.
static SemanticProperty.Builder	builder()
final JsonData	chunking()	API name: chunking
final SemanticDenseEmbeddingConfig	denseEmbeddingConfig()	API name: dense_embedding_config
boolean	equals(Object o)
int	hashCode()
final String	modelId()	Required - API name: model_id
static SemanticProperty	of(Function<SemanticProperty.Builder,ObjectBuilder<SemanticProperty>> fn)
final String	rawFieldType()	API name: raw_field_type
final String	searchModelId()	API name: search_model_id
final String	semanticFieldSearchAnalyzer()	API name: semantic_field_search_analyzer
final String	semanticInfoFieldName()	API name: semantic_info_field_name
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSemanticPropertyDeserializer(ObjectDeserializer<SemanticProperty.Builder> op)
final Boolean	skipExistingEmbedding()	API name: skip_existing_embedding
final SemanticSparseEncodingConfig	sparseEncodingConfig()	API name: sparse_encoding_config
SemanticProperty.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch._types.mapping.PropertyVariant

toProperty

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SemanticProperty> _DESERIALIZER

Json deserializer for SemanticProperty

Method Details

of

public static SemanticProperty of(Function<SemanticProperty.Builder,ObjectBuilder<SemanticProperty>> fn)

_propertyKind

public Property.Kind _propertyKind()

Property variant kind.

Specified by:

_propertyKind in interface PropertyVariant

chunking

@Nullable
public final JsonData chunking()

API name: chunking

denseEmbeddingConfig

@Nullable
public final SemanticDenseEmbeddingConfig denseEmbeddingConfig()

API name: dense_embedding_config

modelId

@Nonnull
public final String modelId()

Required - API name: model_id

rawFieldType

@Nullable
public final String rawFieldType()

API name: raw_field_type

searchModelId

@Nullable
public final String searchModelId()

API name: search_model_id

semanticFieldSearchAnalyzer

@Nullable
public final String semanticFieldSearchAnalyzer()

API name: semantic_field_search_analyzer

semanticInfoFieldName

@Nullable
public final String semanticInfoFieldName()

API name: semantic_info_field_name

skipExistingEmbedding

@Nullable
public final Boolean skipExistingEmbedding()

API name: skip_existing_embedding

sparseEncodingConfig

@Nullable
public final SemanticSparseEncodingConfig sparseEncodingConfig()

API name: sparse_encoding_config

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public SemanticProperty.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SemanticProperty.Builder,SemanticProperty>

Returns:

a new builder instance.

builder

@Nonnull
public static SemanticProperty.Builder builder()

setupSemanticPropertyDeserializer

protected static void setupSemanticPropertyDeserializer(ObjectDeserializer<SemanticProperty.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object