网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
文档首页/ 应用平台 AppStage/ API参考/ API/ 模型调用/ 调用文本对话模型服务

调用文本对话模型服务

更新时间:2025-01-20 GMT+08:00
分享

功能介绍

调用大语言模型推理服务,根据用户问题,获取大语言模型的回答。

调用方法

请参见如何调用API

URI

POST https://aiae.appstage.myhuaweicloud.com/v1/chat/completions

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

参数解释:

鉴权信息。获取平台API Key,并为API Key添加前缀Bearer,得到标准鉴权信息,例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

messages

Array of ChatCompletionRequestMessage objects

参数解释:

文本对话消息体类。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

model

String

参数解释:

模型服务调用唯一id字段。平台定义了4种模型服务:

1.平台预置模型服务

登录AI原生应用引擎,在左侧导航栏选择”资产中心“,选择“大模型”页签,单击模型卡片进入模型详情页面,查看模型服务调用ID。

2.租户部署模型服务

登录AI原生应用引擎,在左侧导航栏选择“模型中心 > 我的模型服务”,选择“我部署的”页签,在模型服务列表中复制模型服务调用ID。

3.租户接入模型服务

登录AI原生应用引擎,在左侧导航栏选择“模型中心 > 我的模型服务”,选择“我接入的”页签,在模型服务列表中复制模型服务调用ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

frequency_penalty

Number

参数解释:

正值会根据文本中新Token的现有频率对其进行惩罚,从而降低模型重复相同行的可能性。

约束限制:

不涉及。

取值范围:

介于-2.0和2.0之间。

默认取值:

0。

logit_bias

Map<String,Integer>

参数解释:

该参数接受一个JSON对象,将标记映射到从-100(禁止)到100(独占选择标记)的关联偏差值。

像-1和1这样的适度值将以较小的程度改变选择标记的概率。

使用logit_bias参数时,偏差被添加到模型生成的logits之前进行抽样。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

max_tokens

Integer

参数解释:

返回体允许的最大token数。

约束限制:

不涉及。

取值范围:

介于1和4096之间。

默认取值:

4096。

n

Integer

参数解释:

返回体中包含的chatCompletionChoice数量,建议默认设置为1,最大限度地降低成本。

约束限制:

不涉及。

取值范围:

介于1和128之间。

默认取值:

1。

presence_penalty

Number

参数解释:

正值会根据它们是否出现在文本中来惩罚得到新的Token,从而增加模型谈论新主题的可能性。

约束限制:

不涉及。

取值范围:

介于-2.0和2.0之间。

默认取值:

0。

stream

Boolean

参数解释:

是否流式返回。

设为true时,返回结果为流式;

设为false时,返回结果为JSON格式结构化数据。

约束限制:

不涉及。

取值范围:

true或者false。

默认取值:

false。

temperature

Number

参数解释:

较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。建议该参数设置为1。

约束限制:

不涉及。

取值范围:

介于0.0和2.0之间。

默认取值:

1。

top_p

Number

参数解释:

影响输出文本的多样性,取值越大,生成文本的多样性越强。

约束限制:

不涉及。

取值范围:

介于0.0和1.0之间。

默认取值:

0.5。

tools

FunctionCallTool object

参数解释:

可供模型调用的工具。

约束限制:

目前仅如下模型支持此功能:

glm-4

glm-3-turbo

moonshot-v1-8k

moonshot-v1-32k

moonshot-v1-128k

取值范围:

参考约束限制。

默认取值:

不涉及。

tool_choice

String

参数解释:

用于控制模型是如何选择要调用的函数,仅当工具类型为function时补充。

约束限制:

不涉及。

取值范围:

当前仅支持auto。

默认取值:

auto。

content_security_verify

ContentSecurityVerify object

参数解释:

控制是否开启内容审核。如果开启内容审核,AI原生应用引擎会对模型返回结果进行审查。

约束限制:

不涉及。

取值范围:

true或者false。

默认取值:

false。

表3 ChatCompletionRequestMessage

参数

是否必选

参数类型

描述

content

String

参数解释:

消息具体内容。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

role

String

参数解释:

消息体对应的角色。

约束限制:

不涉及。

取值范围:

如果是系统则为system。

如果是用户则为user。

默认取值:

不涉及。

name

String

参数解释:

对话参与者的可选名称,提供给模型信息以区分相同角色的不同对话参与者。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 FunctionCallTool

参数

是否必选

参数类型

描述

type

String

参数解释:

调用工具类型。

约束限制:

目前仅支持function。

取值范围:

不涉及。

默认取值:

function。

function

function object

参数解释:

仅当工具类型为function时补充。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表5 function

参数

是否必选

参数类型

描述

name

String

参数解释:

函数名称。

约束限制:

只能包含a-z,A-Z,0-9,下划线和中横线,最大长度限制为64。

取值范围:

不涉及。

默认取值:

不涉及。

description

String

参数解释:

用于描述函数功能。

模型会根据这段描述决定函数调用方式。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

parameters

Object

参数解释:

Json Schema对象,用于定义函数所接受的参数。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表6 ContentSecurityVerify

参数

是否必选

参数类型

描述

is_response_verify

Boolean

参数解释:

是否开启返回体内容审核(默认不开启)。

有文本内容,则对文本进行内容审核;

有图片内容,则会对图片进行内容审核。

约束限制:

不涉及。

取值范围:

true或false

默认取值:

false。

响应参数

状态码: 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。

取值范围:

不涉及。

请求示例

{
  "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

OK

500

服务器内部错误或三方服务器内部错误。

错误码

请参见错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容