格式化输出
POST/v1beta/models/gemini-2.5-pro:generateContent 格式化输出
使用 Vortap 的结构化输出能力,可以让模型按照指定的数据结构返回内容,便于程序直接解析与使用。
接口地址
POST https://www.vortapapi.com/v1/v1beta/models/gemini-2.5-pro:generateContent
查询参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | 是 | Vortap API Key,例如 sk-***。 |
请求头
| 名称 | 必填 | 说明 |
|---|---|---|
Content-Type | 是 | 请求体格式。通常设置为 application/json。 |
请求示例
curl "https://www.vortapapi.com/v1/v1beta/models/gemini-2.5-pro:generateContent?key=sk-***" \
-H "Content-Type: application/json" \
-X POST \
-d '{
"contents": [
{
"role": "user",
"parts": [
{
"text": "请提取以下信息,并按 JSON 返回:小明今年 18 岁,来自上海。"
}
]
}
],
"generationConfig": {
"responseMimeType": "application/json",
"responseSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"age": {
"type": "integer"
},
"city": {
"type": "string"
}
},
"required": ["name", "age", "city"]
}
}
}'
请求体字段说明
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
contents | array | 是 | 对话内容列表。 |
contents[].role | string | 否 | 消息角色,例如 user。 |
contents[].parts | array | 是 | 消息片段列表。 |
contents[].parts[].text | string | 是 | 输入给模型的文本内容。 |
generationConfig | object | 否 | 生成配置。 |
generationConfig.responseMimeType | string | 否 | 指定响应格式。结构化 JSON 输出通常使用 application/json。 |
generationConfig.responseSchema | object | 否 | 期望模型遵循的 JSON Schema。 |
响应示例
{
"candidates": [
{
"content": {
"parts": [
{
"text": "{\"name\":\"小明\",\"age\":18,\"city\":\"上海\"}"
}
],
"role": "model"
},
"finishReason": "STOP"
}
]
}
说明
- 当设置
responseMimeType为application/json时,模型会尽量返回可解析的 JSON 内容。 responseSchema可用于约束返回字段、类型和必填项。- 建议在服务端仍然对模型返回内容进行 JSON 解析与校验,以确保结果满足业务要求。