api-park-docs神州问学文档中心
大语言模型

模型对话

为给定的聊天对话创建模型响应。

POST
/
opi-maas
/
v1
/
chat
/
completions

鉴权

神州问学 API 使用 App-IdApi-Key 进行鉴权,需要在调用接口时将其填入到 HTTP 请求的请求头参数中。可以参考鉴权

App-Id
string
header
required

应用 App ID。

Api-Key
string
header
required

应用 Api Key。

请求

请求体

注:模型参数需要根据模型返回的能力参数和支持的参数进行填写

application/json
model
String
required

要使用的模型名称

messages
Array
required

对话消息列表。

temperature
Number

采样温度,0-2,默认1(可选)。

extra_parameters
Object
required

额外参数。

top_p
Number

核采样概率,0-1,默认1(可选)。

n
Integer

生成多少个聊天完成选项,默认1(可选)。

stream
Boolean

是否流式输出,默认false(可选)。

thinking
Object

思考过程配置(可选)。

stop
StringOrArray

停止序列,遇到则停止生成(可选)。

max_tokens
Integer

生成的最大token数(可选)。

presence_penalty
Number

存在惩罚,-2.0到2.0,默认0(可选)。

frequency_penalty
Number

频率惩罚,-2.0到2.0,默认0(可选)。

logit_bias
Object

token偏好调整,映射token ID到偏差值(可选)。

user
String

用户标识,用于滥用检测(可选)。

response_format
Object

响应格式控制(可选)。

tools
Array

可用工具列表(可选)。

tool_choice
StringOrObject

工具选择策略(可选)。

parallel_tool_calls
Boolean

是否允许并行工具调用,默认true(可选)。

stream_options
Object

流式选项(可选)。

seed
Integer

随机种子,用于确定性输出(可选)。

cURL
curl --location --request POST '{api_base_url}/opi-maas/v1/chat/completions' \
--header 'App-Id: {App-Id}' \
--header 'Api-Key: {Api-Key}' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--data-raw '{
    "model": "微软|Azure-GPT-4",
    "messages": [
        {
            "role": "user",
            "content": "帮我查询武汉热门景点top5"
        }
    ],
    "thinking": {
        "type": "disabled"
    },
    "temperature": 0.5,
    "stream": true,
    "max_tokens": 1024,
    "extra_parameters": {
        "model_id": "3308"
    }
}'

响应

id
String

本次对话的唯一标识符。

created
Integer

创建时间戳(秒)。

model
String

使用的模型名称。

object
String

对象类型,固定为"chat.completion"。

system_fingerprint
String

系统指纹标识(可选)。

choices
Array

生成的选择列表。

usage
Object

Token使用情况。

service_tier
StringOrNull

服务等级(可选)。

prompt_filter_results
Array

提示词过滤结果(可选)。

Response
{
    "id": "chatcmpl-CyTpAkzk5JUU7jNXLB6TsBuvZIjtL",
    "created": 1768530360,
    "model": "gpt-4.1-2025-04-14",
    "object": "chat.completion",
    "system_fingerprint": "fp_f99638a8d7",
    "choices": [
        {
            "finish_reason": "stop",
            "index": 0,
            "message": {
                "content": "当然可以!以下是**武汉热门景点TOP5**(2024年最新推荐):\n\n1. **黄鹤楼**\n   - 简介:位于长江南岸的蛇山顶,是中国最著名的古楼之一,有“天下江山第一楼”之称。\n   - 特色:历史悠久,登楼可俯瞰武汉三镇和长江美景。\n\n2. **武汉东湖风景区**\n   - 简介:中国最大的城市湖泊,湖光山色,风景秀丽。\n   - 特色:有磨山、听涛、落雁等多个景区,适合骑行、散步、赏花。\n\n3. **武汉长江大桥**\n   - 简介:中国第一座公铁两用桥,横跨长江,是武汉的标志性建筑。\n   - 特色:桥上可观江景,夜景尤为壮观。\n\n4. **户部巷**\n   - 简介:武汉著名的小吃街,已有百年历史。\n   - 特色:汇集了热干面、豆皮、三鲜豆腐皮等武汉地道美食。\n\n5. **武汉大学**\n   - 简介:被誉为“中国最美大学”之一,尤其以樱花季闻名。\n   - 特色:春天樱花盛开,建筑风格独特,校园环境优美。\n\n---\n如需详细攻略或其他景点推荐,欢迎随时告知!",
                "role": "assistant",
                "tool_calls": null,
                "function_call": null,
                "annotations": []
            }
        }
    ],
    "usage": {
        "completion_tokens": 327,
        "prompt_tokens": 16,
        "total_tokens": 343,
        "completion_tokens_details": {
            "accepted_prediction_tokens": 0,
            "audio_tokens": 0,
            "reasoning_tokens": 0,
            "rejected_prediction_tokens": 0,
            "text_tokens": null
        },
        "prompt_tokens_details": {
            "audio_tokens": 0,
            "cached_tokens": 0,
            "text_tokens": null,
            "image_tokens": null
        },
        "total_price": 0.343,
        "currency": 1
    },
    "service_tier": null,
    "prompt_filter_results": [
        {
            "prompt_index": 0,
            "content_filter_results": {
                "hate": {
                    "filtered": false,
                    "severity": "safe"
                },
                "jailbreak": {
                    "filtered": false,
                    "detected": false
                },
                "self_harm": {
                    "filtered": false,
                    "severity": "safe"
                },
                "sexual": {
                    "filtered": false,
                    "severity": "safe"
                },
                "violence": {
                    "filtered": false,
                    "severity": "safe"
                }
            }
        }
    ]
}
id
String

本次对话的唯一标识符(同一流中的所有chunk相同)。

created
Integer

创建时间戳(秒)。

model
String

使用的模型名称。

object
String

对象类型,流式中为"chat.completion.chunk"。

system_fingerprint
String

系统指纹标识(仅在第一个chunk中出现)。

choices
Array

流式生成片段。

usage
ObjectOrNull

Token使用情况(仅在最后一个chunk中出现)。

service_tier
StringOrNull

服务等级(可选)。

prompt_filter_results
ArrayOrNull

提示词过滤结果(可选,仅在相关chunk中出现)。

流式响应示例

Stream Chunk
{
    "id": "chatcmpl-CyTuZbH7HRrsSYgvu1kiRBBebqm06",
    "created": 1768530696,
    "model": "gpt-4.1-2025-04-14",
    "object": "chat.completion.chunk",
    "system_fingerprint": "fp_f99638a8d7",
    "choices": [
        {
            "content_filter_results": {
                "hate": {
                    "filtered": false,
                    "severity": "safe"
                },
                "self_harm": {
                    "filtered": false,
                    "severity": "safe"
                },
                "sexual": {
                    "filtered": false,
                    "severity": "safe"
                },
                "violence": {
                    "filtered": false,
                    "severity": "safe"
                }
            },
            "finish_reason": null,
            "index": 0,
            "delta": {
                "provider_specific_fields": null,
                "refusal": null,
                "content": "当然",
                "role": "assistant",
                "tool_calls": null,
                "audio": null
            },
            "logprobs": null
        }
    ],
    "provider_specific_fields": null,
    "citations": null,
    "service_tier": null,
    "obfuscation": "Wdo"
}

错误信息

success
Boolean

请求是否成功,false表示失败。

error
Object

错误详情。

json
{
    "success": false,
    "error": {
        "code": 1003,
        "message": "参数错误",
        "litellm_message": null,
        "type": "business_error"
    }
}
错误代码错误信息
1000服务器内部错误
1003参数错误
1001数据库错误
5002模型设置未找到

目录