对话接口 - LinkAI开放接口

请求参数

Header 参数

Authorization

string

必需

在 LinkAI平台-应用接入生成API Key并填入

示例值:

Bearer YOUR_API_KEY

Body 参数application/json

messages

array [object {2}]

消息列表

必需

消息上下文列表，可以传入历史对话记忆，每一轮包含一条user消息和一条assistant消息，最后一条为用户的问题

role

string

角色

必需

支持填写 system, user, assistant 中的一个，分别表示系统提示词、用户问题、AI回复

content

string

内容

必需

文本内容

app_code

string

应用code

可选

应用或工作流的 code。若不填则表示不绑定具体应用，将请求直接传递给模型

model

string

模型编码

可选

不传则使用应用的默认模型，所有支持模型见模型列表

temperature

number

温度

可选

默认为应用中配置的温度。温度越高回复越具有创意和不确定性，温度越低则回复更严谨

top_p

integer

模型采样范围

可选

控制模型采样范围，默认值为 1

frequency_penalty

number

频率惩罚项

可选

该参数越大则更倾向于产生不同的内容，范围为 [-2, 2]，默认值为 0

presence_penalty

number

存在惩罚项

可选

该参数越大则更倾向于产生不同的内容，范围为 [-2, 2]，默认值为 0

stream

boolean

是否流式输出

可选

默认值为 false

示例

{
  "app_code": "",
  "messages": [
    {
      "role": "user",
      "content": "你好"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.link-ai.tech/v1/chat/completions?members&reference&Type&_postman_listIndexKey=key&_postman_listAllowsMultipleValues' \
--data-raw '{
    "app_code": "",
    "messages": [
        {
            "role": "user",
            "content": "你好"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

choices

array [object {2}]

必需

index

integer

可选

message

object

可选

usage

object

必需

prompt_tokens

integer

请求token数

必需

completion_tokens

integer

响应token数

必需

total_tokens

integer

总token数

必需

总token计算包含请求和响应中的总token数，其中请求又包含应用设定、历史对话、知识库内容、用户问题

示例

{
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "你好啊！有什么我可以帮助你的吗？"
      }
    }
  ],
  "usage": {
    "prompt_tokens": 32,
    "completion_tokens": 24,
    "total_tokens": 56
  }
}

🟢200成功-流式输出

🟠400参数不正确

🟠401API Key鉴权失败

🟠402应用不存在

🟠403应用无访问权限

🟠406余额不足

🟠409内容审核不通过

🔴503服务异常