Package org.springframework.ai.chat.metadata

Interface PromptMetadata

All Superinterfaces:

Iterable<PromptMetadata.PromptFilterMetadata>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface PromptMetadata
extends Iterable<PromptMetadata.PromptFilterMetadata>

Abstract Data Type (ADT) modeling metadata gathered by the AI during request processing.

Since:

0.7.0

Author:

John Blum

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PromptMetadata.PromptFilterMetadata	Abstract Data Type (ADT) modeling filter metadata for all prompts sent during an AI request.

Method Summary

Modifier and Type	Method	Description
static PromptMetadata	empty()	Factory method used to create empty PromptMetadata when the information is not supplied by the AI provider.
default Optional<PromptMetadata.PromptFilterMetadata>	findByPromptIndex(int promptIndex)	Returns an Optional PromptMetadata.PromptFilterMetadata at the given index.
static PromptMetadata	of(Iterable<PromptMetadata.PromptFilterMetadata> iterable)	Factory method used to create a new PromptMetadata composed of an Iterable of PromptMetadata.PromptFilterMetadata.
static PromptMetadata	of(PromptMetadata.PromptFilterMetadata... array)	Factory method used to create a new PromptMetadata composed of an array of PromptMetadata.PromptFilterMetadata.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

empty

static PromptMetadata empty()

Factory method used to create empty PromptMetadata when the information is not supplied by the AI provider.

Returns:

empty PromptMetadata.

of

static PromptMetadata of(PromptMetadata.PromptFilterMetadata... array)

Factory method used to create a new PromptMetadata composed of an array of PromptMetadata.PromptFilterMetadata.

Parameters:

array - array of PromptMetadata.PromptFilterMetadata used to compose the PromptMetadata.

Returns:

a new PromptMetadata composed of an array of PromptMetadata.PromptFilterMetadata.

of

static PromptMetadata of(Iterable<PromptMetadata.PromptFilterMetadata> iterable)

Factory method used to create a new PromptMetadata composed of an Iterable of PromptMetadata.PromptFilterMetadata.

Parameters:

iterable - Iterable of PromptMetadata.PromptFilterMetadata used to compose the PromptMetadata.

Returns:

a new PromptMetadata composed of an Iterable of PromptMetadata.PromptFilterMetadata.

findByPromptIndex

default Optional<PromptMetadata.PromptFilterMetadata> findByPromptIndex(int promptIndex)

Returns an Optional PromptMetadata.PromptFilterMetadata at the given index.

Parameters:

promptIndex - index of the PromptMetadata.PromptFilterMetadata contained in this PromptMetadata.

Returns:

Optional PromptMetadata.PromptFilterMetadata at the given index.

Throws:

IllegalArgumentException - if the prompt index is less than 0.