Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- accept(List<Document>) - Method in class org.springframework.ai.writer.FileDocumentWriter
- ADVISOR - Enum constant in enum class org.springframework.ai.observation.conventions.SpringAiKind
-
Spring AI kind for advisor.
- AI_OPERATION_TYPE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The name of the operation being performed.
- AI_PROVIDER - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The model provider as identified by the client instrumentation.
- AiObservationAttributes - Enum Class in org.springframework.ai.observation.conventions
-
Collection of attribute keys used in AI observations (spans, metrics, events).
- AiObservationMetricAttributes - Enum Class in org.springframework.ai.observation.conventions
-
Collection of metric attributes used in AI observations.
- AiObservationMetricNames - Enum Class in org.springframework.ai.observation.conventions
-
Enumeration of metric names used in AI observations.
- AiOperationMetadata - Record Class in org.springframework.ai.observation
-
Metadata associated with an AI operation (e.g.
- AiOperationMetadata(String, String) - Constructor for record class org.springframework.ai.observation.AiOperationMetadata
-
Create a new
AiOperationMetadatainstance. - AiOperationMetadata.Builder - Class in org.springframework.ai.observation
-
Builder for
AiOperationMetadata. - AiOperationType - Enum Class in org.springframework.ai.observation.conventions
-
Types of operations performed by AI systems.
- AiProvider - Enum Class in org.springframework.ai.observation.conventions
-
Collection of systems providing AI functionality.
- AiTokenType - Enum Class in org.springframework.ai.observation.conventions
-
Types of tokens produced and consumed in an AI operation.
- alignToLeft(String) - Static method in class org.springframework.ai.reader.ExtractedTextFormatter
- ALL - Enum constant in enum class org.springframework.ai.document.MetadataMode
- ANTHROPIC - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by Anthropic.
- apply(String, Map<String, Object>) - Method in class org.springframework.ai.template.NoOpTemplateRenderer
- apply(String, Map<String, Object>) - Method in interface org.springframework.ai.template.TemplateRenderer
- apply(List<Document>) - Method in class org.springframework.ai.transformer.ContentFormatTransformer
-
Post process documents chunked from loader.
- apply(List<Document>) - Method in class org.springframework.ai.transformer.splitter.TextSplitter
- AZURE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Azure.
- AZURE_OPENAI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by Azure.
B
- batch(List<Document>) - Method in interface org.springframework.ai.embedding.BatchingStrategy
-
EmbeddingModel implementations can call this method to optimize embedding tokens.
- batch(List<Document>) - Method in class org.springframework.ai.embedding.TokenCountBatchingStrategy
- BatchingStrategy - Interface in org.springframework.ai.embedding
-
Contract for batching
Documentobjects so that the call to embed them could be optimized. - BEDROCK_CONVERSE - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by Bedrock Converse.
- build() - Method in class org.springframework.ai.content.Media.Builder
-
Builds a new Media instance with the configured properties.
- build() - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder
-
Returns the immutable configuration.
- build() - Method in class org.springframework.ai.document.Document.Builder
- build() - Method in class org.springframework.ai.observation.AiOperationMetadata.Builder
-
Build the
AiOperationMetadatainstance. - build() - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder
-
Constructs and returns an instance of
ExtractedTextFormatterusing the configurations set on this builder. - build() - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
- builder() - Static method in class org.springframework.ai.content.Media
-
Creates a new Media builder.
- builder() - Static method in class org.springframework.ai.document.DefaultContentFormatter
-
Start building a new configuration.
- builder() - Static method in class org.springframework.ai.document.Document
- builder() - Static method in record class org.springframework.ai.observation.AiOperationMetadata
-
Create a new
AiOperationMetadata.Builderinstance. - builder() - Static method in class org.springframework.ai.reader.ExtractedTextFormatter
-
Provides an instance of the builder for this formatter.
- builder() - Static method in class org.springframework.ai.transformer.splitter.TokenTextSplitter
- Builder() - Constructor for class org.springframework.ai.document.Document.Builder
- Builder() - Constructor for class org.springframework.ai.reader.ExtractedTextFormatter.Builder
C
- CASSANDRA - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Cassandra.
- CHARSET_METADATA - Static variable in class org.springframework.ai.reader.TextReader
- CHAT - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType
-
AI operation type for chat.
- CHAT_CLIENT - Enum constant in enum class org.springframework.ai.observation.conventions.SpringAiKind
-
Spring AI kind for chat client.
- CHROMA - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Chroma.
- concatenateEntries(Map<String, Object>) - Static method in class org.springframework.ai.observation.ObservabilityHelper
- concatenateStrings(List<String>) - Static method in class org.springframework.ai.observation.ObservabilityHelper
- Content - Interface in org.springframework.ai.content
-
Data structure that contains content and metadata.
- ContentFormatter - Interface in org.springframework.ai.document
-
Converts the Document text and metadata into an AI, prompt-friendly text representation.
- ContentFormatTransformer - Class in org.springframework.ai.transformer
-
ContentFormatTransformer processes a list of documents by applying a content formatter to each document.
- ContentFormatTransformer(ContentFormatter) - Constructor for class org.springframework.ai.transformer.ContentFormatTransformer
-
Creates a ContentFormatTransformer object with the given ContentFormatter.
- ContentFormatTransformer(ContentFormatter, boolean) - Constructor for class org.springframework.ai.transformer.ContentFormatTransformer
-
The ContentFormatTransformer class is responsible for processing a list of documents by applying a content formatter to each document.
- COSINE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric
-
The cosine metric.
- COSMOSDB - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by CosmosDB.
- COUCHBASE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by CosmosDB.
D
- data(Object) - Method in class org.springframework.ai.content.Media.Builder
-
Sets the media data from any Object.
- data(URI) - Method in class org.springframework.ai.content.Media.Builder
-
Sets the media data from a URI.
- data(Resource) - Method in class org.springframework.ai.content.Media.Builder
-
Sets the media data from a Resource.
- DB_COLLECTION_NAME - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
The name of a collection (table, container) within the database.
- DB_NAMESPACE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
The name of the database, fully qualified within the server address and port.
- DB_OPERATION_NAME - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
The name of the operation or command being executed.
- DB_RECORD_ID - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
The record identifier if present.
- DB_SEARCH_SIMILARITY_METRIC - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
The metric used in similarity search.
- DB_SYSTEM - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
The database management system (DBMS) product as identified by the client instrumentation.
- DB_VECTOR_DIMENSION_COUNT - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
The dimension of the vector.
- DB_VECTOR_FIELD_NAME - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
The name field as of the vector (e.g.
- DB_VECTOR_QUERY_CONTENT - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
The content of the search query being executed.
- DB_VECTOR_QUERY_FILTER - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
The metadata filters used in the search query.
- DB_VECTOR_QUERY_RESPONSE_DOCUMENTS - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
Returned documents from a similarity search query.
- DB_VECTOR_QUERY_SIMILARITY_THRESHOLD - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
Similarity threshold that accepts all search scores.
- DB_VECTOR_QUERY_TOP_K - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
The top-k most similar vectors returned by a query.
- DEEPSEEK - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by DeepSeek.
- DEFAULT_CONTENT_FORMATTER - Static variable in class org.springframework.ai.document.Document
- defaultConfig() - Static method in class org.springframework.ai.document.DefaultContentFormatter
-
Returns the default config.
- DefaultContentFormatter - Class in org.springframework.ai.document
-
Default implementation of
ContentFormatter. - DefaultContentFormatter.Builder - Class in org.springframework.ai.document
- defaults() - Static method in class org.springframework.ai.reader.ExtractedTextFormatter
-
Provides a default instance of the formatter.
- deleteBottomTextLines(String, int, String) - Static method in class org.springframework.ai.reader.ExtractedTextFormatter
-
Removes the specified number of lines from the bottom part of the text.
- deleteTopTextLines(String, int, String) - Static method in class org.springframework.ai.reader.ExtractedTextFormatter
-
Removes a specified number of lines from the top part of the given text.
- DISTANCE - Enum constant in enum class org.springframework.ai.document.DocumentMetadata
-
Measure of distance between the document embedding and the query vector.
- DOC_CSV - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
text/csv. - DOC_DOC - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
application/msword. - DOC_DOCX - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
application/vnd.openxmlformats-officedocument.wordprocessingml.document. - DOC_HTML - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
text/html. - DOC_MD - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
text/markdown. - DOC_PDF - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
application/pdf. - DOC_TXT - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
text/plain. - DOC_XLS - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
application/vnd.ms-excel. - DOC_XLSX - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet. - Document - Class in org.springframework.ai.document
-
A document is a container for the content and metadata of a document.
- Document(String) - Constructor for class org.springframework.ai.document.Document
- Document(String, String, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document
- Document(String, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document
- Document(String, Media, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document
- Document(Media, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document
- Document.Builder - Class in org.springframework.ai.document
- DocumentMetadata - Enum Class in org.springframework.ai.document
-
Common set of metadata keys used in
Documents byDocumentReaders and VectorStores. - DocumentReader - Interface in org.springframework.ai.document
- DocumentTransformer - Interface in org.springframework.ai.document
- DocumentWriter - Interface in org.springframework.ai.document
-
Write a list of
Documentinstances. - doGetSupportingData(EvaluationRequest) - Method in interface org.springframework.ai.evaluation.Evaluator
- doSplit(String, int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter
- DOT - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric
-
The dot product metric.
E
- ELASTICSEARCH - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Elasticsearch.
- EMBED - Enum constant in enum class org.springframework.ai.document.MetadataMode
- EMBEDDING - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType
-
AI operation type for embedding.
- EmptyJsonMetadataGenerator - Class in org.springframework.ai.reader
- EmptyJsonMetadataGenerator() - Constructor for class org.springframework.ai.reader.EmptyJsonMetadataGenerator
- equals(Object) - Method in class org.springframework.ai.document.Document
- equals(Object) - Method in class org.springframework.ai.evaluation.EvaluationRequest
- equals(Object) - Method in class org.springframework.ai.evaluation.EvaluationResponse
- equals(Object) - Method in record class org.springframework.ai.observation.AiOperationMetadata
-
Indicates whether some other object is "equal to" this one.
- estimate(Iterable<MediaContent>) - Method in class org.springframework.ai.tokenizer.JTokkitTokenCountEstimator
- estimate(Iterable<MediaContent>) - Method in interface org.springframework.ai.tokenizer.TokenCountEstimator
-
Estimates the number of tokens in the given messages.
- estimate(String) - Method in class org.springframework.ai.tokenizer.JTokkitTokenCountEstimator
- estimate(String) - Method in interface org.springframework.ai.tokenizer.TokenCountEstimator
-
Estimates the number of tokens in the given text.
- estimate(MediaContent) - Method in class org.springframework.ai.tokenizer.JTokkitTokenCountEstimator
- estimate(MediaContent) - Method in interface org.springframework.ai.tokenizer.TokenCountEstimator
-
Estimates the number of tokens in the given message.
- EUCLIDEAN - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric
-
The euclidean distance metric.
- evaluate(EvaluationRequest) - Method in interface org.springframework.ai.evaluation.Evaluator
- EvaluationRequest - Class in org.springframework.ai.evaluation
-
Represents an evaluation request, which includes the user's text, a list of content data, and a chat response.
- EvaluationRequest(String, String) - Constructor for class org.springframework.ai.evaluation.EvaluationRequest
- EvaluationRequest(String, List<Document>, String) - Constructor for class org.springframework.ai.evaluation.EvaluationRequest
- EvaluationRequest(List<Document>, String) - Constructor for class org.springframework.ai.evaluation.EvaluationRequest
- EvaluationResponse - Class in org.springframework.ai.evaluation
- EvaluationResponse(boolean, float, String, Map<String, Object>) - Constructor for class org.springframework.ai.evaluation.EvaluationResponse
- EvaluationResponse(boolean, String, Map<String, Object>) - Constructor for class org.springframework.ai.evaluation.EvaluationResponse
- Evaluator - Interface in org.springframework.ai.evaluation
- ExtractedTextFormatter - Class in org.springframework.ai.reader
-
A utility to reformat extracted text content before encapsulating it in a
Document. - ExtractedTextFormatter.Builder - Class in org.springframework.ai.reader
-
The
Builderclass is a nested static class ofExtractedTextFormatterdesigned to facilitate the creation and customization of instances ofExtractedTextFormatter.
F
- FileDocumentWriter - Class in org.springframework.ai.writer
-
Writes the content of a list of
Documents into a file. - FileDocumentWriter(String) - Constructor for class org.springframework.ai.writer.FileDocumentWriter
- FileDocumentWriter(String, boolean) - Constructor for class org.springframework.ai.writer.FileDocumentWriter
- FileDocumentWriter(String, boolean, MetadataMode, boolean) - Constructor for class org.springframework.ai.writer.FileDocumentWriter
-
Writes the content of a list of
Documents into a file. - format(String) - Method in class org.springframework.ai.reader.ExtractedTextFormatter
-
Formats the provided text according to the formatter's configuration.
- format(String, int) - Method in class org.springframework.ai.reader.ExtractedTextFormatter
-
Formats the provided text based on the formatter's configuration, considering the page number.
- format(Document, MetadataMode) - Method in interface org.springframework.ai.document.ContentFormatter
- format(Document, MetadataMode) - Method in class org.springframework.ai.document.DefaultContentFormatter
- Format() - Constructor for class org.springframework.ai.content.Media.Format
- FRAMEWORK - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType
-
AI operation type for framework.
- from(DefaultContentFormatter) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder
G
- GEMFIRE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by GemFire.
- generate(Map<String, Object>) - Method in class org.springframework.ai.reader.EmptyJsonMetadataGenerator
- generate(Map<String, Object>) - Method in interface org.springframework.ai.reader.JsonMetadataGenerator
-
The input is the JSON document represented as a map, the output are the fields extracted from the input map that will be used as metadata.
- generateId(Object...) - Method in interface org.springframework.ai.document.id.IdGenerator
-
Generate a unique ID for the given content.
- generateId(Object...) - Method in class org.springframework.ai.document.id.JdkSha256HexIdGenerator
- generateId(Object...) - Method in class org.springframework.ai.document.id.RandomIdGenerator
- get() - Method in class org.springframework.ai.reader.JsonReader
- get() - Method in class org.springframework.ai.reader.TextReader
- get(JsonNode) - Method in class org.springframework.ai.reader.JsonReader
- get(String) - Method in class org.springframework.ai.reader.JsonReader
-
Retrieves documents from the JSON resource using a JSON Pointer.
- getCharset() - Method in class org.springframework.ai.reader.TextReader
- getContentFormatter() - Method in class org.springframework.ai.document.Document
-
Returns the content formatter associated with this document.
- getCustomMetadata() - Method in class org.springframework.ai.reader.TextReader
-
Metadata associated with all documents created by the loader.
- getData() - Method in class org.springframework.ai.content.Media
-
Get the media data object
- getDataAsByteArray() - Method in class org.springframework.ai.content.Media
-
Get the media data as a byte array
- getDataList() - Method in class org.springframework.ai.evaluation.EvaluationRequest
- getExcludedEmbedMetadataKeys() - Method in class org.springframework.ai.document.DefaultContentFormatter
- getExcludedInferenceMetadataKeys() - Method in class org.springframework.ai.document.DefaultContentFormatter
- getFeedback() - Method in class org.springframework.ai.evaluation.EvaluationResponse
- getFormattedContent() - Method in class org.springframework.ai.document.Document
- getFormattedContent(ContentFormatter, MetadataMode) - Method in class org.springframework.ai.document.Document
-
Helper content extractor that uses and external
ContentFormatter. - getFormattedContent(MetadataMode) - Method in class org.springframework.ai.document.Document
- getId() - Method in class org.springframework.ai.content.Media
-
Get the media id
- getId() - Method in class org.springframework.ai.document.Document
-
Returns the unique identifier for this document.
- getMedia() - Method in interface org.springframework.ai.content.MediaContent
-
Get the media associated with the content.
- getMedia() - Method in class org.springframework.ai.document.Document
-
Returns the document's media content, if any.
- getMetadata() - Method in interface org.springframework.ai.content.Content
-
Get the metadata associated with the content.
- getMetadata() - Method in class org.springframework.ai.document.Document
-
Returns the metadata associated with this document.
- getMetadata() - Method in class org.springframework.ai.evaluation.EvaluationResponse
- getMetadataSeparator() - Method in class org.springframework.ai.document.DefaultContentFormatter
- getMetadataTemplate() - Method in class org.springframework.ai.document.DefaultContentFormatter
- getMimeType() - Method in class org.springframework.ai.content.Media
-
Get the media MIME type
- getName() - Method in class org.springframework.ai.content.Media
- getResourceIdentifier(Resource) - Method in class org.springframework.ai.reader.TextReader
- getResponseContent() - Method in class org.springframework.ai.evaluation.EvaluationRequest
- getScore() - Method in class org.springframework.ai.document.Document
- getScore() - Method in class org.springframework.ai.evaluation.EvaluationResponse
- getText() - Method in interface org.springframework.ai.content.Content
-
Get the content of the message.
- getText() - Method in class org.springframework.ai.document.Document
-
Returns the document's text content, if any.
- getText(String) - Static method in class org.springframework.ai.util.ResourceUtils
-
Retrieves the content of a resource as a UTF-8 encoded string.
- getTextTemplate() - Method in class org.springframework.ai.document.DefaultContentFormatter
- getUserText() - Method in class org.springframework.ai.evaluation.EvaluationRequest
H
- HANA - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by HANA.
- hashCode() - Method in class org.springframework.ai.document.Document
- hashCode() - Method in class org.springframework.ai.evaluation.EvaluationRequest
- hashCode() - Method in class org.springframework.ai.evaluation.EvaluationResponse
- hashCode() - Method in record class org.springframework.ai.observation.AiOperationMetadata
-
Returns a hash code value for this object.
I
- id(String) - Method in class org.springframework.ai.content.Media.Builder
-
Sets the ID for the media object.
- id(String) - Method in class org.springframework.ai.document.Document.Builder
- idGenerator(IdGenerator) - Method in class org.springframework.ai.document.Document.Builder
- IdGenerator - Interface in org.springframework.ai.document.id
-
Interface for generating unique document IDs.
- IMAGE - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType
-
AI operation type for image.
- IMAGE_GIF - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
image/gif. - IMAGE_JPEG - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
image/jpeg. - IMAGE_PNG - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
image/png. - IMAGE_WEBP - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
image/webp. - INFERENCE - Enum constant in enum class org.springframework.ai.document.MetadataMode
- INPUT - Enum constant in enum class org.springframework.ai.observation.conventions.AiTokenType
-
Input token.
- instantiateAvailableModules() - Static method in class org.springframework.ai.util.JacksonUtils
-
Instantiate well-known Jackson modules available in the classpath.
- isCopyContentFormatter() - Method in class org.springframework.ai.transformer.splitter.TextSplitter
- isPass() - Method in class org.springframework.ai.evaluation.EvaluationResponse
- isText() - Method in class org.springframework.ai.document.Document
-
Determines whether this document contains text or media content.
J
- JacksonUtils - Class in org.springframework.ai.util
-
Utility methods for Jackson.
- JacksonUtils() - Constructor for class org.springframework.ai.util.JacksonUtils
- JdkSha256HexIdGenerator - Class in org.springframework.ai.document.id
-
A SHA-256 based ID generator that returns the hash as a UUID.
- JdkSha256HexIdGenerator() - Constructor for class org.springframework.ai.document.id.JdkSha256HexIdGenerator
- JdkSha256HexIdGenerator(String, Charset) - Constructor for class org.springframework.ai.document.id.JdkSha256HexIdGenerator
- JsonMetadataGenerator - Interface in org.springframework.ai.reader
- JsonReader - Class in org.springframework.ai.reader
-
A class that reads JSON documents and converts them into a list of
Documentobjects. - JsonReader(Resource) - Constructor for class org.springframework.ai.reader.JsonReader
- JsonReader(Resource, String...) - Constructor for class org.springframework.ai.reader.JsonReader
- JsonReader(Resource, JsonMetadataGenerator, String...) - Constructor for class org.springframework.ai.reader.JsonReader
- JTokkitTokenCountEstimator - Class in org.springframework.ai.tokenizer
-
Estimates the number of tokens in a given text or message using the JTokkit encoding library.
- JTokkitTokenCountEstimator() - Constructor for class org.springframework.ai.tokenizer.JTokkitTokenCountEstimator
-
Creates a new JTokkitTokenCountEstimator with default CL100K_BASE encoding.
- JTokkitTokenCountEstimator(EncodingType) - Constructor for class org.springframework.ai.tokenizer.JTokkitTokenCountEstimator
-
Creates a new JTokkitTokenCountEstimator with the specified encoding type.
L
- LoggingMarkers - Class in org.springframework.ai.util
-
Utility class that provides predefined SLF4J
Markerinstances used in logging operations within the application.
M
- MANHATTAN - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric
-
The manhattan distance metric.
- MARIADB - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by MariaDB.
- media(Media) - Method in class org.springframework.ai.document.Document.Builder
-
Sets the media content of the document.
- Media - Class in org.springframework.ai.content
-
The Media class represents the data and metadata of a media attachment in a message.
- Media(MimeType, URI) - Constructor for class org.springframework.ai.content.Media
-
Create a new Media instance.
- Media(MimeType, Resource) - Constructor for class org.springframework.ai.content.Media
-
Create a new Media instance.
- Media.Builder - Class in org.springframework.ai.content
-
Builder class for Media.
- Media.Format - Class in org.springframework.ai.content
-
Common media formats.
- MediaContent - Interface in org.springframework.ai.content
- metadata(String, Object) - Method in class org.springframework.ai.document.Document.Builder
- metadata(Map<String, Object>) - Method in class org.springframework.ai.document.Document.Builder
- METADATA_END_PAGE_NUMBER - Static variable in class org.springframework.ai.writer.FileDocumentWriter
- METADATA_START_PAGE_NUMBER - Static variable in class org.springframework.ai.writer.FileDocumentWriter
- metadataFilter(Map<String, Object>, MetadataMode) - Method in class org.springframework.ai.document.DefaultContentFormatter
-
Filters the metadata by the configured MetadataMode.
- MetadataMode - Enum Class in org.springframework.ai.document
- MILVUS - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Milvus.
- mimeType(MimeType) - Method in class org.springframework.ai.content.Media.Builder
-
Sets the MIME type for the media object.
- MINIMAX - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by Minimax.
- MISTRAL_AI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by Mistral.
- MONGODB - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by MongoDB.
- mutate() - Method in class org.springframework.ai.document.Document
N
- name(String) - Method in class org.springframework.ai.content.Media.Builder
-
Sets the name for the media object.
- NEO4J - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Neo4j.
- NONE - Enum constant in enum class org.springframework.ai.document.MetadataMode
- NONE - Enum constant in enum class org.springframework.ai.template.ValidationMode
-
No validation is performed.
- NoOpTemplateRenderer - Class in org.springframework.ai.template
-
No-op implementation of
TemplateRendererthat returns the template unchanged. - NoOpTemplateRenderer() - Constructor for class org.springframework.ai.template.NoOpTemplateRenderer
O
- ObservabilityHelper - Class in org.springframework.ai.observation
-
Utilities for observability.
- OCI_GENAI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by Oracle OCI.
- OLLAMA - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by Ollama.
- onError(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler
- onEvent(Observation.Event, T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler
- ONNX - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by ONNX.
- onScopeClosed(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler
- onScopeOpened(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler
- onScopeReset(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler
- onStart(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler
- onStop(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler
- OPENAI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by OpenAI.
- OPENSEARCH - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by OpenSearch.
- OPERATION_DURATION - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationMetricNames
-
The duration of the AI operation.
- operationType() - Method in record class org.springframework.ai.observation.AiOperationMetadata
-
Returns the value of the
operationTyperecord component. - operationType(String) - Method in class org.springframework.ai.observation.AiOperationMetadata.Builder
-
Set the operation type.
- ORACLE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Oracle.
- org.springframework.ai.content - package org.springframework.ai.content
-
Core observation abstractions.
- org.springframework.ai.document - package org.springframework.ai.document
- org.springframework.ai.document.id - package org.springframework.ai.document.id
- org.springframework.ai.embedding - package org.springframework.ai.embedding
- org.springframework.ai.evaluation - package org.springframework.ai.evaluation
- org.springframework.ai.observation - package org.springframework.ai.observation
-
Core observation abstractions.
- org.springframework.ai.observation.conventions - package org.springframework.ai.observation.conventions
-
Conventions for observation-based AI.
- org.springframework.ai.reader - package org.springframework.ai.reader
- org.springframework.ai.template - package org.springframework.ai.template
- org.springframework.ai.tokenizer - package org.springframework.ai.tokenizer
- org.springframework.ai.transformer - package org.springframework.ai.transformer
- org.springframework.ai.transformer.splitter - package org.springframework.ai.transformer.splitter
- org.springframework.ai.util - package org.springframework.ai.util
- org.springframework.ai.writer - package org.springframework.ai.writer
- OUTPUT - Enum constant in enum class org.springframework.ai.observation.conventions.AiTokenType
-
Output token.
- overrideLineSeparator(String) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder
-
Set the line separator to use when formatting the text.
P
- ParsingUtils - Class in org.springframework.ai.util
-
Utility methods for
Stringparsing. - PG_VECTOR - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by PGVector.
- PINECONE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Pinecone.
- provider() - Method in record class org.springframework.ai.observation.AiOperationMetadata
-
Returns the value of the
providerrecord component. - provider(String) - Method in class org.springframework.ai.observation.AiOperationMetadata.Builder
-
Set the provider.
- PUBLIC_DATA_MARKER - Static variable in class org.springframework.ai.util.LoggingMarkers
-
Marker used to identify log statements associated with public data, such as: Public documentation Marketing materials etc. There are no restriction for logging such information.
Q
- QDRANT - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Qdrand.
R
- RandomIdGenerator - Class in org.springframework.ai.document.id
-
A random ID generator that returns a UUID.
- RandomIdGenerator() - Constructor for class org.springframework.ai.document.id.RandomIdGenerator
- read() - Method in interface org.springframework.ai.document.DocumentReader
- reConcatenateCamelCase(String, String) - Static method in class org.springframework.ai.util.ParsingUtils
-
Reconcatenates the given camel-case source
Stringusing the given delimiter. - REDIS - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Redis.
- REGULATED_DATA_MARKER - Static variable in class org.springframework.ai.util.LoggingMarkers
-
Marker used to identify log statements associated with regulated data, such as: PCI (credit card data) PHI (health information) PII (personally identifiable info) Financial records Compliance-controlled data etc. Logging of such information should be avoided.
- REQUEST_EMBEDDING_DIMENSIONS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The number of dimensions the resulting output embeddings have.
- REQUEST_FREQUENCY_PENALTY - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The frequency penalty setting for the model request.
- REQUEST_IMAGE_RESPONSE_FORMAT - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The format in which the generated image is returned.
- REQUEST_IMAGE_SIZE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The size of the image to generate.
- REQUEST_IMAGE_STYLE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The style of the image to generate.
- REQUEST_MAX_TOKENS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The maximum number of tokens the model generates for a request.
- REQUEST_MODEL - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The name of the model a request is being made to.
- REQUEST_PRESENCE_PENALTY - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The presence penalty setting for the model request.
- REQUEST_STOP_SEQUENCES - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
List of sequences that the model will use to stop generating further tokens.
- REQUEST_TEMPERATURE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The temperature setting for the model request.
- REQUEST_TOOL_NAMES - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
List of tool definitions provided to the model in the request.
- REQUEST_TOP_K - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The top_k sampling setting for the model request.
- REQUEST_TOP_P - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The top_p sampling setting for the model request.
- ResourceUtils - Class in org.springframework.ai.util
-
Miscellaneous Resource utility methods.
- ResourceUtils() - Constructor for class org.springframework.ai.util.ResourceUtils
- RESPONSE_FINISH_REASONS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
Reasons the model stopped generating tokens, corresponding to each generation received.
- RESPONSE_ID - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The unique identifier for the AI response.
- RESPONSE_MODEL - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The name of the model that generated the response.
- RESTRICTED_DATA_MARKER - Static variable in class org.springframework.ai.util.LoggingMarkers
-
Marker used to identify log statements associated with restricted data, such as: Authentication credentials Keys and secrets Core intellectual property Critical security configs Trade secrets etc. Logging of such information is usually prohibited in any circumstances.
S
- score(Double) - Method in class org.springframework.ai.document.Document.Builder
-
Sets a score value for this document.
- SENSITIVE_DATA_MARKER - Static variable in class org.springframework.ai.util.LoggingMarkers
-
Marker used to identify log statements associated with sensitive data, such as: Internal business information Employee data Customer non-regulated data Business processes and logic etc. Typically, logging this information should be avoided.
- setCharset(Charset) - Method in class org.springframework.ai.reader.TextReader
- setContentFormatter(ContentFormatter) - Method in class org.springframework.ai.document.Document
-
Replace the document's
ContentFormatter. - setCopyContentFormatter(boolean) - Method in class org.springframework.ai.transformer.splitter.TextSplitter
- SIMPLE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by simple.
- SOURCE_METADATA - Static variable in class org.springframework.ai.reader.TextReader
- split(List<Document>) - Method in class org.springframework.ai.transformer.splitter.TextSplitter
- split(Document) - Method in class org.springframework.ai.transformer.splitter.TextSplitter
- splitCamelCase(String) - Static method in class org.springframework.ai.util.ParsingUtils
-
Splits up the given camel-case
String. - splitCamelCaseToLower(String) - Static method in class org.springframework.ai.util.ParsingUtils
-
Splits up the given camel-case
Stringand returns the parts in lower case. - splitText(String) - Method in class org.springframework.ai.transformer.splitter.TextSplitter
- splitText(String) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter
- SPRING_AI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by Spring AI.
- SpringAiKind - Enum Class in org.springframework.ai.observation.conventions
-
Types of Spring AI constructs which can be observed.
- supportsContext(Observation.Context) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler
T
- TemplateRenderer - Interface in org.springframework.ai.template
-
Renders a template using a given strategy.
- text(String) - Method in class org.springframework.ai.document.Document.Builder
-
Sets the text content of the document.
- TEXT_COMPLETION - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType
-
AI operation type for text completion.
- TextReader - Class in org.springframework.ai.reader
-
A
DocumentReaderthat reads text from aResource. - TextReader(String) - Constructor for class org.springframework.ai.reader.TextReader
- TextReader(Resource) - Constructor for class org.springframework.ai.reader.TextReader
- TextSplitter - Class in org.springframework.ai.transformer.splitter
- TextSplitter() - Constructor for class org.springframework.ai.transformer.splitter.TextSplitter
- THROW - Enum constant in enum class org.springframework.ai.template.ValidationMode
-
If the validation fails, an exception is thrown.
- TOKEN_TYPE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationMetricAttributes
-
The type of token being counted (input, output, total).
- TOKEN_USAGE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationMetricNames
-
The number of AI operations.
- TokenCountBatchingStrategy - Class in org.springframework.ai.embedding
-
Token count based strategy implementation for
BatchingStrategy. - TokenCountBatchingStrategy() - Constructor for class org.springframework.ai.embedding.TokenCountBatchingStrategy
- TokenCountBatchingStrategy(EncodingType, int, double) - Constructor for class org.springframework.ai.embedding.TokenCountBatchingStrategy
- TokenCountBatchingStrategy(EncodingType, int, double, ContentFormatter, MetadataMode) - Constructor for class org.springframework.ai.embedding.TokenCountBatchingStrategy
- TokenCountBatchingStrategy(TokenCountEstimator, int, double, ContentFormatter, MetadataMode) - Constructor for class org.springframework.ai.embedding.TokenCountBatchingStrategy
-
Constructs a TokenCountBatchingStrategy with the specified parameters.
- TokenCountEstimator - Interface in org.springframework.ai.tokenizer
-
Estimates the number of tokens in a given text or message.
- TokenTextSplitter - Class in org.springframework.ai.transformer.splitter
-
A
TextSplitterthat splits text into chunks of a target size in tokens. - TokenTextSplitter() - Constructor for class org.springframework.ai.transformer.splitter.TokenTextSplitter
- TokenTextSplitter(boolean) - Constructor for class org.springframework.ai.transformer.splitter.TokenTextSplitter
- TokenTextSplitter(int, int, int, int, boolean) - Constructor for class org.springframework.ai.transformer.splitter.TokenTextSplitter
- TokenTextSplitter.Builder - Class in org.springframework.ai.transformer.splitter
- TOOL_CALL - Enum constant in enum class org.springframework.ai.observation.conventions.SpringAiKind
-
Spring AI kind for tool calling.
- toString() - Method in class org.springframework.ai.document.Document
- toString() - Method in enum class org.springframework.ai.document.DocumentMetadata
- toString() - Method in class org.springframework.ai.evaluation.EvaluationRequest
- toString() - Method in class org.springframework.ai.evaluation.EvaluationResponse
- toString() - Method in record class org.springframework.ai.observation.AiOperationMetadata
-
Returns a string representation of this record class.
- TOTAL - Enum constant in enum class org.springframework.ai.observation.conventions.AiTokenType
-
Total token.
- TracingAwareLoggingObservationHandler<T extends io.micrometer.observation.Observation.Context> - Class in org.springframework.ai.observation
-
An
ObservationHandlerthat can wrap another one and makes the tracing data available for theObservationHandler.onStop(Observation.Context)method. - TracingAwareLoggingObservationHandler(ObservationHandler<T>, Tracer) - Constructor for class org.springframework.ai.observation.TracingAwareLoggingObservationHandler
-
Creates a new instance.
- transform(List<Document>) - Method in interface org.springframework.ai.document.DocumentTransformer
- trimAdjacentBlankLines(String) - Static method in class org.springframework.ai.reader.ExtractedTextFormatter
-
Replaces multiple, adjacent blank lines into a single blank line.
- TYPESENSE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Typesense.
U
- USAGE_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The number of tokens used in the model input.
- USAGE_OUTPUT_TOKENS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The number of tokens used in the model output.
- USAGE_TOTAL_TOKENS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
The total number of tokens used in the model exchange.
V
- ValidationMode - Enum Class in org.springframework.ai.template
-
Validation modes for template renderers.
- value() - Method in enum class org.springframework.ai.document.DocumentMetadata
- value() - Method in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
Return the value of the attribute key.
- value() - Method in enum class org.springframework.ai.observation.conventions.AiObservationMetricAttributes
-
Return the value of the metric attribute.
- value() - Method in enum class org.springframework.ai.observation.conventions.AiObservationMetricNames
-
Return the value of the metric name.
- value() - Method in enum class org.springframework.ai.observation.conventions.AiOperationType
-
Return the value of the operation type.
- value() - Method in enum class org.springframework.ai.observation.conventions.AiProvider
-
Return the value of the provider.
- value() - Method in enum class org.springframework.ai.observation.conventions.AiTokenType
-
Return the value of the token type.
- value() - Method in enum class org.springframework.ai.observation.conventions.SpringAiKind
-
Return the value of the Spring AI kind.
- value() - Method in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
Return the string value of the attribute.
- value() - Method in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Return the value of the vector store provider.
- value() - Method in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric
- valueOf(String) - Static method in enum class org.springframework.ai.document.DocumentMetadata
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.document.MetadataMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.AiObservationMetricAttributes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.AiObservationMetricNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.AiOperationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.AiProvider
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.AiTokenType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.SpringAiKind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.template.ValidationMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.springframework.ai.document.DocumentMetadata
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.document.MetadataMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.observation.conventions.AiObservationMetricAttributes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.observation.conventions.AiObservationMetricNames
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.observation.conventions.AiOperationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.observation.conventions.AiProvider
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.observation.conventions.AiTokenType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.observation.conventions.SpringAiKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.template.ValidationMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VECTOR_STORE - Enum constant in enum class org.springframework.ai.observation.conventions.SpringAiKind
-
Spring AI kind for vector store.
- VectorStoreObservationAttributes - Enum Class in org.springframework.ai.observation.conventions
-
Collection of attribute keys used in vector store observations (spans, metrics, events).
- VectorStoreProvider - Enum Class in org.springframework.ai.observation.conventions
-
Collection of systems providing vector store functionality.
- VectorStoreSimilarityMetric - Enum Class in org.springframework.ai.observation.conventions
-
Types of similarity metrics used in vector store operations.
- VERTEX_AI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by Vertex AI.
- VIDEO_FLV - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
video/x-flv. - VIDEO_MKV - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
video/x-matros. - VIDEO_MOV - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
video/quicktime. - VIDEO_MP4 - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
video/mp4. - VIDEO_MPEG - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
video/mpeg. - VIDEO_MPG - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
video/mpeg. - VIDEO_THREE_GP - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
video/3gpp. - VIDEO_WEBM - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
video/webm. - VIDEO_WMV - Static variable in class org.springframework.ai.content.Media.Format
-
Public constant mime type for
video/x-ms-wmv.
W
- WARN - Enum constant in enum class org.springframework.ai.template.ValidationMode
-
If the validation fails, a warning is logged.
- WEAVIATE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
-
Vector store provided by Weaviate.
- withChunkSize(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
- withExcludedEmbedMetadataKeys(String...) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder
- withExcludedEmbedMetadataKeys(List<String>) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder
-
Configures the excluded Embed metadata keys to filter out from the generative.
- withExcludedInferenceMetadataKeys(String...) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder
- withExcludedInferenceMetadataKeys(List<String>) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder
-
Configures the excluded Inference metadata keys to filter out from the generative.
- withKeepSeparator(boolean) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
- withLeftAlignment(boolean) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder
-
Align the document text to the left.
- withMaxNumChunks(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
- withMetadataSeparator(String) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder
-
Configures the Document metadata separator.
- withMetadataTemplate(String) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder
-
Configures the Document metadata template.
- withMinChunkLengthToEmbed(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
- withMinChunkSizeChars(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
- withNumberOfBottomTextLinesToDelete(int) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder
-
Remove the bottom N lines from the page text.
- withNumberOfTopPagesToSkipBeforeDelete(int) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder
-
Withdraw the top N pages from the text top/bottom line deletion.
- withNumberOfTopTextLinesToDelete(int) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder
-
Remove the top N lines from the page text.
- withTextTemplate(String) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder
-
Configures the Document text template.
- write(List<Document>) - Method in interface org.springframework.ai.document.DocumentWriter
Z
- ZHIPUAI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
-
AI system provided by Zhipuai.
All Classes and Interfaces|All Packages|Constant Field Values