结构化输出

POST

{{url}}/v1/chat/completions

最后修改时间：2025-11-29 14:38:18

请求参数

Header 参数

Body 参数application/json

示例

{
    "model": "gpt-4.1-mini",
    "messages": [
        {
            "role": "system",
            "content": "提取活动信息"
        },
        {
            "role": "user",
            "content": "爱丽丝和鲍勃将于星期五参加一个科学展览会。"
        }
    ],
    "response_format": {
        "type": "json_schema",
        "json_schema": {
            "name": "CalendarEvent",
            "strict": true,
            "schema": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string"
                    },
                    "date": {
                        "type": "string"
                    },
                    "participants": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    }
                },
                "required": [
                    "name",
                    "date",
                    "participants"
                ],
                "additionalProperties": false
            }
        }
    }
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://api.example.com/v1/chat/completions' \
--header 'Authorization: Bearer sk-xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "gpt-4.1-mini",
    "messages": [
        {
            "role": "system",
            "content": "提取活动信息"
        },
        {
            "role": "user",
            "content": "爱丽丝和鲍勃将于星期五参加一个科学展览会。"
        }
    ],
    "response_format": {
        "type": "json_schema",
        "json_schema": {
            "name": "CalendarEvent",
            "strict": true,
            "schema": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string"
                    },
                    "date": {
                        "type": "string"
                    },
                    "participants": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    }
                },
                "required": [
                    "name",
                    "date",
                    "participants"
                ],
                "additionalProperties": false
            }
        }
    }
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "id": "chatcmpl-ChGNpvCnR03VcMS4q0bz2zOfnGQNV",
    "object": "chat.completion",
    "created": 1764427117,
    "model": "gpt-4.1-mini-2025-04-14",
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "{\"date\":\"星期五\",\"name\":\"科学展览会\",\"participants\":[\"爱丽丝\",\"鲍勃\"]}",
                "refusal": null,
                "annotations": []
            },
            "logprobs": null,
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 82,
        "completion_tokens": 25,
        "total_tokens": 107,
        "prompt_tokens_details": {
            "cached_tokens": 0,
            "audio_tokens": 0
        },
        "completion_tokens_details": {
            "reasoning_tokens": 0,
            "audio_tokens": 0,
            "accepted_prediction_tokens": 0,
            "rejected_prediction_tokens": 0
        }
    },
    "service_tier": "default",
    "system_fingerprint": "fp_24710c7f06"
}

修改于 2025-11-29 14:38:18

PDF识别

流式出图/视频（推荐）