Package dev.langchain4j.data.document.source

Class FileSystemSource

java.lang.Object

dev.langchain4j.data.document.source.FileSystemSource

All Implemented Interfaces:

DocumentSource

public class FileSystemSource
extends Object
implements DocumentSource

Field Summary

Fields

Modifier and Type	Field	Description
final Path	path

Constructor Summary

Constructors

Constructor	Description
FileSystemSource(Path path)

Method Summary

Modifier and Type	Method	Description
static FileSystemSource	from(File file)
static FileSystemSource	from(String filePath)
static FileSystemSource	from(URI fileUri)
static FileSystemSource	from(Path filePath)
InputStream	inputStream()	Provides an InputStream to read the content of the document.
Metadata	metadata()	Returns the metadata associated with the source of the document.

Methods inherited from class java.lang.Object

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

Field Details

path

public final Path path

Constructor Details

FileSystemSource

public FileSystemSource(Path path)

Method Details

inputStream

public InputStream inputStream()
                        throws IOException

Description copied from interface: DocumentSource

Provides an InputStream to read the content of the document. This method can be implemented to read from various sources like a local file or a network connection.

Specified by:

inputStream in interface DocumentSource

Returns:

An InputStream from which the document content can be read.

Throws:

IOException - If an I/O error occurs while creating the InputStream.

metadata

public Metadata metadata()

Description copied from interface: DocumentSource

Returns the metadata associated with the source of the document. This could include details such as the source location, date of creation, owner, etc.

Specified by:

metadata in interface DocumentSource

Returns:

A Metadata object containing information associated with the source of the document.

from

public static FileSystemSource from(Path filePath)

from

public static FileSystemSource from(String filePath)

from

public static FileSystemSource from(URI fileUri)

from

public static FileSystemSource from(File file)