Package org.elasticsearch.xpack.esql.inference

Class AbstractEmbeddingRequestIterator

java.lang.Object

org.elasticsearch.xpack.esql.inference.AbstractEmbeddingRequestIterator

All Implemented Interfaces:

Closeable, AutoCloseable, Iterator<InferenceOperator.BulkInferenceRequestItem>, Releasable, InferenceOperator.BulkInferenceRequestItemIterator

public abstract class AbstractEmbeddingRequestIterator
extends Object
implements InferenceOperator.BulkInferenceRequestItemIterator

Abstract base class for embedding request iterators.

Provides common iteration logic for converting a block of text strings into inference request items. Subclasses implement buildRequestItem(java.lang.String, org.elasticsearch.xpack.esql.inference.InferenceOperator.BulkInferenceRequestItem.PositionValueCountsBuilder) to produce an inference typed requests

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.inference.InferenceOperator.BulkInferenceRequestItemIterator

InferenceOperator.BulkInferenceRequestItemIterator.Factory

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	inferenceId
protected final TaskType	taskType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEmbeddingRequestIterator(String inferenceId, TaskType taskType, BytesRefBlock textBlock)

Method Summary

Modifier and Type	Method	Description
protected abstract InferenceOperator.BulkInferenceRequestItem	buildRequestItem(String text, InferenceOperator.BulkInferenceRequestItem.PositionValueCountsBuilder pvcs)	Subclasses produce a typed inference request
void	close()
int	estimatedSize()	Estimates the number of requests provided by this iterator.
boolean	hasNext()
InferenceOperator.BulkInferenceRequestItem	next()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Details

inferenceId

protected final String inferenceId

taskType

protected final TaskType taskType

Constructor Details

AbstractEmbeddingRequestIterator

protected AbstractEmbeddingRequestIterator(String inferenceId,
 TaskType taskType,
 BytesRefBlock textBlock)

Method Details

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<InferenceOperator.BulkInferenceRequestItem>

next

public InferenceOperator.BulkInferenceRequestItem next()

Specified by:

next in interface Iterator<InferenceOperator.BulkInferenceRequestItem>

buildRequestItem

protected abstract InferenceOperator.BulkInferenceRequestItem buildRequestItem(String text,
 InferenceOperator.BulkInferenceRequestItem.PositionValueCountsBuilder pvcs)

Subclasses produce a typed inference request

Parameters:

text - the text to embed, or null for a null-input position

pvcs - the position value counts builder for this batch

Returns:

the constructed request item

estimatedSize

public int estimatedSize()

Description copied from interface: InferenceOperator.BulkInferenceRequestItemIterator

Estimates the number of requests provided by this iterator.

Specified by:

estimatedSize in interface InferenceOperator.BulkInferenceRequestItemIterator

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable