文档

RunChatResultGeneration - 对话结果生成

更新时间:

对话结果生成,可选择模型进行对话,支持流式和非流式。

接口说明

请确保在使用该接口前,已充分了解通义点金产品的收费方式和价格。

前提条件

已开通 百炼服务和通义点金服务。

获取到 workspaceId:获取 workspace 标识

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /{workspaceId}/api/run/chat/generation

请求参数

名称类型必填描述示例值
workspaceIdstring

路径参数,业务空间 id。

llm-xxxxx
bodyobject

请求体参数。

inferenceParametersobject

推理使用的超参数

{"topP": 0.8}
messagesarray<object>

输入模型的消息

object
contentstring

消息的内容

你是一个信息处理专家
rolestring

消息的角色

user
modelIdstring

模型服务种类,请通过/api/app/config 接口获取,对应的字段 llmHelperTypeList

qwen-max
sessionIdstring

sessionId,可用于标记对话

237645726354
streamboolean

是否流式: true,流式返回答案;false,全量返回答案。不填默认为 false

false
toolsarray<object>

输入的工具信息. 用于指定可供模型调用的工具列表。当输入多个工具时,模型会选择其中一个生成结果。

object

工具信息

functionobject

类型为 object,键值包括 name,description 和 parameters

descriptionstring

类型为 string,表示工具函数的描述,供模型选择何时以及如何调用工具函数

工具函数的描述
namestring

类型为 string,表示工具函数的名称,必须是字母、数字,可以包含下划线和短划线,最大长度为 64

get_time
parametersobject

类型为 object,表示工具的参数描述,需要是一个合法的 JSON Schema。

propertiesobject

属性

{ "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "unit": { "type": "string", "enum": [ "celsius", "fahrenheit" ] } }
typestring

类型

object
requiredarray

必填参数列表

string

必填参数

location
typestring

类型为 string,表示 tools 的类型,当前仅支持 function

function

返回参数

名称类型描述示例值
object
choicesarray<object>

模型生成内容的详情。

object

模型生成内容的详情。

finishReasonstring

有三种情况:

  • 正在生成时为 null;

  • 因触发输入参数中的 stop 条件而结束为 stop;

  • 因生成长度过长而结束为 length。

null
indexinteger

生成的结果序列编号,默认为 0。

0
messageobject

对话消息

contentstring

对话内容

你是谁
rolestring

角色

user
toolCallsarray<object>

工具调用列表

object

工具调用

{ "type": "function", "function": { "name": "get_current_weather", "arguments": "{\"location\": \"长沙\", \"unit\": \"celsius\"}" }, "id": "" }
createdlong

创建时间

1720602203
idstring

请求标识

eb2b6139-ddf1-91a0-a47f-df7617ae9032
modelIdstring

大模型 ID。

qwen-max
requestIdstring

请求 id

eb2b6139-ddf1-91a0-a47f-df7617ae9032
timestring

时间戳

2024-04-24 11:54:34
totalTokensinteger

tokens 总量

500
usageobject

用量

imageCountinteger

图片数,wanx 等模型返回

0
imageTokensinteger

图片 tokens,qwen-vl 等模型返回

0
inputTokensinteger

输入 tokens

200
outputTokensinteger

输出 tokens

300
totalTokensinteger

tokens 总量

500

示例

正常返回示例

JSON格式

{
  "choices": [
    {
      "finishReason": "null",
      "index": 0,
      "message": {
        "content": "你是谁",
        "role": "user",
        "toolCalls": [
          {
            "type": "function",
            "function": {
              "name": "get_current_weather",
              "arguments": "{\"location\": \"长沙\", \"unit\": \"celsius\"}"
            },
            "id": ""
          }
        ]
      }
    }
  ],
  "created": 1720602203,
  "id": "eb2b6139-ddf1-91a0-a47f-df7617ae9032",
  "modelId": "qwen-max",
  "requestId": "eb2b6139-ddf1-91a0-a47f-df7617ae9032\n",
  "time": "2024-04-24 11:54:34",
  "totalTokens": 500,
  "usage": {
    "imageCount": 0,
    "imageTokens": 0,
    "inputTokens": 200,
    "outputTokens": 300,
    "totalTokens": 500
  }
}

错误码

访问错误中心查看更多错误码。