/** * UploadAndCommitFile请求参数结构体 */ export interface UploadAndCommitFileRequest { /** * 实例id */ InstanceId?: string; /** * 上传文件列表 */ CosFiles?: Array; /** * 知识库id */ KnowledgeBaseId?: string; } /** * GetKnowledgeBaseList请求参数结构体 */ export interface GetKnowledgeBaseListRequest { /** * 实例id */ InstanceId: string; } /** * QueryUserAuthority返回参数结构体 */ export interface QueryUserAuthorityResponse { /** * 对象权限信息 */ ModelUserAuthority?: ModelUserAuthority; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddChunk请求参数结构体 */ export interface AddChunkRequest { /** * 实例ID */ InstanceId: string; /** * 文件ID */ FileId: string; /** * 新增chunk的后面一个ChunkID。如果是空就是插到队尾。插入位置的下一个 chunkId。如果插到最前面,传入原切片的第一个。 */ BeforeChunkId?: string; /** * 显式指定的位置,实际的位置。从 0 开始计算。0 代表插到最前面,chunk total 代表插到最后面。 */ InsertPos?: number; /** * chunk内容 */ Content?: string; /** * 新 Chunk 插入到目标 Chunk ​之后的位置。插入位置的上一个 chunkId */ AfterChunkId?: string; /** * 知识库id */ KnowledgeBaseId?: string; } /** * GetUserInstanceList请求参数结构体 */ export type GetUserInstanceListRequest = null; /** * 模型详情 */ export interface ModelList { /** *

模型版本名称

*/ Model?: string; /** *

模型厂商

*/ Vendor?: string; } /** * ModifyChunk请求参数结构体 */ export interface ModifyChunkRequest { /** *

实例ID

*/ InstanceId: string; /** *

文件ID

*/ FileId: string; /** *

切片ID

*/ ChunkId?: string; /** *

编辑后的文本

*/ Content?: string; /** *

分段概要

*/ Summary?: string; /** *

知识库id

*/ KnowledgeBaseId?: string; } /** * ChatAI返回参数结构体 */ export interface ChatAIResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。 */ RequestId?: string; } /** * QueryModels返回参数结构体 */ export interface QueryModelsResponse { /** *

模型列表

*/ Models?: Array; /** *

200成功,500失败

*/ Status?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteChunk请求参数结构体 */ export interface DeleteChunkRequest { /** * 实例ID */ InstanceId: string; /** * 文件ID */ FileId: string; /** * 切片ID */ ChunkIds: Array; /** * 知识库id */ KnowledgeBaseId?: string; } /** * 用户对象的权限 */ export interface ModelUserAuthority { /** * 实例id */ InstanceId?: string; /** * 模块,分为知识库knowledge、数据源datasource、自定义场景scene */ Module?: string; /** * 对象创建者 */ CreatorUin?: string; /** * 对象id,分为知识库id、数据源id、场景id */ ObjectId?: string; /** * 作用范围:1仅自己使用,2指定用户,0全员 */ UseScope?: number; /** * 可使用的用户列表 */ AuthorityUins?: Array; /** * 创建时间 */ CreateTime?: string; /** * 更新时间 */ UpdateTime?: string; } /** * 追加文件 */ export interface AppendDocument { /** *

文件名称

*/ FileName: string; /** *

文件id

*/ FileId: string; /** *

文件url

*/ FileUrl: string; /** *

文件大小

*/ FileSize: number; } /** * QueryChunkList返回参数结构体 */ export interface QueryChunkListResponse { /** *

总数

*/ Total?: number; /** *

文档的自动分段数

*/ AutoTotal?: number; /** *

文档的手动新建分段数

*/ ManualTotal?: number; /** *

分片信息

*/ Chunks?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetUserInstanceList返回参数结构体 */ export interface GetUserInstanceListResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetJobsByKnowledgeBaseId请求参数结构体 */ export interface GetJobsByKnowledgeBaseIdRequest { /** * 实例ID */ InstanceId?: string; /** * 知识库id */ KnowledgeBaseId?: string; } /** * 上传任务 */ export interface UploadJob { /** * id */ Id?: number; /** * 任务id */ JobId?: string; /** * 实例id */ InstanceId?: string; /** * 知识库id */ KnowledgeBaseId?: string; /** * uin */ Uin?: string; /** * subuin */ SubUin?: string; /** * Pending、FileUploading、 FileParsing、 Success、 Failed */ Status?: string; /** * 任务创建时间 */ CreateTime?: string; /** * 任务更新时间 */ UpdateTime?: string; /** * 错误信息 */ Message?: string; } /** * QueryChunkList请求参数结构体 */ export interface QueryChunkListRequest { /** *

表示第一页

*/ Page?: number; /** *

默认一页展示 10 条

*/ PageSize?: number; /** *

知识库id

*/ KnowledgeBaseId?: string; } /** * StopChatAI请求参数结构体 */ export interface StopChatAIRequest { /** * 会话ID */ SessionId?: string; /** * 实例ID */ InstanceId?: string; } /** * QueryModels请求参数结构体 */ export interface QueryModelsRequest { /** *

实例id

*/ InstanceId?: string; } /** * ModifyKnowledgeBase请求参数结构体 */ export interface ModifyKnowledgeBaseRequest { /** *

实例id

*/ InstanceId: string; /** *

操作类型:Create,Update,Delete

*/ OperateType: string; /** *

知识库id,update和delete时必填

*/ KnowledgeBaseId?: string; /** *

知识库名称,create和update时必填。只允许字母、数字、汉字、下划线

*/ KnowledgeBaseName?: string; /** *

知识库描述,create和update时必填

*/ KnowledgeBaseDesc?: string; /** *

1仅自己使用,2指定用户,0全员

*/ UseScope?: number; /** *

可使用用户列表

*/ AuthorityUins?: Array; /** *

知识库任务配置

*/ Config?: KnowledgeTaskConfig; } /** * DeleteChunk返回参数结构体 */ export interface DeleteChunkResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDataAgentSession返回参数结构体 */ export interface CreateDataAgentSessionResponse { /** * 会话 */ SessionId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * cos 文件信息 */ export interface CosFileInfo { /** * 文件名称,包含后缀 */ FileName?: string; /** * 文件类型,"PDF", "DOC", "DOCX", "XLS", "XLSX", "PPT", "PPTX", "MD", "TXT", "PNG", "JPG", "JPEG", "CSV" */ FileType?: string; /** * 用户文件的cosurl */ UserCosUrl?: string; } /** * 知识库信息 */ export interface KnowledgeBase { /** *

知识库id

*/ KnowledgeBaseId?: string; /** *

知识库名称

*/ KnowledgeBaseName?: string; /** *

知识库描述

*/ KnowledgeBaseDesc?: string; /** *

创建者subuin

*/ Creator?: string; /** *

创建时间

*/ CreateTime?: string; /** *

文件数量

*/ FileNum?: number; /** *

知识库关联的数据库列表,目前是只绑定一个数据源,数组预留拓展

*/ DatasourceIds?: Array; /** *

知识库任务配置

*/ Config?: KnowledgeTaskConfig; } /** * ModifyUserAuthority请求参数结构体 */ export interface ModifyUserAuthorityRequest { /** * 实例ID */ InstanceId: string; /** * 分为知识库knowledge、数据源datasource、自定义场景scene */ Module: string; /** * 对象id,分为知识库id、数据源id、场景id */ ObjectId: string; /** * 作用范围:1仅自己使用,2指定用户,0全员 */ UseScope?: number; /** * 可使用的用户列表,UseScope=0/1,取值为[] */ AuthorityUins?: Array; } /** * GetJobsByKnowledgeBaseId返回参数结构体 */ export interface GetJobsByKnowledgeBaseIdResponse { /** * 任务列表详情 */ Jobs?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * QueryKnowledgeTask请求参数结构体 */ export interface QueryKnowledgeTaskRequest { /** *

实例id

*/ InstanceId?: string; /** *

知识库id

*/ KnowledgeBaseId?: string; /** *

文件id列表

*/ FileIds?: Array; } /** * GetUploadJobDetails返回参数结构体 */ export interface GetUploadJobDetailsResponse { /** * 任务详情 */ Job?: UploadJob; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * QueryKnowledgeTask返回参数结构体 */ export interface QueryKnowledgeTaskResponse { /** *

文档任务详情对象

*/ FileList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ExecuteAgentApi请求参数结构体 */ export interface ExecuteAgentApiRequest { /** *

参数路径

*/ RequestPath?: string; /** *

参数值

*/ RequestData?: string; /** *

post还是get

枚举值:

  • post: post请求
  • get: get请求
*/ RequestType?: string; } /** * ModifyChunk返回参数结构体 */ export interface ModifyChunkResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteDataAgentSession返回参数结构体 */ export interface DeleteDataAgentSessionResponse { /** * 删除的会话ID */ SessionId?: string; /** * 删除的会话ID列表 */ SessionIds?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * QueryUserSessionDetail返回参数结构体 */ export interface QueryUserSessionDetailResponse { /** *

用户 Id

*/ SubAccountUin?: string; /** *

会话id

*/ SessionId?: string; /** *

会话详情数组

*/ RecordList?: Array; /** *

记录总数

*/ TotalCount?: number; /** *

运行中的聊天请求, 返回为json字符串

*/ RunRecord?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetKnowledgeBaseFileList返回参数结构体 */ export interface GetKnowledgeBaseFileListResponse { /** * 文件信息列表 */ FileList?: Array; /** * 文件信息总数 */ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChatAI请求参数结构体 */ export interface ChatAIRequest { /** *

会话ID

*/ SessionId?: string; /** *

实例ID

*/ InstanceId?: string; /** *

问题内容

*/ Question?: string; /** *

上下文

*/ Context?: string; /** *

模型

*/ Model?: string; /** *

是否深度思考

*/ DeepThinking?: boolean; /** *

数据源id

*/ DataSourceIds?: Array; /** *

agent类型

*/ AgentType?: string; /** *

需要重新生成答案的记录ID

*/ OldRecordId?: string; /** *

知识库id列表

*/ KnowledgeBaseIds?: Array; /** *

版本信息

*/ ArchVersion?: string; } /** * QueryUserAuthority请求参数结构体 */ export interface QueryUserAuthorityRequest { /** * 实例ID */ InstanceId: string; /** * 分为知识库knowledge、数据源datasource、自定义场景scene */ Module: string; /** * 对象id,分为知识库id、数据源id、场景id */ ObjectId: string; } /** * 知识库文件信息 */ export interface FileInfo { /** *

文件名称

*/ FileName: string; /** *

文件大小,字节

*/ FileSize: number; /** *

文件类型,0=文本,1=表格,默认0

*/ Type: number; /** *

文件ID

*/ FileId: string; /** *

状态,0:数据处理中 1:可用 -1:错误

*/ Status?: number; /** *

操作者

*/ CreateUser?: string; /** *

创建时间

*/ CreateTime?: string; /** *

更新时间

*/ UpdateTime?: string; /** *

分片策略

*/ ChunkConfig?: KnowledgeTaskConfig; /** *

文件来源0=unknow,1=user_cos,2=local

*/ Source?: number; /** *

文件url

*/ FileUrl?: string; /** *

是否官方示例,0=否,1=是

*/ IsShowCase?: number; /** *

文档摘要

*/ DocumentSummary?: string; /** *

网页地址

*/ WebUrl?: string; /** *

文件能力标识列表

*/ Capabilities?: Array; /** *

0:关闭 1:开启图谱构建(入库时构建图谱),默认0

*/ EnableGraphBuild?: number; /** *

0:关闭 1:开启树构建(入库时构建树),默认0

*/ EnableTreeBuild?: number; /** *

图谱构建状态:null=未启用图谱; 0=待入库; 1=入库中; 2=入库成功; -1=入库失败(仅 EnableGraphBuild=1 时有意义)

*/ GraphBuildStatus?: number; /** *

图谱构建状态:null=未启用图谱; 0=待入库; 1=入库中; 2=入库成功; -1=入库失败(仅 EnableGraphBuild=1 时有意义)

*/ TreeBuildStatus?: number; } /** * GetKnowledgeBaseFileList请求参数结构体 */ export interface GetKnowledgeBaseFileListRequest { /** * 实例id */ InstanceId: string; /** * 默认 1 表示第一页,可以不填 */ Page?: number; /** * 默认 10 一页展示 10 条,可以不填 */ PageSize?: number; /** * 知识库id */ KnowledgeBaseId?: string; } /** * AppendKnowledgeTask返回参数结构体 */ export interface AppendKnowledgeTaskResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ExecuteAgentApi返回参数结构体 */ export interface ExecuteAgentApiResponse { /** *

请求路径

*/ RequestPath?: string; /** *

返回的具体指

*/ AgentData?: string; /** *

错误码信息

*/ ErrorMsg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetUploadJobDetails请求参数结构体 */ export interface GetUploadJobDetailsRequest { /** * 实例ID */ InstanceId?: string; /** * 任务id */ JobId?: string; } /** * 文件任务状态 */ export interface FileTaskStatus { /** *

文件id

*/ FileId?: string; /** *

状态

枚举值:

  • 0: 处理中
  • 1: 可用
  • -1: 错误
*/ Status?: number; /** *

是否已拉取过状态

枚举值:

  • 0: 未被拉取过状态
  • 1: 已被拉取过状态
*/ IsTerminated?: number; /** *

错误信息,状态-1时不为空

*/ ErrorMsg?: string; } /** * StopChatAI返回参数结构体 */ export interface StopChatAIResponse { /** * 会话 */ SessionId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUserAuthority返回参数结构体 */ export interface ModifyUserAuthorityResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddChunk返回参数结构体 */ export interface AddChunkResponse { /** * 新增的ChunkId */ ChunkId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ExecuteAgentApiV1请求参数结构体 */ export interface ExecuteAgentApiV1Request { /** *

参数路径

*/ RequestPath?: string; /** *

post还是get

枚举值:

  • post: post请求
  • get: get请求
*/ RequestType?: string; } /** * 记录列表 */ export interface RecordList { /** *

会话上下文

*/ Context?: string; /** *

记录id

*/ RecordId?: string; /** *

追踪id

*/ TraceId?: string; /** *

会话id

*/ SessionId?: string; /** *

问题

*/ Question?: string; /** *

回答

*/ Answer?: string; /** *

0-否定反馈, 1-肯定反馈

*/ Feedback?: number; /** *

错误信息

*/ ErrorContext?: string; /** *

创建时间

*/ CreateTime?: string; /** *

更新时间

*/ UpdateTime?: string; /** *

模型信息

*/ Model?: string; } /** * 文件分片 */ export interface Chunk { /** *

切片ID

*/ Id?: string; /** *

切片内容

*/ Content?: string; /** *

切片的字数

*/ Size?: number; /** *

切片概要

*/ Summary?: string; /** *

分段类型

枚举值:

  • 0: 自动分段
  • 1: 新建分段
*/ ChunkSource?: number; } /** * UploadAndCommitFile返回参数结构体 */ export interface UploadAndCommitFileResponse { /** * 上传任务 */ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AppendKnowledgeTask请求参数结构体 */ export interface AppendKnowledgeTaskRequest { /** *

实例id

*/ InstanceId?: string; /** *

知识库id

*/ KnowledgeBaseId?: string; /** *

文件id

*/ FileId?: string; /** *

追加的文档列表

*/ Documents?: Array; } /** * 任务配置 */ export interface KnowledgeTaskConfig { /** *

切片类型 0:自定义切片,1:智能切片

*/ ChunkType?: number; /** *

/智能切片:最小值 1000,默认 4800 自定义切片:正整数即可,默认值 1000

*/ MaxChunkSize?: number; /** *

切片分隔符,自定义切片使用:默认值为:["\n\n", "\n", "。", "!", "?", ",", ""]

注意:此字段可能返回 null,表示取不到有效值。 */ Delimiters?: Array; /** *

自定义切片使用:默认0 可重叠字符长度

*/ ChunkOverlap?: number; /** *

表格类文档解析

*/ Columns?: Array; /** *

带检索的索引列表

*/ Indexes?: Array; /** *

0:不生成文档摘要,1:生成文档概要。默认0,当取1时,GenParaSummary必须也为1

*/ GenDocSummary?: number; /** *

0:不生成段落摘要,1:生成段落概要。默认0

*/ GenParaSummary?: number; /** *

0:不开启图片理解,1:开启图片理解。默认1

取值范围:[1, 10000]

默认值:1

*/ EnableImageUnderstanding?: number; /** *

是否开启表格结构化提取

枚举值:

  • 0: 不开启表格提取
  • 1: 开启表格提取

默认值:1

*/ EnableExtractDb?: number; /** *

0:关闭 1:开启图谱构建(入库时),默认0

*/ EnableGraphBuild?: number; /** *

0:关闭 1:开启树构建(入库时),默认0

*/ EnableTreeBuild?: number; } /** * CreateDataAgentSession请求参数结构体 */ export interface CreateDataAgentSessionRequest { /** * 实例ID */ InstanceId?: string; } /** * QueryUserSessionDetail请求参数结构体 */ export interface QueryUserSessionDetailRequest { /** *

会话id

*/ SessionId?: string; /** *

分页参数

*/ Limit?: number; /** *

偏移量

*/ Offset?: number; /** *

实例id

*/ InstanceId?: string; } /** * ModifyKnowledgeBase返回参数结构体 */ export interface ModifyKnowledgeBaseResponse { /** *

知识库id

*/ KnowledgeBaseId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteDataAgentSession请求参数结构体 */ export interface DeleteDataAgentSessionRequest { /** * 实例ID */ InstanceId?: string; /** * 会话ID */ SessionId?: string; /** * 批量删除 会话id 列表 */ SessionIds?: Array; } /** * ExecuteAgentApiV1返回参数结构体 */ export interface ExecuteAgentApiV1Response { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。 */ RequestId?: string; } /** * 知识库文档表列信息 */ export interface ColumnInfo { /** * 列名称 */ Name?: string; /** * 列类型:int, bigint, double, date, datetime, string,decimal */ Type?: string; /** * 列名称描述 */ Description?: string; /** * 列索引 */ Index?: number; /** * 原始字段名称 */ OriginalName?: string; } /** * GetKnowledgeBaseList返回参数结构体 */ export interface GetKnowledgeBaseListResponse { /** * 用户实例所有知识库列表 */ KnowledgeBaseList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; }