org.noear.solon.ai.rag

Class Document

java.lang.Object

org.noear.solon.ai.rag.Document

@Preview(value="3.1")
public class Document
extends Object

文档

Since:

3.1

Author:

noear

Field Summary

Fields

Modifier and Type	Field and Description
protected String	content
protected String	id
protected Map<String,Object>	metadata
protected double	score

Constructor Summary

Constructors

Constructor and Description
Document()
Document(String content)
Document(String content, Map<String,Object> metadata)
Document(String id, String content, Map<String,Object> metadata, double score)

Method Summary

Modifier and Type	Method and Description
Document	content(String content) 设置内容
Document	embedding(float[] embedding) 设置嵌入矢量
String	getContent() 获取内容
float[]	getEmbedding() 设置嵌入矢量
String	getId() 获取 id
Map<String,Object>	getMetadata() 获取元数据
Object	getMetadata(String key) 获取元数据
double	getScore() 获取评分
String	getSummary() 获取摘要
String	getTitle() 获取标题
String	getUrl() 获取资源地址
Document	id(String id) 设置 id
Document	metadata(Map<String,Object> metadata) 添加元数据
Document	metadata(String key, Object value) 添加元数据
Document	score(double score) 设置评分
Document	summary(String summary) 摘要（可选）
Document	title(String title) 标题（可选）
String	toString()
Document	url(String url) 资源地址（可选）

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

content

protected String content

metadata

protected final Map<String,Object> metadata

score

protected transient double score

Constructor Detail

Document

public Document()

Document

public Document(String content)

Document

public Document(String content,
                Map<String,Object> metadata)

Document

public Document(String id,
                String content,
                Map<String,Object> metadata,
                double score)

Method Detail

id

public Document id(String id)

设置 id

getId

public String getId()

获取 id

content

public Document content(String content)

设置内容

getContent

public String getContent()

获取内容

embedding

public Document embedding(float[] embedding)

设置嵌入矢量

getEmbedding

public float[] getEmbedding()

设置嵌入矢量

getScore

public double getScore()

获取评分

score

public Document score(double score)

设置评分

getMetadata

public Map<String,Object> getMetadata()

获取元数据

toString

public String toString()

Overrides:

toString in class Object

metadata

public Document metadata(String key,
                         Object value)

添加元数据

metadata

public Document metadata(Map<String,Object> metadata)

添加元数据

getMetadata

public Object getMetadata(String key)

获取元数据

title

public Document title(String title)

标题（可选）

getTitle

public String getTitle()

获取标题

url

public Document url(String url)

资源地址（可选）

getUrl

public String getUrl()

获取资源地址

summary

public Document summary(String summary)

摘要（可选）

getSummary

public String getSummary()

获取摘要