构造请求-j9九游会登录
本节介绍rest api请求的组成,并以调用appstage服务的文本对话接口说明如何调用api。
您还可以通过这个视频教程了解如何构造请求调用api: 。
请求uri
请求uri由如下部分组成。
{uri-scheme} :// {endpoint} / {resource-path} ? {query-string}
尽管请求uri包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。
|
参数 |
描述 |
|---|---|
|
uri-scheme |
表示用于传输请求的协议,当前所有api均采用https协议。 |
|
endpoint |
指定承载rest服务端点的服务器域名或ip,不同服务不同区域的endpoint不同,当前appstage服务只在“华北-北京四”部署,endpoint为“aiae.appstage.myhuaweicloud.com”。 |
|
resource-path |
资源路径,即api访问路径。从具体api的uri模块获取,例如文本对话api的resource-path为“/v1/chat/completions”。 |
|
query-string |
查询参数,是可选部分,并不是每个api都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 |
例如,您需要调用appstage在“华北-北京四”区域的文本对话接口,则需使用“华北-北京四”区域的endpoint(aiae.appstage.myhuaweicloud.com),并在文本对话的uri部分找到resource-path(/v1/chat/completions),拼接起来如下所示。
https://aiae.appstage.myhuaweicloud.com/v1/chat/completions
为查看方便,在每个具体api的uri部分,只给出resource-path部分,并将请求方法写在一起。这是因为uri-scheme都是https,而endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
请求方法
http请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。
|
方法 |
说明 |
|---|---|
|
get |
请求服务器返回指定资源。 |
|
put |
请求服务器更新指定资源。 |
|
post |
请求服务器新增资源或执行特殊操作。 |
|
delete |
请求服务器删除指定资源,如删除对象等。 |
|
head |
请求服务器资源头部。 |
|
patch |
请求服务器更新资源的部分内容。 当资源不存在的时候,patch可能会去创建一个新的资源。 |
在调用文本对话接口的uri部分,您可以看到其请求方法为“post”,则其请求为:
post https://aiae.appstage.myhuaweicloud.com/v1/chat/completions
请求消息头
附加请求头字段,如指定的uri和http方法所要求的字段。例如定义消息体类型的请求头“content-type”,请求鉴权信息等。
|
名称 |
描述 |
是否必选 |
示例 |
|---|---|---|---|
|
content-type |
消息体的类型(格式),当前只支持application/json。 |
是 |
application/json |
|
ts |
毫秒时间戳。 |
是 |
1707101222000 |
|
nonce |
请求唯一标识(uuid)。从ak/sk认证中获取。 |
是 |
- |
|
ak |
为ak/sk凭证文件中的ak明文。从ak/sk认证中获取。 |
是 |
- |
|
sign |
签名字符串。从ak/sk认证中获取。 |
是 |
- |
|
resource-code |
wiseagent对外开放接口对应的唯一编码,每个接口唯一。请参考表5。 |
是 |
modelmarket.chat |
|
名称 |
描述 |
是否必选 |
示例 |
|---|---|---|---|
|
content-type |
消息体的类型(格式),当前只支持application/json。 |
是 |
application/json |
|
authorization |
认证信息。格式为:bearer ${api key} |
是 |
bearer sk-5db9*********dd58 |
|
resource-code |
接口 |
|---|---|
|
modelrouter.chat |
|
|
modelrouter.embeddings |
|
|
knowledgebases.query.embeddata |
请求消息体
请求消息体通常以结构化格式发出,与请求消息头中content-type对应,传递除请求消息头之外的内容。如果请求消息体中参数支持中文,则中文字符必须为utf-8编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),get、delete操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
对于文本对话接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。
post https://aiae.appstage.myhuaweicloud.com/v1/chat/completions
{
"model": "platform:chatglm3-6b",
"messages": [
{
"role": "user",
"content": "你好!"
}
],
"stream": false
}
到这里为止这个请求需要的内容就具备齐全了,您可以使用、或直接编写代码等方式发送请求调用api。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨