AddDocumentRequest (common-dify-client 1.0.3 API)

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

public class AddDocumentRequest
extends Object

通过文本新增文档

嵌套类概要

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

static class AddDocumentRequest.AddDocumentRequestBuilder

嵌套类
限定符和类型	类和说明
`static class`	`AddDocumentRequest.AddDocumentRequestBuilder`

构造器概要

构造器
构造器和说明
`AddDocumentRequest()`
`AddDocumentRequest(String name, String text, Boolean defaultLibrary, Boolean isFirst)` 创建一个默认的业务卡片库
`AddDocumentRequest(String name, String text, String indexingTechnique, String docForm, String docLanguage, ProcessingRule processRule, RetrievalModel retrievalModel, String embeddingModel, String embeddingModelProvider)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static AddDocumentRequest.AddDocumentRequestBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`String`	`getDocForm()` 索引内容的形式：text_model, hierarchical_model, qa_model
`String`	`getDocLanguage()` 在Q&A模式下，指定文档的语言，例如：English、Chinese
`String`	`getEmbeddingModel()` Embedding模型名称
`String`	`getEmbeddingModelProvider()` Embedding模型供应商
`String`	`getIndexingTechnique()` 索引方式：高质量（使用Embedding模型进行嵌入，构建为向量数据库索引）或经济（使用keyword table index的倒排索引进行构建）
`String`	`getName()` 文档名称
`ProcessingRule`	`getProcessRule()` 处理规则
`RetrievalModel`	`getRetrievalModel()` 检索模式
`String`	`getText()` 文档内容
`int`	`hashCode()`
`void`	`setDocForm(String docForm)` 索引内容的形式：text_model, hierarchical_model, qa_model
`void`	`setDocLanguage(String docLanguage)` 在Q&A模式下，指定文档的语言，例如：English、Chinese
`void`	`setEmbeddingModel(String embeddingModel)` Embedding模型名称
`void`	`setEmbeddingModelProvider(String embeddingModelProvider)` Embedding模型供应商
`void`	`setIndexingTechnique(String indexingTechnique)` 索引方式：高质量（使用Embedding模型进行嵌入，构建为向量数据库索引）或经济（使用keyword table index的倒排索引进行构建）
`void`	`setName(String name)` 文档名称
`void`	`setProcessRule(ProcessingRule processRule)` 处理规则
`void`	`setRetrievalModel(RetrievalModel retrievalModel)` 检索模式
`void`	`setText(String text)` 文档内容
`String`	`toString()`

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

构造器详细资料

AddDocumentRequest
```
public AddDocumentRequest(String name,
                          String text,
                          Boolean defaultLibrary,
                          Boolean isFirst)
```
创建一个默认的业务卡片库

参数:

name - 业务卡片库名称

text - 业务卡片库内容

defaultLibrary - 是否是默认的业务卡片库默认的业务卡片库会设置索引方式为高质量，索引内容为 hierarchical_model，语言为中文，处理规则为默认的

isFirst - 是否是第一个业务卡片库第一个创建需要会赋值默认的retrievalModel

AddDocumentRequest
```
public AddDocumentRequest()
```

AddDocumentRequest

public AddDocumentRequest(String name,
                          String text,
                          String indexingTechnique,
                          String docForm,
                          String docLanguage,
                          ProcessingRule processRule,
                          RetrievalModel retrievalModel,
                          String embeddingModel,
                          String embeddingModelProvider)

方法详细资料
- builder
```
public static AddDocumentRequest.AddDocumentRequestBuilder builder()
```
- getName
```
public String getName()
```
  文档名称
- getText
```
public String getText()
```
  文档内容
- getIndexingTechnique
```
public String getIndexingTechnique()
```
  索引方式：高质量（使用Embedding模型进行嵌入，构建为向量数据库索引）或经济（使用keyword table index的倒排索引进行构建）
- getDocForm
```
public String getDocForm()
```
  索引内容的形式：text_model, hierarchical_model, qa_model
- getDocLanguage
```
public String getDocLanguage()
```
  在Q&A模式下，指定文档的语言，例如：English、Chinese
- getProcessRule
```
public ProcessingRule getProcessRule()
```
  处理规则
- getRetrievalModel
```
public RetrievalModel getRetrievalModel()
```
  检索模式
- getEmbeddingModel
```
public String getEmbeddingModel()
```
  Embedding模型名称
- getEmbeddingModelProvider
```
public String getEmbeddingModelProvider()
```
  Embedding模型供应商
- setName
```
public void setName(String name)
```
  文档名称
- setText
```
public void setText(String text)
```
  文档内容
- setIndexingTechnique
```
public void setIndexingTechnique(String indexingTechnique)
```
  索引方式：高质量（使用Embedding模型进行嵌入，构建为向量数据库索引）或经济（使用keyword table index的倒排索引进行构建）
- setDocForm
```
public void setDocForm(String docForm)
```
  索引内容的形式：text_model, hierarchical_model, qa_model
- setDocLanguage
```
public void setDocLanguage(String docLanguage)
```
  在Q&A模式下，指定文档的语言，例如：English、Chinese
- setProcessRule
```
public void setProcessRule(ProcessingRule processRule)
```
  处理规则
- setRetrievalModel
```
public void setRetrievalModel(RetrievalModel retrievalModel)
```
  检索模式
- setEmbeddingModel
```
public void setEmbeddingModel(String embeddingModel)
```
  Embedding模型名称
- setEmbeddingModelProvider
```
public void setEmbeddingModelProvider(String embeddingModelProvider)
```
  Embedding模型供应商
- 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

类 AddDocumentRequest

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

AddDocumentRequest

AddDocumentRequest

AddDocumentRequest

方法详细资料

builder

getName

getText

getIndexingTechnique

getDocForm

getDocLanguage

getProcessRule

getRetrievalModel

getEmbeddingModel

getEmbeddingModelProvider

setName

setText

setIndexingTechnique

setDocForm

setDocLanguage

setProcessRule

setRetrievalModel

setEmbeddingModel

setEmbeddingModelProvider

equals

canEqual

hashCode

toString