聊天接口

POST

/v1/chat/completions

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.uniapi.io/v1/chat/completions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "temperature": 1,
    "top_p": 1,
    "user": "user-1234",
    "service_tier": "auto",
    "messages": [
        {
            "content": "string",
            "role": "developer",
            "name": "string"
        }
    ],
    "model": "string",
    "modalities": [
        "text"
    ],
    "reasoning_effort": "medium",
    "max_completion_tokens": 0,
    "frequency_penalty": 0,
    "presence_penalty": 0,
    "web_search_options": {
        "user_location": {
            "type": "approximate",
            "approximate": {
                "country": "string",
                "region": "string",
                "city": "string",
                "timezone": "string"
            }
        },
        "search_context_size": "medium"
    },
    "top_logprobs": 0,
    "response_format": {
        "type": "text"
    },
    "audio": {
        "voice": "string",
        "format": "wav"
    },
    "store": false,
    "stream": false,
    "stop": "<|endoftext|>",
    "logit_bias": null,
    "logprobs": false,
    "max_tokens": 0,
    "n": 1,
    "prediction": {
        "type": "content",
        "content": "string"
    },
    "seed": -9223372036854776000,
    "stream_options": null,
    "tools": [
        {
            "type": "function",
            "function": {
                "description": "string",
                "name": "string",
                "parameters": {},
                "strict": false
            }
        }
    ],
    "tool_choice": "none",
    "parallel_tool_calls": true,
    "function_call": "none",
    "functions": [
        {
            "description": "string",
            "name": "string",
            "parameters": {}
        }
    ]
}'

响应示例

{
    "id": "string",
    "choices": [
        {
            "finish_reason": "stop",
            "index": 0,
            "message": {
                "content": "string",
                "refusal": "string",
                "tool_calls": [
                    {
                        "id": "string",
                        "type": "function",
                        "function": {
                            "name": "string",
                            "arguments": "string"
                        }
                    }
                ],
                "annotations": [
                    {
                        "type": "url_citation",
                        "url_citation": {
                            "end_index": 0,
                            "start_index": 0,
                            "url": "string",
                            "title": "string"
                        }
                    }
                ],
                "role": "assistant",
                "function_call": {
                    "arguments": "string",
                    "name": "string"
                },
                "audio": {
                    "id": "string",
                    "expires_at": 0,
                    "data": "string",
                    "transcript": "string"
                }
            },
            "logprobs": {
                "content": [
                    {
                        "token": "string",
                        "logprob": 0,
                        "bytes": [
                            0
                        ],
                        "top_logprobs": [
                            {
                                "token": "string",
                                "logprob": 0,
                                "bytes": [
                                    0
                                ]
                            }
                        ]
                    }
                ],
                "refusal": [
                    {
                        "token": "string",
                        "logprob": 0,
                        "bytes": [
                            0
                        ],
                        "top_logprobs": [
                            {
                                "token": "string",
                                "logprob": 0,
                                "bytes": [
                                    0
                                ]
                            }
                        ]
                    }
                ]
            }
        }
    ],
    "created": 0,
    "model": "string",
    "service_tier": "auto",
    "system_fingerprint": "string",
    "object": "chat.completion",
    "usage": {
        "completion_tokens": 0,
        "prompt_tokens": 0,
        "total_tokens": 0,
        "completion_tokens_details": {
            "accepted_prediction_tokens": 0,
            "audio_tokens": 0,
            "reasoning_tokens": 0,
            "rejected_prediction_tokens": 0
        },
        "prompt_tokens_details": {
            "audio_tokens": 0,
            "cached_tokens": 0
        }
    }
}

返回响应

🟢200成功

application/json

Body

表示模型根据提供的输入返回的聊天完成响应。

string

必需

聊天完成的唯一标识符。

choices

array [object {4}]

必需

聊天完成选项列表。如果 n 大于 1，可能有多个选项。

finish_reason

enum<string>

必需

模型停止生成令牌的原因。如果模型达到了自然的停止点或提供了停止序列，这将是 stop，

如果请求中指定的最大令牌数量已达到，这将是 length，

如果由于我们的内容过滤器的标记而省略了内容，这将是 content_filter，

如果模型调用了工具，这将是 tool_calls，或者如果模型调用了函数（已弃用），这将是 function_call。

枚举值:

stoplengthtool_callscontent_filterfunction_call

index

integer

必需

选择列表中的选择索引。

message

object (ChatCompletionResponseMessage)

必需

由模型生成的聊天完成消息。

logprobs

object | null

必需

选择的对数概率信息。

created

integer

必需

聊天完成创建时的 Unix 时间戳（以秒为单位）。

model

string

必需

用于聊天完成的模型。

service_tier

enum<string> | enum<null>

可选

指定用于处理请求的延迟层。此参数适用于订阅了规模层服务的客户：

如果设置为“auto”，且项目启用了规模层，系统将使用规模层积分，直到积分用尽。

如果设置为“auto”，且项目未启用规模层，请求将使用默认服务层处理，具有较低的正常运行时间SLA且不保证延迟。

如果设置为“default”，请求将使用默认服务层处理，具有较低的正常运行时间SLA且不保证延迟。

如果设置为“flex”，请求将使用灵活处理服务层处理。了解更多。

如果未设置此参数，默认行为为“auto”。

当设置此参数时，响应体将包含所使用的service_tier。

枚举值:

autodefaultflex

默认值:

auto

system_fingerprint

string

可选

此指纹表示模型运行的后端配置。

可以与“种子”请求参数结合使用，以了解何时进行了可能影响决定性的后端更改。

object

enum<string>

必需

对象类型，始终为 chat.completion。

枚举值:

chat.completion

usage

object (CompletionUsage)

可选

完成请求的使用统计数据。

completion_tokens

integer

必需

生成的完成内容中的标记数量。

默认值:

prompt_tokens

integer

提示中的标记数量。

必需

默认值:

total_tokens

integer

必需

请求中使用的令牌总数（提示 + 完成）。

默认值:

completion_tokens_details

object

可选

完成中使用的标记细分。

prompt_tokens_details

object

可选

提示中使用的令牌细分。

修改于 2025-05-18 07:36:21

创建转录

自动补全