Module org.elasticsearch.server

Package org.elasticsearch.inference.metadata

Record Class EndpointMetadata

java.lang.Object

java.lang.Record

org.elasticsearch.inference.metadata.EndpointMetadata

Record Components:

heuristics - contains information so clients of the Inference API can determine which models should be used as defaults and presented to users in different scenarios.

internal - contains information that is only used within Elasticsearch. The internal information helps the Inference API know when it needs to update the preconfigured endpoints by tracking the upstream fingerprint and an internal version.

display - contains information for how to display the endpoint in user interfaces (descriptive name, etc).

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public record EndpointMetadata(EndpointMetadata.Heuristics heuristics, EndpointMetadata.Internal internal, EndpointMetadata.Display display)
extends Record
implements ToXContentObject, Writeable

Endpoint metadata contains descriptive information for an inference endpoint. This information allows an upstream service to communicate the features a particular model supports and other properties to help clients of the Inference API determine which model to use for defaults in different scenarios.

The Elastic Inference Service populates these fields so that Kibana and semantic text fields determine the correct defaults.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EndpointMetadata.Display
static final record	EndpointMetadata.Heuristics	Heuristics about the model used in the endpoint to help clients of the Inference API determine which models to use.
static final record	EndpointMetadata.Internal	Internal metadata used by Elasticsearch.

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISPLAY_FIELD_NAME
static final EndpointMetadata	EMPTY_INSTANCE
static final String	HEURISTICS_FIELD_NAME
static final TransportVersion	INFERENCE_ENDPOINT_METADATA_FIELDS_ADDED
static final String	INTERNAL_FIELD_NAME
static final String	METADATA_FIELD_NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
EndpointMetadata(StreamInput in)
EndpointMetadata(EndpointMetadata.Heuristics heuristics, EndpointMetadata.Internal internal, EndpointMetadata.Display display)	Creates an instance of a EndpointMetadata record class.

Method Summary

Modifier and Type	Method	Description
EndpointMetadata.Display	display()	Returns the value of the display record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	fingerprintMatches(EndpointMetadata other)
ToXContent.Params	getXContentParamsExcludeInternalFields()
final int	hashCode()	Returns a hash code value for this object.
boolean	hasNewerVersionThan(EndpointMetadata other)
EndpointMetadata.Heuristics	heuristics()	Returns the value of the heuristics record component.
EndpointMetadata.Internal	internal()	Returns the value of the internal record component.
boolean	isEmpty()
static EndpointMetadata	parse(XContentParser parser)
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

INFERENCE_ENDPOINT_METADATA_FIELDS_ADDED

public static final TransportVersion INFERENCE_ENDPOINT_METADATA_FIELDS_ADDED

EMPTY_INSTANCE

public static final EndpointMetadata EMPTY_INSTANCE

METADATA_FIELD_NAME

public static final String METADATA_FIELD_NAME

See Also:

• Constant Field Values

HEURISTICS_FIELD_NAME

public static final String HEURISTICS_FIELD_NAME

See Also:

• Constant Field Values

INTERNAL_FIELD_NAME

public static final String INTERNAL_FIELD_NAME

See Also:

• Constant Field Values

DISPLAY_FIELD_NAME

public static final String DISPLAY_FIELD_NAME

See Also:

• Constant Field Values

Constructor Details

EndpointMetadata

public EndpointMetadata(EndpointMetadata.Heuristics heuristics,
 EndpointMetadata.Internal internal,
 EndpointMetadata.Display display)

Creates an instance of a EndpointMetadata record class.

Parameters:

heuristics - the value for the heuristics record component

internal - the value for the internal record component

display - the value for the display record component

EndpointMetadata

public EndpointMetadata(StreamInput in)
                 throws IOException

Throws:

IOException

Method Details

parse

public static EndpointMetadata parse(XContentParser parser)
                              throws IOException

Throws:

IOException

isEmpty

public boolean isEmpty()

fingerprintMatches

public boolean fingerprintMatches(EndpointMetadata other)

hasNewerVersionThan

public boolean hasNewerVersionThan(EndpointMetadata other)

getXContentParamsExcludeInternalFields

public ToXContent.Params getXContentParamsExcludeInternalFields()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

heuristics

public EndpointMetadata.Heuristics heuristics()

Returns the value of the heuristics record component.

Returns:

the value of the heuristics record component

internal

public EndpointMetadata.Internal internal()

Returns the value of the internal record component.

Returns:

the value of the internal record component

display

public EndpointMetadata.Display display()

Returns the value of the display record component.

Returns:

the value of the display record component