Module org.elasticsearch.xcore
Class TextSimilarityConfig
java.lang.Object
org.elasticsearch.xpack.core.ml.inference.trainedmodel.TextSimilarityConfig
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject,InferenceConfig,LenientlyParsedInferenceConfig,NlpConfig,StrictlyParsedInferenceConfig,NamedXContentObject
Text similarity configuration for running a cross-encoder transformer model with the given text and some number of documents
containing another text field.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldFields inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfig
DEFAULT_RESULTS_FIELD, DEFAULT_TOP_CLASSES_RESULTS_FIELD, RESULTS_FIELDFields inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.NlpConfig
CLASSIFICATION_LABELS, MINIMUM_NLP_SUPPORTED_VERSION, NUM_TOP_CLASSES, TOKENIZATION, VOCABULARYFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionTextSimilarityConfig(String text, VocabularyConfig vocabularyConfig, Tokenization tokenization, String resultsField, TextSimilarityConfig.SpanScoreFunction spanScoreFunction) -
Method Summary
Modifier and TypeMethodDescriptionapply(InferenceConfigUpdate update) Return a copy of this with the settings updated by the values inupdate.booleanstatic TextSimilarityConfigfromXContentLenient(org.elasticsearch.xcontent.XContentParser parser) static TextSimilarityConfigfromXContentStrict(org.elasticsearch.xcontent.XContentParser parser) All nodes in the cluster must have at least this MlConfigVersion attributeAll communication in the cluster must use at least this versiongetName()getText()inthashCode()booleanbooleanisTargetTypeSupported(TargetType targetType) org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfig
getDefaultInput, getMinimalSupportedVersion, getMinLicenseSupported, getMinLicenseSupportedForAction, incompatibleUpdateException, requestingImportance, validateTrainedModelInputMethods inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.NlpConfig
supportsIngestPipeline, supportsPipelineAggregation, supportsSearchRescorerMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
- See Also:
-
TEXT
public static final org.elasticsearch.xcontent.ParseField TEXT -
SPAN_SCORE_COMBINATION_FUNCTION
public static final org.elasticsearch.xcontent.ParseField SPAN_SCORE_COMBINATION_FUNCTION
-
-
Constructor Details
-
TextSimilarityConfig
public TextSimilarityConfig(String text, VocabularyConfig vocabularyConfig, Tokenization tokenization, String resultsField, TextSimilarityConfig.SpanScoreFunction spanScoreFunction) -
TextSimilarityConfig
- Throws:
IOException
-
-
Method Details
-
fromXContentStrict
public static TextSimilarityConfig fromXContentStrict(org.elasticsearch.xcontent.XContentParser parser) -
fromXContentLenient
public static TextSimilarityConfig fromXContentLenient(org.elasticsearch.xcontent.XContentParser parser) -
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
getWriteableName
- Specified by:
getWriteableNamein interfaceNamedWriteable- Specified by:
getWriteableNamein interfaceVersionedNamedWriteable
-
isTargetTypeSupported
- Specified by:
isTargetTypeSupportedin interfaceInferenceConfig
-
apply
Description copied from interface:InferenceConfigReturn a copy of this with the settings updated by the values inupdate.- Specified by:
applyin interfaceInferenceConfig- Parameters:
update- The update to apply- Returns:
- A new updated config
-
getMinimalSupportedMlConfigVersion
Description copied from interface:InferenceConfigAll nodes in the cluster must have at least this MlConfigVersion attribute- Specified by:
getMinimalSupportedMlConfigVersionin interfaceInferenceConfig
-
getMinimalSupportedTransportVersion
Description copied from interface:InferenceConfigAll communication in the cluster must use at least this version- Specified by:
getMinimalSupportedTransportVersionin interfaceInferenceConfig
-
getName
- Specified by:
getNamein interfaceNamedXContentObject- Returns:
- The name of the XContentObject that is to be serialized
-
equals
-
hashCode
public int hashCode() -
getVocabularyConfig
- Specified by:
getVocabularyConfigin interfaceNlpConfig- Returns:
- the vocabulary configuration that allows retrieving it
-
getTokenization
- Specified by:
getTokenizationin interfaceNlpConfig- Returns:
- the model tokenization parameters
-
getText
-
getSpanScoreFunction
-
getResultsField
- Specified by:
getResultsFieldin interfaceInferenceConfig
-
isAllocateOnly
public boolean isAllocateOnly()- Specified by:
isAllocateOnlyin interfaceInferenceConfig
-