tencentcloud-sdk-nodejs
Version:
1,469 lines (1,467 loc) • 32.6 kB
TypeScript
/**
* UploadAndCommitFile请求参数结构体
*/
export interface UploadAndCommitFileRequest {
/**
* 实例id
*/
InstanceId?: string;
/**
* 上传文件列表
*/
CosFiles?: Array<CosFileInfo>;
/**
* 知识库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;
/**
* QuerySceneList返回参数结构体
*/
export interface QuerySceneListResponse {
/**
* 场景列表
*/
Datas?: Array<Scene>;
/**
* 总数
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 模型详情
*/
export interface ModelList {
/**
* <p>模型版本名称</p>
*/
Model?: string;
/**
* <p>模型厂商</p>
*/
Vendor?: string;
}
/**
* ModifyChunk请求参数结构体
*/
export interface ModifyChunkRequest {
/**
* <p>实例ID</p>
*/
InstanceId: string;
/**
* <p>文件ID</p>
*/
FileId: string;
/**
* <p>切片ID</p>
*/
ChunkId?: string;
/**
* <p>编辑后的文本</p>
*/
Content?: string;
/**
* <p>分段概要</p>
*/
Summary?: string;
/**
* <p>知识库id</p>
*/
KnowledgeBaseId?: string;
}
/**
* ChatAI返回参数结构体
*/
export interface ChatAIResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
*/
RequestId?: string;
}
/**
* QueryModels返回参数结构体
*/
export interface QueryModelsResponse {
/**
* <p>模型列表</p>
*/
Models?: Array<ModelList>;
/**
* <p>200成功,500失败</p>
*/
Status?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteChunk请求参数结构体
*/
export interface DeleteChunkRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 文件ID
*/
FileId: string;
/**
* 切片ID
*/
ChunkIds: Array<string>;
/**
* 知识库id
*/
KnowledgeBaseId?: string;
}
/**
* GetSessionDetails返回参数结构体
*/
export interface GetSessionDetailsResponse {
/**
* 会话记录详情
*/
RecordList?: Array<Record>;
/**
* 记录总数
*/
RecordCount?: number;
/**
* 当前在运行的record信息
*/
RunRecord?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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<string>;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
}
/**
* 问答数据
*/
export interface ExampleQA {
/**
* 示例记录的唯一业务 ID
*/
ExampleId?: string;
/**
* 问题列表
*/
Questions?: Array<string>;
/**
* 对应的标准答案或回复
*/
Answer?: string;
/**
* 内容类型,类型包含 'text', 'sql', 'code'
*/
Type?: string;
/**
* 记录的创建时间
*/
CreateTime?: string;
/**
* 记录的最后更新时间
*/
UpdateTime?: string;
}
/**
* GetUserInstanceList返回参数结构体
*/
export interface GetUserInstanceListResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryChunkList返回参数结构体
*/
export interface QueryChunkListResponse {
/**
* <p>总数</p>
*/
Total?: number;
/**
* <p>文档的自动分段数</p>
*/
AutoTotal?: number;
/**
* <p>文档的手动新建分段数</p>
*/
ManualTotal?: number;
/**
* <p>分片信息</p>
*/
Chunks?: Array<Chunk>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddScene请求参数结构体
*/
export interface AddSceneRequest {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 场景
*/
Scene?: Scene;
/**
* 1仅自己使用,2指定用户,0全员
*/
UseScope?: number;
/**
* 可使用用户列表
*/
AuthorityUins?: Array<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 {
/**
* <p>表示第一页</p>
*/
Page?: number;
/**
* <p>默认一页展示 10 条</p>
*/
PageSize?: number;
/**
* <p>知识库id</p>
*/
KnowledgeBaseId?: string;
}
/**
* StopChatAI请求参数结构体
*/
export interface StopChatAIRequest {
/**
* 会话ID
*/
SessionId?: string;
/**
* 实例ID
*/
InstanceId?: string;
}
/**
* 检索配置
*/
export interface SearchConfig {
/**
* 检索类型:0:混合搜索 1:向量搜索 2:全文搜索
*/
Type?: number;
/**
* 召回数量最大值
*/
Num?: number;
/**
* 权重配置
*/
EmbeddingWeight?: number;
/**
* 0:关闭 1:开启,默认1
*/
Rerank?: number;
/**
* 0:关闭 1:开启,默认0
*/
AutoRag?: number;
/**
* AutoRag关联的知识库ID列表
*/
KnowledgeBaseIds?: Array<string>;
/**
* AutoRag搜索状态:0-未完成,1-已完成。仅当AutoRag=1时,该字段有效
*/
SearchStatus?: number;
}
/**
* 步骤扩展结构
*/
export interface StepExpand {
/**
* 标题
*/
Title?: string;
/**
* 状态
*/
Status?: string;
/**
* cellid数组
*/
CellIds?: Array<string>;
}
/**
* GetSessionDetails请求参数结构体
*/
export interface GetSessionDetailsRequest {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 会话ID
*/
SessionId?: string;
}
/**
* QueryModels请求参数结构体
*/
export interface QueryModelsRequest {
/**
* <p>实例id</p>
*/
InstanceId?: string;
}
/**
* ModifyKnowledgeBase请求参数结构体
*/
export interface ModifyKnowledgeBaseRequest {
/**
* <p>实例id</p>
*/
InstanceId: string;
/**
* <p>操作类型:Create,Update,Delete</p>
*/
OperateType: string;
/**
* <p>知识库id,update和delete时必填</p>
*/
KnowledgeBaseId?: string;
/**
* <p>知识库名称,create和update时必填。只允许字母、数字、汉字、下划线</p>
*/
KnowledgeBaseName?: string;
/**
* <p>知识库描述,create和update时必填</p>
*/
KnowledgeBaseDesc?: string;
/**
* <p>1仅自己使用,2指定用户,0全员</p>
*/
UseScope?: number;
/**
* <p>可使用用户列表</p>
*/
AuthorityUins?: Array<string>;
/**
* <p>知识库任务配置</p>
*/
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 {
/**
* <p>知识库id</p>
*/
KnowledgeBaseId?: string;
/**
* <p>知识库名称</p>
*/
KnowledgeBaseName?: string;
/**
* <p>知识库描述</p>
*/
KnowledgeBaseDesc?: string;
/**
* <p>创建者subuin</p>
*/
Creator?: string;
/**
* <p>创建时间</p>
*/
CreateTime?: string;
/**
* <p>文件数量</p>
*/
FileNum?: number;
/**
* <p>知识库关联的数据库列表,目前是只绑定一个数据源,数组预留拓展</p>
*/
DatasourceIds?: Array<string>;
/**
* <p>知识库任务配置</p>
*/
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<string>;
}
/**
* GetJobsByKnowledgeBaseId返回参数结构体
*/
export interface GetJobsByKnowledgeBaseIdResponse {
/**
* 任务列表详情
*/
Jobs?: Array<UploadJob>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QuerySceneList请求参数结构体
*/
export interface QuerySceneListRequest {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 场景id
*/
SceneId?: string;
/**
* 场景名称
*/
SceneName?: string;
/**
* 页数
*/
Page?: number;
/**
* 页的大小
*/
PageSize?: number;
}
/**
* QueryKnowledgeTask请求参数结构体
*/
export interface QueryKnowledgeTaskRequest {
/**
* <p>实例id</p>
*/
InstanceId?: string;
/**
* <p>知识库id</p>
*/
KnowledgeBaseId?: string;
/**
* <p>文件id列表</p>
*/
FileIds?: Array<string>;
}
/**
* GetUploadJobDetails返回参数结构体
*/
export interface GetUploadJobDetailsResponse {
/**
* 任务详情
*/
Job?: UploadJob;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UploadAndCommitFile返回参数结构体
*/
export interface UploadAndCommitFileResponse {
/**
* 上传任务
*/
JobId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryKnowledgeTask返回参数结构体
*/
export interface QueryKnowledgeTaskResponse {
/**
* <p>文档任务详情对象</p>
*/
FileList?: Array<FileTaskStatus>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ExecuteAgentApi请求参数结构体
*/
export interface ExecuteAgentApiRequest {
/**
* <p>参数路径</p>
*/
RequestPath?: string;
/**
* <p>参数值</p>
*/
RequestData?: string;
/**
* <p>post还是get</p><p>枚举值:</p><ul><li>post: post请求</li><li>get: get请求</li></ul>
*/
RequestType?: string;
}
/**
* ModifyChunk返回参数结构体
*/
export interface ModifyChunkResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteDataAgentSession返回参数结构体
*/
export interface DeleteDataAgentSessionResponse {
/**
* 删除的会话ID
*/
SessionId?: string;
/**
* 删除的会话ID列表
*/
SessionIds?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddScene返回参数结构体
*/
export interface AddSceneResponse {
/**
* 场景id
*/
SceneId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetKnowledgeBaseFileList返回参数结构体
*/
export interface GetKnowledgeBaseFileListResponse {
/**
* 文件信息列表
*/
FileList?: Array<FileInfo>;
/**
* 文件信息总数
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 问答结构
*/
export interface Record {
/**
* 问题内容
*/
Question: string;
/**
* 回答内容
*/
Answer?: string;
/**
* 思考内容
*/
Think?: string;
/**
* 任务列表
*/
TaskList?: Array<Task>;
/**
* 记录创建时间
*/
CreateTime?: string;
/**
* 记录更新时间
*/
UpdateTime?: string;
/**
* 记录id
*/
RecordId?: string;
/**
* 总结内容
*/
FinalSummary?: string;
/**
* 会话ID
*/
SessionId?: string;
/**
* 1=赞,2=踩,0=无反馈
*/
Feedback?: number;
/**
* 数据库信息
*/
DbInfo?: string;
/**
* 错误信息
*/
ErrorContext?: string;
/**
* TaskList的string字符串
*/
TaskListStr?: string;
/**
* 知识库id列表
*/
KnowledgeBaseIds?: Array<string>;
/**
* 上下文
*/
Context?: string;
}
/**
* ChatAI请求参数结构体
*/
export interface ChatAIRequest {
/**
* <p>会话ID</p>
*/
SessionId?: string;
/**
* <p>实例ID</p>
*/
InstanceId?: string;
/**
* <p>问题内容</p>
*/
Question?: string;
/**
* <p>上下文</p>
*/
Context?: string;
/**
* <p>模型</p>
*/
Model?: string;
/**
* <p>是否深度思考</p>
*/
DeepThinking?: boolean;
/**
* <p>数据源id</p>
*/
DataSourceIds?: Array<string>;
/**
* <p>agent类型</p>
*/
AgentType?: string;
/**
* <p>需要重新生成答案的记录ID</p>
*/
OldRecordId?: string;
/**
* <p>知识库id列表</p>
*/
KnowledgeBaseIds?: Array<string>;
/**
* <p>版本信息</p>
*/
ArchVersion?: string;
}
/**
* DeleteScene返回参数结构体
*/
export interface DeleteSceneResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryUserAuthority请求参数结构体
*/
export interface QueryUserAuthorityRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 分为知识库knowledge、数据源datasource、自定义场景scene
*/
Module: string;
/**
* 对象id,分为知识库id、数据源id、场景id
*/
ObjectId: string;
}
/**
* 知识库文件信息
*/
export interface FileInfo {
/**
* <p>文件名称</p>
*/
FileName: string;
/**
* <p>文件大小,字节</p>
*/
FileSize: number;
/**
* <p>文件类型,0=文本,1=表格,默认0</p>
*/
Type: number;
/**
* <p>文件ID</p>
*/
FileId: string;
/**
* <p>状态,0:数据处理中 1:可用 -1:错误</p>
*/
Status?: number;
/**
* <p>操作者</p>
*/
CreateUser?: string;
/**
* <p>创建时间</p>
*/
CreateTime?: string;
/**
* <p>更新时间</p>
*/
UpdateTime?: string;
/**
* <p>分片策略</p>
*/
ChunkConfig?: KnowledgeTaskConfig;
/**
* <p>文件来源0=unknow,1=user_cos,2=local</p>
*/
Source?: number;
/**
* <p>文件url</p>
*/
FileUrl?: string;
/**
* <p>是否官方示例,0=否,1=是</p>
*/
IsShowCase?: number;
/**
* <p>文档摘要</p>
*/
DocumentSummary?: string;
/**
* <p>网页地址</p>
*/
WebUrl?: string;
/**
* <p>文件能力标识列表</p>
*/
Capabilities?: Array<string>;
}
/**
* 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 {
/**
* <p>请求路径</p>
*/
RequestPath?: string;
/**
* <p>返回的具体指</p>
*/
AgentData?: string;
/**
* <p>错误码信息</p>
*/
ErrorMsg?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetUploadJobDetails请求参数结构体
*/
export interface GetUploadJobDetailsRequest {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 任务id
*/
JobId?: string;
}
/**
* 任务步骤
*/
export interface StepInfo {
/**
* 步骤id
*/
Id: number;
/**
* 步骤名称
*/
Name: string;
/**
* 步骤状态
*/
Status: string;
/**
* 类型(text/expand)
*/
Type: string;
/**
* 总结
*/
Summary?: string;
/**
* 步骤扩展结构
*/
Expand?: StepExpand;
/**
* 描述
*/
Desc?: string;
}
/**
* 文件任务状态
*/
export interface FileTaskStatus {
/**
* <p>文件id</p>
*/
FileId?: string;
/**
* <p>状态</p><p>枚举值:</p><ul><li>0: 处理中</li><li>1: 可用</li><li>-1: 错误</li></ul>
*/
Status?: number;
/**
* <p>是否已拉取过状态</p><p>枚举值:</p><ul><li>0: 未被拉取过状态</li><li>1: 已被拉取过状态</li></ul>
*/
IsTerminated?: number;
/**
* <p>错误信息,状态-1时不为空</p>
*/
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 {
/**
* <p>参数路径</p>
*/
RequestPath?: string;
/**
* <p>post还是get</p><p>枚举值:</p><ul><li>post: post请求</li><li>get: get请求</li></ul>
*/
RequestType?: string;
}
/**
* 文件分片
*/
export interface Chunk {
/**
* <p>切片ID</p>
*/
Id?: string;
/**
* <p>切片内容</p>
*/
Content?: string;
/**
* <p>切片的字数</p>
*/
Size?: number;
/**
* <p>切片概要</p>
*/
Summary?: string;
/**
* <p>分段类型</p><p>枚举值:</p><ul><li>0: 自动分段</li><li>1: 新建分段</li></ul>
*/
ChunkSource?: number;
}
/**
* UpdateScene返回参数结构体
*/
export interface UpdateSceneResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 场景
*/
export interface Scene {
/**
* <p>场景ID</p>
*/
SceneId?: string;
/**
* <p>场景名称</p>
*/
SceneName?: string;
/**
* <p>技能列表,包含:rag(知识检索)、data_analytics(数据分析)、data_prediction(数据预测)</p>
*/
Skills?: Array<string>;
/**
* <p>提示词文本</p>
*/
Prompt?: string;
/**
* <p>描述</p>
*/
Description?: string;
/**
* <p>检索配置</p>
*/
SearchConfig?: SearchConfig;
/**
* <p>示例问答列表</p>
*/
ExampleQAList?: Array<ExampleQA>;
/**
* <p>记录的创建时间</p>
*/
CreateTime?: string;
/**
* <p>记录的最后更新时间</p>
*/
UpdateTime?: string;
/**
* <p>创建者Uin</p>
*/
CreatorUin?: string;
/**
* <p>知识</p>
*/
Knowledge?: string;
}
/**
* AppendKnowledgeTask请求参数结构体
*/
export interface AppendKnowledgeTaskRequest {
/**
* <p>实例id</p>
*/
InstanceId?: string;
/**
* <p>知识库id</p>
*/
KnowledgeBaseId?: string;
/**
* <p>文件id</p>
*/
FileId?: string;
/**
* <p>追加的文档列表</p>
*/
Documents?: Array<AppendDocument>;
}
/**
* 任务配置
*/
export interface KnowledgeTaskConfig {
/**
* <p>切片类型 0:自定义切片,1:智能切片</p>
*/
ChunkType?: number;
/**
* <p>/智能切片:最小值 1000,默认 4800 自定义切片:正整数即可,默认值 1000</p>
*/
MaxChunkSize?: number;
/**
* <p>切片分隔符,自定义切片使用:默认值为:["\n\n", "\n", "。", "!", "?", ",", ""]</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Delimiters?: Array<string>;
/**
* <p>自定义切片使用:默认0 可重叠字符长度</p>
*/
ChunkOverlap?: number;
/**
* <p>表格类文档解析</p>
*/
Columns?: Array<ColumnInfo>;
/**
* <p>带检索的索引列表</p>
*/
Indexes?: Array<number | bigint>;
/**
* <p>0:不生成文档摘要,1:生成文档概要。默认0,当取1时,GenParaSummary必须也为1</p>
*/
GenDocSummary?: number;
/**
* <p>0:不生成段落摘要,1:生成段落概要。默认0</p>
*/
GenParaSummary?: number;
/**
* <p>0:不开启图片理解,1:开启图片理解。默认1</p><p>取值范围:[1, 10000]</p><p>默认值:1</p>
*/
EnableImageUnderstanding?: number;
/**
* <p>是否开启表格结构化提取</p><p>枚举值:</p><ul><li>0: 不开启表格提取</li><li>1: 开启表格提取</li></ul><p>默认值:1</p>
*/
EnableExtractDb?: number;
}
/**
* UpdateScene请求参数结构体
*/
export interface UpdateSceneRequest {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 场景
*/
Scene?: Scene;
}
/**
* CreateDataAgentSession请求参数结构体
*/
export interface CreateDataAgentSessionRequest {
/**
* 实例ID
*/
InstanceId?: string;
}
/**
* ModifyKnowledgeBase返回参数结构体
*/
export interface ModifyKnowledgeBaseResponse {
/**
* <p>知识库id</p>
*/
KnowledgeBaseId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteScene请求参数结构体
*/
export interface DeleteSceneRequest {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 场景id
*/
SceneId?: string;
}
/**
* 任务信息
*/
export interface Task {
/**
* 任务ID
*/
Id?: number;
/**
* 任务名称
*/
Name?: string;
/**
* 任务状态
*/
Status?: string;
/**
* 任务步骤列表
*/
StepInfoList?: Array<StepInfo>;
}
/**
* DeleteDataAgentSession请求参数结构体
*/
export interface DeleteDataAgentSessionRequest {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 会话ID
*/
SessionId?: string;
/**
* 批量删除 会话id 列表
*/
SessionIds?: Array<string>;
}
/**
* 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<KnowledgeBase>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 追加文件
*/
export interface AppendDocument {
/**
* <p>文件名称</p>
*/
FileName: string;
/**
* <p>文件id</p>
*/
FileId: string;
/**
* <p>文件url</p>
*/
FileUrl: string;
/**
* <p>文件大小</p>
*/
FileSize: number;
}