华为云用户手册

响应示例 状态码：200 操作成功，返回删除结果。 { "data" : { "id" : "djh28e62-xxxxxxxxx-a15be0d63812", "name" : "知识数据集名称", "result" : false, "reason" : "知识数据集已被知识库引用" } } 状态码：400 请求错误。 { "error_code" : "AIAE.40001001", "error_msg" : "参数xxxx不合法。" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 data DeleteResult object 参数解释： 知识数据集删除结果。 取值范围： 不涉及。 表4 DeleteResult 参数 参数类型 描述 id String 参数解释： 知识库id。 取值范围： 由数字、字母和中划线组成，长度36。 name String 参数解释： 知识库名称。 取值范围： 由中英文、数字、“_”组成，长度为[2-50]。 result Boolean 参数解释： 知识库删除成功或失败。 取值范围： true或false。 reason String 参数解释： 知识库删除失败原因。 取值范围： 不涉及。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 异常错误码。 取值范围： 不涉及。 error_msg String 参数解释： 异常错误信息。 取值范围： 不涉及。

响应示例 状态码：200 操作成功，返回删除结果。 { "data" : { "id" : "djh28e62-xxxxxxxxx-a15be0d63812", "name" : "知识库名称", "result" : false, "reason" : "知识库已启用" } } 状态码：400 请求错误。 { "error_code" : "AIAE.40001001", "error_msg" : "参数xxxx不合法。" }

请求示例 删除Agent文件盒子中的文件。 DELETE https://aiae.appstage.myhuaweicloud.com/v1/routes/open/file/053f5dda365345a9a80cc63895df1647?agent-id=1eb7f2f6f105496c8065be77dc038b63 \ --header "Authorization: sk-162xxxxxxxxxxxx"

请求示例 { "name" : "测试", "description" : "测试", "data_type" : "TEXT", "tags" : [ "对话问答", "文案生成" ], "ingestion_config" : { "data_source" : "FILE_UPLOAD", "file_types" : [ "txt" ] }, "schedule_config" : { "schedule_type" : "ONCE" }, "preprocess_config" : { "cleaning_methods" : [ "invisible" ], "pdf_preprocess_type" : "NO_PREPRO CES S" }, "chunk_config" : { "slicing_configs" : { "txt" : { "slicing_method" : "autoSlicing" } } }, "extraction_config" : { "extraction_example" : "今天天气如何？答：还不错哦。", "extraction_mode" : "RULE_EXTRACTION", "rule_extraction_configs" : [ { "extraction_rule" : "SEPARATOR", "field_name" : "question", "separator_extraction" : { "contain_separator" : false, "extraction_code" : 1, "separator" : "？" } }, { "extraction_rule" : "TEMPLATE", "field_name" : "answer", "template_extraction" : { "contain_end" : true, "contain_start" : false, "end_with" : "。", "extraction_code" : 1, "start_with" : "答" } } ] }, "index_config" : { "description" : "索引配置", "long_text_solution" : "TRUNCATE_MODE", "name" : "索引配置", "rag_type" : "VECTOR_RAG", "retrieval_configs" : [ { "category" : "FULL_CHUNK", "name" : "chunk", "retrieval_return" : false, "text_filter" : false, "vector_retrieval" : false }, { "category" : "CHUNK_FRAGMENT", "name" : "question", "retrieval_return" : true, "text_filter" : true, "vector_retrieval" : true }, { "category" : "CHUNK_FRAGMENT", "name" : "answer", "retrieval_return" : true, "text_filter" : true, "vector_retrieval" : false } ], "vector_model_service_key" : "GPT-4" } }

请求示例 { "name" : "知识库名称", "description" : "知识库描述", "retrieval_status" : "ENABLE", "rag_type" : "VECTOR_RAG", "retrieval_config" : { "retrieval_modes" : [ "SEMANTIC_RETRIEVAL", "FULL_TEXT_RETRIEVAL" ], "retrieval_hybrid_mode" : "RRF" }, "knowledge_data_sets" : [ { "data_set_id" : "djh28e62-xxxxxxxxx-a15be0d63812", "data_set_version" : "v2024-11-21T11:36:55Z", "index_config_id" : "d3f28e62-xxxxxxx-a15be0d638a2" } ] }

请求示例 { "model" : "publisher:baichuan:Baichuan2-Turbo", "messages" : [ { "role" : "system", "content" : "You are a helpful assistant." }, { "role" : "user", "content" : "你好!" } ] }

响应示例 状态码：200 OK { "created" : 1718772336, "usage" : { "completion_tokens" : 23, "prompt_tokens" : 45, "total_tokens" : 68 }, "model" : "Baichuan2-Turbo", "id" : "chatcmpl-xxx", "choices" : [ { "finish_reason" : "stop", "index" : 0, "message" : { "role" : "assistant", "content" : "你好，有什么我可以帮助你的吗？" }, "logprobs" : null } ], "object" : "chat.completion" } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error" : { "message" : "Internal server error, please try again later!", "type" : "internal_error", "param" : null, "code" : "internal_error" }, "error_code" : "AIAE.31001001", "error_msg" : "Internal server error, please try again later!" }

响应参数 状态码：200 表7 响应Body参数 参数 参数类型 描述 id String 参数解释： 文本对话唯一标识符。 取值范围： 不涉及。 choices Array of choices objects 参数解释： 返回体列表。 如果‘n’大于1，则结果为多个。 取值范围： 不涉及。 created Integer 参数解释： 问答发生的时间（格式为时间戳）。 取值范围： 不涉及。 model String 参数解释： 实际转发后调用的模型名称，与请求体中model可能不同。 取值范围： 不涉及。异常详情 object String 参数解释： 固定值。 取值范围： ‘chat.completion’。 usage CompletionUsage object 参数解释： 每次请求的用量统计。 取值范围： 不涉及。 表8 choices 参数 参数类型 描述 finish_reason String 参数解释： 返回结束的原因。 1.stop：模型达到自然停止点或提供的停止序列； 2.length：达到请求中指定的最大令牌数； 3.content_filter：由于内容过滤器的标志而省略了内容。 取值范围： 不涉及。 index Integer 参数解释： 返回多个choices时，每个choice对应的顺序。 取值范围： 不涉及。 message ChatCompletionResponseMessage object 参数解释： 模型服务返回的具体消息体内容。 取值范围： 不涉及。 表9 ChatCompletionResponseMessage 参数 参数类型 描述 content String 参数解释： 返回消息体的内容。 取值范围： 不涉及。 role String 参数解释： 返回消息体的角色。 取值范围： 不涉及。 表10 CompletionUsage 参数 参数类型 描述 completion_tokens Integer 参数解释： 回答包含的token数。 取值范围： 不涉及。 prompt_tokens Integer 参数解释： 提问包含的token数。 取值范围： 不涉及。 total_tokens Integer 参数解释： 提问+回答token总数。 取值范围： 不涉及。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error Error object 参数解释： 异常详情。 取值范围： 不涉及。 error_code String 参数解释： 平台异常错误码。 取值范围： 不涉及。 error_msg String 参数解释： 异常信息。 取值范围： 不涉及。 表12 Error 参数 参数类型 描述 code String 参数解释： 异常码。 取值范围： 不涉及。 message String 参数解释： 异常信息。 取值范围： 不涉及。 param String 参数解释： 异常参数，暂未使用。 取值范围： 不涉及。 type String 参数解释： 异常类型，同code。 取值范围： 不涉及。

操作指引 图1 AI原生应用引擎使用流程 表1 编排Agent的流程详解 序号 流程环节 说明 1 创建及发布Agent 创建专属Agent，并将应用程序及相关组件进行发布，使其能够正常运行。当前支持创建LLM模式和工作流模式两种类型的Agent。 LLM模式下，将准备好的模型服务（必选）、工具、工作流及知识库等编排成Agent。 工作流模式下，用户与工作流进行对话，因此必须添加工作流，不支持添加模型、工具、知识库等配置。 2 体验Agent 以对话的形式，对创建的Agent或平台资产中心预置的AI应用进行体验调测，以发现并解决Agent接口上的问题和错误。 3 使用Agent 支持通过API接口调用或Web界面访问两种方式使用Agent。

chat 将用户输入的对话内容传递给大模型，大模型对当前对话做出响应。 输入 配置执行动作，相关参数说明如表4所示。 表4 输入参数说明 参数 是否必填项 说明 模型服务调用ID 是 需要调用的大模型。 对于资产中心的模型，在资产中心选择“大模型”页签，单击模型卡片进入模型详情页面，查看模型服务调用ID。 对于我的模型（我部署的、我接入的）和我的路由策略，需要填写模型服务调用ID，请单击“获取模型服务调用ID”，进入“我的模型服务”页面，在模型服务列表中单击复制。 消息 是 选择数组类型的节点输出。 单击可切换为数组样式，配置“角色”和“对话内容（输入）”。 角色：对话内容对应的角色，支持user或system。 user表示用户向大模型提问。 system表示给大模型输入对话背景及设定。 对话内容：支持自定义输入文本，也可将前置节点的输出作为输入。 当角色为user时，输入发送给大模型的问题。例如：请帮我分析一下这个股票的潜在价值。 当角色为system时，输入大模型的对话背景，即对大模型的设定。例如输入给大模型：你是一个理财专家，请在后续的回答中，结合理财技巧给出答复。 高级配置 频率惩罚 否 介于-2.0和2.0之间的数字。正值会尽量避免使用常见的单词和短语，更倾向于生成较少见的单词。 输入加输出最大token数 否 表示模型输入加输出的最大长度。 存在惩罚 否 介于-2.0和2.0之间的数字。正值会尽量避免重复已经使用过的词语，更倾向于生成新词语。 温度 否 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。建议该参数和“多样性”只设置1个。 多样性 否 影响输出文本的多样性，取值越大，生成文本的多样性越强。建议该参数和“温度”只设置1个。 输出 该执行动作是根据用户定义的内容输出指定参数。 节点实例 在工作流中首次调用LLM节点需要新增实例，实例是节点的鉴权方式，如果未新增实例，节点就无法调通。 单击“新增实例”，在“创建实例”面板，配置表5参数信息。 表5 创建实例参数说明 参数名称 参数说明 基本信息 实例名称 必填项，自定义实例名称。 描述 选填项，输入实例相关描述信息。 验证信息 API Key 必填项，具体介绍请参见创建API Key。 单击“保存”，创建实例成功。 节点备注 输入节点备注信息，方便后续查阅节点功能。

对话 支持引入历史对话，并将历史对话和当前对话一起传递给大模型，大模型会结合历史对话内容对当前对话做出响应。 模型 表1 模型参数说明 参数 说明 模型服务 选择需要调用的模型服务。 模型设置 频率惩罚：介于-2.0和2.0之间的数字。正值会尽量避免使用常见的单词和短语，更倾向于生成较少见的单词。 输入加输出最大token数：表示模型输入加输出的最大长度。 存在惩罚：介于-2.0和2.0之间的数字。正值会尽量避免重复已经使用过的词语，更倾向于生成新词语。 温度：较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。建议该参数和“多样性”只设置1个。 多样性：影响输出文本的多样性，取值越大，生成文本的多样性越强。建议该参数和“温度”只设置1个。 输入 配置执行动作，相关参数说明如表2所示。 表2 输入参数说明 参数 是否必填项 说明 历史对话 历史对话 开关默认开启，开启时可以引入历史对话。 对话 如果起始节点配置了引入历史对话，此处默认选择起始节点的WISEAGENT_CONVERSATION参数。同时，也支持自定义数组格式内容，例如： [ { "role": "user", "content": "我刚问了什么" }, { "role": "assistant", "content": "您刚刚询问了南京的天气情况。" }, { "role": "user", "content": "北京天气" }, { "role": "assistant", "content": "北京今天的天气是多云，气温在20°C到29°C之间，湿度为60%，风向为西南风2级。明天预计会有雷阵雨，气温在21°C到28°C之间，湿度为70%，风向为西南风3级。" } ] 对话轮数 填写引入历史对话的轮数，取值范围为1~30。 系统提示词 输入大模型的对话背景，即对大模型的设定。例如：你是一个理财专家，请在后续的回答中，结合理财技巧给出答复。 支持自定义文本或引入前置节点的输出作为输入，也支持两者组合使用。 用户提示词 输入发送给大模型的问题，即当前对话。大模型会结合历史对话内容对当前对话进行响应。例如：请帮我分析一下这个股票的潜在价值。 支持自定义文本或引入前置节点的输出作为输入，也支持两者组合使用。 输出 该执行动作是根据用户定义的内容输出指定参数。 节点实例 在工作流中首次调用LLM节点需要新增实例，实例是节点的鉴权方式，如果未新增实例，节点就无法调通。 单击“新增实例”，在“创建实例”面板，配置表3参数信息。 表3 创建实例参数说明 参数名称 参数说明 基本信息 实例名称 必填项，自定义实例名称。 描述 选填项，输入实例相关描述信息。 验证信息 API Key 必填项，具体介绍请参见创建API Key。 单击“保存”，创建实例成功。 节点备注 输入节点备注信息，方便后续查阅节点功能。

AI原生应用引擎使用流程 AI原生应用引擎是企业专属的一站式大模型开发及应用构建平台，其核心是将自创建或平台预置的模型服务、工具、工作流及知识库等编排成具有一定智能性和自主性的Agent。本章节梳理了AI原生应用引擎使用流程，可帮助您快速了解AI原生应用引擎的核心功能。 图1 AI原生应用引擎使用流程 表1 AI原生应用引擎使用流程详解 序号 流程环节 说明 1 创建及发布Agent 创建专属Agent，并将应用程序及相关组件进行发布，使其能够正常运行。当前支持创建LLM模式和工作流模式两种类型的Agent。 LLM模式下，将准备好的模型服务（必选）、工具、工作流及知识库等编排成Agent。 工作流模式下，用户与工作流进行对话，因此必须添加工作流，不支持添加模型、工具、知识库等配置。 2 体验Agent 以对话的形式，对创建的Agent或平台资产中心预置的AI应用进行体验调测，以发现并解决Agent接口上的问题和错误。 3 使用Agent 支持通过API接口调用或Web界面访问两种方式使用Agent。

测试工作流 当前仅支持post请求调用测试，也可以使用其他调测工具进行调测。 流保存成功后，单击页面右上角的“测试”。 您也可以在工作流列表中，单击工作流名称，进入工作流查看页面，单击“测试”。 在测试面板，输入参数，单击“提交测试”。 查看测试结果。 单击“查看运行历史详情”，在运行详情页面，查看本次测试过程中工作流的运行总次数、成功次数、失败次数，以及各节点的执行时长、输入参数及输出参数等，方便定位问题。

构造JSON对象 输入参数 用户配置构造JSON对象执行动作，相关参数说明如表1所示。 表1 构造JSON对象输入参数说明 参数 必须 说明 JSON对象 是 根据对象定义模式设置参数。 root 否 根据下拉框选择数据类型，有“object”、“array”可以选择。两种类型都可以添加子节点。 key_***** 否 是root的子节点，有“string”、“number”、“boolean”、“object”、“array”可以选择。其中只有“object”和“array”类型可以添加子节点。

更多操作 创建数据集完成后，可根据需要执行如表2所示的操作。 表2 更多操作 操作 步骤 查看数据集详情 在微调数据集页面选择“我创建的”页签。 在数据集列表中单击数据集名称，在微调数据集详情页面查看数据概况、调度历史，并支持对数据集进行溯源。 修改数据集 在微调数据集页面选择“我创建的”页签。 在数据集列表中，单击操作列的“修改”。 在修改页面编辑数据集描述、修改标签，单击“保存”。 删除数据集 被标注的数据集无法删除。 单个删除数据集 在微调数据集页面选择“我创建的”页签。 在数据集列表中，单击“操作”列的“删除”。 单击“确定”。 批量删除数据集 在微调数据集页面选择“我创建的”页签。 在数据集列表勾选多个数据集，再单击列表上方“批量删除”。 在“批量删除”对话框，单击“确认”。 标注数据集 只有格式为“对话文本”的数据集才可进行标注。 调度类型为“一次性调度”的数据集才可进行标注。 需要先在对微调数据集进行数据标注中创建标注任务，才能在当前页面执行数据标注。 在微调数据集页面选择“我创建的”页签。 在数据集列表中，单击数据集记录前的。 单击版本列表操作列的“标注”，参照对微调数据集进行数据标注进行数据标注。

前提条件 通过OBS（ 对象存储服务 ）接入数据时，操作账号需获得OBS只读权限和下载权限，具体操作请参见对其他账号授予桶的读写权限。 需具备充足的知识库容量包资源（包含OBS存储配额和向量库存储配额，两者比例为5:1），每个租户默认具备5G的OBS存储配额，默认配额用完后，请参考购买AppStage购买知识库容量包。 需要具备AI原生应用引擎管理员或开发者权限，权限申请操作请参见AppStage组织成员申请权限。

工作流工具节点说明 工作流的工具节点可以是系统提供的，也可以是用户自定义的工具，用于实现特定的业务逻辑或功能。，包含以下三种类型： 华为类：为用户提供各种华为类的工具节点，如华为会议、华为天气服务等。具体介绍请参见华为类。 生活服务类：为用户提供各种用途全面，功能丰富的API资产，如银行网点查询、生活小窍门等。具体介绍请参见生活服务类。 我的工具类：包含AI原生应用引擎资产中心预置的三方工具以及自创建的工具。 资产中心预置的三方工具：在AI原生应用引擎的左侧导航栏选择“资产中心” ，选择“工具”页签，单击工具卡片，在工具详情页面可以查看工具描述、执行动作、参数配置等信息。 自创建的工具：工具是API的代理或容器，用户可以将常用API封装为工具。在创建工具时，需要先将选定的 API服务 注册为一个工具，然后再添加该服务下的API作为工具的执行动作。具体介绍请参见创建工具。 在工作流中首次调用我的工具类的节点需要新增实例，实例是工具的鉴权方式，如果未新增实例，工具就无法调通。 在工具类节点配置时，单击“新增实例”，此处以“历史上的今天”节点配置为例，如图1所示。 图1 历史上的今天节点配置 在“创建实例”面板，配置表1参数信息。 表1 创建实例参数说明 参数名称 参数说明 基本信息 实例名称 必填项，自定义实例名称。 描述 选填项，输入实例相关描述信息。 验证信息 API Key 必填项。 资产中心预置的三方工具 对于第三方厂商工具，需要在该厂商的官网进行购买或注册，以获取鉴权信息。 对于其他租户上架的工具，在AI原生应用引擎的左侧导航栏选择“资产中心” ，选择“工具”页签，鼠标光标移至工具卡片上，单击“设置鉴权”，设置鉴权信息弹框中通常会展示工具鉴权获取地址，请根据界面提示进行获取。 租户自创建的工具，请填写工具创建时设置的鉴权信息。 父主题： 管理工作流

查询知识库配置说明 输入参数 用户配置运行动作执行动作，相关参数说明如表1所示。 表1 输入参数说明 参数 是否必填项 说明 知识库ID 是 需要使用的知识库。 单击“获取知识库ID”，进入“我的知识库”列表，单击复制。 similarity_min 否 搜索的关键字和返回内容的相似度阈值，取值范围是0~1。 示例：如果输入0.5，则返回相似度大于等于0.5的结果。 limit 否 检索返回切片限制数量，默认为10条。 filter 否 过滤条件。默认为空，支持填写SearchSqlFilter类对象，SearchSqlFilter参数说明如表2所示，样例如下： { "group_type": "OR", "expressions": [ { "field": "metadata.file_name", "field_type": "STRING", "operator": "EQUAL", "values": [ "四大名著介绍.txt" ] }, { "field": "metadata.path", "field_type": "STRING", "operator": "EQUAL", "values": [ "四大名著介绍.txt" ] } ] } order_by 否 排序规则。默认为空，支持填写SqlOrder类对象，SqlOrder参数说明如表2所示，样例如下： { "order_items": [ { "field": "metadata.order", "field_type": "INT", "order_type": "DESC" } ] } keyword 否 检索的关键字。 根据输入的关键字从知识库内召回匹配的信息，支持自定义输入文本，也可将前序节点的输出作为输入。 表2 SearchSqlFilter 参数 是否必选 参数类型 描述 group_type 否 String 参数解释： 过滤条件运算符。 约束限制： 只有一个expression时，不需要group_type，group_type可以为null。 取值范围： 可以为null，如果不为null，枚举值AND和OR。 默认取值： 不涉及。 expressions 否 Array of Expression objects 参数解释： 过滤条件。 约束限制： 不涉及。 取值范围： 非空，条件数量介于1到10之间。 默认取值： 不涉及。 表3 Expression 参数 是否必选 参数类型 描述 field 否 String 参数解释： 过滤字段。 约束限制： 不涉及。 取值范围： 非空，字符串长度介于1到100之间。 默认取值： 不涉及。 field_type 否 String 参数解释： 过滤字段类型。 约束限制： 不涉及。 取值范围： 可以为null，如果不为null，枚举值：INT、FLOAT、BOOLEAN和STRING。 默认取值： 不涉及。 operator 否 String 参数解释： 过滤操作符。 约束限制： 不涉及。 取值范围： 可以为null，如果不为null，枚举值：EQUAL、NOT_EQUAL、GREAT_THAN、GREAT_EQUAL、LESS_THAN、LESS_EQUAL、IN、NOTIN和STARTS_WITH。 默认取值： 不涉及。 values 否 Array of strings 参数解释： 过滤值。 约束限制： 不涉及。 取值范围： 非空，数量介于1到100之间，每个字符串长度最大不超过2000。 默认取值： 不涉及。 表4 SqlOrder 参数 是否必选 参数类型 描述 order_items 否 Array of OrderItem objects 参数解释： 排序规则。 约束限制： 不涉及。 取值范围： 非空，数量介于1到10之间。 默认取值： 不涉及。 表5 OrderItem 参数 是否必选 参数类型 描述 field 否 String 参数解释： 排序字段。 约束限制： 不涉及。 取值范围： 非空，字符串长度介于1到100之间。 默认取值： 不涉及。 field_type 否 String 参数解释： 排序字段类型。 约束限制： 不涉及。 取值范围： 可以为null，如果不为null，枚举值：INT、FLOAT、BOOLEAN和STRING。 默认取值： 不涉及。 order_type 否 String 参数解释： 排序类型。 约束限制： 不涉及。 取值范围： 不为null，枚举值：ASC（升序）和DESC（降序）。 默认取值： 不涉及。 输出参数 该执行动作是根据用户定义的内容输出指定参数。 节点实例 在工作流中首次调用知识库节点需要新增实例，实例是节点的鉴权方式，如果未新增实例，节点就无法调通。 单击“新增实例”，在“创建实例”面板，配置表6参数信息。 表6 创建实例参数说明 参数名称 参数说明 基本信息 实例名称 必填项，自定义实例名称。 描述 选填项，输入实例相关描述信息。 验证信息 API Key 必填项，具体介绍请参见创建API Key。 单击“保存”，创建实例成功。 节点备注 输入节点备注信息，方便后续查阅节点功能。

前提条件 通过OBS接入数据时，操作账号需获得OBS（对象存储服务）只读权限，具体操作请参见对其他账号授予桶的读写权限。 需具备充足的知识库容量包资源（包含OBS存储配额和向量库存储配额，两者比例为5:1），每个租户默认1G的向量库存储配额，默认配额用完后，请参考购买AppStage购买知识库容量包。 需要具备AI原生应用引擎管理员或开发者权限，权限申请操作请参见AppStage组织成员申请权限。

命中测试 命中测试即测试检索的命中率。 在知识库列表中，单击操作列的“命中测试”。 在命中测试页面，配置测试输入参数，参数说明如表4所示，配置完单击“测试”。 表4 测试输入参数配置 参数 说明 检索内容 输入测试文本。 选择数据集 选择待测试的数据集。 相似度阈值 取值范围为0~1，例如配置为0.5，则返回相似度大于等于0.5的结果。 查询数量 查询最大返回数量。 在“测试结果”区域查看测试效果，测试结果根据相似度从大到小进行排序。 在“测试历史”区域查看该知识库的测试历史记录，每个知识库测试记录最多保留50条。

创建执行动作 在工具详情页面，单击“创建执行动作”，配置执行动作基础信息，参数如表2所示。 表2 执行动作基本信息参数说明 参数 说明 名称 执行动作是需要完成的特定任务，自定义执行动作的名称，比如，“发送电子邮件”。“更新行”。 长度不能超过64个字符，可包含中文、大小写字母、数字及下划线、中划线、英文小括号，不能以下划线、中划线、英文小括号开头。 英文名称 执行动作的英文名称。 类型 默认为API，表示通过调用API的方式创建执行动作。 可见性 可见 隐藏 设置为隐藏的执行动作，在流编排中将不可见。 描述 执行动作的描述信息。 单击“下一步”，配置输入，参数如表2所示，配置完成后单击“下一步”。 表3 输入参数说明 参数 说明 接口路径 API的请求路径。必须以/开头，且不能有连续多个/，不包含除/_-:@%+.~#?&={}[]()、$以外的特殊字符和空格。 以https://aiae.appstage.myhuaweicloud.com/v1/chat/completions为例，接口路径可以填写为v1/chat/completions、/chat/completions、/completions或不填。原则上基准URL+执行动作中填写的接口路径拼接起来为完整的/v1/chat/completions即可。 输入参数 API的请求参数，如果被调用API没有请求参数可不填。 请求头（Header）：HTTP请求消息的组成部分之一，请求头负责通知服务器有关于客户端请求的信息。 单击参数列表“操作”列的可以新增参数，参数配置说明请参见表4。 请求体（Body）：HTTP请求消息的组成部分之一，请求体呈现发送给服务器的数据。 JSON/XML：JSON、XML格式的数据。 参数列表“操作”列的：可选择是否开启“是否支持根节点输入”参数，开启并发布对应工具后，在创建流中添加该执行动作时可以自定义请求体参数的值。 参数列表“操作”列的：新增参数，参数配置说明请参见表4。 导入：可直接粘贴被调用API的JSON、JSON Schema或XML数据，减少逐个配置参数的工作量。导入文件示例请参见JSON Schema/JSON/XML文件示例。 如果请求体使用XML格式，XML header参数必须配置。 复制：复制请求体参数的JSON或XML数据。 预览：可以预览参数的JSON或XML结构。 form-data：文件格式数据。 参数列表“操作”列的：新增参数，参数配置说明请参见表4。 Binary：文件格式数据。输入、输出仅支持配置一处。例如，输出入参数选择了“Binary”，则输出不显示，反之亦成立。 查询参数（Query）：查询参数会追加到URL。例如，在 /items?id=#### 中，查询参数为ID。 单击参数列表“操作”列的可以新增参数，参数配置说明请参见表4。 路径参数（Path）：路径与路径模板一起使用，其中参数值实际上是操作URL的一部分。 表4 参数配置说明 参数 说明 参数名称 输入参数的名称。 显示字段 用户在表单中看到的参数项标签。 必填 勾选该参数是否是用户必填项。 参数类型 选择参数类型，支持string、number、boolean、integer类型。 此外，当请求体（Body）为JSON或XML时，还支持array、object类型参数；当请求体（Body）为form-data时，还支持file类型参数。 说明 关于输入值的介绍说明。 操作 单击：配置参数在界面的显示样式。配置完成并发布对应工具后，在创建流中添加该执行动作时可以查看参数的界面显示效果。 参数类型：选择参数类型。 格式：设置用户输入该参数时界面显示的样式，可选择文本框、日期时间、富文本、下拉列表。不同的参数类型可选择的格式不同。 当格式选择为下拉列表时，需设置标签和下拉列表的值。单击“新增”可进行添加。 设置完成后，如果勾选了“支持多选”，则可在创建流中添加该执行动作时选择多个值，否则，只能选择一个值。需要配置分隔符，分隔符只能输入单个特殊字符，如“,”“$”、“%”、“^”、“&”等，不设置时，默认为“,”。 可见性：设置用户输入该参数时界面显示的可见性。 无：在流中正常显示。 高级：默认隐藏在高级设置菜单里。 隐藏：该参数向用户隐藏。 重要：优先显示在表单的最开始。 默认值：当格式选择为文本框、日期时间、富文本时，支持设置该参数的预设值。 单击：新增节点。 单击：删除该节点。 单击“下一步”，配置输出参数，参数如表2所示。 表5 输出参数说明 参数 说明 添加响应 单击“添加响应”，根据被调用API的响应码信息添加响应码。 输出参数 配置输出参数，如被调用API没有响应参数可不填。 响应体：HTTP响应消息的组成部分之一，响应体呈现发送给服务器的数据。 JSON/XML：JSON、XML格式的数据。 参数列表“操作”列的：新增参数，参数配置说明请参见表4。 当选择XML格式时，单击参数列表“操作”列的，配置XML标签名。 导入：可直接粘贴被调用API的JSON Schema、JSON或XML数据，减少逐个配置参数的工作量。导入文件示例请参见JSON Schema/JSON/XML文件示例。 如果响应体使用XML格式，XML header参数必须配置。 复制：复制请求体参数的JSON或XML数据。 预览：可以预览参数的JSON或XML结构。 Binary：文件格式数据。输入、输出仅支持配置一处。例如，输出入参数选择了“Binary”，则输出不显示，反之亦成立。 响应头：HTTP响应消息的组成部分之一，响应头负责通知服务器有关于客户端请求的信息。 单击参数列表“操作”列的可以新增参数，参数配置说明请参见表4。 单击“下一步”，调试校验工具，验证工具是否可用。 配置用例设置参数，参数说明如表6所示。配置完成后，单击“提交测试”。 表6 配置用例设置参数说明 参数 说明 实例 选择已创建好的实例。 也支持新建实例，单击“新建实例”，配置实例名称、描述及验证信息，验证信息填写工具创建时所配置的鉴权信息，单击“保存”。 验证信息与步骤3所选的验证方式相关，如果验证方式为“无验证”，则无需配置实例。 定义参数 配置输入参数。 在测试结果预览区域，查看测试结果。 工具调试完成后，单击“保存”。 新创建的工具显示在“我的工具”列表中，任务状态为“待上架”，请参考表1上架工具。

多分支条件 选择多分支条件后，侧边栏会展示该动作包含的参数，画布上会展示一个多分支条件的白色框，单击“添加分支”，添加业务场景所需要的各个分支条件，同时画布上会展示各个分支条件的信息，分支条件里面可以再添加其他分支。 如果想对多分支条件的当前项进行数据处理，可在多分支条件中进行业务编排。流开始运行时，会先运行多分支条件里面的各个执行动作，之后运行分支以外的执行动作。如果多分支条件运行没有结果，系统默认会按照分支默认条件去执行。 参数配置 用户配置多分支条件执行动作，相关参数说明如表3所示。 表3 多分支条件参数说明 参数 是否必填项 说明 数据类型 是 支持字符串、整数。 条件值 是 多分支条件需要满足的条件。 节点备注 输入节点备注信息，方便后续查阅节点功能。

数据分片 数据分片执行动作可以将数组类型的变量按指定策略进行分组。例如：输入参数为[1,2,3,4]，按固定数量策略进行分组，期望分片数量为2，那么最终结果为[[1,2],[3,4]]。如果不能整分，则每小组数量为入参数组长度与期望分片数量相除，结果向上取整，例如：输入参数为[1,2,3,4,5]，按固定数量策略进行分组，期望分片数量为2，那么最终结果为[[1,2,3],[4,5]]。 参数配置 数据分片相关参数如表2所示。 表2 数据分片参数说明 参数 是否必填项 说明 分片对象 是 数组类型的自定义变量或之前节点的出参。 分片策略 是 设置分片策略，目前策略仅有“固定数量”一种。 分片数量 是 获得数组数量的期望值。 节点备注 输入节点备注信息，方便后续查阅节点功能。

发布Agent Agent发布后，用户即可通过API接口调用或Web界面进行访问。 Agent创建完成后，在创建页面单击“发布”。 也可以在“我创建的”列表中，单击Agent列表操作列的“发布Agent”，进入发布页面。 选择发布渠道并设置发布密钥，单击“发布”。 表4 发布参数说明 参数 说明 选择发布渠道 API：以API的方式发布Agent，发布成功后可复制API地址进行分享。 Web UrI：以Web Url的方式发布Agent，发布成功后可复制Web链接进行分享。 设置发布密钥 设置该密钥是确保发布分享Agent后，用户能正常调用Agent相关联的模型、工具、工作流和知识库。 API Key：输入AI原生应用引擎平台API Key，获取方式请参见创建API Key。 部署资源 选择发布方式 免费额度：每个租户有3个免费额度，使用免费额度发布Agent运行速度相对缓慢。 运行时引擎SKU额度：请参见购买AI原生应用引擎进行订购，一个额度代表一个节点数量。 节点数量 使用免费额度发布，默认为单节点部署。 使用运行时引擎SKU额度发布，可选择多节点集群部署。 在Agent列表的“发布地址”列，单击或，复制发布地址进行分享。

操作指引 图1 模型使用操作指引 表1 模型使用流程详解 序号 流程环节 说明 1 基于微调数据集进行模型微调 创建微调数据集 收藏预置微调数据集 对于需要个性化定制模型或者在特定任务上追求更高性能表现的场景，往往需要对大语言模型进行模型微调以适应特定任务。微调数据集是模型微调的基础，通过在微调数据集上进行训练从而获得改进后的新模型。 创建模型微调任务 模型微调是指调整大型语言模型的参数以适应特定任务的过程，适用于需要个性化定制模型或者在特定任务上追求更高性能表现的场景。这是通过在与任务相关的微调数据集上训练模型来实现的，所需的微调量取决于任务的复杂性和数据集的大小。在深度学习中，微调用于改进预训练模型的性能。 2 生成模型服务 将模型部署为模型服务 接入模型服务 支持通过API接入模型服务，同时支持将平台预置模型进行微调后，部署为模型服务，模型服务可以在创建Agent时使用或通过模型调用接口调用。 3 调测模型 通过调测模型，可检验模型的准确性、可靠性及反应效果，发现模型中存在的问题和局限性，确保模型能够在实际应用中正常运行，并且能够准确地预测和处理数据。

标注数据集 在“数据标注”列表中，单击操作列的“标注”。 在“标注信息”页面，在“数据集文件列表”下拉列表中选择文件。 单击“全部信息”页签下的“创建对话”顺次生成一条不完整信息（对话样式），用户根据实际需要填写对话的instruction（指令）、input（输入/提问）、output（输出/回答），完成一条数据标注。 对于单条标注，还可执行以下操作： 单击标注右侧“添加回答”可继续添加多条output。 单击标注右侧“删除”，可删除标注。 对于标注中的output，还可执行以下操作： 单击output所在行右侧的“自动生成”，由平台内置的模型chatglm3-6b自动生成当前行的output信息。 单击output所在行右侧的“重新生成”，由平台内置的模型chatglm3-6b重新生成当前行的output信息。 单击output所在行右侧的“删除”，可删除当前行的output信息。

更多操作 一条数据标注完成后，可执行如下表1所示的操作。 表1 更多操作 操作 说明 删除标注 在“数据标注”页面的标注数据集列表中，单击操作列的“删除”。 发布标注 在“数据标注”页签下的列表中，单击操作列的“发布”。 在“发布”对话框，有两种发布方式： 选择发布后“更新原始数据集”，单击“确定”，覆盖原数据集信息（数据集名称不变）。 选择发布后“创建新数据集”，设置新数据集名称，然后单击“确定”。

追加到字符串变量 需要先定义一个字符串变量，可将“值”内填写的数据，以字符串的形式追加到字符串变量中。例如，先定义一个变量名为data的变量，类型为字符串，值为Str，使用追加到字符串变量后，可在下拉框内选择data，传入值ing，运行即可获得变量data，类型为字符串，值为String。 参数配置 追加到字符串变量相关参数说明请参考表5。 表5 追加到字符串变量输入参数说明 参数 说明 变量名 选择已定义的变量。 值 填写待追加的值。 节点备注 输入节点备注信息，方便后续查阅节点功能。

数值递减 需要先定义一个整数变量，可按填写的值进行递减。例如，先定义参数data为整数10，数值递减值为2，递减后可以得到data的值为8，如果放在循环内执行，可以得到递减次数为循环次数的数值data。 参数配置 用户配置数值递减执行动作，相关参数说明请参考表4。 表4 数值递减输入参数说明 参数 说明 变量名 选择已定义的变量。 值 设定参数的预设值。 节点备注 输入节点备注信息，方便后续查阅节点功能。