Uses of Interface
dev.langchain4j.data.document.Document

Packages that use Document

Package	Description
dev.langchain4j.classification
dev.langchain4j.data.document
dev.langchain4j.data.document.loader
dev.langchain4j.data.document.loader.amazon.s3
dev.langchain4j.data.document.loader.azure.storage.blob
dev.langchain4j.data.document.loader.gcs
dev.langchain4j.data.document.loader.github
dev.langchain4j.data.document.loader.selenium
dev.langchain4j.data.document.loader.tencent.cos
dev.langchain4j.data.document.parser
dev.langchain4j.data.document.parser.apache.pdfbox
dev.langchain4j.data.document.parser.apache.poi
dev.langchain4j.data.document.parser.apache.tika
dev.langchain4j.data.document.splitter
dev.langchain4j.data.document.transformer.jsoup
dev.langchain4j.rag.content.retriever.azure.search
dev.langchain4j.store.embedding
dev.langchain4j.web.search

Uses of Document in dev.langchain4j.classification

Methods in dev.langchain4j.classification with parameters of type Document

Modifier and Type	Method	Description
default List<L>	TextClassifier.classify(Document document)	Classifies the given Document.
default ClassificationResult<L>	TextClassifier.classifyWithScores(Document document)	Classifies the given Document and returns labels with scores.

Uses of Document in dev.langchain4j.data.document

Classes in dev.langchain4j.data.document that implement Document

Modifier and Type	Class	Description
final record	DefaultDocument	A default implementation of a Document.

Methods in dev.langchain4j.data.document that return Document

Modifier and Type	Method	Description
static Document	Document.document(String text)	Creates a new Document from the given text.
static Document	Document.document(String text, Metadata metadata)	Creates a new Document from the given text.
static Document	Document.from(String text)	Creates a new Document from the given text.
static Document	Document.from(String text, Metadata metadata)	Creates a new Document from the given text.
static Document	DocumentLoader.load(DocumentSource source, DocumentParser parser)	Loads a document from the given source using the given parser.
Document	DocumentParser.parse(InputStream inputStream)	Parses a given InputStream into a Document.
Document	DocumentTransformer.transform(Document document)	Transforms a provided document.

Methods in dev.langchain4j.data.document that return types with arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentTransformer.transformAll(List<Document> documents)	Transforms all the provided documents.

Methods in dev.langchain4j.data.document with parameters of type Document

Modifier and Type	Method	Description
List<TextSegment>	DocumentSplitter.split(Document document)	Splits a single Document into a list of TextSegment objects.
Document	DocumentTransformer.transform(Document document)	Transforms a provided document.

Method parameters in dev.langchain4j.data.document with type arguments of type Document

Modifier and Type	Method	Description
default List<TextSegment>	DocumentSplitter.splitAll(List<Document> documents)	Splits a list of Documents into a list of TextSegment objects.
default List<Document>	DocumentTransformer.transformAll(List<Document> documents)	Transforms all the provided documents.

Uses of Document in dev.langchain4j.data.document.loader

Methods in dev.langchain4j.data.document.loader that return Document

Modifier and Type	Method	Description
static Document	UrlDocumentLoader.load(String url, DocumentParser documentParser)	Loads a document from the specified URL.
static Document	UrlDocumentLoader.load(URL url, DocumentParser documentParser)	Loads a document from the specified URL.
static Document	ClassPathDocumentLoader.loadDocument(String pathOnClasspath)	Loads a Document from the specified file path.
static Document	ClassPathDocumentLoader.loadDocument(String pathOnClasspath, DocumentParser documentParser)	Loads a Document from the specified file path.
static Document	FileSystemDocumentLoader.loadDocument(String filePath)	Loads a Document from the specified file path.
static Document	FileSystemDocumentLoader.loadDocument(String filePath, DocumentParser documentParser)	Loads a Document from the specified file path.
static Document	FileSystemDocumentLoader.loadDocument(Path filePath)	Loads a Document from the specified file Path.
static Document	FileSystemDocumentLoader.loadDocument(Path filePath, DocumentParser documentParser)	Loads a Document from the specified file Path.

Methods in dev.langchain4j.data.document.loader that return types with arguments of type Document

Modifier and Type	Method	Description
static List<Document>	ClassPathDocumentLoader.loadDocuments(String directoryOnClasspath)	Loads Documents from the specified directory.
static List<Document>	ClassPathDocumentLoader.loadDocuments(String directoryOnClasspath, DocumentParser documentParser)	Loads Documents from the specified directory.
static List<Document>	ClassPathDocumentLoader.loadDocuments(String directoryOnClasspath, PathMatcher pathMatcher)	Loads matching Documents from the specified directory.
static List<Document>	ClassPathDocumentLoader.loadDocuments(String directoryOnClasspath, PathMatcher pathMatcher, DocumentParser documentParser)	Loads matching Documents from the specified directory.
static List<Document>	FileSystemDocumentLoader.loadDocuments(String directoryPath)	Loads Documents from the specified directory.
static List<Document>	FileSystemDocumentLoader.loadDocuments(String directoryPath, DocumentParser documentParser)	Loads Documents from the specified directory.
static List<Document>	FileSystemDocumentLoader.loadDocuments(String directoryPath, PathMatcher pathMatcher)	Loads matching Documents from the specified directory.
static List<Document>	FileSystemDocumentLoader.loadDocuments(String directoryPath, PathMatcher pathMatcher, DocumentParser documentParser)	Loads matching Documents from the specified directory.
static List<Document>	FileSystemDocumentLoader.loadDocuments(Path directoryPath)	Loads Documents from the specified directory.
static List<Document>	FileSystemDocumentLoader.loadDocuments(Path directoryPath, DocumentParser documentParser)	Loads Documents from the specified directory.
static List<Document>	FileSystemDocumentLoader.loadDocuments(Path directoryPath, PathMatcher pathMatcher)	Loads matching Documents from the specified directory.
static List<Document>	FileSystemDocumentLoader.loadDocuments(Path directoryPath, PathMatcher pathMatcher, DocumentParser documentParser)	Loads matching Documents from the specified directory.
static List<Document>	ClassPathDocumentLoader.loadDocumentsRecursively(String directoryOnClasspath)	Recursively loads Documents from the specified directory and its subdirectories.
static List<Document>	ClassPathDocumentLoader.loadDocumentsRecursively(String directoryOnClasspath, DocumentParser documentParser)	Recursively loads Documents from the specified directory and its subdirectories.
static List<Document>	ClassPathDocumentLoader.loadDocumentsRecursively(String directoryOnClasspath, PathMatcher pathMatcher)	Recursively loads matching Documents from the specified directory and its subdirectories.
static List<Document>	ClassPathDocumentLoader.loadDocumentsRecursively(String directoryOnClasspath, PathMatcher pathMatcher, DocumentParser documentParser)	Recursively loads matching Documents from the specified directory and its subdirectories.
static List<Document>	FileSystemDocumentLoader.loadDocumentsRecursively(String directoryPath)	Recursively loads Documents from the specified directory and its subdirectories.
static List<Document>	FileSystemDocumentLoader.loadDocumentsRecursively(String directoryPath, DocumentParser documentParser)	Recursively loads Documents from the specified directory and its subdirectories.
static List<Document>	FileSystemDocumentLoader.loadDocumentsRecursively(String directoryPath, PathMatcher pathMatcher)	Recursively loads matching Documents from the specified directory and its subdirectories.
static List<Document>	FileSystemDocumentLoader.loadDocumentsRecursively(String directoryPath, PathMatcher pathMatcher, DocumentParser documentParser)	Recursively loads matching Documents from the specified directory and its subdirectories.
static List<Document>	FileSystemDocumentLoader.loadDocumentsRecursively(Path directoryPath)	Recursively loads Documents from the specified directory and its subdirectories.
static List<Document>	FileSystemDocumentLoader.loadDocumentsRecursively(Path directoryPath, DocumentParser documentParser)	Recursively loads Documents from the specified directory and its subdirectories.
static List<Document>	FileSystemDocumentLoader.loadDocumentsRecursively(Path directoryPath, PathMatcher pathMatcher)	Recursively loads matching Documents from the specified directory and its subdirectories.
static List<Document>	FileSystemDocumentLoader.loadDocumentsRecursively(Path directoryPath, PathMatcher pathMatcher, DocumentParser documentParser)	Recursively loads matching Documents from the specified directory and its subdirectories.

Uses of Document in dev.langchain4j.data.document.loader.amazon.s3

Methods in dev.langchain4j.data.document.loader.amazon.s3 that return Document

Modifier and Type	Method	Description
Document	AmazonS3DocumentLoader.loadDocument(String bucket, String key, DocumentParser parser)	Loads a single document from the specified S3 bucket based on the specified object key.

Methods in dev.langchain4j.data.document.loader.amazon.s3 that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	AmazonS3DocumentLoader.loadDocuments(String bucket, DocumentParser parser)	Loads all documents from an S3 bucket.
List<Document>	AmazonS3DocumentLoader.loadDocuments(String bucket, String prefix, DocumentParser parser)	Loads all documents from an S3 bucket.

Uses of Document in dev.langchain4j.data.document.loader.azure.storage.blob

Methods in dev.langchain4j.data.document.loader.azure.storage.blob that return Document

Modifier and Type	Method	Description
Document	AzureBlobStorageDocumentLoader.loadDocument(String containerName, String blobName, DocumentParser parser)

Methods in dev.langchain4j.data.document.loader.azure.storage.blob that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	AzureBlobStorageDocumentLoader.loadDocuments(String containerName, DocumentParser parser)

Uses of Document in dev.langchain4j.data.document.loader.gcs

Methods in dev.langchain4j.data.document.loader.gcs that return Document

Modifier and Type	Method	Description
Document	GoogleCloudStorageDocumentLoader.loadDocument(String bucket, String objectName, DocumentParser parser)	Loads a single document from the specified Google Cloud Storage bucket based on the specified object key.

Methods in dev.langchain4j.data.document.loader.gcs that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	GoogleCloudStorageDocumentLoader.loadDocuments(String bucket, DocumentParser parser)	Loads all documents from an GCS bucket.
List<Document>	GoogleCloudStorageDocumentLoader.loadDocuments(String bucket, String globPattern, DocumentParser parser)	Load a list of documents from the specified bucket, filtered with a glob pattern.

Uses of Document in dev.langchain4j.data.document.loader.github

Methods in dev.langchain4j.data.document.loader.github that return Document

Modifier and Type	Method	Description
Document	GitHubDocumentLoader.loadDocument(String owner, String repo, String branch, String path, DocumentParser parser)

Methods in dev.langchain4j.data.document.loader.github that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	GitHubDocumentLoader.loadDocuments(String owner, String repo, String branch, DocumentParser parser)
List<Document>	GitHubDocumentLoader.loadDocuments(String owner, String repo, String branch, String path, DocumentParser parser)

Uses of Document in dev.langchain4j.data.document.loader.selenium

Methods in dev.langchain4j.data.document.loader.selenium that return Document

Modifier and Type	Method	Description
Document	SeleniumDocumentLoader.load(String url, DocumentParser documentParser)	Loads a document from the specified URL.

Uses of Document in dev.langchain4j.data.document.loader.tencent.cos

Methods in dev.langchain4j.data.document.loader.tencent.cos that return Document

Modifier and Type	Method	Description
Document	TencentCosDocumentLoader.loadDocument(String bucket, String key, DocumentParser parser)	Loads a single document from the specified COS bucket based on the specified object key.

Methods in dev.langchain4j.data.document.loader.tencent.cos that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	TencentCosDocumentLoader.loadDocuments(String bucket, DocumentParser parser)	Loads all documents from an COS bucket.
List<Document>	TencentCosDocumentLoader.loadDocuments(String bucket, String prefix, DocumentParser parser)	Loads all documents from an COS bucket.

Uses of Document in dev.langchain4j.data.document.parser

Methods in dev.langchain4j.data.document.parser that return Document

Modifier and Type	Method	Description
Document	TextDocumentParser.parse(InputStream inputStream)

Uses of Document in dev.langchain4j.data.document.parser.apache.pdfbox

Methods in dev.langchain4j.data.document.parser.apache.pdfbox that return Document

Modifier and Type	Method	Description
Document	ApachePdfBoxDocumentParser.parse(InputStream inputStream)

Uses of Document in dev.langchain4j.data.document.parser.apache.poi

Methods in dev.langchain4j.data.document.parser.apache.poi that return Document

Modifier and Type	Method	Description
Document	ApachePoiDocumentParser.parse(InputStream inputStream)

Uses of Document in dev.langchain4j.data.document.parser.apache.tika

Methods in dev.langchain4j.data.document.parser.apache.tika that return Document

Modifier and Type	Method	Description
Document	ApacheTikaDocumentParser.parse(InputStream inputStream)

Uses of Document in dev.langchain4j.data.document.splitter

Methods in dev.langchain4j.data.document.splitter with parameters of type Document

Modifier and Type	Method	Description
List<TextSegment>	HierarchicalDocumentSplitter.split(Document document)

Uses of Document in dev.langchain4j.data.document.transformer.jsoup

Methods in dev.langchain4j.data.document.transformer.jsoup that return Document

Modifier and Type	Method	Description
Document	HtmlToTextDocumentTransformer.transform(Document document)

Methods in dev.langchain4j.data.document.transformer.jsoup with parameters of type Document

Modifier and Type	Method	Description
Document	HtmlToTextDocumentTransformer.transform(Document document)

Uses of Document in dev.langchain4j.rag.content.retriever.azure.search

Methods in dev.langchain4j.rag.content.retriever.azure.search with parameters of type Document

Modifier and Type	Method	Description
void	AzureAiSearchContentRetriever.add(Document document)	Add Document to the full text search engine.

Uses of Document in dev.langchain4j.store.embedding

Methods in dev.langchain4j.store.embedding with parameters of type Document

Modifier and Type	Method	Description
IngestionResult	EmbeddingStoreIngestor.ingest(Document document)	Ingests a specified document into an EmbeddingStore that was specified during the creation of this EmbeddingStoreIngestor.
IngestionResult	EmbeddingStoreIngestor.ingest(Document... documents)	Ingests specified documents into an EmbeddingStore that was specified during the creation of this EmbeddingStoreIngestor.
static IngestionResult	EmbeddingStoreIngestor.ingest(Document document, EmbeddingStore<TextSegment> embeddingStore)	Ingests a specified Document into a specified EmbeddingStore.

Method parameters in dev.langchain4j.store.embedding with type arguments of type Document

Modifier and Type	Method	Description
IngestionResult	EmbeddingStoreIngestor.ingest(List<Document> documents)	Ingests specified documents into an EmbeddingStore that was specified during the creation of this EmbeddingStoreIngestor.
static IngestionResult	EmbeddingStoreIngestor.ingest(List<Document> documents, EmbeddingStore<TextSegment> embeddingStore)	Ingests specified Documents into a specified EmbeddingStore.

Uses of Document in dev.langchain4j.web.search

Methods in dev.langchain4j.web.search that return Document

Modifier and Type	Method	Description
Document	WebSearchOrganicResult.toDocument()	Converts this WebSearchOrganicResult to a Document.

Methods in dev.langchain4j.web.search that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	WebSearchResults.toDocuments()	Converts the organic search results to a list of documents.