检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 类型 说明 工作流 调用工作流应用接口。 智能体 调用智能体应用、上传文件接口。
接入模型服务API接口规范 当前模型网关支持文本对话(Chat)、文本向量化(Embeddings)、文本排序(Rerank)、图像理解类型的API接入。 模型API接入之前,请确保符合相对应的接口规范,其中文本对话、文本向量化、图像理解类型需要符合OpenAI接口规范,文本排序类型需要符合AI引擎标准协议。
发布完成后跳转至发布管理页面,可以查看API调用接口信息。 也可通过左侧导航栏中选择“开发中心 > 应用管理 > 单智能体应用”,单击目标应用,进入应用主页面,单击右上角“发布管理”按钮,可进入发布管理页面。 图6 调用API 通过API运行应用 应用发布为API服务之后,可通过API调用单智能体应用
在应用广场主界面单击“智能体”页签,找到“天气查询助手”智能体,如图3所示。 图3 天气查询助手智能体 单击“天气查询助手”应用,在智能体应用主界面,您可以在对话框中输入描述。例如:“南京未来一周的天气怎么样?”,体验该智能体功能是否符合您的需求。 图4 天气查询助手智能体 在应用页面的右上
如何调用API 构造请求 认证鉴权 返回结果
工作流应用”页面,选择目标工作流。 单击“ > 复制ID”,可获取当前工作流ID。请记录保存,用于填写调用Agent应用接口的agent_id字段。 使用API调用单智能体应用 工作流发布为API服务之后,可通过API调用工作流应用。详情请参考调用工作流应用示例。 父主题: 使用工作流
API 工作流 智能体
使用API调用多智能体应用 Versatile的API调用是应用开发中的强大工具,可以帮助用户快速集成功能和服务,同时支持与其他系统或服务进行交互,提升应用性能和用户体验。合理设计和管理API是确保应用安全和稳定的关键。通过API,用户可以构建功能丰富、高效的应用,满足多样化的用户需求。
使用API调用单智能体应用 Versatile提供Open API请求方式,可通过调用路径发送请求,程序将调用应用并返回预期结果。 Versatile的API调用是应用开发中的强大工具,可以帮助用户快速集成功能和服务,同时支持与其他系统或服务进行交互,提升应用性能和用户体验。合理
请求头 填写API的请求头信息,需根据API的参数配置要求填写。 例如: Key:Content-Type Value:application/json 权限校验 选择调用API时是否需要鉴权。 无需鉴权:API可以公开访问,不需要任何形式的身份验证或授权。 API Key:在调用API时提供一个唯一的API
调用智能体应用 功能介绍 该接口用于运行知识型智能体应用,支持单智能体和多智能体,支持在指定的项目、智能体和对话上下文中执行智能体逻辑。接口支持流式响应模式,可以根据需要返回增量执行结果,适用于实时交互场景。 适用场景: 在项目中运行预定义的知识型智能体应用。 支持调试模式和发布模式,适用于不同开发和生产环境。
调用工作流应用 功能介绍 该接口用于运行场景化应用,支持在指定的项目、工作流和对话上下文中执行工作流逻辑。接口支持流式响应模式,可以根据需要返回增量执行结果,适用于实时交互场景。 适用场景: 在项目中运行预定义的工作流。 支持调试模式和发布模式,适用于不同开发和生产环境。 支持流
charset=utf-8。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数
工作流 调用工作流应用 父主题: API
智能体 调用智能体应用 上传文件 父主题: API
完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头
上传文件 功能介绍 该接口用于智能体上传文件,支持多种图片、文档、表格等多种格式的文件上传。接口返回临时下载路径,可用于临时下载文件。 适用场景:在智能体应用中上传文件。 格式要求: 办公文档:DOC、DOCX、XLS、XLSX、PPT、PPTX、PDF、Numbers、CSV。
使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过
应用示例 调用工作流应用示例 调用智能体应用示例
附录 状态码 错误码 获取项目ID 获取账号ID 获取工作区ID