类的使用
com.agentsflex.core.document.Document

使用Document的程序包

程序包	说明
com.agentsflex.core.document
com.agentsflex.core.document.id
com.agentsflex.core.document.splitter
com.agentsflex.core.model.embedding
com.agentsflex.core.model.rerank
com.agentsflex.core.store

com.agentsflex.core.document中Document的使用

返回Document的com.agentsflex.core.document中的方法

修饰符和类型	方法	说明
static Document	Document.of(String content)

返回变量类型为Document的类型的com.agentsflex.core.document中的方法

修饰符和类型	方法	说明
default List<Document>	DocumentSplitter.split(Document text)
List<Document>	DocumentSplitter.split(Document text, DocumentIdGenerator idGenerator)
default List<Document>	DocumentSplitter.splitAll(List<Document> documents, DocumentIdGenerator idGenerator)

参数类型为Document的com.agentsflex.core.document中的方法

修饰符和类型	方法	说明
default List<Document>	DocumentSplitter.split(Document text)
List<Document>	DocumentSplitter.split(Document text, DocumentIdGenerator idGenerator)

类型变量类型为Document的com.agentsflex.core.document中的方法参数

修饰符和类型	方法	说明
default List<Document>	DocumentSplitter.splitAll(List<Document> documents, DocumentIdGenerator idGenerator)

com.agentsflex.core.document.id中Document的使用

参数类型为Document的com.agentsflex.core.document.id中的方法

修饰符和类型	方法	说明
Object	DocumentIdGenerator.generateId(Document document)	Generate a unique ID for the Document
Object	MD5IdGenerator.generateId(Document document)	Generate a unique ID for the Document
Object	RandomIdGenerator.generateId(Document document)	Generate a unique ID for the Document

com.agentsflex.core.document.splitter中Document的使用

返回变量类型为Document的类型的com.agentsflex.core.document.splitter中的方法

修饰符和类型	方法	说明
List<Document>	AIDocumentSplitter.split(Document document, DocumentIdGenerator idGenerator)
List<Document>	MarkdownHeaderSplitter.split(Document document, DocumentIdGenerator idGenerator)
List<Document>	RegexDocumentSplitter.split(Document document, DocumentIdGenerator idGenerator)
List<Document>	SimpleDocumentSplitter.split(Document document, DocumentIdGenerator idGenerator)
List<Document>	SimpleTokenizeSplitter.split(Document document, DocumentIdGenerator idGenerator)

参数类型为Document的com.agentsflex.core.document.splitter中的方法

修饰符和类型	方法	说明
private void	MarkdownHeaderSplitter.flushChunk(List<MarkdownHeaderSplitter.DocumentChunk> chunks, String content, Deque<MarkdownHeaderSplitter.HeaderInfo> headerStack, int startLine, int endLine, Document sourceDoc)
List<Document>	AIDocumentSplitter.split(Document document, DocumentIdGenerator idGenerator)
List<Document>	MarkdownHeaderSplitter.split(Document document, DocumentIdGenerator idGenerator)
List<Document>	RegexDocumentSplitter.split(Document document, DocumentIdGenerator idGenerator)
List<Document>	SimpleDocumentSplitter.split(Document document, DocumentIdGenerator idGenerator)
List<Document>	SimpleTokenizeSplitter.split(Document document, DocumentIdGenerator idGenerator)

com.agentsflex.core.model.embedding中Document的使用

参数类型为Document的com.agentsflex.core.model.embedding中的方法

修饰符和类型	方法	说明
default VectorData	EmbeddingModel.embed(Document document)
VectorData	EmbeddingModel.embed(Document document, EmbeddingOptions options)

com.agentsflex.core.model.rerank中Document的使用

返回变量类型为Document的类型的com.agentsflex.core.model.rerank中的方法

修饰符和类型	方法	说明
default List<Document>	RerankModel.rerank(String query, List<Document> documents)
List<Document>	RerankModel.rerank(String query, List<Document> documents, RerankOptions options)

类型变量类型为Document的com.agentsflex.core.model.rerank中的方法参数

修饰符和类型	方法	说明
default List<Document>	RerankModel.rerank(String query, List<Document> documents)
List<Document>	RerankModel.rerank(String query, List<Document> documents, RerankOptions options)

com.agentsflex.core.store中Document的使用

返回变量类型为Document的类型的com.agentsflex.core.store中的方法

修饰符和类型	方法	说明
abstract List<Document>	DocumentStore.doSearch(SearchWrapper wrapper, StoreOptions options)
List<Document>	DocumentStore.search(SearchWrapper wrapper, StoreOptions options)

类型变量类型为Document的com.agentsflex.core.store中的方法参数

修饰符和类型	方法	说明
abstract StoreResult	DocumentStore.doStore(List<Document> documents, StoreOptions options)
abstract StoreResult	DocumentStore.doUpdate(List<Document> documents, StoreOptions options)
protected void	DocumentStore.embedDocumentsIfNecessary(List<Document> documents, StoreOptions options)
StoreResult	DocumentStore.store(List<Document> documents, StoreOptions options)
static StoreResult	StoreResult.successWithIds(List<Document> documents)
StoreResult	DocumentStore.update(List<Document> documents, StoreOptions options)