Package org.opensearch.ml.common.model

Class QuestionAnsweringModelConfig

java.lang.Object

org.opensearch.ml.common.model.MLModelConfig

org.opensearch.ml.common.model.QuestionAnsweringModelConfig

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

public class QuestionAnsweringModelConfig
extends MLModelConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QuestionAnsweringModelConfig.FrameworkType
static class	QuestionAnsweringModelConfig.QuestionAnsweringModelConfigBuilder

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FRAMEWORK_TYPE_FIELD
static final String	MODEL_MAX_LENGTH_FIELD
static final String	NORMALIZE_RESULT_FIELD
static final String	PARSE_FIELD_NAME
static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry	XCONTENT_REGISTRY

Fields inherited from class org.opensearch.ml.common.model.MLModelConfig

ALL_CONFIG_FIELD, allConfig, MODEL_TYPE_FIELD, modelType

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
QuestionAnsweringModelConfig(String modelType, QuestionAnsweringModelConfig.FrameworkType frameworkType, String allConfig, boolean normalizeResult, Integer modelMaxLength)
QuestionAnsweringModelConfig(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
static QuestionAnsweringModelConfig.QuestionAnsweringModelConfigBuilder	builder()
QuestionAnsweringModelConfig.FrameworkType	getFrameworkType()
Integer	getModelMaxLength()
String	getWriteableName()
boolean	isNormalizeResult()
static QuestionAnsweringModelConfig	parse(org.opensearch.core.xcontent.XContentParser parser)
QuestionAnsweringModelConfig.QuestionAnsweringModelConfigBuilder	toBuilder()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.ml.common.model.MLModelConfig

getAllConfig, getModelType, setAllConfig, setModelType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

PARSE_FIELD_NAME

public static final String PARSE_FIELD_NAME

XCONTENT_REGISTRY

public static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry XCONTENT_REGISTRY

FRAMEWORK_TYPE_FIELD

public static final String FRAMEWORK_TYPE_FIELD

See Also:

• Constant Field Values

NORMALIZE_RESULT_FIELD

public static final String NORMALIZE_RESULT_FIELD

See Also:

• Constant Field Values

MODEL_MAX_LENGTH_FIELD

public static final String MODEL_MAX_LENGTH_FIELD

See Also:

• Constant Field Values

Constructor Details

QuestionAnsweringModelConfig

public QuestionAnsweringModelConfig(String modelType,
 QuestionAnsweringModelConfig.FrameworkType frameworkType,
 String allConfig,
 boolean normalizeResult,
 Integer modelMaxLength)

QuestionAnsweringModelConfig

public QuestionAnsweringModelConfig(org.opensearch.core.common.io.stream.StreamInput in)
                             throws IOException

Throws:

IOException

Method Details

parse

public static QuestionAnsweringModelConfig parse(org.opensearch.core.xcontent.XContentParser parser)
                                          throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class MLModelConfig

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Throws:

IOException

builder

public static QuestionAnsweringModelConfig.QuestionAnsweringModelConfigBuilder builder()

toBuilder

public QuestionAnsweringModelConfig.QuestionAnsweringModelConfigBuilder toBuilder()

getFrameworkType

public QuestionAnsweringModelConfig.FrameworkType getFrameworkType()

isNormalizeResult

public boolean isNormalizeResult()

getModelMaxLength

public Integer getModelMaxLength()