Package org.opensearch.ml.common.output.model

Class ModelResultFilter

java.lang.Object

org.opensearch.ml.common.output.model.ModelResultFilter

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable

public class ModelResultFilter
extends Object
implements org.opensearch.core.common.io.stream.Writeable

This class is to filter model results.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModelResultFilter.ModelResultFilterBuilder

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	RETURN_BYTES_FIELD
static final String	RETURN_NUMBER_FIELD
protected final boolean	returnBytes
protected final boolean	returnNumber
static final String	TARGET_RESPONSE_FIELD
static final String	TARGET_RESPONSE_POSITIONS_FIELD
protected final List<String>	targetResponse
protected final List<Integer>	targetResponsePositions

Constructor Summary

Constructors

Constructor	Description
ModelResultFilter(boolean returnBytes, boolean returnNumber, List<String> targetResponse, List<Integer> targetResponsePositions)
ModelResultFilter(org.opensearch.core.common.io.stream.StreamInput streamInput)

Method Summary

Modifier and Type	Method	Description
static ModelResultFilter.ModelResultFilterBuilder	builder()
List<String>	getTargetResponse()
List<Integer>	getTargetResponsePositions()
boolean	isReturnBytes()
boolean	isReturnNumber()
static ModelResultFilter	parse(org.opensearch.core.xcontent.XContentParser parser)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput streamOutput)

Methods inherited from class java.lang.Object

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

Field Details

RETURN_BYTES_FIELD

public static final String RETURN_BYTES_FIELD

See Also:

• Constant Field Values

RETURN_NUMBER_FIELD

public static final String RETURN_NUMBER_FIELD

See Also:

• Constant Field Values

TARGET_RESPONSE_FIELD

public static final String TARGET_RESPONSE_FIELD

See Also:

• Constant Field Values

TARGET_RESPONSE_POSITIONS_FIELD

public static final String TARGET_RESPONSE_POSITIONS_FIELD

See Also:

• Constant Field Values

returnBytes

protected final boolean returnBytes

returnNumber

protected final boolean returnNumber

targetResponse

protected final List<String> targetResponse

targetResponsePositions

protected final List<Integer> targetResponsePositions

Constructor Details

ModelResultFilter

public ModelResultFilter(boolean returnBytes,
 boolean returnNumber,
 List<String> targetResponse,
 List<Integer> targetResponsePositions)

ModelResultFilter

public ModelResultFilter(org.opensearch.core.common.io.stream.StreamInput streamInput)
                  throws IOException

Throws:

IOException

Method Details

writeTo

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

Specified by:

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

Throws:

IOException

parse

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

Throws:

IOException

builder

public static ModelResultFilter.ModelResultFilterBuilder builder()

isReturnBytes

public boolean isReturnBytes()

isReturnNumber

public boolean isReturnNumber()

getTargetResponse

public List<String> getTargetResponse()

getTargetResponsePositions

public List<Integer> getTargetResponsePositions()