Document (common-dify-client 1.0.3 API)

java.lang.Object
- com.dify.client.params.documents.Document

```
public class Document
extends Object
```
文档

嵌套类概要

嵌套类
限定符和类型类和说明

static class Document.DocumentBuilder

嵌套类
限定符和类型	类和说明
`static class`	`Document.DocumentBuilder`

构造器概要

构造器
构造器和说明
`Document()`
Document(String id, int position, String dataSourceType, DataSourceInfo dataSourceInfo, String datasetProcessRuleId, String name, String createdFrom, String createdBy, Long createdAt, Integer tokens, String indexingStatus, Long completedAt, long updatedAt, Long indexingLatency, String error, boolean enabled, Long disabledAt, String disabledBy, boolean archived, int segmentCount, int averageSegmentLength, Integer wordCount, Integer hitCount, String displayStatus, String docForm, String docLanguage, List<Metadata> docMetadata)

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static Document.DocumentBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`int`	`getAverageSegmentLength()` 平均分段长度
`Long`	`getCompletedAt()` 完成时间戳（可能为null）
`Long`	`getCreatedAt()` 创建时间戳（秒级）
`String`	`getCreatedBy()` 文档创建者ID
`String`	`getCreatedFrom()` 文档创建来源，例如：web, api 等
`String`	`getDatasetProcessRuleId()` 数据集处理规则ID
`DataSourceInfo`	`getDataSourceInfo()` 数据来源详细信息
`String`	`getDataSourceType()` 数据来源类型，例如：upload_file, web 等
`Long`	`getDisabledAt()` 禁用时间（可能为null）
`String`	`getDisabledBy()` 禁用者ID（可能为null）
`String`	`getDisplayStatus()` 展示状态，如 queuing, indexing 等
`String`	`getDocForm()` 文档形式，如 hierarchical_model
`String`	`getDocLanguage()` 文档语言，如 Chinese Simplified
`List<Metadata>`	`getDocMetadata()` 文档元数据
`String`	`getError()` 错误信息（可能为null）
`Integer`	`getHitCount()` 命中次数（可能为null）
`String`	`getId()` 文档唯一ID
`Long`	`getIndexingLatency()` 索引耗时（可能为null）
`String`	`getIndexingStatus()` 索引状态，如 waiting, completed 等
`String`	`getName()` 文档名称
`int`	`getPosition()` 文档在文档集中的位置序号
`int`	`getSegmentCount()` 分段数量
`Integer`	`getTokens()` 文档总Token数（可能为null）
`long`	`getUpdatedAt()` 最后更新时间戳（秒级）
`Integer`	`getWordCount()` 文字数
`int`	`hashCode()`
`boolean`	`isArchived()` 是否已归档
`boolean`	`isEnabled()` 是否启用文档
`void`	`setArchived(boolean archived)` 是否已归档
`void`	`setAverageSegmentLength(int averageSegmentLength)` 平均分段长度
`void`	`setCompletedAt(Long completedAt)` 完成时间戳（可能为null）
`void`	`setCreatedAt(Long createdAt)` 创建时间戳（秒级）
`void`	`setCreatedBy(String createdBy)` 文档创建者ID
`void`	`setCreatedFrom(String createdFrom)` 文档创建来源，例如：web, api 等
`void`	`setDatasetProcessRuleId(String datasetProcessRuleId)` 数据集处理规则ID
`void`	`setDataSourceInfo(DataSourceInfo dataSourceInfo)` 数据来源详细信息
`void`	`setDataSourceType(String dataSourceType)` 数据来源类型，例如：upload_file, web 等
`void`	`setDisabledAt(Long disabledAt)` 禁用时间（可能为null）
`void`	`setDisabledBy(String disabledBy)` 禁用者ID（可能为null）
`void`	`setDisplayStatus(String displayStatus)` 展示状态，如 queuing, indexing 等
`void`	`setDocForm(String docForm)` 文档形式，如 hierarchical_model
`void`	`setDocLanguage(String docLanguage)` 文档语言，如 Chinese Simplified
`void`	`setDocMetadata(List<Metadata> docMetadata)` 文档元数据
`void`	`setEnabled(boolean enabled)` 是否启用文档
`void`	`setError(String error)` 错误信息（可能为null）
`void`	`setHitCount(Integer hitCount)` 命中次数（可能为null）
`void`	`setId(String id)` 文档唯一ID
`void`	`setIndexingLatency(Long indexingLatency)` 索引耗时（可能为null）
`void`	`setIndexingStatus(String indexingStatus)` 索引状态，如 waiting, completed 等
`void`	`setName(String name)` 文档名称
`void`	`setPosition(int position)` 文档在文档集中的位置序号
`void`	`setSegmentCount(int segmentCount)` 分段数量
`void`	`setTokens(Integer tokens)` 文档总Token数（可能为null）
`void`	`setUpdatedAt(long updatedAt)` 最后更新时间戳（秒级）
`void`	`setWordCount(Integer wordCount)` 文字数
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

Document
```
public Document()
```

Document

public Document(String id,
                int position,
                String dataSourceType,
                DataSourceInfo dataSourceInfo,
                String datasetProcessRuleId,
                String name,
                String createdFrom,
                String createdBy,
                Long createdAt,
                Integer tokens,
                String indexingStatus,
                Long completedAt,
                long updatedAt,
                Long indexingLatency,
                String error,
                boolean enabled,
                Long disabledAt,
                String disabledBy,
                boolean archived,
                int segmentCount,
                int averageSegmentLength,
                Integer wordCount,
                Integer hitCount,
                String displayStatus,
                String docForm,
                String docLanguage,
                List<Metadata> docMetadata)

方法详细资料

builder

public static Document.DocumentBuilder builder()

getId
```
public String getId()
```
文档唯一ID

getPosition
```
public int getPosition()
```
文档在文档集中的位置序号

getDataSourceType
```
public String getDataSourceType()
```
数据来源类型，例如：upload_file, web 等

getDataSourceInfo

public DataSourceInfo getDataSourceInfo()

数据来源详细信息

getDatasetProcessRuleId
```
public String getDatasetProcessRuleId()
```
数据集处理规则ID

getName
```
public String getName()
```
文档名称

getCreatedFrom
```
public String getCreatedFrom()
```
文档创建来源，例如：web, api 等

getCreatedBy
```
public String getCreatedBy()
```
文档创建者ID

getCreatedAt
```
public Long getCreatedAt()
```
创建时间戳（秒级）

getTokens
```
public Integer getTokens()
```
文档总Token数（可能为null）

getIndexingStatus
```
public String getIndexingStatus()
```
索引状态，如 waiting, completed 等

getCompletedAt
```
public Long getCompletedAt()
```
完成时间戳（可能为null）

getUpdatedAt
```
public long getUpdatedAt()
```
最后更新时间戳（秒级）

getIndexingLatency
```
public Long getIndexingLatency()
```
索引耗时（可能为null）

getError
```
public String getError()
```
错误信息（可能为null）

isEnabled
```
public boolean isEnabled()
```
是否启用文档

getDisabledAt
```
public Long getDisabledAt()
```
禁用时间（可能为null）

getDisabledBy
```
public String getDisabledBy()
```
禁用者ID（可能为null）

isArchived
```
public boolean isArchived()
```
是否已归档

getSegmentCount
```
public int getSegmentCount()
```
分段数量

getAverageSegmentLength
```
public int getAverageSegmentLength()
```
平均分段长度

getWordCount
```
public Integer getWordCount()
```
文字数

getHitCount
```
public Integer getHitCount()
```
命中次数（可能为null）

getDisplayStatus
```
public String getDisplayStatus()
```
展示状态，如 queuing, indexing 等

getDocForm
```
public String getDocForm()
```
文档形式，如 hierarchical_model

getDocLanguage
```
public String getDocLanguage()
```
文档语言，如 Chinese Simplified

getDocMetadata

public List<Metadata> getDocMetadata()

文档元数据

setId
```
public void setId(String id)
```
文档唯一ID

setPosition
```
public void setPosition(int position)
```
文档在文档集中的位置序号

setDataSourceType
```
public void setDataSourceType(String dataSourceType)
```
数据来源类型，例如：upload_file, web 等

setDataSourceInfo

public void setDataSourceInfo(DataSourceInfo dataSourceInfo)

数据来源详细信息

setDatasetProcessRuleId

public void setDatasetProcessRuleId(String datasetProcessRuleId)

数据集处理规则ID

setName
```
public void setName(String name)
```
文档名称

setCreatedFrom
```
public void setCreatedFrom(String createdFrom)
```
文档创建来源，例如：web, api 等

setCreatedBy

public void setCreatedBy(String createdBy)

文档创建者ID

setCreatedAt

public void setCreatedAt(Long createdAt)

创建时间戳（秒级）

setTokens
```
public void setTokens(Integer tokens)
```
文档总Token数（可能为null）

setIndexingStatus
```
public void setIndexingStatus(String indexingStatus)
```
索引状态，如 waiting, completed 等

setCompletedAt

public void setCompletedAt(Long completedAt)

完成时间戳（可能为null）

setUpdatedAt
```
public void setUpdatedAt(long updatedAt)
```
最后更新时间戳（秒级）

setIndexingLatency

public void setIndexingLatency(Long indexingLatency)

索引耗时（可能为null）

setError
```
public void setError(String error)
```
错误信息（可能为null）

setEnabled

public void setEnabled(boolean enabled)

是否启用文档

setDisabledAt

public void setDisabledAt(Long disabledAt)

禁用时间（可能为null）

setDisabledBy

public void setDisabledBy(String disabledBy)

禁用者ID（可能为null）

setArchived

public void setArchived(boolean archived)

是否已归档

setSegmentCount

public void setSegmentCount(int segmentCount)

分段数量

setAverageSegmentLength

public void setAverageSegmentLength(int averageSegmentLength)

平均分段长度

setWordCount

public void setWordCount(Integer wordCount)

文字数

setHitCount

public void setHitCount(Integer hitCount)

命中次数（可能为null）

setDisplayStatus
```
public void setDisplayStatus(String displayStatus)
```
展示状态，如 queuing, indexing 等

setDocForm
```
public void setDocForm(String docForm)
```
文档形式，如 hierarchical_model

setDocLanguage

public void setDocLanguage(String docLanguage)

文档语言，如 Chinese Simplified

setDocMetadata

public void setDocMetadata(List<Metadata> docMetadata)

文档元数据

equals
```
public boolean equals(Object o)
```
覆盖:

equals 在类中 Object

canEqual

protected boolean canEqual(Object other)

hashCode
```
public int hashCode()
```
覆盖:

hashCode 在类中 Object

toString
```
public String toString()
```
覆盖:

toString 在类中 Object

类 Document

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Document

Document

方法详细资料

builder

getId

getPosition

getDataSourceType

getDataSourceInfo

getDatasetProcessRuleId

getName

getCreatedFrom

getCreatedBy

getCreatedAt

getTokens

getIndexingStatus

getCompletedAt

getUpdatedAt

getIndexingLatency

getError

isEnabled

getDisabledAt

getDisabledBy

isArchived

getSegmentCount

getAverageSegmentLength

getWordCount

getHitCount

getDisplayStatus

getDocForm

getDocLanguage

getDocMetadata

setId

setPosition

setDataSourceType

setDataSourceInfo

setDatasetProcessRuleId

setName

setCreatedFrom

setCreatedBy

setCreatedAt

setTokens

setIndexingStatus

setCompletedAt

setUpdatedAt

setIndexingLatency

setError

setEnabled

setDisabledAt

setDisabledBy

setArchived

setSegmentCount

setAverageSegmentLength

setWordCount

setHitCount

setDisplayStatus

setDocForm

setDocLanguage

setDocMetadata

equals

canEqual

hashCode

toString