找不到 API ? 点击 反馈吧
- 平台能力-文档库
- 更新文档块内容UpdateDocumentChunk
- 获取配置信息GetAppConfig
- 创建文档库CreateLibrary
- 获取文档库列表GetLibraryList
- 获取文档库详情GetLibrary
- 上传文档UploadDocument
- 获取文档的下载链接GetDocumentUrl
- 预览文档PreviewDocument
- 按元信息过滤查询文档列表GetFilterDocumentList
- 获取文档列表GetDocumentList
- 删除文档DeleteDocument
- 更新文档UpdateDocument
- 创建预定义文档CreatePredefinedDocument
- 获取文档块列表GetDocumentChunkList
- 文档召回RecallDocument
- 获取文档解析结果GetParseResult
- 重建索引ReIndex
- 更新文档库UpdateLibrary
- 删除文档库DeleteLibrary
- 文档库会话生成RunLibraryChatGeneration
- 根据业务类型获取对话历史记录GetHistoryListByBizType
- 调用插件InvokePlugin
- 平台能力-应用
- 获取会话详情GetDialogDetail
- 创建会话分析任务CreateDialogAnalysisTask
- 运行智能体RunAgent
- 获取会话分析结果GetDialogAnalysisResult
- 实时会话RealTimeDialog
- 创建外呼会话CreateDialog
- 重建任务RebuildTask
- 创建按年份总结文档任务CreateAnnualDocSummaryTask
- 获取质检结果GetQualityCheckTaskResult
- 创建质检任务CreateQualityCheckTask
- 创建多文档总结任务CreateDocsSummaryTask
- 获取结果GetTaskResult
- 创建pdf文档翻译任务CreatePdfTranslateTask
- 意图识别RecognizeIntention
- 创建财报总结任务CreateFinReportSummaryTask
- 获取任务状态GetTaskStatus
- 获取财报总结任务结果GetSummaryTaskResult
- 取消任务EvictTask
- 对话结果生成RunChatResultGeneration
- 获取问答结果GetChatQuestionResp
- 根据文档解析问答QAGenDocQaResult
- 更新QA问答库UpdateQaLibrary
- 提交问题列表SubmitChatQuestion
CreateLibrary
创建文档库。创建一个新的文档库,文档库用作隔离文档信息、索引信息,如果使用场景中需要经常按类别去做自然语言检索,建议创建多个文档库,来隔离不同类型的数据。支持按照格式自定义向量索引和文本索引
服务地址:
华北2(北京)
参数配置
高级配置
输入参数
只看必填
注意事项
workspaceId业务空间id
body请求体
description文档库的描述
indexSetting文档库的索引设置
chunkStrategy分段策略
docTreeSplit版面切分
请选择布尔值
docTreeSplitSize版面切分大小
enhanceGraph是否解析文档中的图片内容
请选择布尔值
enhanceTable是否解析文档中的表格内容
请选择布尔值
overlapchunk重叠长度
sentenceSplit按句子切分
请选择布尔值
sentenceSplitSize按句子切分大小
sizechunk大小
split是否切块
请选择布尔值
modelConfig模型配置
temperature用于控制模型回复的随机性和多样性
topP生成过程中的核采样方法概率阈值
promptRoleStyleprompt风格角色
queryEnhancer问题增强配置
enableFollowUp是否根据历史记录改写问题
请选择布尔值
enableMultiQuery是否利用大模型知识拆解问题
请选择布尔值
enableOpenQa是否利用大模型知识回答问题
请选择布尔值
enableQueryRewrite是否使用问题改写
请选择布尔值
enableSession是否开启多轮对话
请选择布尔值
localKnowledgeId知识改写使用的文档库id
withDocumentReference是否带文档引用
请选择布尔值
recallStrategy召回策略
documentRankType合并&排序策略
limit两路合并总结的结果数
textIndexSetting文本索引配置
category文本索引类型
enable是否启用文本索引
请选择布尔值
indexAnalyzer文本索引的索引分析器: (Standa...
rankThreshold文本索引排序阈值
searchAnalyzer文本索引的搜索分析器: (Standa...
topK文本索引最后总结结果数
vectorIndexSetting向量索引设置
category向量索引来源:目前只支持 ADB
embeddingType向量索引文本Embedding类型
enable是否开启
请选择布尔值
rankThreshold向量索引排序阈值
topK向量索引最后总结结果数
libraryName文档库的名称
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
接口说明
请求语法
POST /{workspaceId}/api/library/create HTTP/1.1
路径参数
字段名称 | 字段详情 |
---|---|
workspaceIdstring | 业务空间 id 示例值:llm-ik******RVYCKzt |
请求参数
字段名称 | 字段详情 |
---|---|
bodyobject | 请求体。 |
返回参数
字段名称 | 字段详情 |
---|---|
costinteger<int64> | 耗时 注意
请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。 示例值:300 |
datastring | 返回数据 示例值:a1b2c3 |
dataTypestring | 数据类型 示例值:null |
errCodestring | 错误码 示例值:0 |
messagestring | 错误信息 示例值:成功 |
requestIdstring | 请求 id 示例值:xxxx-xxxx-xxxx-xxxx |
successboolean | 是否成功 示例值:true |
timestring | 时间戳 示例值:null |
变更历史