Chat Completions

开发中

POST

/api/v2/assistant/chat/completions

可以直接使用OpenAI官方SDK中的ChatOpenAI组件去使用助手（只支持文档内有的参数。官方组件里其他的例如n、top_p、max_token等参数暂不支持）
示例代码如下：

请求参数

Body 参数application/json

model

string

要使用的助手ID

必需

示例值:

a31d044d-af13-43da-b715-d87a29569809

messages

array [object {2}]

必需

历史消息列表。不支持system类型，system使用助手本身的prompt

role

string

必需

示例值:

user

content

string

必需

示例值:

你好

temperature

integer

可选

使用什么采样温度，介于 0 和 2 之间。非0值会覆盖助手配置

stream

boolean

是否是流式返回

可选

示例

{
    "model": "a31d044d-af13-43da-b715-d87a29569809",
    "messages": [
        {
            "role": "user",
            "content": "你好"
        }
    ],
    "temperature": 0,
    "stream": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://192.168.50.15:7860/api/v2/assistant/chat/completions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "a31d044d-af13-43da-b715-d87a29569809",
    "messages": [
        {
            "role": "user",
            "content": "你好"
        }
    ],
    "temperature": 0,
    "stream": true
}'

返回响应

🟢200成功

application/json

Body

string

必需

object

string

必需

created

integer

必需

choices

array [object {3}]

必需

index

integer

可选

message

object

可选

finish_reason

string

可选

usage

object

必需

prompt_tokens

integer

必需

completion_tokens

integer

必需

total_tokens

integer

必需

示例

{
    "id": "148964adf7ec439f87a6240289735740",
    "object": "chat.completion",
    "created": 1720755036,
    "model": "a31d044d-af13-43da-b715-d87a29569809",
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "你好，有什么可以帮你的？"
            },
            "finish_reason": "stop"
        }
    ]
}

修改于 2024-09-06 03:47:25

OpenAPI

Get Knowledge